| Back | Main view
Entity move using IMiS/Storage Connector Services REST
| Product: | IMiS/StorageConnector Services REST |
| Release: | 9.8.2110 |
| Date: | 08/31/2022 |
Case:
Entity move using IMiS/Storage Connector Services REST
Description:
This example demonstrates operations which moves an entity on the IMiS/ARChive Server.
Requests and responses are in JSON format.
Below is a description of operations for the entity move.
1. Entity move
Operation moves an entity under the selected parent entity with the internal entity identifiers. The request body and reason for entity move are required, classification_code is the canonical form of the full classification code which is optional.
Request
PUT archives/{archiveId}/entities/{id}/move/{parentId}.json
Headers:
- Authorization: Bearer <session-token>
Query Parameters:
- fields: Defines the fields in the reply.
Body:
{
"classification_code": "String",
"reason": "String"
}
Response
Body:
{
"entity_stub": {
"accessed": "2022-08-30T14:40:44.768Z",
"created": "2022-08-30T14:40:44.768Z",
"modified": "2022-08-30T14:40:44.768Z",
"title": "Document",
"id": "XtxFIpYYiz6LXm0tYWywKYsX-5xHFpSlJWz45KX6-ok",
...
}
}
2. Entity move with id kind
Operation moves an entity under the selected parent entity with entity id kind. The request body and reason for entity move are required, classification_code is the canonical form of the full classification code which is optional.
Request
PUT archives/{archiveId}/entities/{entityIdKind}:{id}/move/{entityIdKind}:{parentId}.json
The set of entityIdKind values: C, E, I, e, c.
Headers:
- Authorization: Bearer <session-token>
Query Parameters:
- fields: Defines the fields in the reply.
Body:
{
"classification_code": "String",
"reason": "String"
}
Response
Body:
{
"entity_stub": {
"accessed": "2022-08-31T14:24:44.768Z",
"created": "2022-08-31T14:24:44.768Z",
"modified": "2022-08-31T14:24:44.768Z",
"title": "Case",
"id": "c2EFVqN8sUZTHoWyrlEqKDKXAGvx6KzSvmauwfnG1yg",
...
}
}
2.1. Entity move with classification code
Operation moves an entity under the selected parent entity with classification code.
Request
PUT archives/{archiveId}/entities/C:C=5^F=2020-000193^D=000020/move/C:C=5^F=2020-000194.json
Headers:
- Authorization: Bearer <session-token>
Query Parameters:
- fields: Defines the fields in the reply.
Body:
{
"reason": "String"
}
Response
Body:
{
"entity_stub": {
"accessed": "2022-08-31T14:24:44.768Z",
"created": "2022-08-31T14:24:44.768Z",
"modified": "2022-08-31T14:24:44.768Z",
"title": "Document",
"id": "fS4ZcDoctIIePsntFlsAff1WJ_snzlGPePppMRxCMWc",
...
}
}
2.2. Entity move with classification code in Base64 format
Operation moves an entity under the selected parent entity with classification code in Base64URL format.
Request
PUT archives/{archiveId}/entities/c:Qz01XkY9MjAyMC0wMDAxOTNeRD0wMDAwMjA/move/c:Qz01XkY9MjAyMC0wMDAxOTQ.json
Headers:
- Authorization: Bearer <session-token>
Query Parameters:
- fields: Defines the fields in the reply.
Body:
{
"reason": "String"
}
Response
Body:
{
"entity_stub": {
"accessed": "2022-08-31T14:24:44.768Z",
"created": "2022-08-31T14:24:44.768Z",
"modified": "2022-08-31T14:24:44.768Z",
"title": "Document",
"id": "fS4ZcDoctIIePsntFlsAff1WJ_snzlGPePppMRxCMWc",
...
}
}
2.3. Entity move with external identifier
Operation moves an entity under the selected parent entity with external identifier.
Request
PUT archives/{archiveId}/entities/E:ExternalDocumentId01/move/E:CaseExternal01.json
Headers:
- Authorization: Bearer <session-token>
Query Parameters:
- fields: Defines the fields in the reply.
Body:
{
"reason": "String"
}
Response
Body:
{
"entity_stub": {
"accessed": "2022-08-31T14:24:44.768Z",
"created": "2022-08-31T14:24:44.768Z",
"modified": "2022-08-31T14:24:44.768Z",
"title": "Document",
"id": "fS4ZcDoctIIePsntFlsAff1WJ_snzlGPePppMRxCMWc",
...
}
}
2.4. Entity move with external identifier in Base64 format
Operation moves an entity under the selected parent entity with external identifier in Base64URL format.
Request
PUT archives/{archiveId}/entities/e:RXh0ZXJuYWxEb2N1bWVudElkMDE/move/e:Q2FzZUV4dGVybmFsMDE.json
Headers:
- Authorization: Bearer <session-token>
Query Parameters:
- fields: Defines the fields in the reply.
Body:
{
"reason": "String"
}
Response
Body:
{
"entity_stub": {
"accessed": "2022-08-31T14:24:44.768Z",
"created": "2022-08-31T14:24:44.768Z",
"modified": "2022-08-31T14:24:44.768Z",
"title": "Document",
"id": "fS4ZcDoctIIePsntFlsAff1WJ_snzlGPePppMRxCMWc",
...
}
}
Related Documents:
| Back | Main view