Appearance
Document Attachments
Files attached to a document (uploaded to temporary storage first, then persisted onto the record).
List attachments
GET/api/v2013/documents/{uid}/attachments
This playground connects to the production environment (
api.cbd.int). Requests made here affect real, live data.This is a protected route. To access this content, you need to be logged in. Logging in will provide you with an authentication token, which is required for making API calls.
Swagger playground is loading, please wait...
An error occurred while loading Swagger playground, please refresh the page.
Get attachment data
GET/api/v2013/documents/{uid}/attachments/{attachmentId}/{guid}/{filename}
This playground connects to the production environment (
api.cbd.int). Requests made here affect real, live data.Swagger playground is loading, please wait...
An error occurred while loading Swagger playground, please refresh the page.
Get attachment thumbnail
GET/api/v2013/documents/{uid}/attachments/{attachmentId}/{filename}/{guid}/thumbnail
This playground connects to the production environment (
api.cbd.int). Requests made here affect real, live data.Swagger playground is loading, please wait...
An error occurred while loading Swagger playground, please refresh the page.
Check an attachment exists
HEAD/api/v2013/documents/{uid}/attachments/{attachmentId}
This playground connects to the production environment (
api.cbd.int). Requests made here affect real, live data.Swagger playground is loading, please wait...
An error occurred while loading Swagger playground, please refresh the page.
Create an attachment
POST/api/v2013/documents/{uid}/attachments/{filename}
This playground connects to the production environment (
api.cbd.int). Requests made here affect real, live data.This is a protected route. To access this content, you need to be logged in. Logging in will provide you with an authentication token, which is required for making API calls.
Swagger playground is loading, please wait...
An error occurred while loading Swagger playground, please refresh the page.
Persist an attachment from temporary storage
POST/api/v2013/documents/{uid}/attachments/persist-temporary/{tempFileId}
This playground connects to the production environment (
api.cbd.int). Requests made here affect real, live data.This is a protected route. To access this content, you need to be logged in. Logging in will provide you with an authentication token, which is required for making API calls.
Swagger playground is loading, please wait...
An error occurred while loading Swagger playground, please refresh the page.