Update ScratchFile

Beta

PATCH

https://{tenant_name}.benchling.com/api/v3/scratch-file/:scratch_file_id

PATCH

/api/v3/scratch-file/:scratch_file_id

curl -X PATCH https://{tenant_name}.benchling.com/api/v3/scratch-file/scratch_file_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "uploadStatus": "SUCCEEDED"
}'

{
  "__typename": "__typename",
  "createdAt": "createdAt",
  "creator": {
    "__typename": "__typename",
    "id": "id"
  },
  "downloadUrl": "downloadUrl",
  "errorMessage": "errorMessage",
  "externalFileId": "externalFileId",
  "file": {
    "__typename": "__typename",
    "id": "id"
  },
  "filename": "filename",
  "id": "id",
  "mimeType": "mimeType",
  "modifiedAt": "modifiedAt",
  "name": "name",
  "originAutomationStepData": {
    "__typename": "__typename",
    "id": "id"
  },
  "size": 1,
  "uploadStatus": "SUCCEEDED",
  "uploadUrl": "uploadUrl",
  "originPipelineStepData": {
    "__typename": "__typename",
    "id": "id"
  }
}

Update ScratchFile.

Authentication

AuthorizationBearer

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

Path parameters

scratch_file_idstringRequired

ID of the ScratchFile.

Request

This endpoint expects an object.

uploadStatusenumRequired

Allowed values:

Response

__typenamestringOptional

createdAtstring or nullOptional

creatorobjectOptional

downloadUrlstring or nullOptional

errorMessagestring or nullOptional

externalFileIdstring or nullOptional

fileobject or nullOptional

filenamestringOptional

idstringOptional

mimeTypestring or nullOptional

modifiedAtstring or nullOptional

namestringOptional

originAutomationStepDataobject or nullOptional

The automation step data that produced this file.

sizeinteger or nullOptional

uploadStatusenumOptional

Allowed values:

uploadUrlstring or nullOptional

originPipelineStepDataobject or nullOptionalDeprecated

Use originAutomationStepData instead.

Errors

400

Scratch File Update Request Bad Request Error

403

Scratch File Update Request Forbidden Error

404

Scratch File Update Request Not Found Error

409

Scratch File Update Request Conflict Error

429

Scratch File Update Request Too Many Requests Error

500

Scratch File Update Request Internal Server Error

Authentication

Path parameters

Headers

Request

Response

Errors