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
Request
- Base URLhttps://api.production-na01.definedcrowd.com (the document declares no server; this is the origin it was published from)
- AuthAPI key in header Authorization
- TypeScriptA function with typed inputs. Its response is checked against the schema.
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.
Example response
{
"deliverables": [
{
"projectId": "00000000-0000-0000-0000-000000000000",
"deliverableId": "00000000-0000-0000-0000-000000000000"
}
]
}Changes
No recorded changes to this operation across all 1 revision of this API.