latestOpenAPI 3.0.12026-08-082942150.5 KB

14cab8ac3bca

Deliverables

Get Deliverables

The function retrieves details, including metadata and the ID, for all available files of the given project ID.

Permission Required: Read Project Properties

get/v2.0/public/projects/{projectId}/deliverables

Path parameters

projectIdstring uuid required

Example:00000000-0000-0000-0000-000000000000

Project ID.

Query parameters

sortBystring

Type of filter. Valid values: "createdTimestamp", "isPartial", "downloadCount", "fileName", "type". Please note that, it is only possible to use one filter at a time.

sortDirectionstring

Order of displayed results. Valid values: "asc", "desc".

pageNumberinteger

The page to retrieve.

itemsPerPageinteger

The number of items to retrieve per page. The maximum number of items per page allowed is 100.

type'Classic' | 'Aggregated' | 'Flat' | 'CrowdMetadata'

The project deliverable type.

isPartialboolean

Indication of whether the file contains partial result set or complete result set.

Response

Success.

totalCountinteger

Total number of items available.

Example response

{
  "deliverables": [
    {
      "projectId": "00000000-0000-0000-0000-000000000000",
      "deliverableId": "00000000-0000-0000-0000-000000000000"
    }
  ]
}