ONonecodex

PATCH assets

Changed on
patch/api/v1/assets/{id}

Request

  • Base URL
    https://app.onecodex.com
  • URL
    https://app.onecodex.com/api/v1/assets/{id}
  • Auth
    API key in header X-API-Key

Path parameters

idstring required

Request body

namestring required

A new display name for the asset.

Response

OK

$uristring required
created_atstring date-time required

Timestamp for when the object was created on the One Codex platform, encoded as a RFC 3339 timestamp.

filenamestring required

The asset filename.

namestring required

A display name for the asset. Defaults to the filename if not provided at upload time.

sizeinteger nullable

The size of the uploaded file in bytes.

status'importing' | 'available' | 'failed' required

The status of the asset. importing while the file is being copied to One Codex storage, available once the asset is ready to use, and failed if the import did not succeed.

Example response

{
  "$uri": "/api/v1/assets/0d77065796f8d173",
  "uploader": {
    "__DOLLAR_REF__": "/api/v1/users/a1b2c3d4e5f67890"
  }
}

Changes