Records Lifecycle Service (1.1)

Download OpenAPI specification:Download

Records Lifecycle Service

records

getRecords

A collection of records, summary metadata only

query Parameters

owner	string Default: "" owner id
keyword	string Default: "" keyword

Responses

200

A collection of records

401

Invalid auth header. No credentials provided.

500

Internal server error; no action required; may help to retry request later or contact support.

get /records

https://digitalrecords.showthething.com/api/records

putRecord

Create a new record. If record contains files they must be pre-uploaded.

Request Body schema: multipart/form-data

recordMetedata

required

string

record metadata for create/update record requests. see 'recordMetadata' model

Responses

200

A created record

401

Invalid auth header. No credentials provided.

500

Internal server error; no action required; may help to retry request later or contact support.

post /records

https://digitalrecords.showthething.com/api/records

getRecordById

Get the latest record version by id

path Parameters

required

string

Default: ""

record id

Responses

200

A record

404

Not Found

get /records/{id}

https://digitalrecords.showthething.com/api/records/{id}

getRecordVersions

A record versions

path Parameters

required

string

Default: ""

record id

Responses

200

A record versions

get /records/{id}/versions

https://digitalrecords.showthething.com/api/records/{id}/versions

addRecordVersion

Create new record version. Provide metadata and files to be attached/removed.

path Parameters

required

string

Default: ""

record id

Request Body schema: multipart/form-data

recordMetedata

required

string

record metadata for create/update record requests. see 'recordMetadata' model

Responses

200

Freshly created record version

401

Invalid auth header. No credentials provided.

500

Internal server error; no action required; may help to retry request later or contact support.

post /records/{id}/versions

https://digitalrecords.showthething.com/api/records/{id}/versions

getRecordVersion

Get a specific record version

path Parameters

id required	string Default: "" record id
version_id required	string Default: "" record version UUID

Responses

200

A record version

get /records/{id}/versions/{version_id}

https://digitalrecords.showthething.com/api/records/{id}/versions/{version_id}

documents

getRecordDocuments

Get a list of documents from the latest record version.

path Parameters

required

string

Default: ""

record id

Responses

200

record documents

get /records/{id}/documents

https://digitalrecords.showthething.com/api/records/{id}/documents

getRecordDocument

Get a document by ID from the specific record

path Parameters

id required	string Default: "" record id
document_id required	string Default: "" document UUID

Responses

200

The document content

get /records/{id}/documents/{document_id}

https://digitalrecords.showthething.com/api/records/{id}/documents/{document_id}

getRecordVersionDocuments

Get a list of documents from the specific record version.

path Parameters

id required	string Default: "" record id
version_id required	string Default: "" record version UUID

Responses

200

A list of documents

get /records/{id}/versions/{version_id}/documents

https://digitalrecords.showthething.com/api/records/{id}/versions/{version_id}/documents

getRecordVersionDocument

Get a document conetnt by id from the specific record version.

path Parameters

id required	string Default: "" record id
version_id required	string Default: "" record version UUID
document_id required	string Default: "" document UUID

Responses

200

Document content

get /records/{id}/versions/{version_id}/documents/{document_id}

https://digitalrecords.showthething.com/api/records/{id}/versions/{version_id}/documents/{document_id}

Return instructions to upload the document

Responses

200

Information required to upload the file

post /filegate/

https://digitalrecords.showthething.com/api/filegate/