Undeletes multiple 'Blob' entities

POST 
/blob/bulk/undelete

Undeletes multiple existing 'Blob' entities (only if the entity type supports soft-deletion). Returns a full undeleted entity list including (optional) deletion metadata.

Request

application/json

Body

array

required

• Array [

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

200

Returns an array of Blob.

application/json

Schema

Schema

• Array [

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

• ]

Example (from schema)

[
  {
    "id": 0,
    "title": "string",
    "is_deleted": true,
    "project_id": 0,
    "created_at": "1970-01-01T00:00:00.000Z",
    "created_by": 0,
    "modified_at": "1970-01-01T00:00:00.000Z",
    "modified_by": 0,
    "deleted_at": "1970-01-01T00:00:00.000Z",
    "deleted_by": 0,
    "blob_id": "string",
    "mime_type": "string",
    "filename": "string",
    "size": 0,
    "category": "string",
    "external_key": "PROJ1_A123456",
    "data": "BASE64 BLOB DATA"
  }
]

4XX

The request failed because invalid request parameters or data were supplied or access was denied.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

5XX

The request failed because an error occurred during processing of the request.

application/json

Schema

Schema

code string
The error code describing the general error category.
Example: API_INVALID_INPUT_DATA
status integer

The HTTP status code.

message stringrequired

The actual error message describing the error in more detail.

reqid string

The request id for following up on specific errors.

Example (from schema)

{
  "code": "API_INVALID_INPUT_DATA",
  "status": 0,
  "message": "string",
  "reqid": "string"
}

Loading...