Back to QMetry All Products Help Page
API for Attachment
- Mrunalini Potnis
Get List of Linked Attachments
POST /rest/attachments/list
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
entityId | body | yes | entity ID | - | string |
entityType | body | yes | entityType | - | string |
start | body | yes | start index of records | - | integer |
limit | body | yes | number of records per page | - | integer |
page | body | yes | page number to be displayed | - | integer |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Linked attachments shown successfully | |
400 | Invalid json object or mandatory fields missing | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Download Attachment
GET /rest/attachments/{id}
Request
Content-Type: application/json
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
body | body | no | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model |
|---|---|---|
200 | Attachment downloaded successfully | - |
401 | Unauthorised or session expired | - |
500 | Returned when server connection times out | - |
Upload Attachment
POST /rest/attachments
API to upload attachment
Request
Parameters
Name | Located in | Required | Description | Default | Schema |
|---|---|---|---|---|---|
file[] | formData | yes | file to upload | - | string |
Response
Content-Type: application/json
Status Code | Reason | Response Model</ |
|---|