Update an Automation Input Generator

PATCH

https://{tenant_name}.benchling.com/api/v2/automation-input-generators/:input_generator_id

PATCH

/api/v2/automation-input-generators/:input_generator_id

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

{
  "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": "aif_C3wGA9HF",
  "status": "SUCCEEDED",
  "apiURL": "https://benchling.com/api/v2/automation-input-generators/aif_C3wGA9HF",
  "createdAt": "2024-01-15T09:30:00Z",
  "modifiedAt": "2024-01-15T09:30:00Z",
  "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 Input Generator

Authentication

AuthorizationBearer

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

Path parameters

input_generator_idstringRequired

Request

This endpoint expects an object.

fileIdstring or nullOptional

The ID of the file (blob) associated with the input generator. Set to null to remove an existing file from the generator.

Response

assayRunIdstringOptional

automationFileConfigobjectOptional

fileobject or nullOptional

idstringOptional

statusenumOptional

Allowed values:

apiURLstringOptionalRead-onlyformat: "uri"

The canonical url of the Automation Input Generator in the API.

createdAtdatetimeOptionalRead-only

DateTime the Automation Input Generator was last modified

modifiedAtdatetimeOptionalRead-only

DateTime the Automation Input Generator was last modified

transformslist of objectsOptional

Errors

400

Bad Request Error