Create WorkflowOutput

POST

https://{tenant_name}.benchling.com/api/v3/workflow-output

POST

/api/v3/workflow-output

curl -X POST https://{tenant_name}.benchling.com/api/v3/workflow-output \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "taskId": "taskId"
}'

{
  "__typename": "__typename",
  "archiveReason": "archiveReason",
  "archived": true,
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "displayId": "displayId",
  "id": "id",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "schema": {
    "__typename": "__typename",
    "id": "id"
  },
  "schemaFields": [
    {
      "__typename": "__typename",
      "id": "id",
      "linkedEntityId": "linkedEntityId"
    }
  ],
  "task": {
    "__typename": "__typename",
    "id": "id"
  },
  "workflowTaskGroup": {
    "__typename": "__typename",
    "id": "id"
  }
}

Create WorkflowOutput.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

taskIdstringRequired

The ID of the workflow task that this output belongs to. The task must be in the IN_PROGRESS status.

schemaFieldsmap from strings to objectsOptional

Schema field values for the output, keyed by field name.

Response

Created

__typenamestringOptional

archiveReasonstring or nullOptional

Reason the item was archived

archivedbooleanOptional

If the item is archived

createdAtstringOptional

creatorobjectOptional

The creator of the item

displayIdstringOptional

User-friendly ID of the workflow output

idstringOptional

The ID of the workflow output

modifiedAtstringOptional

namestringOptional

schemaobjectOptional

schemaFieldslist of objects or nullOptional

taskobjectOptional

workflowTaskGroupobjectOptional

Errors

400

Workflow Output Create Request Bad Request Error

403

Workflow Output Create Request Forbidden Error

404

Workflow Output Create Request Not Found Error

409

Workflow Output Create Request Conflict Error

429

Workflow Output Create Request Too Many Requests Error

500

Workflow Output Create Request Internal Server Error