Object Store API Schema - DRAFT (0.1.0)

Download OpenAPI specification:Download

E-mail: info@dina-project.net License: Apache 2.0

Object Store API Schema

Metadata

List metadatas

By passing in query string, user can get available metadatas authorised

query Parameters

filter[rsql]	string pass an optional search string for looking up the metadatas
sort	string optional sort string, can have sort order such as descending denoted by "-"
page[offset]	integer <int32> number of records to skip when paging
page[limit]	integer <int32> [ 0 .. 50 ] maximum number of records to return when paging
fields	string names of sparse fields that should be in query results
include	string names of related entities that should be in query results

Responses

Response samples

200

Content type

application/json

[{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "metadata",
"attributes": {"createdBy": "string",
"createdOn": "1985-04-12T23:20:50.52Z",
"group": "string",
"dcFormat": "string",
"dcType": "IMAGE",
"acSubtype": "string",
"fileIdentifier": "string",
"bucket": "string",
"acCaption": "string",
"acDigitizationDate": "string",
"xmpMetadataDate": "string",
"originalFilename": "string",
"fileExtension": "string",
"acHashFunction": "string",
"acHashValue": "string",
"xmpRightsUsageTerms": "string",
"xmpRightsWebStatement": "string",
"dcRights": "string",
"xmpRightsOwner": "string",
"publiclyReleasable": true,
"notPubliclyReleasableReason": "string",
"managedAttributes": {"property1": "string",
"property2": "string"
},
"acTags": ["string"
],
"orientation": 0,
"resourceExternalURL": "http://example.com"
},
"relationships": {"derivatives": {"data": [{"type": "derivative",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
]
},
"dcCreator": {"data": {"type": "person",
"id": "8f68a05f-937d-4d40-88b4-ed92720d9c3f"
}
},
"acMetadataCreator": {"data": {"type": "person",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
}
}
}
}
]

Add a metadata

Request Body schema: application/json

Metadata to add

required

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"type": "metadata",
"attributes": {"group": "string",
"dcType": "IMAGE",
"acSubtype": "string",
"fileIdentifier": "string",
"bucket": "string",
"acCaption": "string",
"acDigitizationDate": "string",
"xmpMetadataDate": "string",
"xmpRightsUsageTerms": "string",
"xmpRightsWebStatement": "string",
"dcRights": "string",
"xmpRightsOwner": "string",
"publiclyReleasable": true,
"notPubliclyReleasableReason": "string",
"managedAttributes": {"property1": "string",
"property2": "string"
},
"acTags": ["string"
],
"orientation": 0,
"resourceExternalURL": "http://example.com"
},
"relationships": {"derivatives": {"data": [{"type": "derivative",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
]
},
"dcCreator": {"data": {"type": "person",
"id": "8f68a05f-937d-4d40-88b4-ed92720d9c3f"
}
},
"acMetadataCreator": {"data": {"type": "person",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
}
}
}
}

Get a metadata

Return a single metadata

path Parameters

Id

required

string <uuid>

ID of metadata to return

Responses

Response samples

200

Content type

application/json

{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "metadata",
"attributes": {"createdBy": "string",
"createdOn": "1985-04-12T23:20:50.52Z",
"group": "string",
"dcFormat": "string",
"dcType": "IMAGE",
"acSubtype": "string",
"fileIdentifier": "string",
"bucket": "string",
"acCaption": "string",
"acDigitizationDate": "string",
"xmpMetadataDate": "string",
"originalFilename": "string",
"fileExtension": "string",
"acHashFunction": "string",
"acHashValue": "string",
"xmpRightsUsageTerms": "string",
"xmpRightsWebStatement": "string",
"dcRights": "string",
"xmpRightsOwner": "string",
"publiclyReleasable": true,
"notPubliclyReleasableReason": "string",
"managedAttributes": {"property1": "string",
"property2": "string"
},
"acTags": ["string"
],
"orientation": 0,
"resourceExternalURL": "http://example.com"
},
"relationships": {"derivatives": {"data": [{"type": "derivative",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
]
},
"dcCreator": {"data": {"type": "person",
"id": "8f68a05f-937d-4d40-88b4-ed92720d9c3f"
}
},
"acMetadataCreator": {"data": {"type": "person",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
}
}
}
}

Update a metadata

path Parameters

Id

required

string <uuid>

metadata id to patch

Request Body schema: application/json

metadata to add

required

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "metadata",
"attributes": {"group": "string",
"dcType": "IMAGE",
"acSubtype": "string",
"fileIdentifier": "string",
"bucket": "string",
"acCaption": "string",
"acDigitizationDate": "string",
"xmpMetadataDate": "string",
"xmpRightsUsageTerms": "string",
"xmpRightsWebStatement": "string",
"dcRights": "string",
"xmpRightsOwner": "string",
"publiclyReleasable": true,
"notPubliclyReleasableReason": "string",
"managedAttributes": {"property1": "string",
"property2": "string"
},
"acTags": ["string"
],
"orientation": 0,
"resourceExternalURL": "http://example.com"
},
"relationships": {"derivatives": {"data": [{"type": "derivative",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
]
},
"dcCreator": {"data": {"type": "person",
"id": "8f68a05f-937d-4d40-88b4-ed92720d9c3f"
}
},
"acMetadataCreator": {"data": {"type": "person",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
}
}
}
}

Delete a metadata

path Parameters

Id

required

string <uuid>

metadata id to delete

Responses

Managed Attribute

List managed attributes

By passing in query string, user can get available managed attributes authorised

query Parameters

filter[rsql]	string pass an optional search string for looking up the managed attributes
sort	string optional sort string, can have sort order such as descending denoted by "-"
page[offset]	integer <int32> number of records to skip when paging
page[limit]	integer <int32> [ 0 .. 50 ] maximum number of records to return when paging

Responses

Response samples

200

Content type

application/json

[{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "managed-attribute",
"attributes": {"createdBy": "string",
"createdOn": "1985-04-12T23:20:50.52Z",
"name": "specimenView",
"key": "specimen_view",
"vocabularyElementType": "STRING",
"acceptedValues": ["dorsal",
1
],
"multilingualDescription": {"descriptions": [{"lang": "string",
"desc": "string"
}
]
}
}
}
}
]

Add a managed attribute

Request Body schema: application/json

Managed attribute to add

required

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "managed-attribute",
"attributes": {"name": "specimenView",
"key": "specimen_view",
"vocabularyElementType": "STRING",
"acceptedValues": ["dorsal",
1
],
"multilingualDescription": {"descriptions": [{"lang": "string",
"desc": "string"
}
]
}
}
}
}

