Workflow APIs

You can manage workflow with the following APIs.


Get Workflow Definitions

Use this API to get limited information about all workflow definitions.

HTTP Request

GET /api/v3/workflow_definitions?organizationId={organizationId}

Query Parameters

Key Required Description
organizationId yes Supply your organization's internal identifier. (It's the 123 in this example: https://lab.ovation.io/orgs/123/dashboard.)

Response Body

{
  "workflow_definitions": [
    {
      "id": 1234,
      "name": "Some Name"
    },
    {
      "id": 5678,
      "name": "Another Name"
    }
  ]
}
Field name Description
workflow_definitions[].id The internal identifier of the workflow definition. Optionally provide this to the Get a QC Workflow Report API.
workflow_definitions[].name The workflow definition's name

Get Workflow

Use this API to get detailed information about a workflow.

HTTP Request

GET /api/v3/workflows/{Id}

Query Parameters

Key Required Description
Id yes Supply the internal identifier of the workflow. (It's the 456 in this example: https://lab.ovation.io/orgs/123/workflows/456.)

Response Body

{
  "workflow": {
    "id": 22709,
    "name": "Mini Workflow",
    "status": "completed",
    "workflowDefinitionId": 115051,
    "createdAt": "2024-01-26T19:16:32Z",
    "completedAt": "2024-01-26T19:26:29Z",
    "samples": [
      {
        "identifier": "sample 1",
        "workflowSampleResultIds": [
          128211
        ]
      },
      {
        "identifier": "sample 2",
        "workflowSampleResultIds": [
          128212
        ]
      }
    ]
  }
}
Field name Description
id The internal identifier of the workflow (as provided)
name The workflow's name
status The workflow's status
workflowDefinitionId The workflow's definition's internal ID. Optionally provide this to the Get a QC Workflow Report API.
createdAt When the workflow was created
completedAt When the workflow was completed
samples[] Array of samples included in the workflow
samples[].identifier The sample's internal identifier
samples[].workflowSampleResultIds Comma-separated list of test results for the sample. Provide these to the Get Test Result or Get Test Results API.
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.