Sign in
latestOpenAPI 3.0.12026-08-082942150.5 KB

14cab8ac3bca

Project Management

Get Project Status

When invoked, Get Project Status returns current project status and — if input data errors were detected — error information associated with each input data unit where an error occurred.

A project’s state can change due to REST API calls executed by your code, changes made to a project in the Enterprise Portal as well as project-related events occurring at Defined.ai. It is not guaranteed that project states follow a sequential, ordered progression.

REST API Call InvocationProject Related EventProject StatusInvokable REST API Calls
Create ProjectProject has been createdNOT ACTIVEUpload Data Units
Delete Project
Upload Data UnitsDefined.ai is running validationPROCESSING DATA UPLOAD
Upload to Defined.ai is complete and no errors were detectedUPLOAD SUCCESSUpload Data Units
Delete Project
Upload to Defined.ai is complete but Defined.ai found errors in some Input UnitsUPLOAD ERRORSUpload Data Units
Delete Project
Upload to Defined.ai is complete but no data unit is validINSUFFICIENT DATAUpload Data Units
Delete Project
Defined.ai is preparing the project before deploying it to our human intelligence communityPREPARING PROJECTCancel Project
Defined.ai has deployed the project to our human intelligence communityRUNNINGCancel Project
Defined.ai is accessing the quality of the human intelligence communityASSESSING QUALITYCancel Project
Defined.ai is curating and preparing the results for downloadGENERATING RESULTS
Defined.ai has completed the project and data is available for downloadPROJECT COMPLETEDDelete Project
Get Deliverables
Cancel ProjectDefined.ai has canceled the projectCANCELLEDDelete Project
Delete ProjectDefined.ai has deleted the projectDELETED

Permission Required: Read Project Properties

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

Path parameters

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

Project identifier.

Response

The ProjectStatus structure.

Example response

{
  "projectDetails": {
    "id": "00000000-0000-0000-0000-000000000000",
    "uploadInputUnitsError": [
      {
        "inputDataUnitId": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}