Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

PI Web API Reference

EventFrame GetAnnotationAttachmentMediaMetadataById

EventFrame GetAnnotationAttachmentMediaMetadataById

EventFrame GetAnnotationAttachmentMediaMetadataById

Gets the metadata of the media attached to the specified annotation.

Request

GET eventframes/{webId}/annotations/{id}/attachment/media/metadata

URL Parameters

  • webId

    The ID of the owner event frame.

  • id

    The Annotation identifier of the specific annotation.

  • selectedFields

    List of fields to be returned in the response, separated by semicolons (;). If this parameter is not specified, all available fields will be returned. See Selected Fields for more information.

  • webIdType

    Optional parameter. Used to specify the type of WebID. Useful for URL brevity and other special cases. Default is the value of the configuration item "WebIDType". See WebID Type for more information.

Status Codes

200: The requested metadata.

400: The supplied Web ID could not be parsed, or the request was somehow otherwise invalid.

404: The specified Event Frame did not exist, the specified annotation was not found, or the annotation did not have attached media.

Sample Response Body

{
  "Author": "DOMAIN\\username",
  "ChangeDate": "2017-12-06T19:12:06.8369725Z",
  "Description": "The description of my media",
  "Name": "myExampleMedia.pdf",
  "Size": 86753098675309.0,
  "Links": {
    "Self": "https://localhost/piwebapi/eventframes/I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAChexQ/annotations/bf92908e-b313-4e81-80eb-86333171938c/attachment/media/metadata",
    "Owner": "https://localhost/piwebapi/eventframes/I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAChexQ/annotations/bf92908e-b313-4e81-80eb-86333171938c",
    "MediaData": "https://localhost/piwebapi/eventframes/I1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAChexQ/annotations/bf92908e-b313-4e81-80eb-86333171938c/attachment/media/mediadata"
  }
}
In This Topic
TitleResults for “How to create a CRG?”Also Available in