Skip to main content

Update one 'Blob' entity

PUT 
/blob/:id

Update a single existing 'Blob' entity. Returns a full updated entity including (optional) modification metadata.

Request​

Path Parameters

    id integerrequired

    The id tof the object to update

Query Parameters

    force boolean

    Forces the update even if '_etag' is missing or not matching.

Body

required

    id integer

    The unique entity id - must be a positive integer

    title string

    An optional descriptive title for the blob

    is_deleted boolean

    If the entity has been soft-deleted this value is true

    project_id integer

    The project id this entity or mapping belongs to

    created_at date-time

    The creation time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    created_by number

    The creator user id of this entity or mapping value - or zero if created by the system

    Example: 0
    modified_at date-time

    The last modification time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    modified_by number

    The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system

    Example: 0
    deleted_at date-time

    The soft-deletion time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    deleted_by number

    The id of the user who deleted this entity or mapping value - or zero if deleted by the system

    Example: 0
    blob_id string

    A globally unique id for the blob

    mime_type string

    The MIME type of the blob (e.g. image/jpeg)

    filename string

    The file name of the blob when it was uploaded. Should have an extension compatible with the 'mime_type'

    size number

    The size in bytes of the final blob

    category string

    The category of the blob

    external_key string

    An optional external key for identification

    Example: PROJ1_A123456
    data string

    The base64 data of the blob when uploading - as an alternative to uploading the blob in a separate request (for small blobs)

    Example: BASE64 BLOB DATA

Responses​

Returns a single Blob

Schema

    id integer

    The unique entity id - must be a positive integer

    title string

    An optional descriptive title for the blob

    is_deleted boolean

    If the entity has been soft-deleted this value is true

    project_id integer

    The project id this entity or mapping belongs to

    created_at date-time

    The creation time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    created_by number

    The creator user id of this entity or mapping value - or zero if created by the system

    Example: 0
    modified_at date-time

    The last modification time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    modified_by number

    The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system

    Example: 0
    deleted_at date-time

    The soft-deletion time for this entity or mapping value

    Example: 1970-01-01T00:00:00.000Z
    deleted_by number

    The id of the user who deleted this entity or mapping value - or zero if deleted by the system

    Example: 0
    blob_id string

    A globally unique id for the blob

    mime_type string

    The MIME type of the blob (e.g. image/jpeg)

    filename string

    The file name of the blob when it was uploaded. Should have an extension compatible with the 'mime_type'

    size number

    The size in bytes of the final blob

    category string

    The category of the blob

    external_key string

    An optional external key for identification

    Example: PROJ1_A123456
    data string

    The base64 data of the blob when uploading - as an alternative to uploading the blob in a separate request (for small blobs)

    Example: BASE64 BLOB DATA
Loading...