IMaaS Content Metadata Service
Number of APIs: 146
CMS handles object metadata. CMS APIs are tenant-based. Service/User Token is requested for accessing these APIs. Objects can be documents, files, folders, business objects, relationships and permissions. Namespaces, Categories, Types and Traits are used for domain specific business logic. Content uploads and downloads can be done by these APIs as well. Validations and Localizations can be customized. Retention, History, Search, Filtering and Scripts are supported. Deployment bundling, upgrade, case modeling and templates are available. Default namespace is provided. System categories are cmsfile, cmsfolder and cms_object. User can create customized category, type definition and trait definition based on the business needs. Object instances are created based on the category, type and trait. Type can be extendable based on business needs. ETS, OTDS (Identity and Auth) and Content Storage Service (CSS) are pre-requisites to use CMS.
1. List all service endpoints
GET {{baseUrl}}/service
List all service endpoints
2. Execute full text search against search service
POST {{baseUrl}}/ft-query?page=53258108&items-per-page=53258108&include-total=ex ut enim aute
Run full text search
3. categories-{id} - get category by id
GET {{baseUrl}}/categories/:id
4. categories-{id} - update category details
PUT {{baseUrl}}/categories/:id
5. categories-{id} - patch category details
PATCH {{baseUrl}}/categories/:id
6. categories - List all the categories
GET {{baseUrl}}/categories?page=53258108&items-per-page=53258108
List all the categories
7. categories - Create a new category
POST {{baseUrl}}/categories
Create a new category
8. categories - get category by name
GET {{baseUrl}}/categories/name/:name
9. groups-{group Id}-members-{group Member Id} - Get group member details
GET {{baseUrl}}/groups/:groupId/members/:groupMemberId
10. groups-{group Id}-members-{group Member Id} - delete group members
DELETE {{baseUrl}}/groups/:groupId/members/:groupMemberId
11. groups-{group Id}-members - Get group members details
GET {{baseUrl}}/groups/:groupId/members
12. groups-{group Id}-members - Update group membership details
PUT {{baseUrl}}/groups/:groupId/members
13. groups-{group Id}-members - Add a new group member
POST {{baseUrl}}/groups/:groupId/members
14. groups-{group Id}-members - Delete Group Member
DELETE {{baseUrl}}/groups/:groupId/members
15. groups-{group Id} - Get group details
GET {{baseUrl}}/groups/:groupId
16. groups-{group Id} - Delete group
DELETE {{baseUrl}}/groups/:groupId
17. groups - List all groups
GET {{baseUrl}}/groups?page=53258108&items-per-page=53258108
List all groups
18. groups - Create a new group
POST {{baseUrl}}/groups
19. instances-{category}/{type}-{id}-linked-parents-{folder Id} - Get linked parent details
GET {{baseUrl}}/instances/:category/:type/:id/linked-parents/:folderId
20. instances-{category}/{type}-{id}-linked-parents-{folder Id} - Delete linked parent
DELETE {{baseUrl}}/instances/:category/:type/:id/linked-parents/:folderId
21. instances-{category}/{type}-{id}-linked-parents - List linked parents
GET {{baseUrl}}/instances/:category/:type/:id/linked-parents
22. instances-{category}/{type}-{id}-linked-parents - Add linked parent to an object
POST {{baseUrl}}/instances/:category/:type/:id/linked-parents
23. instances-{category}/{type}-{id}-acl - get ACL associated with object instance
GET {{baseUrl}}/instances/:category/:type/:id/acl
24. instances-{category}/{type}-{id}-acl - Change ACL action
PUT {{baseUrl}}/instances/:category/:type/:id/acl
25. instances-{category}/{type}-{id}-acl - Update permits for an ACL associated with an object
PATCH {{baseUrl}}/instances/:category/:type/:id/acl
26. instances-{category}/{type}-{id}-parent - Get parent instance details
GET {{baseUrl}}/instances/:category/:type/:id/parent
27. instances-{category}/{type}-{id}-parent - Change parent for object instance
PUT {{baseUrl}}/instances/:category/:type/:id/parent
28. instances-{category}/{type}-{id}-policies-{Retention Id} - Get a policy of an object
GET {{baseUrl}}/instances/:category/:type/:id/policies/:RetentionId
29. instances-{category}/{type}-{id}-policies-{Retention Id} - Update qualification date, base_date or policy replacement of an item policy
PUT {{baseUrl}}/instances/:category/:type/:id/policies/:RetentionId
30. instances-{category}/{type}-{id}-policies-{Retention Id} - Delete policy for an object
DELETE {{baseUrl}}/instances/:category/:type/:id/policies/:RetentionId
31. instances-{category}/{type}-{id}-policies - List all policies of an object
GET {{baseUrl}}/instances/:category/:type/:id/policies
32. instances-{category}/{type}-{id}-policies - Attach a policy to an object
POST {{baseUrl}}/instances/:category/:type/:id/policies
33. instances-{category}/{type}-{id}-holds - List all holds of an object
GET {{baseUrl}}/instances/:category/:type/:id/holds
34. instances-{category}/{type}-{id}-holds - Attach a hold to an object
POST {{baseUrl}}/instances/:category/:type/:id/holds
35. instances-{category}/{type}-{id}-hold/{Retention Id} - Get a hold of an object
GET {{baseUrl}}/instances/:category/:type/:id/hold/:RetentionId
36. instances-{category}/{type}-{id}-hold/{Retention Id} - Replace existing hold to be a new hold
PUT {{baseUrl}}/instances/:category/:type/:id/hold/:RetentionId
37. instances-{category}/{type}-{id}-hold/{Retention Id} - Delete hold for an object
DELETE {{baseUrl}}/instances/:category/:type/:id/hold/:RetentionId
38. instances-{category}/{type}-{id}-case-node/{case Node Id} - Get case instance details
GET {{baseUrl}}/instances/:category/:type/:id/case-node/:caseNodeId
39. instances-{category}/{type}-{id}-case-node/{case Node Id} - Create case instance child
POST {{baseUrl}}/instances/:category/:type/:id/case-node/:caseNodeId
40. instances-{category}/{type}-{id}-case-node/{case Node Id} - List case role groups
GET {{baseUrl}}/instances/:category/:type/:id/case-node/:caseNodeId/groups
41. instances-{category}/{type}-{id} - get object instance details
GET {{baseUrl}}/instances/:category/:type/:id
42. instances-{category}/{type}-{id} - update instance details
PUT {{baseUrl}}/instances/:category/:type/:id
43. instances-{category}/{type}-{id} - delete object instance
DELETE {{baseUrl}}/instances/:category/:type/:id
44. instances-{category}/{type}-{id} - update instance details
PATCH {{baseUrl}}/instances/:category/:type/:id
45. instances-{category}/{type}-{id} - Copy an object instance
POST {{baseUrl}}/instances/:category/:type/:id/copy
46. instances-{category}/{type}-{id} - Get effective permissions of the object
GET {{baseUrl}}/instances/:category/:type/:id/permissions
47. instances-{category}/{type}-{id} - Request instance to send to search
POST {{baseUrl}}/instances/:category/:type/:id/search-index
48. instances-{category}/{type}-{id} - Get history of changes on an object instance.
GET {{baseUrl}}/instances/:category/:type/:id/history
49. instances-{category}/{type}-{id} - Get relations based on source relation type
POST {{baseUrl}}/instances/:category/:type/:id/source-relation/:relationType
50. instances-{category}/{type}-{id} - Get relations based on target relation type
GET {{baseUrl}}/instances/:category/:type/:id/target-relation/:relationType
51. instances-{category}/{type} - List object instances
GET {{baseUrl}}/instances/:category/:type?page=53258108&items-per-page=53258108&include-total=ex ut enim aute&filter=ex ut enim aute&sortBy=ex ut enim aute
52. instances-{category}/{type} - create new instance
POST {{baseUrl}}/instances/:category/:type
53. instances-file/{type}/{id}-lock - Lock the file instance
PUT {{baseUrl}}/instances/file/:type/:id/lock
54. instances-file/{type}/{id}-lock - Delete the lock on a file
DELETE {{baseUrl}}/instances/file/:type/:id/lock
55. instances-file/{type}/{id}-contents-{rendition Id} - get rendition detail of the file
GET {{baseUrl}}/instances/file/:type/:id/contents/:renditionId
56. instances-file/{type}/{id}-contents-{rendition Id} - Update a rendition
PUT {{baseUrl}}/instances/file/:type/:id/contents/:renditionId
57. instances-file/{type}/{id}-contents-{rendition Id} - Delete rendition
DELETE {{baseUrl}}/instances/file/:type/:id/contents/:renditionId
58. instances-file/{type}/{id}-contents-{rendition Id} - Patch rendition
PATCH {{baseUrl}}/instances/file/:type/:id/contents/:renditionId
59. instances-file/{type}/{id}-contents - List all renditions associated with a file
GET {{baseUrl}}/instances/file/:type/:id/contents
60. instances-file/{type}/{id}-contents - Add new rendition to file
POST {{baseUrl}}/instances/file/:type/:id/contents
61. instances-file/{type}/{id} - Delete all versions of an object
DELETE {{baseUrl}}/instances/file/:type/:id/all
62. instances-file/{type}/{id} - Check if user privilege to download the content associated with file type
GET {{baseUrl}}/instances/file/:type/:id/canDownload
63. instances-file/{type}/{id} - Make current to latest version
POST {{baseUrl}}/instances/file/:type/:id/make-current
64. instances-file/{type}/{id} - List all versions of the file
GET {{baseUrl}}/instances/file/:type/:id/versions
65. instances-file/{type}/{id} - Check in as next version
POST {{baseUrl}}/instances/file/:type/:id/nextVersion
66. instances-file/{type}/{id} - Check in as current version
POST {{baseUrl}}/instances/file/:type/:id/currentVersion
67. instances-case/{type} - Create case instance
POST {{baseUrl}}/instances/case/:type
68. instances-case/{type} - Get case node instances
GET {{baseUrl}}/instances/case/:type/:id/case-node-instance-children
69. instances-folder/{type}/{id}/items - List object instances under the folder.
GET {{baseUrl}}/instances/folder/:type/:id/items
70. instances-folder/{type}/{id}/items - create object instances under the folder.
POST {{baseUrl}}/instances/folder/:type/:id/items
71. localizations-{id} - get localization details
GET {{baseUrl}}/localizations/:id
72. localizations-{id} - update Localization details
PUT {{baseUrl}}/localizations/:id
73. localizations-{id} - Delete Localization
DELETE {{baseUrl}}/localizations/:id
74. localizations - List all Localizations
GET {{baseUrl}}/localizations?page=53258108&items-per-page=53258108
List all the Localizations
75. localizations - update all localizations
PUT {{baseUrl}}/localizations
76. localizations - Create a new Localization
POST {{baseUrl}}/localizations
Create a new Localization
77. localizations - Delete all localizations
DELETE {{baseUrl}}/localizations
78. bundles-{id} - Get bundle
GET {{baseUrl}}/bundles/:id
79. bundles-{id} - Delete bundle
DELETE {{baseUrl}}/bundles/:id
80. bundles-{bundle Id}/deployments - Get all bundles
GET {{baseUrl}}/bundles/:bundleId/deployments
81. bundles-{bundle Id}/deployments - Install bundle into tenant
POST {{baseUrl}}/bundles/:bundleId/deployments
82. bundles-{bundle Id}/deployments - Delete bundle deployment
DELETE {{baseUrl}}/bundles/:bundleId/deployments/:id
83. bundles - Get all bundles
GET {{baseUrl}}/bundles
84. bundles - Create bundle using zip file or json
POST {{baseUrl}}/bundles
85. permissions-{id} - get permission details
GET {{baseUrl}}/permissions/:id
86. permissions-{id} - update permission details
PUT {{baseUrl}}/permissions/:id
87. permissions-{id} - Delete permission
DELETE {{baseUrl}}/permissions/:id
88. permissions-{id} - patch permission details
PATCH {{baseUrl}}/permissions/:id
89. permissions - List all the permissions
GET {{baseUrl}}/permissions?page=53258108&items-per-page=53258108&include-total=ex ut enim aute&filter=ex ut enim aute&sortBy=ex ut enim aute
List all the permissions
90. permissions - Create a new permission
POST {{baseUrl}}/permissions
Create a new permission
91. retention-item Policy - For backward compatibility, it is old API for list all CMS objects with policies or holds based on the filters
GET {{baseUrl}}/retention/itemPolicy?page=53258108&items-per-page=53258108&include-total=ex ut enim aute&filter=ex ut enim aute&sortBy=ex ut enim aute
List all CMS objects with policies or holds based on the filters
92. retention-item Policy - For backward compatibility, it is old API for setting all item objects for null qualification date on given policy id
PUT {{baseUrl}}/retention/itemPolicy/policy/:RetentionId
93. retention - List all CMS objects with policies or holds based on the filters
GET {{baseUrl}}/retention?page=53258108&items-per-page=53258108&include-total=ex ut enim aute&filter=ex ut enim aute&sortBy=ex ut enim aute
List all CMS objects with policies or holds based on the filters
94. retention - Set all item objects for null qualification date on given policy id
PUT {{baseUrl}}/retention/policy/:RetentionId
95. retention - Remove same hold id for all CMS objects
DELETE {{baseUrl}}/retention/hold/:RetentionId
96. retention - Dispose a list of CMS objects which is from RPS approval list
POST {{baseUrl}}/retention/item_disposition
97. retention - For backward compatibility, it is old API for disposing a list of CMS objects which is from RPS approval list
POST {{baseUrl}}/retention/itemDisposition
98. case-type-definitions-{id} - Get case model by case model id
GET {{baseUrl}}/case/type-definitions/:id
99. case-type-definitions-{id} - Update case model by case model id
PUT {{baseUrl}}/case/type-definitions/:id
100. case-type-definitions-{id} - Delete case model by case model id
DELETE {{baseUrl}}/case/type-definitions/:id
101. case-type-definitions - List case models
GET {{baseUrl}}/case/type-definitions?page=53258108&items-per-page=53258108&include-total=ex ut enim aute&filter=ex ut enim aute&sortBy=ex ut enim aute
102. case-type-definitions - Create a new case model
POST {{baseUrl}}/case/type-definitions
103. case-case-nodes/{id} - Get case node details by case node id
GET {{baseUrl}}/case/case-nodes/:id
104. case-case-nodes/{id} - Update case node by id
PUT {{baseUrl}}/case/case-nodes/:id
105. case-case-nodes/{id} - Delete case node by id
DELETE {{baseUrl}}/case/case-nodes/:id
106. case-case-nodes/{id} - Get case node parent details
GET {{baseUrl}}/case/case-nodes/:id/parent
107. trait-definitions-{trait Name}-attributes-{attribute Id} - Get trait attribute details
GET {{baseUrl}}/trait-definitions/:traitName/attributes/:attributeId
Get trait attribute details
108. trait-definitions-{trait Name}-attributes-{attribute Id} - Update trait attribute details
PUT {{baseUrl}}/trait-definitions/:traitName/attributes/:attributeId
Update trait attribute details
109. trait-definitions-{trait Name}-attributes-{attribute Id} - Delete trait attribute
DELETE {{baseUrl}}/trait-definitions/:traitName/attributes/:attributeId
Delete trait attribute
110. trait-definitions-{trait Name}-attributes - List all the attributes associated with a trait
GET {{baseUrl}}/trait-definitions/:traitName/attributes
List all the attributes associated with a trait
111. trait-definitions-{trait Name}-attributes - create new trait attribute
POST {{baseUrl}}/trait-definitions/:traitName/attributes
create new trait attribute
112. trait-definitions-{trait Name}-index-definitions-{index Id} - Get trait index definition details
GET {{baseUrl}}/trait-definitions/:traitName/index-definitions/:indexId
Get trait index definition details
113. trait-definitions-{trait Name}-index-definitions-{index Id} - Update trait index definition details
PUT {{baseUrl}}/trait-definitions/:traitName/index-definitions/:indexId
Update trait index definition details
114. trait-definitions-{trait Name}-index-definitions-{index Id} - Delete index definition details
DELETE {{baseUrl}}/trait-definitions/:traitName/index-definitions/:indexId
Delete index definition details
115. trait-definitions-{trait Name}-index-definitions - List all the index definitions associated with a trait
GET {{baseUrl}}/trait-definitions/:traitName/index-definitions
List all the index definitions associated with a trait
116. trait-definitions-{trait Name}-index-definitions - create new index definition for trait
POST {{baseUrl}}/trait-definitions/:traitName/index-definitions
create new index definition for trait
117. trait-definitions-{trait Name} - get trait definition details
GET {{baseUrl}}/trait-definitions/:traitName
118. trait-definitions-{trait Name} - update trait definition
PUT {{baseUrl}}/trait-definitions/:traitName
119. trait-definitions-{trait Name} - delete trait definition
DELETE {{baseUrl}}/trait-definitions/:traitName
120. trait-definitions-{trait Name} - patch trait definition
PATCH {{baseUrl}}/trait-definitions/:traitName
121. trait-definitions - List all trait definitions
GET {{baseUrl}}/trait-definitions
List all trait definitions
122. trait-definitions - create a new custom trait definition
POST {{baseUrl}}/trait-definitions
123. type-definitions-{type Name}-attributes-{attribute Id} - Get type attribute details
GET {{baseUrl}}/type-definitions/:typeName/attributes/:attributeId
Get type attribute details
124. type-definitions-{type Name}-attributes-{attribute Id} - Update type attribute details
PUT {{baseUrl}}/type-definitions/:typeName/attributes/:attributeId
Update type attribute details
125. type-definitions-{type Name}-attributes - List all the attributes associated with a type
GET {{baseUrl}}/type-definitions/:typeName/attributes
List all the attributes associated with a type
126. type-definitions-{type Name}-attributes - create new type attribute
POST {{baseUrl}}/type-definitions/:typeName/attributes
create new type attribute
127. type-definitions-{type Name}-index-definitions-{index Id} - Get type index definition details
GET {{baseUrl}}/type-definitions/:typeName/index-definitions/:indexId
Get type index definition details
128. type-definitions-{type Name}-index-definitions-{index Id} - Update type index definition details
PUT {{baseUrl}}/type-definitions/:typeName/index-definitions/:indexId
Update type index definition details
129. type-definitions-{type Name}-index-definitions-{index Id} - Delete index definition details
DELETE {{baseUrl}}/type-definitions/:typeName/index-definitions/:indexId
Delete index definition details
130. type-definitions-{type Name}-index-definitions - List all the index definitions associated with a type
GET {{baseUrl}}/type-definitions/:typeName/index-definitions
List all the index definitions associated with a type
131. type-definitions-{type Name}-index-definitions - create new type index definition
POST {{baseUrl}}/type-definitions/:typeName/index-definitions
create new type index definition
132. type-definitions-{type Name}-required-traits - List all the required traits associated with the type definitions
GET {{baseUrl}}/type-definitions/:typeName/required-traits
List all the required traits associated with the type definitions
133. type-definitions-{type Name}-required-traits - associate a new required trait with a type definition
POST {{baseUrl}}/type-definitions/:typeName/required-traits
associate a new required trait with a type definition
134. type-definitions-{type Name}-requird-traits/{required Trait Id} - Get required trait details
GET {{baseUrl}}/type-definitions/:typeName/requird-traits/:requiredTraitId
Get required trait details
135. type-definitions-{type Name}-requird-traits/{required Trait Id} - Update required trait details
PUT {{baseUrl}}/type-definitions/:typeName/requird-traits/:requiredTraitId
Update required trait details
136. type-definitions-{type Name}-requird-traits/{required Trait Id} - Delete the required trait definition
DELETE {{baseUrl}}/type-definitions/:typeName/requird-traits/:requiredTraitId
Delete the required trait definition
137. type-definitions-{type Name} - get type definition details
GET {{baseUrl}}/type-definitions/:typeName
138. type-definitions-{type Name} - update type definition
PUT {{baseUrl}}/type-definitions/:typeName
create a new custom type definition
139. type-definitions-{type Name} - Get type and inherited types attributes details
GET {{baseUrl}}/type-definitions/:typeName/attributes-all
Get type and inherited attributes details
140. type-definitions - List all type definitions
GET {{baseUrl}}/type-definitions
List all type definitions
141. type-definitions - create a new custom type definition for the given category.
POST {{baseUrl}}/type-definitions/:category
create a new custom type definition
142. namespaces-{namespace Id} - get Namespace Details
GET {{baseUrl}}/namespaces/:namespaceId
The Namespace's end point to get a namespace details using id of namespace
143. namespaces-{namespace Id} - Update a namespace
PUT {{baseUrl}}/namespaces/:namespaceId
Update a namespace
144. namespaces-{namespace Id} - Update a namespace by patch
PATCH {{baseUrl}}/namespaces/:namespaceId
Update a namespace by patch
145. namespaces - Get list of Namespaces
GET {{baseUrl}}/namespaces?page=53258108&items-per-page=53258108&include-total=ex ut enim aute&filter=ex ut enim aute&sortBy=ex ut enim aute
The Namespace's end point lists the list of namespaces
146. namespaces - create a new Namespace
POST {{baseUrl}}/namespaces
Create a new namespace
ENDPOINTS