Update an Automation Output Processor

PATCH

https://{tenant_name}.benchling.com/api/v2/automation-output-processors/:output_processor_id

PATCH

/api/v2/automation-output-processors/:output_processor_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v2/automation-output-processors/output_processor_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "fileId": "cd624536-c6ba-41b9-b802-9461689e2ea3 or file_65Cevxgm"
}'

{
  "assayRunId": "588aca02-1a20-4b94-a40f-b3f3a0081749",
  "automationFileConfig": {
    "name": "MyInstrumentName"
  },
  "file": {
    "id": "c33fe52d-fe6a-4c98-adcd-211bdf6778f7",
    "mimeType": "text/csv",
    "name": "MyInstrumentInputFile.csv",
    "type": "RAW_FILE",
    "uploadStatus": "IN_PROGRESS"
  },
  "id": "aop_C3wGA9HF",
  "status": "SUCCEEDED",
  "apiURL": "https://benchling.com/api/v2/automation-output-processors/aop_C3wGA9HF",
  "archiveRecord": {
    "reason": "Made in error"
  },
  "completeWithErrors": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "errorFile": {
    "id": "c33fe52d-fe6a-4c98-adcd-211bdf6778f7",
    "mimeType": "text/csv",
    "name": "MyInstrumentInputFile.csv",
    "type": "RAW_FILE",
    "uploadStatus": "IN_PROGRESS"
  },
  "modifiedAt": "2024-01-15T09:30:00Z",
  "progressStats": {
    "rowsFailed": 1,
    "rowsSucceeded": 1,
    "rowsUnprocessed": 1
  },
  "transforms": [
    {
      "apiURL": "string",
      "blobId": "string",
      "customTransformId": "string",
      "errors": {
        "topLevelErrors": [
          {
            "errorMessage": "string"
          }
        ]
      },
      "id": "string",
      "inputGeneratorId": "string",
      "modifiedAt": "2024-01-15T09:30:00Z",
      "outputProcessorId": "string",
      "status": "NOT_STARTED"
    }
  ]
}

Update an Automation Output Processor

Authentication

AuthorizationBearer

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

Path parameters

output_processor_idstringRequired

Request

This endpoint expects an object.

fileIdstringRequired

The ID of a blob link or the API ID of a file to process.

Response

assayRunIdstringOptional

automationFileConfigobjectOptional

fileobject or nullOptional

idstringOptional

statusenumOptional

Allowed values:

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the Automation Output Processor in the API.

archiveRecordobject or nullOptional

completeWithErrorsbooleanOptional

Specifies whether file processing should complete with errors. False means any error in output file processing will result in no actions being committed. True means that if row-level errors occur, then failing rows and their errors will be saved to errorFile, and actions from successful rows will be committed.

createdAtdatetimeOptional

DateTime the Automation Output Processor was created

errorFileobject or nullOptional

modifiedAtdatetimeOptional

DateTime the Automation Output Processor was last modified

progressStatsobjectOptional

Processing progress information.

transformslist of objectsOptional

Errors

400

Bad Request Error