API Documentation

Documents Attachments ​

Exists ​

Overview ​

The "Exists" API endpoint is used to check if a specific attachment is associated with a given document. By providing the document identifier (uid) and the attachment filename, this endpoint determines whether the specified attachment exists without retrieving or displaying the full content of the attachment. This is useful for validating the presence of attachments before attempting to access or manipulate them.

Endpoint ​

HEAD /api/v2013/documents/{uid}/attachments/{filename}

Headers ​

The request must include the following headers:

FieldTypeDescription
AcceptStringSpecifies the format in which the client expects the server to return the response data. The allowed value is application/json, indicating that the response should be in JSON format. This helps the server understand how to format the response to meet the client's expectations.
Content-TypeStringIndicates the format of the request body sent by the client. The allowed value is application/json, meaning that the data being sent to the server is formatted as JSON. This informs the server of the data type it should expect and how to process it accordingly.

URL Parameters ​

The following URL parameter is required:

FieldTypeDescription
uidStringA unique identifier for the document. This value is case-sensitive and is used to uniquely identify and retrieve the specific document. The identifier must conform to the pattern /^[A-Za-z0-9\-_]{11,128}$/, meaning it can include uppercase and lowercase letters, numbers, hyphens, and underscores, with a length between 11 and 128 characters. This ensures that each document has a distinct and valid ID.
filenameStringThe name of the file that needs to be checked for existence. This field specifies the file name to verify if it is present in the system or storage. It should be formatted correctly and include the appropriate file extension if necessary. The check will determine whether the file with the specified name exists or not, which is useful for file management and validation purposes.

Playground ​

Swagger playground is loading, please wait...

Get Thumbnail ​

Overview ​

The "Get Thumbnail" API endpoint allows you to retrieve a thumbnail representation of a specific attachment, provided the attachment is an image. This endpoint is designed to offer a preview of the image in a smaller, more manageable format, which is especially useful for displaying previews in user interfaces, galleries, or file management systems.

Endpoint ​

GET /api/v2013/documents/{uid}/attachments/{filename}/thumbnail

Headers ​

The request must include the following headers:

FieldTypeDescription
AcceptStringSpecifies the format in which the client expects the server to return the response data. The allowed value is application/json, indicating that the response should be in JSON format. This helps the server understand how to format the response to meet the client's expectations.
Content-TypeStringIndicates the format of the request body sent by the client. The allowed value is application/json, meaning that the data being sent to the server is formatted as JSON. This informs the server of the data type it should expect and how to process it accordingly.

URL Parameters ​

The following URL parameter is required:

FieldTypeDescription
uidStringA unique identifier for the document. This value is case-sensitive and is used to uniquely identify and retrieve the specific document. The identifier must conform to the pattern /^[A-Za-z0-9\-_]{11,128}$/, meaning it can include uppercase and lowercase letters, numbers, hyphens, and underscores, with a length between 11 and 128 characters. This ensures that each document has a distinct and valid ID.
filenameStringThe name of the file that needs to be checked for existence. This field specifies the file name to verify if it is present in the system or storage. It should be formatted correctly and include the appropriate file extension if necessary. The check will determine whether the file with the specified name exists or not, which is useful for file management and validation purposes.

Playground ​

Swagger playground is loading, please wait...

Get ​

Overview ​

The "Get" API endpoint allows you to retrieve the data of a specific attachment associated with a given document. By providing the document identifier (uid) and the attachment filename, this endpoint returns the attachment in its original format, provided that it exists. This is useful for downloading or accessing the content of an attachment directly.

Endpoint ​

GET /api/v2013/documents/{uid}/attachments/{filename}

Headers ​

The request must include the following headers:

FieldTypeDescription
AcceptStringSpecifies the format in which the client expects the server to return the response data. The allowed value is application/json, indicating that the response should be in JSON format. This helps the server understand how to format the response to meet the client's expectations.
Content-TypeStringIndicates the format of the request body sent by the client. The allowed value is application/json, meaning that the data being sent to the server is formatted as JSON. This informs the server of the data type it should expect and how to process it accordingly.

URL Parameters ​

The following URL parameter is required:

FieldTypeDescription
uidStringA unique identifier for the document. This value is case-sensitive and is used to uniquely identify and retrieve the specific document. The identifier must conform to the pattern /^[A-Za-z0-9\-_]{11,128}$/, meaning it can include uppercase and lowercase letters, numbers, hyphens, and underscores, with a length between 11 and 128 characters. This ensures that each document has a distinct and valid ID.
filenameStringThe name of the file that needs to be checked for existence. This field specifies the file name to verify if it is present in the system or storage. It should be formatted correctly and include the appropriate file extension if necessary. The check will determine whether the file with the specified name exists or not, which is useful for file management and validation purposes.

Playground ​

Swagger playground is loading, please wait...

List ​

Overview ​

The "List" API endpoint retrieves a comprehensive list of attachments associated with a specific document. This endpoint is designed to support various filtering, ordering, and pagination options, allowing you to efficiently manage and retrieve attachments based on specific criteria.

Endpoint ​

GET /api/v2013/documents/{uid}/attachments

Headers ​

The request must include the following headers:

FieldTypeDescription
AuthorizationStringContains the token used for authenticating the request. This header is crucial for accessing protected resources and services. It typically holds a bearer token or other authentication credentials that the server uses to verify the identity of the client making the request. Ensure that the token is valid and kept confidential.
AcceptStringSpecifies the desired format for the response from the server. The allowed value is "application/json", which means the client expects the response data to be formatted in JSON. This header helps the server understand how to structure the response to meet the client's expectations and ensure compatibility with the client's data handling mechanisms.

Query Parameters ​

The following query parameters can be used to refine the request:

FieldTypeDescription
filterStringOptional. The $filter system query option enables clients to specify criteria for filtering the results of a query. This allows for retrieving only those resources that meet certain conditions or constraints. For example, you can use $filter to return only items that have a specific property value or that fall within a certain range. For detailed usage and examples, refer to the OData $filter documentation.
orderbyStringOptional. The $orderby system query option allows clients to sort the results of a query based on one or more properties. By specifying this option, you can control the order in which resources are returned, such as sorting by date, name, or any other attribute. This helps in organizing the results in a meaningful way according to the specified criteria. For detailed usage and examples, refer to the OData $orderby documentation.
topStringOptional. The $top system query option limits the number of items returned in the result set. This is useful for pagination or for retrieving a subset of the total results, such as getting the top N records. For example, specifying $top=10 would return only the first 10 items of the queried collection. For detailed usage and examples, refer to the OData $top documentation.
skipStringOptional. The $skip system query option specifies the number of items to be skipped from the beginning of the result set. This is commonly used in conjunction with $top to implement pagination, where you can skip a certain number of records and then return the next set. For example, specifying $skip=20 would skip the first 20 items and return the subsequent items from the query. For detailed usage and examples, refer to the OData $skip documentation.

Playground ​

Swagger playground is loading, please wait...

Update ​

Overview ​

The "Update" API endpoint allows you to modify the details of a specific attachment associated with a given document. This endpoint provides the functionality to update metadata related to the attachment, such as its name, description, or other relevant attributes. This operation is crucial for maintaining accurate and up-to-date information about attachments within the document management system.

Endpoint ​

PUT /api/v2013/documents/{uid}/attachments/{filename}

Headers ​

The request must include the following headers:

FieldTypeDescription
AuthorizationStringContains the token used for authenticating the request. This header is crucial for accessing protected resources and services. It typically holds a bearer token or other authentication credentials that the server uses to verify the identity of the client making the request. Ensure that the token is valid and kept confidential.
AcceptStringSpecifies the desired format for the response from the server. The allowed value is "application/json", which means the client expects the response data to be formatted in JSON. This header helps the server understand how to structure the response to meet the client's expectations and ensure compatibility with the client's data handling mechanisms.

URL Parameters ​

The following URL parameter is required:

FieldTypeDescription
uidStringA unique identifier for the document. This value is case-sensitive and is used to uniquely identify and retrieve the specific document. The identifier must conform to the pattern /^[A-Za-z0-9\-_]{11,128}$/, meaning it can include uppercase and lowercase letters, numbers, hyphens, and underscores, with a length between 11 and 128 characters. This ensures that each document has a distinct and valid ID.
filenameStringThe name of the file that needs to be checked for existence. This field specifies the file name to verify if it is present in the system or storage. It should be formatted correctly and include the appropriate file extension if necessary. The check will determine whether the file with the specified name exists or not, which is useful for file management and validation purposes.

Playground ​

Swagger playground is loading, please wait...