Get a managed attribute

Return a single managed attribute

path Parameters

Id

required

string <uuid>

ID of managed attribute to return

Responses

Response samples

200

Content type

application/json

{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "managed-attribute",
"attributes": {"createdBy": "string",
"createdOn": "1985-04-12T23:20:50.52Z",
"name": "specimenView",
"key": "specimen_view",
"vocabularyElementType": "STRING",
"acceptedValues": ["dorsal",
1
],
"multilingualDescription": {"descriptions": [{"lang": "string",
"desc": "string"
}
]
}
}
}
}

Update a managed attribute

path Parameters

Id

required

string <uuid>

managed attribute id to patch

Request Body schema: application/json

managed attribute to add

required

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
"type": "managed-attribute",
"attributes": {"name": "specimenView",
"key": "specimen_view",
"vocabularyElementType": "STRING",
"acceptedValues": ["dorsal",
1
],
"multilingualDescription": {"descriptions": [{"lang": "string",
"desc": "string"
}
]
}
}
}
}

Delete a managed attribute

path Parameters

Id

required

string <uuid>

managed attribute id to delete

Responses

Object Subtype

List object-subtypes

By passing in query string, user can get available object-subtypes authorised

query Parameters

filter[rsql]	string pass an optional search string for looking up the object-subtypes
sort	string optional sort string, can have sort order such as descending denoted by "-"
page[offset]	integer <int32> number of records to skip when paging
page[limit]	integer <int32> [ 0 .. 50 ] maximum number of records to return when paging

Responses

Response samples

200

Content type

application/json

[{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "object-subtype",
"attributes": {"createdBy": "string",
"createdOn": "1985-04-12T23:20:50.52Z",
"dcType": "IMAGE",
"acSubtype": "string"
}
}
}
]

Add an object-subtype

Request Body schema: application/json

object-subtype to add

required

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"type": "object-subtype",
"attributes": {"dcType": "IMAGE",
"acSubtype": "string"
}
}
}

Get an object-subtype

Return a single object-subtype

path Parameters

Id

required

string <uuid>

ID of object-subtype to return

Responses

Response samples

200

Content type

application/json

{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "object-subtype",
"attributes": {"createdBy": "string",
"createdOn": "1985-04-12T23:20:50.52Z",
"dcType": "IMAGE",
"acSubtype": "string"
}
}
}

Update an object-subtype

path Parameters

Id

required

string <uuid>

object-subtype id to patch

Request Body schema: application/json

object-subtype to update

required

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "object-subtype",
"attributes": {"dcType": "IMAGE",
"acSubtype": "string"
}
}
}

Delete an object-subtype

