Skip to content

Retrieve model information

GET
/api/v4/admin/data_management/{model_name}

Retrieves information about a data model in an instance. Only available to administrators.

model_name
required
string
>= 1 characters
Example
uploads
page
integer
default: 1 nullable

Current page number

Example
1
per_page
integer
default: 20 nullable

Number of items per page

Example
20
identifiers
One of:
Array<integer>
nullable

The record identifiers to filter by

checksum_state
string
nullable
Allowed values: pending started succeeded failed disabled

The checksum status of the records to filter by

cursor
string
nullable

Cursor for obtaining the next set of records

sort
string
default: asc nullable
Allowed values: asc desc

Order of sorting

OK

Media type application/json
object
record_identifier
One of:
string
model_class
string
created_at
string format: date-time
file_size
integer
checksum_information
object
Example
{
"record_identifier": "abc123",
"model_class": "Project",
"created_at": "2025-01-31T15:10:45.080Z",
"file_size": 123,
"checksum_information": {
"checksum": {
"type": "string",
"example": "abc"
},
"last_checksum": {
"type": "dateTime",
"example": "2025-01-31T15:10:45.080Z"
},
"checksum_state": {
"type": "string",
"example": "pending"
},
"checksum_retry_count": {
"type": "integer",
"example": 100
},
"checksum_retry_at": {
"type": "dateTime",
"example": "2025-01-31T15:10:45.080Z"
},
"checksum_failure": {
"type": "string",
"example": "failed"
}
}
}

400 Bad request

401 Unauthorized

403 Forbidden

404 Model Not Found