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}

Request

Base URL
https://api.production-na01.definedcrowd.com (the document declares no server; this is the origin it was published from)
Auth
API key in header Authorization
TypeScript
https://skmtc.dev/definedcrowd/apis/defined-ai-api/docs/v2.0/public/projects/:projectId/deliverables/:deliverableId/get.ts
A function with typed inputs. Its response is checked against the schema.

projectIdstring uuid required

Example:00000000-0000-0000-0000-000000000000

Project ID.

deliverableIdstring uuid required

Example:00000000-0000-0000-0000-000000000000

Deliverable ID.

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.

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

No recorded changes to this operation across all 1 revision of this API.