path Parameters

Id

required

string <uuid>

object-subtype id to delete

Responses

Derivative

List derivatives

By passing in query string, user can get available derivatives authorised

query Parameters

filter[rsql]	string pass an optional search string for looking up the derivatives
sort	string optional sort string, can have sort order such as descending denoted by "-"
page[offset]	integer <int32> number of records to skip when paging
page[limit]	integer <int32> [ 0 .. 50 ] maximum number of records to return when paging

Responses

Response samples

200

Content type

application/json

[{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "derivative",
"attributes": {"createdBy": "string",
"createdOn": "1985-04-12T23:20:50.52Z",
"bucket": "string",
"fileExtension": "string",
"fileIdentifier": "string",
"dcType": "IMAGE",
"dcFormat": "string",
"acHashFunction": "string",
"acHashValue": "string",
"derivativeType": "THUMBNAIL_IMAGE",
"publiclyReleasable": true,
"notPubliclyReleasableReason": "string"
},
"relationships": {"generatedFromDerivative": {"data": {"type": "derivative",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
},
"acDerivedFrom": {"data": {"type": "metadata",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
}
}
}
}
]

Add an derivative

Request Body schema: application/json

derivative to add

required

object

Responses

Request samples

Payload

Content type

application/json

{"data": {"type": "derivative",
"attributes": {"bucket": "string",
"fileExtension": "string",
"fileIdentifier": "string",
"dcType": "IMAGE",
"dcFormat": "string",
"acHashFunction": "string",
"acHashValue": "string",
"derivativeType": "THUMBNAIL_IMAGE",
"publiclyReleasable": true,
"notPubliclyReleasableReason": "string"
},
"relationships": {"generatedFromDerivative": {"data": {"type": "derivative",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
},
"acDerivedFrom": {"data": {"type": "metadata",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
}
}
}
}

Get an derivative

Return a single derivative

path Parameters

Id

required

string <uuid>

ID of derivative to return

Responses

Response samples

200

Content type

application/json

{"data": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"type": "derivative",
"attributes": {"createdBy": "string",
"createdOn": "1985-04-12T23:20:50.52Z",
"bucket": "string",
"fileExtension": "string",
"fileIdentifier": "string",
"dcType": "IMAGE",
"dcFormat": "string",
"acHashFunction": "string",
"acHashValue": "string",
"derivativeType": "THUMBNAIL_IMAGE",
"publiclyReleasable": true,
"notPubliclyReleasableReason": "string"
},
"relationships": {"generatedFromDerivative": {"data": {"type": "derivative",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
},
"acDerivedFrom": {"data": {"type": "metadata",
"id": "1096500a-25dc-4a63-ba14-ea6ee5057fb3"
}
}
}
}
}

Delete an derivative

path Parameters

Id

required

string <uuid>

derivative id to delete

Responses

File Controller

upload file

upload a file

path Parameters

bucket

required

string

Namespace of the file described by the metadata

Request Body schema:
application/octet-stream

derivative to add

string <binary>

Responses

Response samples

200

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"fileIdentifier": "string",
"dcType": "IMAGE",
"createdBy": "string",
"createdOn": "1985-04-12T23:20:50.52Z",
"originalFilename": "string",
"receivedMediaType": "string",
"detectedMediaType": "string",
"detectedFileExtension": "string",
"evaluatedMediaType": "string",
"evaluatedFileExtension": "string",
"sha1Hex": "string",
"bucket": "string",
"dateTimeDigitized": "string",
"exif": ["string"
],
"isDerivative": true
}

upload derivative

Add an derivative

path Parameters

bucket

required

string

Namespace of the file described by the metadata

Request Body schema:
application/octet-stream

derivative to add

string <binary>

Responses

Response samples

200

Content type

application/json

{"uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
"fileIdentifier": "string",
"dcType": "IMAGE",
"createdBy": "string",
"createdOn": "1985-04-12T23:20:50.52Z",
"originalFilename": "string",
"receivedMediaType": "string",
"detectedMediaType": "string",
"detectedFileExtension": "string",
"evaluatedMediaType": "string",
"evaluatedFileExtension": "string",
"sha1Hex": "string",
"bucket": "string",
"dateTimeDigitized": "string",
"exif": ["string"
],
"isDerivative": true
}

download Object

Triggers a download of a file. Note that the file requires a metadata entry in the database to be available for download.

path Parameters

bucket required	string Namespace of the file described by the metadata
fileId required	string <uuid> metadata id to patch

Responses

download Derivative

Triggers a download of a derivative.

path Parameters

bucket required	string Namespace of the file described by the metadata
fileId required	string <uuid> metadata id to patch