Sign in
latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Attachments

Find attachments

Returns attachments matching the given search criteria. Only parameters that are specified in this request and have not <code>null</code> values are used for filtering. All other parameters are ignored. The returned attachments satisfy all constraints that are specified in this search criteria. By default a result containing 1000 attachments is returned.

get/attachments

Query parameters

offsetinteger

The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>.

limitinteger

The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000.

countLimitinteger

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

fileNamestring

The name of the file representing searched attachment.

fileContentTypestring

The type of the content of the file representing searched attachment.

uploadDateinteger

The date of attachment upload. It is the timestamp (in UTC time standard).

userIdstring uuid

The ID of the user who uploaded the attachment.

baseResourceIdstring uuid

The ID of the resource the attachment refers to.

sortField'FILE_CONTENT_TYPE' | 'CREATED_BY' | 'FILE_NAME' | 'CREATED_ON' | 'BASE_RESOURCE_ID' | 'LAST_MODIFIED'

The field that should be used as reference for sorting.

sortOrder'ASC' | 'DESC'

The order of sorting.

Response

OK - The request has succeeded.

totalinteger

The total number of results.

offsetinteger

The offset for the results.

limitinteger

The maximum number of results to be returned.