Retrieves the metadata for all files attached to the given form data. In order to get the contents of a file itself, use the Get attachment file by ID endpoint, passing the id from the metadata object returned by this request as the attachmentId parameter of that request.
Permissions
To use this endpoint, the user is required to have the Forms View (Forms_ViewAccess) permission for the iTwin, or for the form's definition if form definition security is specified. (Having any other Forms permission automatically grants the View permission as well.)
Authentication
Requires Authorization header with valid Bearer token for scope itwin-platform.
For more documentation on authorization and how to get access token visit OAUTH2 Authorization page.
Request parameters
The ID of the form data instance for which to retrieve attachments
Request headers
OAuth access token with itwin-platform scope
Setting to application/vnd.bentley.itwin-platform.v1+json is recommended.
Response 200 OK
OK
{ "attachments": [{ "id": "XZzxOCC8sVvUcgeXz1Ih_exlLgPfRTpAuShXz1cTpAu", "fileName": "CrackedConcrete.png", "createdDateTime": "2020-10-20T16:16:30.6704320Z", "size": 34770, "caption": "Picture of the cracked concrete", "binding": null, "type": "png" }, { "id": "XZzxOCC8sVvUcgeXz1Ih_exlLgPfRTpAuShXz1cTpAu", "fileName": "StreetView.png", "createdDateTime": "2020-10-20T16:08:30.2804722Z", "size": 56893, "caption": "Picture showing the bridge from the perspective of an approaching car", "binding": "Location", "type": "png" } ] }
Response 401 Unauthorized
This response indicates that request lacks valid authentication credentials. Access token might not been provided, issued by the wrong issuer, does not have required scopes or request headers were malformed.
{ "error": { "code": "HeaderNotFound", "message": "Header Authorization was not found in the request. Access denied." } }
Response 404 Not Found
This response indicates that the specified form data instance does not exist or is inaccessible to the user.
{ "error": { "code": "FormDataNotFound", "message": "Requested form data is not available.", "target": "id" } }
Response 429 Too many requests
This response indicates that the user has sent too many requests in a given amount of time.
{ "error": { "code": "TooManyRequests", "message": "More requests were received than the subscription rate-limit allows." } }
Response headers
The number of requests exceeds the rate-limit for the client subscription.
Attachment Metadata List
{ "type": "object", "title": "Attachment Metadata List", "properties": { "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/attachment-metadata-get" } } }, "additionalProperties": false }
Attachment Metadata (get)
Read-only. String that uniquely identifies this attachment and can be used in the Get attachment file by ID request to download the file.
The name of the file that was uploaded.
Read-only. File extension of the uploaded file. Derived from fileName.
Descriptive string provided by a user for this attachment, if any.
Date and time the attachment was uploaded. Read-only; auto-set when attachment is created.
Size of the file in bytes. Read-only; auto-set when attachment is created.
If the attachment was uploaded from an Image Drop control, this is the property name the control is bound to. Otherwise, null.
{ "type": "object", "title": "Attachment Metadata (get)", "properties": { "id": { "type": "string", "description": "Read-only. String that uniquely identifies this attachment and can be used in the `Get attachment file by ID` request to download the file." }, "fileName": { "type": "string", "description": "The name of the file that was uploaded." }, "type": { "type": "string", "nullable": true, "description": "Read-only. File extension of the uploaded file. Derived from fileName." }, "caption": { "type": "string", "nullable": true, "description": "Descriptive string provided by a user for this attachment, if any." }, "createdDateTime": { "type": "string", "format": "date-time", "description": "Date and time the attachment was uploaded. Read-only; auto-set when attachment is created." }, "size": { "type": "integer", "nullable": true, "description": "Size of the file in bytes. Read-only; auto-set when attachment is created." }, "binding": { "type": "string", "nullable": true, "description": "If the attachment was uploaded from an Image Drop control, this is the property name the control is bound to. Otherwise, null." } }, "additionalProperties": false }
Error
Contains error information.
One of a server-defined set of error codes.
A human-readable representation of the error.
The target of the error.
{ "type": "object", "description": "Contains error information.", "properties": { "code": { "type": "string", "description": "One of a server-defined set of error codes." }, "message": { "type": "string", "description": "A human-readable representation of the error." }, "target": { "type": "string", "description": "The target of the error.", "nullable": true } }, "required": [ "code", "message" ], "additionalProperties": true }
Error Response
Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.
{ "type": "object", "title": "Error Response", "description": "Gives details for an error that occurred while handling the request. Note that clients MUST NOT assume that every failed request will produce an object of this schema, or that all of the properties in the response will be non-null, as the error may have prevented this response from being constructed.", "properties": { "error": { "description": "Error information.", "$ref": "#/components/schemas/Error" } }, "required": [ "error" ], "additionalProperties": false }
Was this page helpful?