| Back | Main view
IMiS/Storage Connector Services REST - Read entities
| Product: | IMiS/StorageConnector Services REST |
| Release: | 9.6.2010 |
| Date: | 08/18/2021 |
Case:
IMiS/Storage Connector Services REST - Read entities
Description:
This example demonstrates operations which reads entities with parameters on the IMiS/ARChive Server.
Requests and responses are in JSON format.
Below is a description of operations for the reading entities.
1. Read root entities
Operation reads the root entities, the collection is using response fields filter, page start from 0 and page size 50, order by entity type and classification code, on the IMiS/ARChive Server.
Request
GET archives/{archiveId}/entities.json?fields=entities(id%2Ctitle%2Cmodified%2Cclassification_code%2Ceffective_rights%2Cchild_count%2Cclosed%2Cpermanent%2Cpublic_classification_code%2Cdescription%2Ctype%2Chas_draft%2Cparent_id%2Ctemplate)%2Cpage_size%2Cpage_start%2Csize%2Ccategories%2Chandle&page_start=0&page_size=50&refresh=true&sort=sys%3AEntityType%2Csys%3ATitle&sort_order=asc
Headers:
- Authorization: Bearer <session-token>
Query String Parameters:
- fields: entities(id,title,modified,classification_code,effective_rights,child_count,closed,permanent,public_classification_code,description,type,has_draft,parent_id,template),page_size,page_start,size,categories
- page_start: 0
- page_size: 50
- refresh: true
- sort: sys:EntityType,sys:Title
- sort_order: asc
Response
Body:
{
"size": 3,
"page_start": 0,
"page_size": 50,
"entities": [
{
"child_count": 4,
"classification_code": "C=16",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "4s-K2adKg-SjYFERx-m18oM6T5lh9204",
"modified": "2020-09-27T18:29:37.422Z",
"permanent": false,
"public_classification_code": "16",
"template": {
"id": "Class",
"label": "Class",
"entity_type": "CLASS"
},
"title": "Other",
"type": "CLASS"
},
{
"child_count": 18,
"classification_code": "C=1",
"description": "Production documents",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"modified": "2021-01-25T13:31:17.879Z",
"permanent": false,
"public_classification_code": "1",
"template": {
"id": "Class01",
"label": "Class 01",
"entity_type": "CLASS"
},
"title": "Production",
"type": "CLASS"
}
{
"child_count": 8,
"classification_code": "C=15",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "JLPpHhU5ml2eDSv0KifStSwEzJ6EWELS",
"modified": "2020-05-20T13:16:31.665Z",
"permanent": false,
"public_classification_code": "15",
"template": {
"id": "Class",
"label": "Class",
"entity_type": "CLASS"
},
"title": "Support",
"type": "CLASS"
}
],
"categories": []
}
2. Read sub-entities
Operation reads the child entities of entity with classification code "C=1", the collection is using response fields filter, page start from 0 and page size 5, order by entity type and classification code, on the IMiS/ARChive Server.
Request
GET archives/{archiveId}/entities/C:C=1/entities.json?filter=all&fields=entities(id%2Ctitle%2Cmodified%2Cclassification_code%2Ceffective_rights%2Cchild_count%2Cclosed%2Cpermanent%2Cpublic_classification_code%2Cdescription%2Ctype%2Chas_draft%2Cparent_id%2Ctemplate)%2Cpage_size%2Cpage_start%2Csize%2Ccategories&page_start=0&page_size=5&refresh=true&sort=sys%3AEntityType%2Csys%3ATitle&sort_order=asc
Headers:
- Authorization: Bearer <session-token>
Query String Parameters:
- fields: entities(id,title,modified,classification_code,effective_rights,child_count,closed,permanent,public_classification_code,description,type,has_draft,parent_id,template),page_size,page_start,size,categories
- page_start: 0
- page_size: 5
- refresh: true
- sort: sys:EntityType,sys:Title
- sort_order: asc
Response
Body:
{
"size": 18,
"page_start": 0,
"page_size": 5,
"entities": [
{
"child_count": 79,
"classification_code": "C=1^C=76",
"description": "Class",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "urYoS_EWGWQXGTKTQe-xzv5x65WM2TEj",
"modified": "2020-07-15T15:10:32.127Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1.76",
"template": {
"id": "Class01",
"label": "Class 01",
"entity_type": "CLASS"
},
"title": "Class 01",
"type": "CLASS"
},
{
"child_count": 537,
"classification_code": "C=1^C=123",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "1lVB8mb6XsnApr9k4rooUdtpKktDRa8y",
"modified": "2020-03-11T12:01:43.642Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1.123",
"template": {
"id": "Class01",
"label": "Class 01",
"entity_type": "CLASS"
},
"title": "Content",
"type": "CLASS"
},
{
"child_count": 0,
"classification_code": "C=1^D=000121",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "0mfoPIBoBC-B-ggTrY38DWIZXPdyLCtD",
"modified": "2020-08-10T09:56:47.667Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1/000121",
"template": {
"id": "D01",
"label": "Document 01",
"entity_type": "DOCUMENT"
},
"title": "3.8",
"type": "DOCUMENT"
},
{
"child_count": 0,
"classification_code": "C=1^D=000120",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "9LoN63IPpjVPJFekF3vYMMhwyZ49fhjX",
"modified": "2020-10-23T06:52:45.517Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1/000120",
"template": {
"id": "D01",
"label": "Document 01",
"entity_type": "DOCUMENT"
},
"title": "41",
"type": "DOCUMENT"
},
{
"child_count": 0,
"classification_code": "C=1^D=000149",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "h2YvWVp8ux-4SF1mdx5k0hmFt-pMJPUP",
"modified": "2021-08-25T13:31:40.523Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1/000149",
"template": {
"id": "D01",
"label": "Document 01",
"entity_type": "DOCUMENT"
},
"title": "D01",
"type": "DOCUMENT"
}
],
"categories": []
}
3. Read sub-entities with entity type filter
Operation reads the child entities of entity with classification code "C=1", the collection is using response fields filter, documents filter, page start from 0 and page size 5, order by entity type and classification code, on the IMiS/ARChive Server.
Request
GET archives/{archiveId}/entities/C:C=1/entities.json?filter=all&fields=entities(id%2Ctitle%2Cmodified%2Cclassification_code%2Ceffective_rights%2Cchild_count%2Cclosed%2Cpermanent%2Cpublic_classification_code%2Cdescription%2Ctype%2Chas_draft%2Cparent_id%2Ctemplate)%2Cpage_size%2Cpage_start%2Csize%2Ccategories&page_start=0&page_size=5&refresh=true&sort=sys%3AEntityType%2Csys%3ATitle&sort_order=asc&documents=true
Headers:
- Authorization: Bearer <session-token>
Query String Parameters:
- fields: entities(id,title,modified,classification_code,effective_rights,child_count,closed,permanent,public_classification_code,description,type,has_draft,parent_id,template),page_size,page_start,size,categories
- page_start: 0
- page_size: 5
- refresh: true
- sort: sys:EntityType,sys:Title
- sort_order: asc
- documents: true
Response
Body:
{
"size": 16,
"page_start": 0,
"page_size": 5,
"entities": [
{
"child_count": 0,
"classification_code": "C=1^D=000121",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "0mfoPIBoBC-B-ggTrY38DWIZXPdyLCtD",
"modified": "2020-08-10T09:56:47.667Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1/000121",
"template": {
"id": "D01",
"label": "Document 01",
"entity_type": "DOCUMENT"
},
"title": "3.8",
"type": "DOCUMENT"
},
{
"child_count": 0,
"classification_code": "C=1^D=000120",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "9LoN63IPpjVPJFekF3vYMMhwyZ49fhjX",
"modified": "2020-10-23T06:52:45.517Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1/000120",
"template": {
"id": "D01",
"label": "Document 01",
"entity_type": "DOCUMENT"
},
"title": "41",
"type": "DOCUMENT"
},
{
"child_count": 0,
"classification_code": "C=1^D=000149",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "h2YvWVp8ux-4SF1mdx5k0hmFt-pMJPUP",
"modified": "2021-08-25T13:31:40.523Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1/000149",
"template": {
"id": "D01",
"label": "Document 01",
"entity_type": "DOCUMENT"
},
"title": "Doc 01",
"type": "DOCUMENT"
},
{
"child_count": 0,
"classification_code": "C=1^D=000012",
"description": "Audio",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "oX3HlGiLNtvNXUFgVdAiaFxcIpM0UvjG",
"modified": "2021-08-25T13:31:45.074Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1/000012",
"template": {
"id": "D01",
"label": "Document 01",
"entity_type": "DOCUMENT"
},
"title": "Document 01",
"type": "DOCUMENT"
},
{
"child_count": 0,
"classification_code": "C=1^D=000129",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "gxNbQ0VsQhK3VM1tFBLOSHd8EXBz0aKJ",
"modified": "2021-08-25T13:31:50.258Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1/000129",
"template": {
"id": "D01",
"label": "Document 01",
"entity_type": "DOCUMENT"
},
"title": "Document 20",
"type": "DOCUMENT"
}
],
"categories": []
}
4. Read sub-entities with entity type filter and categorization
Operation reads the child entities of entity with classification code "C=1", with categorization by category property and "Cat" category, the collection is using response fields filter, documents filter, page start from 0 and page size 5, order by entity type and classification code, on the IMiS/ARChive Server.
Request
GET archives/{archiveId}/entities/C:C=1/entities.json?fields=entities(id%2Ctitle%2Cmodified%2Cclassification_code%2Ceffective_rights%2Cchild_count%2Cclosed%2Cpermanent%2Cpublic_classification_code%2Cdescription%2Ctype%2Chas_draft%2Cparent_id%2Ctemplate)%2Cpage_size%2Cpage_start%2Csize%2Ccategories&page_start=0&page_size=5&refresh=true&sort=sys%3AEntityType%2Csys%3ATitle&sort_order=asc&documents=true&category_properties=sys:Category&category=Cat
Headers:
- Authorization: Bearer <session-token>
Query String Parameters:
- fields: entities(id,title,modified,classification_code,effective_rights,child_count,closed,permanent,public_classification_code,description,type,has_draft,parent_id,template),page_size,page_start,size,categories
- page_start: 0
- page_size: 5
- refresh: true
- sort: sys:EntityType,sys:Title
- sort_order: asc
- documents: true
- category_properties: sys:Category
- category: Cat
Response
Body:
{
"size": 3,
"page_start": 0,
"page_size": 5,
"entities": [
{
"child_count": 0,
"classification_code": "C=1^D=000149",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "h2YvWVp8ux-4SF1mdx5k0hmFt-pMJPUP",
"modified": "2021-08-25T13:31:40.523Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1/000149",
"template": {
"id": "D01",
"label": "Document 01",
"entity_type": "DOCUMENT"
},
"title": "Doc 01",
"type": "DOCUMENT"
},
{
"child_count": 0,
"classification_code": "C=1^D=000012",
"description": "Audio",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "oX3HlGiLNtvNXUFgVdAiaFxcIpM0UvjG",
"modified": "2021-08-25T13:31:45.074Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1/000012",
"template": {
"id": "D01",
"label": "Document 01",
"entity_type": "DOCUMENT"
},
"title": "Document 01",
"type": "DOCUMENT"
},
{
"child_count": 0,
"classification_code": "C=1^D=000129",
"effective_rights": {
"create_references": true,
"create_sub_entities": true,
"change_retention": true,
"change_rights": true,
"change_security_class": true,
"change_status": true,
"delete_access": true,
"move_access": true,
"read_access": true,
"write_access": true
},
"has_draft": false,
"id": "gxNbQ0VsQhK3VM1tFBLOSHd8EXBz0aKJ",
"modified": "2021-08-25T13:31:50.258Z",
"parent_id": "wbEepinOwdbo0FyZhpTm--HpIlHvyC7X",
"permanent": false,
"public_classification_code": "1/000129",
"template": {
"id": "D01",
"label": "Document 01",
"entity_type": "DOCUMENT"
},
"title": "Document 20",
"type": "DOCUMENT"
}
],
"categories": [
{
"name": "",
"size": 10
},
{
"name": "Cat",
"size": 3
},
{
"name": "cat5",
"size": 1
},
{
"name": "test",
"size": 1
}
]
}
Related Documents:
| Back | Main view