Update a workflow output

PATCH

https://{tenant_name}.benchling.com/api/v2/workflow-outputs/:workflow_output_id

PATCH

/api/v2/workflow-outputs/:workflow_output_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v2/workflow-outputs/wfout_5cJLQKVF \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "displayId": "string",
  "id": "wfout_5cJLQKVF",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "createdAt": "2020-08-01T00:00:00.000Z",
  "creationOrigin": {
    "application": "string",
    "originId": "string",
    "originModalUuid": "string",
    "originType": "string"
  },
  "fields": {},
  "modifiedAt": "2020-08-01T00:00:00.000Z",
  "nextOutputs": [
    {
      "displayId": "string",
      "id": "wfout_5cJLQKVF"
    }
  ],
  "nextTasks": [
    {
      "displayId": "string",
      "id": "wftask_OnnsW08k"
    }
  ],
  "sourceOutputs": [
    {
      "displayId": "string",
      "id": "wfout_5cJLQKVF"
    }
  ],
  "sourceTasks": [
    {
      "displayId": "string",
      "id": "wftask_OnnsW08k"
    }
  ],
  "webURL": "string",
  "workflowTask": {
    "displayId": "string",
    "id": "wftask_OnnsW08k"
  },
  "workflowTaskGroup": {
    "displayId": "string",
    "id": "prs_giVNQcTL",
    "name": "string"
  }
}

Update a workflow output

Authentication

AuthorizationBearer

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

Path parameters

workflow_output_idstringRequired

The ID of the workflow output

Request

This endpoint expects an object.

fieldsmap from strings to objectsOptional

Response

displayIdstringOptional

User-friendly ID of the workflow task group

idstringOptionalRead-only

The ID of the workflow output

archiveRecordobject or nullOptional

createdAtstringOptional

The ISO formatted date and time that the task was created

creationOriginobjectOptional

fieldsmap from strings to objectsOptional

modifiedAtstringOptional

The ISO formatted date and time that the task was last modified

nextOutputslist of objectsOptional

The outputs in the flowchart which are generated by this output.

nextTaskslist of objectsOptional

The downstream tasks in the flowchart which are generated by this output.

sourceOutputslist of objectsOptional

The outputs in the flowchart which were used to generate this output.

sourceTaskslist of objectsOptional

The tasks in the flowchart which were used to generate this output.

webURLstringOptionalRead-onlyformat: "uri"

URL of the workflow output

workflowTaskobjectOptional

workflowTaskGroupobjectOptional

Errors

400

Bad Request Error

404

Not Found Error