Sign in
latestOpenAPI 3.0.12026-08-082942150.5 KB

14cab8ac3bca

Deliverables

Get Deliverable Details

Retrieves a deliverable file with details on what will be provided for each project.

Permission Required: Read Project Properties

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

Path parameters

projectIdstring uuid required
Example:00000000-0000-0000-0000-000000000000

Project ID.

deliverableIdstring uuid required
Example:00000000-0000-0000-0000-000000000000

Deliverable ID.

Response

Success.

projectIdstring uuid

Project ID.

deliverableIdstring uuid

Deliverable ID within a project.

typestring nullable

Classic</br> is a standard JSON format generated by our API.

Aggregated</br> is a format that combines results for all responses at the task level.

Flat</br> is a result file at the response level.

CrowdMetadata</br> contains information about the contributors that are relevant to their results.

fileNamestring nullable

Name of the result file.

createdTimestampstring date-time

Date and timestamp of when the file was created.

isPartialboolean

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

downloadCountinteger

Number of times file was downloaded.

Example response

{
  "projectId": "00000000-0000-0000-0000-000000000000",
  "deliverableId": "00000000-0000-0000-0000-000000000000"
}