| Back | Main view
Entity stub read using IMiS/Storage Connector Services REST
| Product: | IMiS/StorageConnector Services REST |
| Release: | 9.9.2210 |
| Date: | 02/07/2023 |
Case:
Entity stub read using IMiS/Storage Connector Services REST
Description:
This example demonstrates operations which reads an entity stub on the IMiS/ARChive Server.
Responses are in JSON format.
Below is a description of operations for the entity stub read.
1. Entity stub read
Operation reads an entity stub using the internal entity identifier.
Request
GET archives/{archiveId}/entities/{id}/stub.json
Headers:
- Authorization: Bearer <session-token>
Query Parameters:
- fields: Defines the fields in the reply.
Response
Body:
{
"entity_stub": {
"accessed": "2023-01-30T14:40:44.768Z",
"created": "2023-01-30T14:40:44.768Z",
"modified": "2023-01-30T14:40:44.768Z",
"title": "Document",
"id": "XtxFIpYYiz6LXm0tYWywKYsX-5xHFpSlJWz45KX6-ok",
...
}
}
2. Entity stub read with id kind
Operation reads an entity stub using entity id kind and entity identifier.
Request
GET archives/{archiveId}/entities/{entityIdKind}:{id}/stub.json
The set of entityIdKind values:
- C (classification code),
- E (externail identifier),
- I (internal identifier),
- e (external identifier in Base64 format),
- c (classification code in Base64 format).
Headers:
- Authorization: Bearer <session-token>
Query Parameters:
- fields: Defines the fields in the reply.
Response
Body:
{
"entity_stub": {
"accessed": "2023-01-31T14:24:44.768Z",
"created": "2023-01-31T14:24:44.768Z",
"modified": "2023-01-31T14:24:44.768Z",
"title": "Case",
"id": "c2EFVqN8sUZTHoWyrlEqKDKXAGvx6KzSvmauwfnG1yg",
...
}
}
2.1. Entity stub read with classification code
Operation reads an entity stub using classification code "C=3^C=143".
Request
GET archives/{archiveId}/entities/C:C=3^C=143/stub.json.
Headers:
- Authorization: Bearer <session-token>
Query Parameters:
- fields: Defines the fields in the reply.
Response
Body:
{
"entity_stub": {
"accessed": "2023-01-31T14:24:44.768Z",
"created": "2023-01-31T14:24:44.768Z",
"modified": "2023-01-31T14:24:44.768Z",
"title": "Class",
"id": "c2EFVqN8sUZTHoWyrlEqKDKXAGvx6KzSvmauwfnG1yg",
...
}
}
2.2. Entity stub read with classification code in Base64 format
Operation reads an entity stub using classification code "C=3^C=143^D=311/2023" in Base64 format.
Request
GET archives/{archiveId}/entities/c:Qz0zXkM9MTQzXkQ9MzExLzIwMjM/stub.json.
Headers:
- Authorization: Bearer <session-token>
Query Parameters:
- fields: Defines the fields in the reply.
Response
Body:
{
"entity_stub": {
"accessed": "2023-01-31T14:24:44.768Z",
"created": "2023-01-31T14:24:44.768Z",
"modified": "2023-01-31T14:24:44.768Z",
"title": "Document",
"id": "c2EFVqN8sUZTHoWyrlEqKDKXAGvx6KzSvmauwfnG1yg",
...
}
}
Related Documents:
| Back | Main view