EventFrame GetAnnotationAttachmentMediaById

Retrieves the requested media.

Request

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

URL Parameters

• webId

  The ID of the owner event frame.

• id

  The Annotation identifier of the specific annotation.

• disposition

  Optional parameter. When present, overrides the disposition type of the Content-Disposition of the response. Can be "Attachment" or "Inline".

• 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 media's metadata and mediadata, in that order. To receive this response, the request must include the Accept: multipart/related header value.

300: A collection of choices of media representations. The response's Location header is a link to the preferred representation. Representations are given as links in the Links object of the response.

304: The resource has not been modified since the time specified by the request's If-Modified-Since header.

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.

412: Request header preconditions could not be satisfied.

Sample Response Body

{
  "Reason": "The requested resource has multiple representations.",
  "Links": {
    "MediaData": "https://localhost/piwebapi/eventframes/F1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAChexQUkVTVFVOSVRcRFJFWEVMXEVWRU5URlJBTUVTW0hBU0ZJTEVBTk5PVEFUSU9OXQ/annotations/bf92908e-b313-4e81-80eb-86333171938c/attachment/media/mediadata",
    "MediaMetadata": "https://localhost/piwebapi/eventframes/F1FmDqD5loBNH0erqeqJodtALADqD5loBNH0cAAAAAAChexQUkVTVFVOSVRcRFJFWEVMXEVWRU5URlJBTUVTW0hBU0ZJTEVBTk5PVEFUSU9OXQ/annotations/bf92908e-b313-4e81-80eb-86333171938c/attachment/media/metadata"
  }
}