EventFrame CreateAnnotationAttachmentMediaById
- Last UpdatedJun 15, 2023
- 1 minute read
- PI System
- PI Web API Reference
- Developer
EventFrame CreateAnnotationAttachmentMediaById
Attaches the supplied media to the specified event frame annotation, replacing any existing media already attached.
Request
POST eventframes/{webId}/annotations/{id}/attachment/media
URL Parameters
-
webId The ID of the owner event frame of the annotation on which to attach the media. See WebID for more information.
-
id The Annotation identifier of the specific annotation.
-
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.
Body Parameter
The media to attach to the annotation formatted as multipart/form-data. The Content-Disposition header must have the filename property set to the desired filename, encapsulated in double quotes. See Multipart Requests for more information.
Status Codes
201: The media was attached to the specified event frame annotation. The response's Location header is a link to the media metadata.
Sample Request Body
--AUNIQUESTRINGNOTINTHECONTENT
Content-Type: text/plain
Content-Disposition: attachment; filename="thisIsMyFileName.txt"
This is an example of some file content.
The file being uploaded in this example is plaintext, but any file type supported for
upload on your Asset Framework server can be used.
--AUNIQUESTRINGNOTINTHECONTENT--