Documentum REST Services
API References for Documentum REST Services 16.4 SNAPSHOT (Feldspar) Build.
States
State: Start
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Entry point | [None] | GET | home-doc |
Transition: Entry point
By performing HTTP method GET on state Start.
- Response:
-
- Result States:
- Media Types:
State: home-doc
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Get product information | about |
GET | product-info |
| Get repositories | http://identifiers.emc.com/linkrel/repositories |
GET | repositories |
Transition: Get product information
By performing HTTP method GET on link relation about of state home-doc.
- Response:
-
- Result States:
- Media Types:
Transition: Get repositories
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/repositories of state home-doc.
- Request:
- Response:
-
- Result States:
- Media Types:
State: repositories
Properties
See repositories.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find repository | edit on entry |
GET | repository |
Transition: Find repository
By performing HTTP method GET on link relation edit on entry of state repositories.
- Response:
-
- Result States:
- Media Types:
State: product-info
Transitions
No transitions.
State: repository
Properties
See repository.
Transitions
Transition: Get cabinets
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/cabinets of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get checked out objects
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/checked-out-objects of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Create batch
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/batches of state repository.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Create batch with multipart/related
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get batch capabilities
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/batch-capabilities of state repository.
- Response:
-
- Result States:
- Media Types:
Transition: Execute DQL query
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/dql of state repository.
- Request:
-
- URI Parameters:
- Input: dql-query-request
- Response:
-
- Result States:
- Media Types:
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/dql of state repository.
- Request:
-
- Input: dql-query-request
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Get users
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/users of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get groups
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/groups of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get current user
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/current-user of state repository.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get current user preferences
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/current-user-preferences of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get formats
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/formats of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get relation types
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/relation-types of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get relations
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/relations of state repository.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get network locations
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/network-locations of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get types
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/types of state repository.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Execute full-text search
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/search of state repository.
- Request:
- Response:
-
- Result States:
- Media Types:
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/search of state repository.
- Request:
-
- URI Parameters:
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Get aspect types
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/aspect-types of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get saved searches
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/saved-searches of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get search templates
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/search-templates of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get acls
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/acls of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get lifecycles
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/lifecycles of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get snapshots
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/snapshots of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get single object all contents
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/archived-contents of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get multiple objects contents
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/archived-contents of state repository.
- Request:
-
- URI Parameters:
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Log off
This transition is not yet specified in an HTTP interface.
Transition: Get audit trails
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/audit-trails of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get current user subscriptions
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/subscriptions of state repository.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
State: cabinets
Properties
See cabinets.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find cabinet | edit on entry |
GET | cabinet |
| Create cabinet | http://identifiers.emc.com/linkrel/cabinets |
POST | cabinet |
Transition: Find cabinet
By performing HTTP method GET on link relation edit on entry of state cabinets.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Create cabinet
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/cabinets of state cabinets.
- Request:
-
- Input: cabinet
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: cabinet
Properties
See cabinet.
Transitions
Transition: Modify cabinet
By performing HTTP method POST on link relation edit of state cabinet.
Transition: Remove cabinet
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state cabinet.
- Request:
-
- URI Parameters:
Transition: Get child folders
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/folders of state cabinet.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get child documents
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/documents of state cabinet.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get child objects
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/objects of state cabinet.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get child links
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/child-links of state cabinet.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get lifecycle
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/lifecycle of state cabinet.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get attachable lifecycles
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/attachable-lifecycles of state cabinet.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get object lifecycle
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state cabinet.
- Response:
-
- Result States:
- Media Types:
Transition: Attach lifecycle
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state cabinet.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Detach lifecycle
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state cabinet.
State: folder-child-folders
Properties
See folder-child-folders.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find folder | edit on entry |
GET | folder |
| Create folder | http://identifiers.emc.com/linkrel/folders |
POST | folder |
Transition: Find folder
By performing HTTP method GET on link relation edit on entry of state folder-child-folders.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Create folder
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/folders of state folder-child-folders.
- Request:
-
- Input: folder
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: folder
Properties
See folder.
Transitions
Transition: Modify folder
By performing HTTP method POST on link relation edit of state folder.
Transition: Remove folder
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state folder.
- Request:
-
- URI Parameters:
Transition: Get child folders
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/folders of state folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get child documents
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/documents of state folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get child objects
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/objects of state folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get child links
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/child-links of state folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get cabinet
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/cabinet of state folder.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get canonical cabinet
By performing HTTP method GET on link relation canonical of state folder.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent folder
By performing HTTP method GET on link relation parent of state folder.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent links
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/parent-links of state folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get lightweight objects
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/lightweight-objects of state folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get shared parent
- Response:
-
- Result States:
- Media Types:
Transition: Dematerialize lightweight object
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/dematerialize of state folder.
Transition: Materialize lightweight object
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/materialize of state folder.
- Response:
-
- Result States:
- Media Types:
Transition: Get lifecycle
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/lifecycle of state folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get attachable lifecycles
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/attachable-lifecycles of state folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get object lifecycle
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state folder.
- Response:
-
- Result States:
- Media Types:
Transition: Attach lifecycle
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state folder.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Detach lifecycle
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state folder.
State: folder-child-documents
Properties
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find document | edit on entry |
GET | document |
| Create document | http://identifiers.emc.com/linkrel/documents |
POST | document |
| Create contentful document | http://identifiers.emc.com/linkrel/documents |
POST | document |
Transition: Find document
By performing HTTP method GET on link relation edit on entry of state folder-child-documents.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Create document
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/documents of state folder-child-documents.
- Request:
-
- URI Parameters:
- Input: document
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Create contentful document
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/documents of state folder-child-documents.
- Request:
-
- URI Parameters:
- Input: document
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: document
Properties
See document.
Transitions
Transition: Modify document
By performing HTTP method POST on link relation edit of state document.
Transition: Remove document
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state document.
- Request:
-
- URI Parameters:
Transition: Get contents
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/contents of state document.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get primary content
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/primary-content of state document.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get all versions
By performing HTTP method GET on link relation version-history of state document.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get current version
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/current-version of state document.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get precedent version
By performing HTTP method GET on link relation predecessor-version of state document.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Checkout
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/checkout of state document.
- Response:
-
- Result States:
- Media Types:
Transition: Get cabinet
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/cabinet of state document.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent folder
By performing HTTP method GET on link relation parent of state document.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent links
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/parent-links of state document.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get lightweight objects
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/lightweight-objects of state document.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get shared parent
- Response:
-
- Result States:
- Media Types:
Transition: Dematerialize lightweight object
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/dematerialize of state document.
Transition: Materialize lightweight object
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/materialize of state document.
- Response:
-
- Result States:
- Media Types:
Transition: Get lifecycle
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/lifecycle of state document.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get attachable lifecycles
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/attachable-lifecycles of state document.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get object lifecycle
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state document.
- Response:
-
- Result States:
- Media Types:
Transition: Attach lifecycle
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state document.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Detach lifecycle
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state document.
Transition: Get virtual document nodes
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/virtual-document-nodes of state document.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Convert simple document to virtual document
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/virtual-document-conversion of state document.
- Request:
- Response:
Transition: Get virtual document snapshots
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/snapshots of state document.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
State: folder-child-objects
Properties
See folder-child-objects.
Transitions
Transition: Find SysObject
By performing HTTP method GET on link relation edit on entry of state folder-child-objects.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Create SysObject
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/objects of state folder-child-objects.
- Request:
-
- URI Parameters:
- Input: object
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Create contentful object
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/objects of state folder-child-objects.
- Request:
-
- URI Parameters:
- Input: document
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Copy SysObject
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/objects of state folder-child-objects.
- Request:
-
- URI Parameters:
- Input: object-copy-ref
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: object
Properties
See object.
Transitions
Transition: Modify SysObject
By performing HTTP method POST on link relation edit of state object.
Transition: Remove SysObject
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state object.
- Request:
-
- URI Parameters:
Transition: Get contents
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/contents of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get primary content
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/primary-content of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get all versions
By performing HTTP method GET on link relation version-history of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get current version
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/current-version of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get precedent version
By performing HTTP method GET on link relation predecessor-version of state object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Checkout
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/checkout of state object.
- Response:
-
- Result States:
- Media Types:
Transition: Get cabinet
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/cabinet of state object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent folder
By performing HTTP method GET on link relation parent of state object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent links
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/parent-links of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get canonical document
By performing HTTP method GET on link relation canonical of state object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get canonical folder
By performing HTTP method GET on link relation canonical of state object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get canonical cabinet
By performing HTTP method GET on link relation canonical of state object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get object aspects
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/object-aspects of state object.
- Response:
-
- Result States:
- Media Types:
Transition: Get virtual document nodes
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/virtual-document-nodes of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Convert simple document to virtual document
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/virtual-document-conversion of state object.
- Request:
- Response:
Transition: Get virtual document snapshots
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/snapshots of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get SysObject permission set
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/permission-set of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: View permissions
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/permissions of state object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get lightweight objects
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/lightweight-objects of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get shared parent
- Response:
-
- Result States:
- Media Types:
Transition: Dematerialize lightweight object
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/dematerialize of state object.
Transition: Materialize lightweight object
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/materialize of state object.
- Response:
-
- Result States:
- Media Types:
Transition: Get comments
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/comments of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get lifecycle
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/lifecycle of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get attachable lifecycles
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/attachable-lifecycles of state object.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get object lifecycle
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state object.
- Response:
-
- Result States:
- Media Types:
Transition: Attach lifecycle
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Detach lifecycle
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state object.
State: checked-out-objects
Properties
See checked-out-objects.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find checked out object | edit on entry |
GET | object |
Transition: Find checked out object
By performing HTTP method GET on link relation edit on entry of state checked-out-objects.
- Request:
- Response:
-
- Result States:
- Media Types:
State: checked-out-object
Transitions
Transition: Cancel checkout
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/cancel-checkout of state checked-out-object.
Transition: Check in as next major
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/checkin-next-major of state checked-out-object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Check in as next minor
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/checkin-next-minor of state checked-out-object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Check in as branch
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/checkin-branch of state checked-out-object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Check in with content as next major
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/checkin-next-major of state checked-out-object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Check in with content as next minor
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/checkin-next-minor of state checked-out-object.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Check in with content as branch
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/checkin-branch of state checked-out-object.
- Request:
- Response:
-
- Result States:
- Media Types:
State: child-folder-links
Properties
See child-folder-links.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find child folder link | edit on entry |
GET | child-folder-link |
| Link to this folder | http://identifiers.emc.com/linkrel/child-links |
POST | child-folder-link |
Transition: Find child folder link
By performing HTTP method GET on link relation edit on entry of state child-folder-links.
- Response:
-
- Result States:
- Media Types:
Transition: Link to this folder
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/child-links of state child-folder-links.
- Request:
-
- Input: object-ref
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: parent-folder-links
Properties
See parent-folder-links.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find parent folder link | edit on entry |
GET | parent-folder-link |
| Link to a specified folder | http://identifiers.emc.com/linkrel/parent-links |
POST | parent-folder-link |
Transition: Find parent folder link
By performing HTTP method GET on link relation edit on entry of state parent-folder-links.
- Response:
-
- Result States:
- Media Types:
Transition: Link to a specified folder
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/parent-links of state parent-folder-links.
- Request:
-
- Input: object-ref
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: child-folder-link
Properties
See folder-link.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Remove child folder link | self |
DELETE |
Transition: Remove child folder link
By performing HTTP method DELETE on link relation self of state child-folder-link.
State: parent-folder-link
Properties
See folder-link.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Remove parent folder link | self |
DELETE | |
| Move SysObject | self |
PUT | parent-folder-link |
Transition: Remove parent folder link
By performing HTTP method DELETE on link relation self of state parent-folder-link.
Transition: Move SysObject
By performing HTTP method PUT on link relation self of state parent-folder-link.
- Request:
-
- URI Parameters:
- Input: object-ref
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: contents
Properties
See contents.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find content | edit on entry |
GET | content |
| Add content | http://identifiers.emc.com/linkrel/contents |
POST | content |
Transition: Find content
By performing HTTP method GET on link relation edit on entry of state contents.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Add content
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/contents of state contents.
- Request:
-
- URI Parameters:
- Input: content
- Response:
-
- Result States:
- Media Types:
State: content
Properties
See content.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Remove content | self |
DELETE | |
| Get content media | http://identifiers.emc.com/linkrel/content-media |
GET | content-media |
| Get parent object | parent |
GET | object |
Transition: Remove content
By performing HTTP method DELETE on link relation self of state content.
Transition: Get content media
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/content-media of state content.
- Request:
-
- Headers:
-
- If-None-Match (optional)
- URI Parameters:
- Response:
-
- Result States:
- Headers:
-
- ETag (optional)
- Media Types:
Transition: Get parent object
By performing HTTP method GET on link relation parent of state content.
- Request:
- Response:
-
- Result States:
- Media Types:
State: all-versions
Properties
See all-versions.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find revision | edit on entry |
GET | object |
Transition: Find revision
By performing HTTP method GET on link relation edit on entry of state all-versions.
- Request:
- Response:
-
- Result States:
- Media Types:
State: current-version
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Get canonical SysObject | canonical |
GET | object |
Transition: Get canonical SysObject
By performing HTTP method GET on link relation canonical of state current-version.
- Request:
- Response:
-
- Result States:
- Media Types:
State: content-media
State: batch
Properties
See batch.
State: batch-capabilities
Properties
See batch-capabilities.
State: dql-query
Properties
See dql-query.
State: groups
Properties
See groups.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find group | edit on entry |
GET | group |
| Create group | http://identifiers.emc.com/linkrel/groups |
POST | group |
Transition: Find group
By performing HTTP method GET on link relation edit on entry of state groups.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Create group
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/groups of state groups.
State: group
Properties
See group.
Transitions
Transition: Modify group
By performing HTTP method POST on link relation edit of state group.
- Request:
-
- Input: group
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Remove group
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state group.
Transition: Get parent groups
By performing HTTP method GET on link relation parent of state group.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get sub groups
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/groups of state group.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get group users
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/users of state group.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
State: group-member-groups
Properties
See group-member-groups.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find group | edit on entry |
GET | group |
| Add group member | http://identifiers.emc.com/linkrel/groups |
POST | |
| Remove group member | http://identifiers.emc.com/linkrel/delete |
DELETE |
Transition: Find group
By performing HTTP method GET on link relation edit on entry of state group-member-groups.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Add group member
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/groups of state group-member-groups.
- Request:
-
- Input: group
- Media Types:
Transition: Remove group member
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state group-member-groups.
State: group-member-users
Properties
See group-member-users.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find user | edit on entry |
GET | user |
| Add user member to group | http://identifiers.emc.com/linkrel/users |
POST | |
| Remove user member | http://identifiers.emc.com/linkrel/delete |
DELETE |
Transition: Find user
By performing HTTP method GET on link relation edit on entry of state group-member-users.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Add user member to group
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/users of state group-member-users.
- Request:
-
- Input: user
- Media Types:
Transition: Remove user member
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state group-member-users.
State: users
Properties
See users.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find user | edit on entry |
GET | user |
| Create user | http://identifiers.emc.com/linkrel/users |
POST | user |
Transition: Find user
By performing HTTP method GET on link relation edit on entry of state users.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Create user
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/users of state users.
State: user
Properties
See user.
Transitions
Transition: Modify user
By performing HTTP method POST on link relation edit of state user.
- Request:
-
- Input: user
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Remove user
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state user.
Transition: Get parent groups
By performing HTTP method GET on link relation parent of state user.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get default folder
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/default-folder of state user.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get user associated permission set
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/permission-set of state user.
- Request:
-
- URI Parameters:
- Response:
State: current-user
Properties
See user.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Modify current user | edit |
POST | current-user |
| Get parent groups | parent |
GET | groups |
| Get default folder | http://identifiers.emc.com/linkrel/default-folder |
GET | default-folder |
Transition: Modify current user
By performing HTTP method POST on link relation edit of state current-user.
- Request:
-
- Input: user
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent groups
By performing HTTP method GET on link relation parent of state current-user.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get default folder
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/default-folder of state current-user.
- Request:
- Response:
-
- Result States:
- Media Types:
State: current-user-preferences
Properties
See preferences.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Create user preference | http://identifiers.emc.com/linkrel/current-user-preferences |
POST | current-user-preference |
| Find user preference | edit on entry |
GET | current-user-preference |
Transition: Create user preference
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/current-user-preferences of state current-user-preferences.
- Request:
-
- Input: preference
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Find user preference
By performing HTTP method GET on link relation edit on entry of state current-user-preferences.
- Request:
- Response:
-
- Result States:
- Media Types:
State: current-user-preference
Properties
See preference.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Modify user preference | edit |
POST | current-user-preference |
| Remove user preference | http://identifiers.emc.com/linkrel/delete |
DELETE |
Transition: Modify user preference
By performing HTTP method POST on link relation edit of state current-user-preference.
- Request:
-
- Input: preference
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Remove user preference
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state current-user-preference.
State: default-folder
Properties
See folder.
Transitions
Transition: Modify folder
By performing HTTP method POST on link relation edit of state default-folder.
- Request:
- Response:
-
- Result States:
- Headers:
-
- Location (optional)
- Media Types:
Transition: Remove folder
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state default-folder.
- Request:
-
- URI Parameters:
Transition: Get child folders
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/folders of state default-folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get child documents
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/documents of state default-folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get child objects
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/objects of state default-folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get child links
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/child-links of state default-folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get cabinet
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/cabinet of state default-folder.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get canonical cabinet
By performing HTTP method GET on link relation canonical of state default-folder.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent folder
By performing HTTP method GET on link relation parent of state default-folder.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent links
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/parent-links of state default-folder.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
State: network-locations
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find network location | edit on entry |
GET | network-location |
Transition: Find network location
By performing HTTP method GET on link relation edit on entry of state network-locations.
- Request:
- Response:
-
- Result States:
- Media Types:
State: network-location
Properties
See network-location.
State: types
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find type | edit on entry |
GET | type |
Transition: Find type
By performing HTTP method GET on link relation edit on entry of state types.
- Request:
- Response:
-
- Result States:
- Media Types:
State: type
Properties
See type.
Transitions
Transition: Get parent types
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/types of state type.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent type
By performing HTTP method GET on link relation parent of state type.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get the assist values of a type
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/assist-values of state type.
- Request:
-
- URI Parameters:
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent sharable type
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/parent-sharable-type of state type.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get lightweight types
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/lightweight-types of state type.
- Request:
- Response:
-
- Result States:
- Media Types:
State: type-value-assistances
Properties
See assist-values.
State: formats
Properties
See formats.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find format | edit on entry |
GET | format |
Transition: Find format
By performing HTTP method GET on link relation edit on entry of state formats.
- Request:
- Response:
-
- Result States:
- Media Types:
State: format
Properties
See format.
State: relation-types
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find relation type | edit on entry |
GET | relation-type |
Transition: Find relation type
By performing HTTP method GET on link relation edit on entry of state relation-types.
- Request:
- Response:
-
- Result States:
- Media Types:
State: relation-type
Properties
See relation-type.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Get relations | http://identifiers.emc.com/linkrel/relations |
GET | relations |
Transition: Get relations
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/relations of state relation-type.
- Request:
- Response:
-
- Result States:
- Media Types:
State: relations
Properties
See relations.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find relation | edit on entry |
GET | relation |
| Create relation | http://identifiers.emc.com/linkrel/relations |
POST | relation |
Transition: Find relation
By performing HTTP method GET on link relation edit on entry of state relations.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Create relation
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/relations of state relations.
- Request:
-
- Input: relation
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: relation
Properties
See relation.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Get relation type | http://identifiers.emc.com/linkrel/relation-type |
GET | relation-type |
| Get parent object | parent |
GET | object |
| Get child object | child |
GET | object |
| Remove relation | http://identifiers.emc.com/linkrel/delete |
DELETE |
Transition: Get relation type
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/relation-type of state relation.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get parent object
By performing HTTP method GET on link relation parent of state relation.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Get child object
By performing HTTP method GET on link relation child of state relation.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Remove relation
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state relation.
State: search
Properties
See search-result.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find a search result | edit on entry |
GET | |
| Navigate a facet | http://identifiers.emc.com/linkrel/search |
GETPOST |
Transition: Find a search result
By performing HTTP method GET on link relation edit on entry of state search.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Navigate a facet
- Request:
- Response:
-
- Result States:
- Media Types:
- Request:
-
- URI Parameters:
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: saved-searches
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Create saved search | http://identifiers.emc.com/linkrel/saved-searches |
POST | saved-search |
| Find saved search | edit on entry |
GET | saved-search |
Transition: Create saved search
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/saved-searches of state saved-searches.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Find saved search
By performing HTTP method GET on link relation edit on entry of state saved-searches.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
State: saved-search
Transitions
Transition: Modify saved search
By performing HTTP method POST on link relation edit of state saved-search.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Remove saved search
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state saved-search.
Transition: Execute a saved search
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/search-execution of state saved-search.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get saved search results
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/saved-search-results of state saved-search.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Enable or refresh saved search results
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/saved-search-results of state saved-search.
- Response:
-
- Result States:
- Media Types:
State: saved-search-results
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Disable saved search results | http://identifiers.emc.com/linkrel/saved-search-results |
DELETE |
Transition: Disable saved search results
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/saved-search-results of state saved-search-results.
State: search-templates
Transitions
Transition: Create search template
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/search-templates of state search-templates.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Save search as template
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/as-search-template of state search-templates.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Find search template
By performing HTTP method GET on link relation edit on entry of state search-templates.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
State: search-template
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Remove search template | http://identifiers.emc.com/linkrel/delete |
DELETE | |
| Execute a search template | http://identifiers.emc.com/linkrel/search-execution |
POST | search |
Transition: Remove search template
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state search-template.
Transition: Execute a search template
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/search-execution of state search-template.
- Request:
-
- URI Parameters:
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: aspect-types
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find aspect type | edit on entry |
GET | aspect-type |
Transition: Find aspect type
By performing HTTP method GET on link relation edit on entry of state aspect-types.
- Request:
- Response:
-
- Result States:
- Media Types:
State: aspect-type
Properties
See aspect-type.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Get type | http://identifiers.emc.com/linkrel/type |
GET | type |
Transition: Get type
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/type of state aspect-type.
- Request:
- Response:
-
- Result States:
- Media Types:
State: object-aspects
Properties
See aspects.
Transitions
Transition: Get object aspects
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/object-aspects of state object-aspects.
- Response:
-
- Result States:
- Media Types:
Transition: Attach aspect
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/object-aspects of state object-aspects.
- Request:
-
- Input: aspects
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Detach aspect
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state object-aspects.
Transition: Get aspect type
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/aspect-type of state object-aspects.
- Request:
- Response:
-
- Result States:
- Media Types:
State: permission-set
Properties
See permission-set.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Modify permission set | edit |
PUT | permission-set |
Transition: Modify permission set
By performing HTTP method PUT on link relation edit of state permission-set.
- Request:
-
- Input: permission-set
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: virtual-document-nodes
Properties
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find virtual document node | edit on entry |
GET | virtual-document-relation |
| Add node to the virtual document | http://identifiers.emc.com/linkrel/virtual-document-nodes |
POST | virtual-document-relation |
Transition: Find virtual document node
By performing HTTP method GET on link relation edit on entry of state virtual-document-nodes.
- Request:
-
- URI Parameters:
- Response:
Transition: Add node to the virtual document
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/virtual-document-nodes of state virtual-document-nodes.
- Request:
- Response:
State: virtual-document-relation
Properties
See virtual-document-relation.
Transitions
Transition: Modify virtual document node
By performing HTTP method POST on link relation edit of state virtual-document-relation.
- Request:
- Response:
Transition: Remove virtual document node
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state virtual-document-relation.
Transition: Get the virtual document node object
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/virtual-document-component of state virtual-document-relation.
- Request:
- Response:
-
- Result States:
- Media Types:
State: permissions
Properties
See permissions.
State: user-permission-set
Properties
See user-permission-set.
State: acls
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find acl | edit on entry |
GET | acl |
| Create acl | http://identifiers.emc.com/linkrel/acls |
POST | acl |
Transition: Find acl
By performing HTTP method GET on link relation edit on entry of state acls.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Create acl
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/acls of state acls.
- Request:
-
- Input: acl
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: acl
Properties
See acl.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Modify acl | edit |
POST | acl |
| Remove acl | http://identifiers.emc.com/linkrel/delete |
DELETE | |
| Get acl associated objects | http://idendifiers.emc.com/linkrel/associations |
GET | acl-associated-objects |
Transition: Modify acl
By performing HTTP method POST on link relation edit of state acl.
Transition: Remove acl
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state acl.
- Request:
-
- URI Parameters:
Transition: Get acl associated objects
By performing HTTP method GET on link relation http://idendifiers.emc.com/linkrel/associations of state acl.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
State: acl-associated-objects
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find acl associated object | edit on entry |
GET | object |
Transition: Find acl associated object
By performing HTTP method GET on link relation edit on entry of state acl-associated-objects.
- Request:
- Response:
-
- Result States:
- Media Types:
State: object-lightweight-objects
Properties
See object-lightweight-objects.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Get lightweight objects | http://identifiers.emc.com/linkrel/lightweight-objects |
GET | object |
| Create lightweight object | http://identifiers.emc.com/linkrel/lightweight-objects |
POST | object |
Transition: Get lightweight objects
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/lightweight-objects of state object-lightweight-objects.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Create lightweight object
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/lightweight-objects of state object-lightweight-objects.
- Request:
-
- URI Parameters:
- Input: object
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: object-parent
Properties
See object.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Get shared parent | http://identifiers.emc.com/linkrel/shared-parent |
GET | object |
| Reparent | http://identifiers.emc.com/linkrel/shared-parent |
POST | object |
Transition: Get shared parent
- Response:
-
- Result States:
- Media Types:
Transition: Reparent
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/shared-parent of state object-parent.
- Request:
- Response:
-
- Result States:
- Media Types:
State: materialization
Properties
See object.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Dematerialize lightweight object | http://identifiers.emc.com/linkrel/dematerialize |
DELETE | |
| Materialize lightweight object | http://identifiers.emc.com/linkrel/materialize |
PUT | object |
Transition: Dematerialize lightweight object
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/dematerialize of state materialization.
Transition: Materialize lightweight object
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/materialize of state materialization.
- Response:
-
- Result States:
- Media Types:
State: comments
Properties
See comments.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find comment | edit on entry |
GET | comment |
| Create comment | http://identifiers.emc.com/linkrel/comments |
POST | comment |
Transition: Find comment
By performing HTTP method GET on link relation edit on entry of state comments.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Create comment
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/comments of state comments.
- Request:
-
- Input: comment
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: comment-replies
Properties
See comment-replies.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find comment | edit on entry |
GET | comment |
| Create comment | http://identifiers.emc.com/linkrel/comments |
POST | comment |
Transition: Find comment
By performing HTTP method GET on link relation edit on entry of state comment-replies.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Create comment
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/comments of state comment-replies.
- Request:
-
- Input: comment
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: comment
Properties
See comment.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Get parent comment | parent |
GET | comment |
| Get replies | http://identifiers.emc.com/linkrel/replies |
GET | comment-replies |
| Create reply | http://identifiers.emc.com/linkrel/replies |
POST | comment |
| Remove comment | http://identifiers.emc.com/linkrel/delete |
DELETE |
Transition: Get parent comment
By performing HTTP method GET on link relation parent of state comment.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get replies
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/replies of state comment.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Create reply
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/replies of state comment.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Remove comment
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state comment.
- Request:
-
State: lifecycle
Properties
See lifecycle.
State: lifecycles
Properties
See lifecycles.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find lifecycle | edit on entry |
GET | lifecycle |
Transition: Find lifecycle
By performing HTTP method GET on link relation edit on entry of state lifecycles.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
State: object-lifecycle
Transitions
Transition: Get lifecycle
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/lifecycle of state object-lifecycle.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Attach lifecycle
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state object-lifecycle.
- Request:
-
- Input: acl
- Media Types:
- Response:
-
- Result States:
- Media Types:
Transition: Detach lifecycle
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/object-lifecycle of state object-lifecycle.
State: object-lifecycle-promotion
Properties
See object-lifecycle.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Promote lifecycle | http://identifiers.emc.com/linkrel/promotion |
PUT | object-lifecycle |
| Cancel lifecycle promotion | http://identifiers.emc.com/linkrel/cancel-promotion |
DELETE |
Transition: Promote lifecycle
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/promotion of state object-lifecycle-promotion.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Cancel lifecycle promotion
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/cancel-promotion of state object-lifecycle-promotion.
- Request:
-
- URI Parameters:
State: object-lifecycle-demotion
Properties
See object-lifecycle.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Demote lifecycle | http://identifiers.emc.com/linkrel/demotion |
PUT | object-lifecycle |
| Cancel lifecycle demotion | http://identifiers.emc.com/linkrel/cancel-demotion |
DELETE |
Transition: Demote lifecycle
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/demotion of state object-lifecycle-demotion.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Cancel lifecycle demotion
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/cancel-demotion of state object-lifecycle-demotion.
- Request:
-
- URI Parameters:
State: object-lifecycle-resumption
Properties
See object-lifecycle.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Resume lifecycle | http://identifiers.emc.com/linkrel/resumption |
PUT | object-lifecycle |
| Cancel lifecycle resumption | http://identifiers.emc.com/linkrel/cancel-resumption |
DELETE |
Transition: Resume lifecycle
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/resumption of state object-lifecycle-resumption.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Cancel lifecycle resumption
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/cancel-resumption of state object-lifecycle-resumption.
- Request:
-
- URI Parameters:
State: object-lifecycle-suspension
Properties
See object-lifecycle.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Suspend lifecycle | http://identifiers.emc.com/linkrel/suspension |
PUT | object-lifecycle |
| Cancel lifecycle suspension | http://identifiers.emc.com/linkrel/cancel-suspension |
DELETE |
Transition: Suspend lifecycle
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/suspension of state object-lifecycle-suspension.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: Cancel lifecycle suspension
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/cancel-suspension of state object-lifecycle-suspension.
- Request:
-
- URI Parameters:
State: snapshots
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find snapshot | edit on entry |
GET | snapshot |
| Create snapshot | http://identifiers.emc.com/linkrel/snapshots |
POST | snapshot |
Transition: Find snapshot
By performing HTTP method GET on link relation edit on entry of state snapshots.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Create snapshot
By performing HTTP method POST on link relation http://identifiers.emc.com/linkrel/snapshots of state snapshots.
- Request:
-
- Input: snapshot
- Media Types:
- Response:
-
- Result States:
- Media Types:
State: snapshot
Properties
See snapshot.
Transitions
Transition: Remove snapshot
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state snapshot.
Transition: Freeze snapshot
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/freeze of state snapshot.
- Response:
-
- Result States:
- Media Types:
Transition: UnFreeze snapshot
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/unfreeze of state snapshot.
Transition: Get snapshot nodes
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/snapshot-nodes of state snapshot.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get snapshot associated virtual document
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/virtual-document of state snapshot.
- Request:
- Response:
-
- Result States:
- Media Types:
State: snapshot-frozen
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Get canonical snapshot | canonical |
GET | snapshot |
| Get snapshot associated virtual document | http://identifiers.emc.com/linkrel/virtual-document |
GET | object |
| UnFreeze snapshot | http://identifiers.emc.com/linkrel/unfreeze |
DELETE |
Transition: Get canonical snapshot
By performing HTTP method GET on link relation canonical of state snapshot-frozen.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Transition: Get snapshot associated virtual document
By performing HTTP method GET on link relation http://identifiers.emc.com/linkrel/virtual-document of state snapshot-frozen.
- Request:
- Response:
-
- Result States:
- Media Types:
Transition: UnFreeze snapshot
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/unfreeze of state snapshot-frozen.
State: snapshot-nodes
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find virtual document node | edit on entry |
GET | virtual-document-relation |
Transition: Find virtual document node
By performing HTTP method GET on link relation edit on entry of state snapshot-nodes.
- Request:
-
- URI Parameters:
- Response:
State: archived-contents
Properties
See archived-contents.
State: audit-trail
Properties
See audit-trail.
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Remove audit trail | http://identifiers.emc.com/linkrel/delete |
DELETE |
Transition: Remove audit trail
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state audit-trail.
State: audit-trails
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find audit trail | edit on entry |
GET | audit-trail |
Transition: Find audit trail
By performing HTTP method GET on link relation edit on entry of state audit-trails.
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
State: subscription
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Subscribe an object | http://identifiers.emc.com/linkrel/subscribe |
PUT | object |
| Unsubscribe an object | http://identifiers.emc.com/linkrel/delete |
DELETE |
Transition: Subscribe an object
By performing HTTP method PUT on link relation http://identifiers.emc.com/linkrel/subscribe of state subscription.
- Response:
-
- Result States:
- Media Types:
Transition: Unsubscribe an object
By performing HTTP method DELETE on link relation http://identifiers.emc.com/linkrel/delete of state subscription.
State: subscriptions
Transitions
| Transition | Link Relation | Method | Result State |
|---|---|---|---|
| Find subscribed object | edit on entry |
GET | object |
Transition: Find subscribed object
By performing HTTP method GET on link relation edit on entry of state subscriptions.
- Request:
- Response:
-
- Result States:
- Media Types:
Link Relations
| Link relation | Transitions | Description |
|---|---|---|
about |
Specification: http://tools.ietf.org/html/rfc6903. |
|
canonical |
|
Specification: http://tools.ietf.org/html/rfc6596. |
child |
Specification: http://www.w3.org/MarkUp/draft-ietf-html-relrev-00.txt. |
|
edit |
|
Specification: http://tools.ietf.org/html/rfc5023. |
edit on entry |
|
The real link relation name for this is |
http://idendifiers.emc.com/linkrel/associations |
SysObjects associated with a given ACL |
|
http://identifiers.emc.com/linkrel/acls |
|
ACLs |
http://identifiers.emc.com/linkrel/archived-contents |
Get multiple objects contents in ZIP file format |
|
http://identifiers.emc.com/linkrel/as-search-template |
Create search template from a given saved search |
|
http://identifiers.emc.com/linkrel/aspect-type |
Aspect type |
|
http://identifiers.emc.com/linkrel/aspect-types |
Aspect type collection |
|
http://identifiers.emc.com/linkrel/assist-values |
Assist values of a given type or an given object |
|
http://identifiers.emc.com/linkrel/attachable-lifecycles |
The attachable lifecycles collection |
|
http://identifiers.emc.com/linkrel/audit-trails |
Retrieves audit trails in the given repository |
|
http://identifiers.emc.com/linkrel/batch-capabilities |
Batch capabilities |
|
http://identifiers.emc.com/linkrel/batches |
Batches |
|
http://identifiers.emc.com/linkrel/cabinet |
|
Cabinet |
http://identifiers.emc.com/linkrel/cabinets |
Cabinet collection |
|
http://identifiers.emc.com/linkrel/cancel-checkout |
Cancel checkout the SysObject |
|
http://identifiers.emc.com/linkrel/cancel-demotion |
Cancel the scheduled lifecycle demotion |
|
http://identifiers.emc.com/linkrel/cancel-promotion |
Cancel the scheduled lifecycle promotion |
|
http://identifiers.emc.com/linkrel/cancel-resumption |
Cancel the scheduled lifecycle resumption |
|
http://identifiers.emc.com/linkrel/cancel-suspension |
Cancel the scheduled lifecycle suspension |
|
http://identifiers.emc.com/linkrel/checked-out-objects |
Checked out objects collection |
|
http://identifiers.emc.com/linkrel/checkin-branch |
Check in the SysObject as branch |
|
http://identifiers.emc.com/linkrel/checkin-next-major |
Check in the SysObject as next major |
|
http://identifiers.emc.com/linkrel/checkin-next-minor |
Check in the SysObject as next minor |
|
http://identifiers.emc.com/linkrel/checkout |
Checkout the SysObject |
|
http://identifiers.emc.com/linkrel/child-links |
Child folder links for a parent folder |
|
http://identifiers.emc.com/linkrel/comments |
Comments of a given SysObject |
|
http://identifiers.emc.com/linkrel/content-media |
Contents of a SysObject |
|
http://identifiers.emc.com/linkrel/contents |
|
Contents of a SysObject |
http://identifiers.emc.com/linkrel/current-user |
Current user |
|
http://identifiers.emc.com/linkrel/current-user-preferences |
Current user preferences |
|
http://identifiers.emc.com/linkrel/current-version |
Current version of a SysObject |
|
http://identifiers.emc.com/linkrel/default-folder |
User default folder |
|
http://identifiers.emc.com/linkrel/delete |
|
Delete the resource |
http://identifiers.emc.com/linkrel/dematerialize |
Dematerialize a lightweight SysObject |
|
http://identifiers.emc.com/linkrel/demotion |
The lifecycle demotion |
|
http://identifiers.emc.com/linkrel/documents |
Folder child documents |
|
http://identifiers.emc.com/linkrel/dql |
Execute a DQL query |
|
http://identifiers.emc.com/linkrel/folders |
Folder child folders |
|
http://identifiers.emc.com/linkrel/formats |
Format collection |
|
http://identifiers.emc.com/linkrel/freeze |
Freeze an unfrozen snapshot |
|
http://identifiers.emc.com/linkrel/groups |
Group collection |
|
http://identifiers.emc.com/linkrel/lifecycle |
The single lifecycle |
|
http://identifiers.emc.com/linkrel/lifecycles |
The lifecycles collection |
|
http://identifiers.emc.com/linkrel/lightweight-objects |
|
The lightweight SysObjects of a shared object |
http://identifiers.emc.com/linkrel/lightweight-types |
Lightweight types for a parent sharable type |
|
http://identifiers.emc.com/linkrel/logoff |
Log off from a repository for a logged in user |
|
http://identifiers.emc.com/linkrel/materialize |
Materialize a lightweight SysObject |
|
http://identifiers.emc.com/linkrel/network-locations |
Network location collection |
|
http://identifiers.emc.com/linkrel/object-aspects |
Object aspect types collection |
|
http://identifiers.emc.com/linkrel/object-lifecycle |
|
The current object lifecycle status |
http://identifiers.emc.com/linkrel/objects |
|
Folder child objects |
http://identifiers.emc.com/linkrel/parent-links |
Parent folder links for a SysObject |
|
http://identifiers.emc.com/linkrel/parent-sharable-type |
Parent sharable type for a lightweight type |
|
http://identifiers.emc.com/linkrel/permission-set |
SysObject's or user's permission set |
|
http://identifiers.emc.com/linkrel/permissions |
Permissions on a given SysObject for a specified user or group |
|
http://identifiers.emc.com/linkrel/primary-content |
The primary content of a SysObject |
|
http://identifiers.emc.com/linkrel/promotion |
The lifecycle promotion |
|
http://identifiers.emc.com/linkrel/relation-type |
Relation type |
|
http://identifiers.emc.com/linkrel/relation-types |
Relation type collection |
|
http://identifiers.emc.com/linkrel/relations |
Relation collection |
|
http://identifiers.emc.com/linkrel/replies |
Replies of a comment |
|
http://identifiers.emc.com/linkrel/repositories |
Repository collection |
|
http://identifiers.emc.com/linkrel/resumption |
The lifecycle resumption |
|
http://identifiers.emc.com/linkrel/saved-search-results |
Saved search results |
|
http://identifiers.emc.com/linkrel/saved-searches |
Saved search collection |
|
http://identifiers.emc.com/linkrel/search |
Execute a full-text search |
|
http://identifiers.emc.com/linkrel/search-execution |
Execute a saved search or search template |
|
http://identifiers.emc.com/linkrel/search-templates |
Search templates collection |
|
http://identifiers.emc.com/linkrel/shared-parent |
The shared parent of a lightweight SysObject |
|
http://identifiers.emc.com/linkrel/snapshot-nodes |
Get the components of a snapshot hierarchy |
|
http://identifiers.emc.com/linkrel/snapshots |
Get snapshots in the repository |
|
http://identifiers.emc.com/linkrel/subscribe |
Subscribe the object for the current user or for other user(s) as well |
|
http://identifiers.emc.com/linkrel/subscriptions |
Retrieves all subscribed objects of the current user in the given repository |
|
http://identifiers.emc.com/linkrel/suspension |
The lifecycle suspension |
|
http://identifiers.emc.com/linkrel/type |
|
Type |
http://identifiers.emc.com/linkrel/types |
|
Type collection |
http://identifiers.emc.com/linkrel/unfreeze |
Unfreeze a frozen snapshot |
|
http://identifiers.emc.com/linkrel/users |
User collection |
|
http://identifiers.emc.com/linkrel/virtual-document |
Get the snapshot associated virtual document |
|
http://identifiers.emc.com/linkrel/virtual-document-component |
Get the virtual document node component object |
|
http://identifiers.emc.com/linkrel/virtual-document-conversion |
Convert a simple document to childless virtual document |
|
http://identifiers.emc.com/linkrel/virtual-document-nodes |
Virtual document nodes of a given virtual document root |
|
parent |
|
Specification: http://www.w3.org/MarkUp/draft-ietf-html-relrev-00.txt. |
predecessor-version |
Specification: http://tools.ietf.org/html/rfc5829. |
|
self |
(Transitions are not listed for the |
Specification: http://tools.ietf.org/html/rfc5988. |
version-history |
Specification: http://tools.ietf.org/html/rfc5829. |
Property Groups
acl
all-versions
-
URI of resource all-versions
-
All Versions
-
Server's current time
-
Each entry represents a specific version of the version tree
-
URI of the specific version
-
object_name for the specific version
-
r_modify_date for the specific version
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
archived-contents
-
Defines the object id of the object whose contents the client wants to get.
-
When the object is a virtual document this parameter determines whether or not to get the content from its children.
-
Determines whether or not to include nodes with broken bindings for a virtual document.
-
Determines the version label that is used to resolve late bound nodes for a virtual document.
-
Defines to what depth level in the virtual document hierarchy will be returned. A value of -1 is used to return the whole virtual document tree.
-
Specifies the file format of the contents that is to be retrieved.
-
Determines whether to retrieve all of the contents, or only retrieve the first page contents.
object-id - string
include-children - boolean
include-broken - boolean
binding-label - string
depth - integer
format - string
all-contents - boolean
aspect-type
aspects
aspects* - string
assist-values
batch-capabilities
transactions - string
sequence - string
on-error - string
batchable-resource* - string
non-batchable-resource* - string
batch-request
In this release, batch requests are executed in synchronous mode. The response is not returned until the REST server completes the request. The response of a batch request includes:
-
Batch properties. In addition to those described in Batch Request Properties, the
response also
includes:
- state, which indicates the state of the batch operation. In synchronous mode, the value of this property is always Finished.
-
substate, which indicates the substate of a finished batch operation. Valid values
are:
- failed: The REST server completes the batch operation. However, all the operations are failed. Generally, this value is returned for transactional batch requests.
- finished_with_error: The REST server completes the batch operation, while the operation is partially failed. Generally, this value is returned for non-transactional batch requests.
- owner, which indicates the user submitting the batch request.
- submitted, which indicates the time point when the batch request is submitted.
- started, which indicates the time point when the server starts processing the batch request.
- finished, which indicates the time point when the batch operation completes.
- Each embedded request if return-request is true.
- The response of each embedded operation.
-
Description of the batch request.
-
Determines whether to process the batch request as a transaction. true: All embedded operations are treated as one atomic unit, meaning that either all operations within a transaction are performed, or none of the operations are performed. A transactional batch request ensures that operations made by one process are not interrupted by another. false: Embedded operations are not treated as one atomic unit. The batch operation may continue or terminate, depending on the on-error setting (if sequential is set to true), when one or more operations within the batch fail. Default value: true
-
Determines whether to process the batch request sequentially for non-transactional batch requests. true: Operations in a batch are executed in the submission order. false: The REST server determines whether to execute the operations in sequence or in parallel. Default value: true
-
Determines whether to continue or terminate a batch operation when one or more of the embedded operations fail. This property works when transactional is set to false and sequential is set to true. Valid values are:
- continue: The REST server continues processing the batch operation when one or more of the embedded operations fail.
- fail: The REST server terminates the batch operation when one or more of the embedded operations fail.
-
Determines whether to return the request of each operation in the response. Default value: false
description - string
transactional - boolean
sequential - boolean
on-error - string
return-request - boolean
operations* (see operation-properties)
batch-result
cabinet
-
object_name is required for the new cabinet creation
propertiesobject_name - string
cabinets
The body contains a list of cabinets (or subtypes of dm_cabinet).
- Each object may contain all properties of the cabinet, depending on the setting of the query parameter view.
- The returned child objects collection only contains those that you have access to.
- Pagination is supported.
- By default, the results are listed in alphabetical order. The returned cabinets can be ordered by any non-repeating property.
- The total count is returned only when you explicitly set the include-total parameter to true in the request. In this case, the link for last page is returned.
- Each cabinet object must contain links a specific to dm_cabinet type. See Link Relation, page 247 in SysObject resource to view the links that are available to the dm_cabinet object type.
-
URI of resource cabinets
-
Cabinets
-
Server's current time
-
Each entry represents a cabinet
-
URI of the specific cabinet
-
object_name for the specific cabinet
-
Cabinet description
-
r_modify_date for the specific cabinet
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
checked-out-objects
- Each object may contain all or a set of properties of the objects, depending on the setting of the query parameter view.
- The returned child objects collection only contains those that you have access to.
- Pagination is supported.
- By default, the results are listed in alphabetical order by object name.
-
URI of the checked out objects
-
Checked out objects
-
Server's current time
-
Each entry represents a checked out object
-
URI of the version
-
object_name for the object
-
r_modify_date for the object
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
child-folder-links
- The body contains a list of links between the given object and each of its parent folders.
- Each link contains the URI for the given folder and the URI for one of its child folders.
- Each entry contains the parent ID and the child ID.
- Each entry in the collection has a self link referring to the link resource.
- Pagination is supported.
-
URI of the feed
-
List of parent folders
-
r_modify_date of the object
-
URI of the folder link
-
Formatted string with both the child object ID and the parent object ID
-
r_modify_date for the child object
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
comment
-
Contains the HTML that is required for the new comment creation.
-
Title of the comment
content_value - string
title - string
comment-replies
The body contains a list of replies for the specified comment.
-
URI of resource comment replies
-
Comments on object r_object_id in reply to comment parent_id
-
Open Text Documentum
-
Server's current time
-
Each entry represents a comment
-
URI of the specific comment
-
title for the specific comment
-
Comment comment_id on object r_object_id in reply to comment parent_id
-
r_modify_date for the comment
-
r_creation_date for the comment
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
author (http://tools.ietf.org/html/rfc4287#section-4.2.1)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.1.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
published (http://tools.ietf.org/html/rfc4287#section-4.2.9)
- string
comments
The body contains a list of comments.
-
URI of resource comments
-
Comments on object r_object_id
-
Open Text Documentum
-
Server's current time
-
Each entry represents a comment
-
URI of the specific comment
-
title for the specific comment
-
Comment comment_id on object r_object_id
-
r_modify_date for the comment
-
r_creation_date for the comment
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
author (http://tools.ietf.org/html/rfc4287#section-4.2.1)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.1.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
published (http://tools.ietf.org/html/rfc4287#section-4.2.9)
- string
content
message represents the content metadata and a URL for content download.
contents
-
URI of the content without the file extension.
-
Object name.
-
Last updated time of the object.
-
Each entry represents a content
-
URI of the content
-
object_name for the content
-
Content description
-
r_modify_date of the content
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
document
-
Object type of the new document is specified in the r_object_type property of the request body. The r_object_type property is optional. If this property is not specified in a client request, it is set to dm_document by default.
r_object_type - string
dql-query
- The query result is included in the query-result element.
- If the client tries to perform a non-select query, the server returns an HTTP 400 Bad Request status.
- The returned query result set only contains the resources that you have access to.
- Pagination is supported.
-
Feed URI
-
DQL Query Results
-
Server's current time
-
Query result corresponding to one of the rows in the result set
-
Query resource URI with the item index in the current page
-
Value of the first property of the query result. For example, if you perform the DQL statement select r_object_id, object_name from dm_document, the value of r_object_id is used as the title.
-
Content description
-
r_modify_date of the query result if this property exists. Otherwise, an empty string.
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
dql-query-request
Query statement to perform in application/x-www-form-urlencoded. Alternatively, you can leave the request body blank and use the dql parameter to hold the query statement. Use the request body when the query statement is long. Note: An error may occur if you specify the same query statement in both the request body and the dql parameter.
-
dql query is to be executed
-
quantity of items would be shown in one page.
-
quantity of pages would be returned.
dql - string
items-per-page - string
page - string
folder
Note: The user name in the URL is encoded.
-
object_name is required for the new folder creation
-
Object type of the new document is specified in the r_object_type property of the request body. The r_object_type property is optional. If this property is not specified in a client request, it is set to dm_folder by default.
propertiesobject_name - string
r_obejct_type - string
folder-child-documents
- The body contains a list of document resources, each of which is filed under the specified folder.
- Each object may contain all properties of the object, depending on the setting of the query parameter view.
- Each object contains links specific to the type of the object. See Link Relation, in SysObject resource, which provides information on what links are available for a certain type of object.
- The returned child objects collection only contains those that you have access to.
-
URI of the documents without the file extension
-
List of folder child objects
-
Server's current time
-
URI of the document
-
Document name
-
Document description
-
r_modify_date of the document
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
folder-child-folders
- The body contains a list of child folder objects, each of which is filed under the specified folder.
- Each object may contain all properties of the folder ,depending on the setting of the query parameter view.
- Each object contains links specific to the folder object type. See in SysObject resource, which provides information on what kind of links are available for a certain type of object.
- The returned child objects collection only contains those that you have access to.
-
URI of the folders
-
List of folder child folders
-
Server's current time
-
URI of the folder
-
Folder name
-
Folder description
-
r_modify_date of the folder
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
folder-child-objects
- The body contains a list of SysObject resources, each of which is filed under the specified folder.
- Each object may contain all properties of the object, depending on the setting of the query parameter view.
- Each object contains links specific to the type of the object. See in SysObject resource, which provides information on what links are available for a certain type of object.
- The returned child objects collection only contains those that you have access to.
-
URI of the objects
-
List of folder child objects
-
Server's current time
-
URI of the object
-
Object name
-
Object description
-
r_modify_date of the object
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
folder-link
The body contains the URI for the parent object and the URI for the child object. The body also contains the parent ID and child ID.
format
Note: The format name in the URL is encoded.
formats
- The body contains a list of the dm_format instances(or subtypes of dm_format
- Each object may contain all or a set of properties of the format, depending on the setting of the query parameter view.
- The returned child objects collection only contains those that you have access to.
- Pagination is supported.
- By default, the results are listed in alphabetical order by format name.
- The format name in the URL is encoded.
-
Feed URI
-
List of formats
-
URI of the format
-
Format name
-
Format description
-
r_modify_date of the format
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
group
Note: The group name in the URL is encoded.
-
group_name is required for the new group creation
propertiesgroup_name - string
group-member-groups
- The body contains a list of the dm_group instances(or subtypes of dm_group.
- Each object may contain all or a set of properties of the group, depending on the setting of the query parameter view.
- The returned child objects collection only contains those that you have access to.
- Pagination is supported.
- By default, the results are listed in alphabetical order by group name.
-
Feed URI
-
List of groups
-
Server's current time
-
URI of the group
-
Group name
-
Group description
-
r_modify_date of the group
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
group-member-users
- The body contains a list of the dm_user instances(or subtypes of dm_user.
- Each object may contain all or a set of properties of the user, depending on the setting of the query parameter view.
- The returned child objects collection only contains those that you have access to.
- Pagination is supported.
- By default, the results are listed in alphabetical order by user name.
-
Feed URI
-
List of users
-
URI of the user
-
User name
-
User description
-
r_modify_date of the user
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
groups
- The body contains a list of the dm_group instances(or subtypes of dm_group.
- Each object may contain all or a set of properties of the group, depending on the setting of the query parameter view.
- The returned child objects collection only contains those that you have access to.
- Pagination is supported.
- By default, the results are listed in alphabetical order by group name.
- The group name in the URL is encoded.
-
Feed URI
-
List of groups
-
URI of the group
-
Group name
-
Group description
-
r_modify_date of the group
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
lifecycle
-
the r_object_id of the dm_policy
-
the object_name of the dm_policy
-
the title of the dm_policy
-
the subject of the dm_policy
-
the keywords of the dm_policy
-
the java_methods of the dm_policy
-
the owner_name of the dm_policy
-
the r_creation_date of the dm_policy
-
the r_modify_date of the dm_policy
-
the r_version_label of the dm_policy
-
the alias_set_ids of the dm_policy
-
the included_type of the dm_policy
-
the include_subtypes of the dm_policy
-
the r_object_id of the dmc_module
-
the user_validation_service of the dm_policy
-
the primary_class of the dmc_module
-
the app_validation_id of the dm_policy
-
the object_name of the dm_procedure
-
the app_validation_ver of the dm_policy
-
the state_name of the dm_policy
-
the state_type of the dm_policy
-
the state_description of the dm_policy
-
the state_class of the dm_policy
-
the exception_state of the dm_policy
-
the allow_attach of the dm_policy
-
the allow_schedule of the dm_policy
-
the allow_demote of the dm_policy
-
the return_to_base of the dm_policy
-
the index of the state in the states
-
the i_state_no of the dm_policy
-
the return_condition of the dm_policy
-
the type_override_id of the dm_policy
-
the entry_criteria_id of the dm_policy
-
the expression_text of the dm_func_expr
-
the action_object_id of the dm_policy
-
the object_name of the dm_procedure
-
the user_criteria_id of the dm_policy
-
the object_name of the dm_procedure
-
the user_criteria_ver of the dm_policy
-
the user_action_id of the dm_policy
-
the object_name of the dm_procedure
-
the user_action_ver of the dm_policy
-
the user_postproc_id of the dm_policy
-
the object_name of the dm_procedure
-
the user_postproc_ver of the dm_policy
-
the r_object_id of the dmc_module
-
the user_criteria_service of the dm_policy
-
the primary_class of the dmc_module
-
the r_object_id of the dmc_module
-
the user_action_service of the dm_policy
-
the primary_class of the dmc_module
-
the r_object_id of the dmc_module
-
the user_postprocessing_service of the dm_policy
-
the primary_class of the dmc_module
-
the r_object_id of the dmc_module
-
the system_actions of the dm_policy
-
the primary_class of the dmc_module
-
the r_definition_state of the dm_policy
id - string
name - string
title - string
subject - string
keywordskeyword* - string
implementation-type - string
owner - string
created - string
modifed - string
version-labelsversion-label* - string
alias-setsalias-set* - string
type-inclusionstype-inclusion*
type - string
include-subtype - boolean
user-validation-serviceid - string
name - string
primary-class - string
app-validationid - string
name - string
version - string
statesstate*
name - string
type - string
description - string
exceptional - boolean
exception-state - string
allow-attach - boolean
allow-schedule - boolean
allow-demote - boolean
allow-return-to-base - boolean
index - integer
no - integer
return-conditionsreturn-condition* - string
type-override-id - string
entry-criteriaid - string
expression - string
actionid - string
name - string
user-criteriaid - string
name - string
version - string
user-actionid - string
name - string
version - string
user-post-actionid - string
name - string
version - string
user-criteria-serviceid - string
name - string
primary-class - string
user-action-serviceid - string
name - string
primary-class - string
user-post-serviceid - string
name - string
primary-class - string
system-actionid - string
name - string
primary-class - string
status - string
lifecycles
- The body contains a list of the dm_policy instances
- The returned child objects collection only contains those that you have access to.
- Pagination is supported.
- By default, the results are listed in alphabetical order by lifecycle name.
-
Feed URI
-
List of lifecycles
-
URI of the lifecycle
-
Lifecycle name
-
Lifecycle description
-
r_modify_date of the lifecycle
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
lightweight-object-reparent
href - string
multipart-batch-request
Operations embedded in a batch request may have binary contents attached, such as content creation, and content checkin. Documentum REST Services leverages the XML-binary Optimized Packaging (XPO) protocol to support multipart operations in batches. As defined in XPO, a multipart batch request must have the Multipart/Related Content-type header. Typically, a multipart batch request contains several portions as shown in the following pattern:
-- boundary
Content-Type: ...
Content-ID: ...
Content-disposition: ...
<batch>
<operations>
<operation id="id-1">
<request>
...
<entity>
...
</entity>
<attachment>
<xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include'
href='cid:id-1-content'/>
</attachment>
</request>
</operation>
<operation id="id-2">
<request>
...
<entity>
...
</entity>
<attachment>
<xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include'
href='cid:id-2-content'/>
</attachment>
</request>
</operation>
...
</operations>
</batch>
-- boundary
Content-Type: ...
Content-ID: id-1-content
Content-disposition: ...
Attachment 1
-- boundary
Content-Type: ...
Content-ID: id-2-content
Content-disposition: ...
Attachment 2
-- boundary
...
-- boundary --
The first portion batch is identical to its counterpart in standard batch requests with the only
addition of an extra attachment element in the request block of each embedded operation. The
attachment element contains a content ID (cid) specifying the binary content to be attached which
is defined in the subsequent portions of the batch request. The sequence of the portions
holding
binary contents must be identical to the sequence they are referenced in the batch portion.
-
Determines whether to process the batch request as a transaction. true: All embedded operations are treated as one atomic unit, meaning that either all operations within a transaction are performed, or none of the operations are performed. A transactional batch request ensures that operations made by one process are not interrupted by another. false: Embedded operations are not treated as one atomic unit. The batch operation may continue or terminate, depending on the on-error setting (if sequential is set to true), when one or more operations within the batch fail. Default value: true
-
Determines whether to process the batch request sequentially for non-transactional batch requests. true: Operations in a batch are executed in the submission order. false: The REST server determines whether to execute the operations in sequence or in parallel. Default value: true
transactional - boolean
sequential - boolean
operations* (see multipart-operation-properties)
multipart-operation-properties
Each batch request must have one operation at least. The maximum number of operations allowed to be embedded in one request is limited by the rest.batch.operations.max.count parameter.
-
Operation identifier. Each embedded operation must have its unique identifier in one batch request. REST services does not have constraints on how this value is produced. For example, you can use ordering numbers, UUIDs, or even random numbers.
-
Description of the operation.
id - string
description - string
request* (see multipart-operation-request)
multipart-operation-request
HTTP method and target URI of the operation.
-
HTTP method. Example: POST, GET, etc.
-
The URI can be either an absolute URI you get from a certain response or a relative URI, which starts with a slash (/).
-
Absolute URI:
uri="http://localhost:8080/repositories/REPO/folders/0c00208080000107/objects"
-
Relative URI:
uri="/repositories/REPO/folders/0c00208080000107/objects"
-
Absolute URI:
-
The entity of operation request.
method - string
uri - string
header* (see multipart-request-header)
entity - string
multipart-request-header
-
Specifies the Content ID of the portion.
-
This parameter must be set with the following pattern:
Content-disposition: form-data; name=Content IDExample:Content-disposition: form-data; name=id-01-content
content-type (see multipart-request-header-content-type)
content-id - string
content-disposition - string
multipart-request-header-content-type
For the start portion batch, this parameter specifies the media type of the batch request together with the media type of the start portion in the type property, for example:
Content-Type: application/xop+xml; type="application/vnd.emc.documentum+xml"
For portions holding binary contents, this parameter
specifies the media type, for example:
Content-Type: text/plain
-
Specifies the boundary used to separate each portion
-
Specifies the media type of the batch request. Valid values are:
- application/xop+xml (for XML)
- application/jop+json (for JSON)
-
Specified the portion to be processed first by Content ID. If not specified, the first portion is processed first. In a multipart batch request, the start portion must be a batch block.
-
The media type of the start portion. Valid values are:
- application/vnd.emc.documentum+xml (for XML)
- application/vnd.emc.documentum+json (for JSON)
boundary - string
type - string
start - string
start-info - string
network-location
The response contains properties of a network location, depending on the setting of the view query parameter. By default, all properties are returned. Note: The network location in the URL is encoded.
network-locations
- The body contains a list of network locations.
- Each object may contain all properties of the network location, depending on the setting of the query parameter view.
- The returned network locations collection only contains those that you have access to.
- Pagination is supported.
- By default, the results are listed in alphabetical order by netloc_ident.
- The network location in the URL is encoded.
-
Feed URI
-
List of network locations
-
Server's current time
-
Network location URI
-
Display name of the network location
-
r_modify_date of the network location(the dm_network_location_map instance).
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
object
-
The object type is specified in the r_object_type property of the request body. The r_object_type property is optional. If this property is not specified in a client request, it is set to dm_folder by default.
-
Content Server validates the object_name property in the request. This property is mandatory for some types, for example, dm_folder.
r_object_type - string
object_name - string
object-copy-ref
href - string
object-lifecycle
- The body contains the lifecycle id, the current state and the alias set name.
- All the parameters are optional.
lifecycle-id - string
current-state - string
aliasset-name - string
object-lightweight-objects
- The body contains a list of (Lightweight) SysObject resources, each of which is the child of the shared parent object.
- Each object may contain all properties of the object, depending on the setting of the query parameter view.
- Each object contains links specific to the type of the object. See in SysObject resource, which provides information on what links are available for a certain type of object.
- The returned child objects collection only contains those that you have access to.
-
URI of the objects
-
Objects
-
Server's current time
-
URI of the object
-
Object name
-
Object description
-
r_modify_date of the object
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
object-ref
The body contains the reference to the child object.
-
{"href":"http://localhost:8080/dctm-rest/repositories/myrepo/objects/0900000c80000cc4"}
href - string
operation-properties
Each batch request must have one operation at least. The maximum number of operations allowed to be embedded in one request is limited by the rest.batch.operations.max.count parameter.
-
Operation identifier. Each embedded operation must have its unique identifier in one batch request. REST services does not have constraints on how this value is produced. For example, you can use ordering numbers, UUIDs, or even random numbers.
-
Description of the operation.
id - string
description - string
request* (see operation-request)
operation-request
HTTP method and target URI of the operation.
-
HTTP method. Example: POST, GET, etc.
-
The URI can be either an absolute URI you get from a certain response or a relative URI, which starts with a slash (/).
-
Absolute URI:
uri="http://localhost:8080/repositories/REPO/folders/0c00208080000107/objects"
-
Relative URI:
uri="/repositories/REPO/folders/0c00208080000107/objects"
-
Absolute URI:
-
The entity of operation request.
method - string
uri - string
header* (see request-header)
entity - string
parent-folder-links
- The body contains a list of links between the given object and each of its parent folders.
- Each link contains the URI for the given folder and the URI for one of its parent folders.
- Each entry contains the parent ID and the child ID.
- Each entry in the collection has a self link referring to the link resource.
- Pagination is supported.
-
URI of the feed
-
Parent links
-
r_modify_date of the object
-
URI of the folder link
-
Formatted string with both the child object ID and the parent object ID
-
r_modify_date for the child object
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
permission-set
permissions
preference
preferences
relation
relation-type
Note: The relation type name in the URL is encoded.
relation-types
Note: The type name in the URL is encoded.
-
URI of the relation types
-
Relation Types
-
Server's current time
-
URI of the relation type
-
Relation type name
-
Relation type description
-
r_modify_date of the relation type
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
relations
- The body contains a list of dm_relation instances(or subtypes of dm_relation)
- Each object may contain all properties of the relation, depending on the setting of the query parameter view.
- Pagination is supported.
- By default, the results are listed in alphabetical order by relation name.
-
Feed URI
-
List of relations
-
URI of the relation
-
Relation name
-
Relation description
-
r_modify_date of the relation
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
repositories
-
URI of the repositories without the file extension
-
List of repositories
-
Server's current time
-
URI of the repository without the file extension
-
Repositor name
-
Repository description
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
repository
request-header
-
The header attribute name.
-
The header attribute value.
name - string
value - string
search-result
- The body must contain a list of SysObjects(or subtypes of dm_sysobject), each of which may contain all attributes of a SysObject, depending on the setting of query parameter view.
- The returned SysObjects collection only contains objects the user is entitled to.
- Pagination is supported.
- Default sort order is the ranking returned by the search engine and it can be overridden with any SysObject attribute.
- Total count can be returned only when it is explicityly specified in the request parameter, along with it the link for last page can be returned.
- Each SysObject must contain links specific to the object type. See Link Relation in SysObject resource, which provides information on what kind of links are avaliable to SysObjects type.
- Please refer to EDAA JSON and Atom Syndication Format For more details about collection media type.
-
URI of the feed
-
Search
-
Current time
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (see object)
snapshot
The snapshot is a SysObject whose r_assembled_from_id is not null.
type
Note: The type name in the URL is encoded.
types
Note: The type name in the URL is encoded.
-
Feed URI
-
Types collection
-
Server's current time
-
Type URI
-
Display name of the type
-
r_modify_date of the object
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
user
Note: The user name in the URL is encoded.
-
user_name is required for the new user creation
propertiesuser_name - string
user-permission-set
users
Note: The type name in the URL is encoded.
-
Feed URI
-
List of users
-
Server's current time
-
URI of the user
-
User name
-
User description
-
r_modify_date of the user
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
entry* (http://tools.ietf.org/html/rfc4287#section-4.2.2)
id (http://tools.ietf.org/html/rfc4287#section-4.2.6)
- string
title (http://tools.ietf.org/html/rfc4287#section-4.2.14)
- string
summary (http://tools.ietf.org/html/rfc4287#section-4.2.13)
- string
updated (http://tools.ietf.org/html/rfc4287#section-4.2.15)
- string
virtual-document-nodes
virtual-document-relation
- The body contains attributes including parent-id, chronicle-id, relationship-id, binding, copy-behavior, follow-assembly, order-number, override-late-binding
-
Object ID of the object that directly contains the component
-
the r_object_id of the original version of the node component object
-
the object id of this virtual document relation, namely the r_object_id of the dmr_containment
-
version label for the node component, namely the version_label of dmr_containment
-
defines client behavior when the document containing the component is copied, namely the copy_child of dmr_containment
-
defines whether the system to resolve a component using the component assembly, namely the follow_assembly of the dmr_containment
-
number representing the component position within the components of the virtual document identified by parent_id, namely the order_no of dmr_containment
-
defines whether to use the early-bound symbolic label to resolve late-bound descendants of the component during assembly, namely the use_node_ver _label of dmr_containment
parent-id - string
chronicle-id - string
relation-id - string
binding - string
copy-behavior - integer
follow-assembly - boolean
order-number - integer
override-late-binding - boolean
URI Parameters
all-primary
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
true |
Specifies whether to import all contents using the same type as the primary content for different pages (page 0, 1, 2...), or one primary content, and others as renditions for the first page. |
binding-label
| Datatype | Documentation |
|---|---|
string |
The symbolic version label to use when resolving late binding nodes. |
checked-out-by
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
string |
current-user,any,specific-user |
current-user |
Ensure whether to overwrite existing content with the same content attributes (aka, page, format and modifier).
|
collections
| Datatype | Documentation |
|---|---|
string |
The parameter specifies a list of collections separated by comma (,). to which the query is scoped. The collections must exist in xPlore. |
comment
| Datatype | Documentation |
|---|---|
string |
Comments for check in. |
content-charset
| Datatype | Documentation |
|---|---|
string |
The charset of the content. If the content format is required for the sanitization, this is used to parse the input content. This is optional. If not provided, the server will try to get the charset from the content. If failed, the default charset will be used. |
content-count
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
integer |
>=0 |
0 |
Specifies how many pieces of content are submitted. The metadata part is excluded from the count. |
content-length
| Datatype | Documentation |
|---|---|
string |
The content length in bytes of the content to be uploaded. Optional for the most of storages, and required for the Centera storage. If provided, it must be an accurate value. Otherwise, there will be an exception. |
del-all-links
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Ensures whether multi-linked child is deleted or unlinked from this specified cabinet.
|
del-non-empty
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Ensure whether allowing to delete non-empty cabinet.
|
del-vd-all
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true,false |
false |
Delete options for virtual document object.
|
del-version
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
string |
selected, unused, all |
all |
Delete options for multi-version document object.
|
depth
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
integer |
-1 or >= 0 |
1 |
Determines the level of depth that the virtual document hierarchy will be returned. Setting a value of -1 will return the whole virtual directory tree. |
dml-view
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
string |
basic, all, none |
basic |
Specifies the elements to return.
|
dql
| Datatype | Documentation |
|---|---|
string |
The mandatory query parameter contains the DQL statement to be executed in the repository. |
facet
| Datatype | Documentation |
|---|---|
string |
The parameter specifies the property to be used as facet. |
facet-value-constraints
| Datatype | Documentation |
|---|---|
string |
The parameter specifies a property constraint expression. For example, when facet is set to r_object_type and facet-value -constraints is set to dm_object, only dm_object instances are returned. You can use boolean operators + for AND and | for OR in a property constraint expression to define more complex constrains. For example, the expression dm_object|dm _folder returns both dm_object and dm_folder instances. |
filter
| Datatype | Documentation |
|---|---|
string |
A filter expression in a subset of XPath. |
follow-assembly
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Determines whether the server selects a component descendants using the containment objects or a snapshot associated with the component. The server selects components from the snapshot when the follow-assembly property is set to true and a snapshot is available. |
force
| Datatype | Values | Documentation |
|---|---|---|
boolean |
true, false |
Indicates whether to destroy the ACL object even if it is referenced by other objects in the repository.
|
format
| Datatype | Documentation |
|---|---|
string |
Specify the dm_format name for the content during document creation and content management. If this parameter is not specified, server will try to detect and determine the format according to the Content-Type provided for the primary content part in the multipart request and assign a format for the primary content. However, this is not guaranteed to be accurate. |
group-name
| Datatype | Default Value | Documentation |
|---|---|---|
string |
null |
Only groups that contain a sub group (a dm_group instance) whose group_name property equals to the specified string are returned in the result. The group-name is optional. |
hide-shared-parent
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Specifies whether to show the shared parent object of the lightweight object. Note: Enabling hide-shared-parent may decrease the performance. |
include-all-versions
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Specify whether listing all versions of the child objects belong to the folder.
|
include-broken
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Specifies whether to display nodes with broken bindings using the CURRENT label. |
include-total
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
[true, false] |
false |
Indicate to calculate the total count of the feed items as though not returning them all in one page. When the result feed is paged, the attribute include-total will be displayed in the feed.
|
include-value-assist
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Specifies whether the type response includes the definition information of value assist for the type properties. |
inherited
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
true |
Specifies whether or not to include inherited properties from parent type.
|
inline
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Ensures whether to show content (the object instance) in the atom entry for a collection.
|
items-per-page
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
integer |
no less than 1 |
100 |
The number of entries per page. When the result feed is paged, the attribute items-per-page will be displayed in the feed. |
latest-versions-only
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Indicate whether show the latest versions only.
|
links
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
true |
Ensures whether link relations to be returned for this object representation.
|
locale
| Datatype | Default Value | Documentation |
|---|---|---|
string |
null |
Specifies the locale of the request. The locale is optional. |
locations
| Datatype | Documentation |
|---|---|
string |
The parameter specifies a list of folder paths separated by comma (,) to which the query is scoped. |
make-current
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Indicate whether make current check in as current version. If set this to false, a specified version-label is required.
|
media-url-policy
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
string |
dc-pref, dc-only, local, all |
dc-pref |
Specify the content media URL return policy.
|
modifier
| Datatype | Documentation |
|---|---|
string |
Specify the page modifier for the rendition. |
network-location
| Datatype | Documentation |
|---|---|
string |
Specify the network location identifier for BOCS content download, this is used only when content-return-policy=DC-PREF or DC-ONLY. |
object-id
| Datatype | Documentation |
|---|---|
string |
The object id on which the object will be checked in. This parameter is mandatory. |
object-type
| Datatype | Documentation |
|---|---|
string |
The parameter specifies an object type. Only instances of the specified type or its sub types are returned in the search result. |
overwrite
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Ensure whether to overwrite existing content with the same content attributes (aka, page, format and modifier).
|
page
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
integer |
no less than 1 |
1 |
The number of the page to be served. When the result feed is paged, the attribute page will be displayed in the feed. |
parent-type
| Datatype | Default Value | Documentation |
|---|---|---|
string |
null |
Gets direct sub types or all sub types of the specified type. You can combine this variable with recursive to indicate whether or not to return all sub types or just the direct sub types of the specified type. The parent-type is optional. |
primary
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
true |
Ensure whether the importing content is primary or rendition.
|
q
| Datatype | Documentation |
|---|---|
string |
The parameter specifies the search criterion with a full-text expression in simple search language. |
raw
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Indicates whether to return the DQL results as raw property bags or with links generated. When this parameter is set to false, the REST server generates link relations and/or including thumbnail links if possible. |
recursive
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Determines whether or not to return all indirect children recursively when a request tries to get the children of an object.
|
related-object-id
| Datatype | Default Value | Documentation |
|---|---|---|
string |
null |
Only relations that contain an object whose object ID equals to the specified string are returned in the result. |
related-object-role
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
string |
child, parent, any |
any |
Indicates the role of the object specified by the object ID. (Only works when the related-object-id parameter is specified.) |
relation-name
| Datatype | Default Value | Documentation |
|---|---|---|
string |
null |
Only relations whose name equals to the specified string are returned in the result. Relation names are case sensitive. |
retain-lock
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
boolean |
true, false |
false |
Specifies whether the object is to remain checked out and locked by the user after the new version is saved.
|
schedule
| Datatype | Documentation |
|---|---|
string |
The schedule time when the operation will be done. The value should follow ISO 8601 format. |
sort
| Datatype | Documentation |
|---|---|
string |
Sorting for entries in collection result.
A sort consists of multiple sort specifications, separated by comma (',').
Each sort specification consists of an attribute to be sorted and its sort order,
separated by the
spacpe (' ').
Sort order can be either
DESC
orASC, case insensitive.
Sort order is optional, if not specified, the default sort order isASC.
Optionally it can be specified with non-repeating attributes.
|
thumbnail
| Datatype | Values | Documentation |
|---|---|---|
string |
true, false |
The parameter specifies whether this operation returns thumbnail link for each entry or not.
|
timezone
| Datatype | Documentation |
|---|---|
string |
The parameter indicates the time zone used to compute date facets. Valid time zones include (case-insensitive):
|
to-base
| Datatype | Values | Documentation |
|---|---|---|
boolean |
true, false |
Indicates whether to demote or resume the lifecycle to the base state.
|
trial
| Datatype | Values | Documentation |
|---|---|---|
boolean |
true, false |
Indicates whether to doing lifecycle operations with test. Means only verify whether the operation can be done without really doing the operation.
|
user-name
| Datatype | Documentation |
|---|---|
string |
Specify the specific lock owner of checked out objects, it MUST only appear when checked-out-by parameter is of value "specific-user". |
vdm-number
| Datatype | Documentation |
|---|---|
string |
The node's number in the virtual document tree. For example 1.2.3 |
version-label
| Datatype | Documentation |
|---|---|
string |
The version label desired to be matched, only the versions with matched version label MUST be returned. This query parameter MAY be specified multiple times in the request, which indicates an object containing any version-label specified is qualified and MUST be returned by server in the resulting collection. |
version-policy
| Datatype | Values | Default Value | Documentation |
|---|---|---|---|
string |
true, false |
false |
The policy to control checked in object's version.
|
view
| Datatype | Default Value | Documentation |
|---|---|---|
string |
:default |
Properties to return. The pattern is like:
|
Headers
Accept (request)
Acceptable media types for the response
Authorization (request)
The authorization header for authentication
Content-Length (entity)
The length of the request or response body in octets (8-bit bytes)
Content-Type (entity)
The media type of the request or response body
Cookie (request)
The HTTP cookie on behalf of the user authentication token
DOCUMENTUM-CSRF-HEADER-NAME (response)
Header name to send CSRF token with
DOCUMENTUM-CSRF-QUERY-NAME (response)
QUery parameter name to send CSRF token with
DOCUMENTUM-CSRF-TOKEN (response)
CSRF token
DOCUMENTUM-NO-CAS-REDIRECT (request)
Disabling initial HTTP redirect for CAS SSO
DOCUMENTUM-NO-SAML2-REDIRECT (request)
Disabling initial HTTP redirect for SAML 2.0 Web SSO
ETag (response)
ETag value generated by the server
If-Modified-Since (request)
Last modified date time for the conditional web cache
If-None-Match (request)
ETag token for the conditional web cache
Last-Modified (response)
Last modified time of the resource
Location (response)
URI of the newly created resource
Set-Cookie (response)
Setting back the HTTP cookie for the authenticated user
WWW-Authenticate (response)
Indicates the authentication scheme that should be used to access the requested entity
Status Codes
200
The request has succeeded. The information returned with the response is dependent on the method used in the request, for example: GET an entity corresponding to the requested resource is sent in the response; POST or PUT an entity describing or containing the modified resource.
201
The request has been fulfilled and resulted in a new resource being created. The newly created resource can be referenced by the URI(s) returned in the entity of the response, with the most specific URI for the resource given by a Location header field. The entity format is specified by the media type given in the Content-Type header field.
204
The server fulfilled the request, but does not need to return a response message body.
304
The request want do get the resource, but it is not modified since last get.
400
The request could not be understood by the server due to malformed syntax, missing or invalid information (such as validation error on an input field, a missing required value, and so on). The client SHOULD NOT repeat the request without modifications.
401
The authentication credentials included with this request are missing or invalid. The response MUST include a WWW-Authenticate header field containing a challenge applicable to the requested resource.
403
The server recognized your credentials, but you do not possess authorization to perform this request, and the request SHOULD NOT be repeated.
404
The request specified a URI of a resource that does not exist.
405
The HTTP verb specified in the request (DELETE, GET, HEAD, POST, PUT) is not supported for this request URI.
406
The resource identified by this request is not capable of generating a representation corresponding to one of the media types in the Accept header of the request.
409
A creation or update request could not be completed, because it would cause a conflict in the current state of the resources supported by the server (for example, an attempt to create a new resource with a unique identifier already assigned to some existing resource).
415
The server is refusing to service the request because the entity of the request is in a format not supported by the requested resource for the requested method.
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
Media Types
| Media Type | Documentation |
|---|---|
*/* |
Any media type. This represents the arbitrary media type for the content media. |
application/atom+xml |
XML ATOM feed representation for collection based resources Specification |
application/home+json |
JSON home document |
application/home+xml |
XML home document |
application/json |
Compatible JSON read-only media type Specification |
application/vnd.emc.documentum+json |
JSON representation for both collection based and non-collection based resources |
application/vnd.emc.documentum+xml |
XML representation for non-collection based resources |
application/www-form-urlencoded |
Form url encoded media type Specification |
application/xml |
Compatible XML read-only media type Specification |
application/zip |
This represents the body is a ZIP archived file. |
multipart/form-data |
Multipart media type Specification |
multipart/related |
Multipart media type Specification |
Media Type: application/atom+xml
Representation: repositories
Example:
<feed
xmlns:dm="http://identifiers.emc.com/vocab/documentum"
xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories</id>
<title>Repositories</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-02-04T05:54:11.646+00:00</updated>
<dm:page>1</dm:page>
<dm:items-per-page>1000</dm:items-per-page>
<dm:total>1</dm:total>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO</id>
<title>REPO</title>
<summary/>
<updated>2015-02-04T05:54:11.646+00:00</updated>
<published>2015-02-04T05:54:11.646+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO"/>
<content type="application/vnd.emc.documentum+xml" src="http://localhost:8080/dctm-rest/repositories/REPO"/>
</entry>
</feed>
Representation: cabinets
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/cabinets</id>
<title>Cabinets</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-02-11T08:05:57.560+00:00</updated>
<dm:page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">1
</dm:page>
<dm:items-per-page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">100
</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets"/>
<link rel="next" href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets?items-per-page=100&page=2"/>
<link rel="first" href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets?items-per-page=100&page=1"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105</id>
<title>Administrator</title>
<author>
<name>REPO</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/REPO</uri>
</author>
<summary>dm_cabinet 0c00000180000105</summary>
<updated>2014-12-04T18:15:35.000+00:00</updated>
<published>2014-12-04T18:15:35.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105"/>
<content type="application/xml" src="http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105"/>
</entry>
</feed>
Representation: folder-child-folders
Example:
<feed
xmlns="http://www.w3.org/2005/Atom"
>
<id>http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/folders</id>
<title>Folders under folder 0c00000180000107</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-19T05:42:05.906+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/folders"/>
<link rel="next"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/folders?items-per-page=100&page=2"/>
<link rel="first"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/folders?items-per-page=100&page=1"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a</id>
<title>restFolder-28ed6374-1e72-433b-894b-4cd700cd24b3</title>
<author>
<name>dave</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/dave</uri>
</author>
<summary>dm_folder 0b00000180011a3a</summary>
<updated>2015-03-19T01:31:53.000+00:00</updated>
<published>2015-03-19T01:31:53.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a"/>
</entry>
</feed>
Representation: folder-child-documents
Example:
<feed
xmlns="http://www.w3.org/2005/Atom"
>
<id>http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/documents</id>
<title>Documents under folder 0c00000180000107</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-19T06:23:38.734+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/documents"/>
<link rel="next"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/documents?items-per-page=100&page=2"/>
<link rel="first"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/documents?items-per-page=100&page=1"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000180011a70</id>
<title>obj_with_content</title>
<author>
<name>dmadmin</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin</uri>
</author>
<summary>dm_document 0900000180011a70</summary>
<updated>2015-03-19T02:25:23.000+00:00</updated>
<published>2015-03-19T02:24:59.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000180011a70"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000180011a70"/>
</entry>
</feed>
Representation: folder-child-objects
Example:
<feed
xmlns="http://www.w3.org/2005/Atom"
>
<id>http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/objects</id>
<title>Objects under folder 0c00000180000107</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-19T06:27:37.937+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/objects"/>
<link rel="next"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/objects?items-per-page=100&page=2"/>
<link rel="first"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/objects?items-per-page=100&page=1"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70</id>
<title>obj_with_content</title>
<author>
<name>dmadmin</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin</uri>
</author>
<summary>dm_document 0900000180011a70</summary>
<updated>2015-03-19T02:25:23.000+00:00</updated>
<published>2015-03-19T02:24:59.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70"/>
</entry>
</feed>
Representation: child-folder-links
Example:
<feed
xmlns="http://www.w3.org/2005/Atom"
>
<id>http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links</id>
<title>Child folder links of folder 0c00000180000107</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-19T07:31:29.343+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<dm:total xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:total>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links"/>
<link rel="next"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links?items-per-page=100&page=2"/>
<link rel="first"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links?items-per-page=100&page=1"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links/0900000180011a70</id>
<title>Folder link between child 0900000180011a70 and parent 0c00000180000107</title>
<summary>0900000180011a70</summary>
<updated>2015-03-19T07:31:29.343+00:00</updated>
<published>2015-03-19T07:31:29.343+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links/0900000180011a70"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links/0900000180011a70"/>
</entry>
</feed>
Representation: parent-folder-links
Example:
<feed
xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links</id>
<title>Parent folder links of object 0900000180011a70</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-19T07:35:58.406+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<dm:total xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:total>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links/0c0000018000010</id>
<title>Folder link between child 0900000180011a70 and parent 0c00000180000107</title>
<summary>0c00000180000107</summary>
<updated>2015-03-19T07:35:58.406+00:00</updated>
<published>2015-03-19T07:35:58.406+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links/0c00000180000107"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links/0c00000180000107"/>
</entry>
</feed>
Representation: contents
Example:
<feed
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents</id>
<title>Contents of object Blank PowerPoint Pre-3.0 Presentation</title>
<author>
<name>Administrator</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator</uri>
</author>
<updated>2014-12-04T10:18:20.000+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents/0600000180000114</id>
<title>Content [page: 0, format: powerpoint, modifier: ]</title>
<summary>0600000180000114</summary>
<updated>2014-12-04T10:18:20.000+00:00</updated>
<published>2014-12-04T10:18:20.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents/content?format=powerpoint&modifier=&page=0"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents/content?format=powerpoint&modifier=&page=0"/>
</entry>
</feed>
Representation: all-versions
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions</id>
<title>All versions of chronicle object 0900000180001904</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-19T09:20:31.578+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904</id>
<title>REST-API-TEST-DOC-TO-CHECK-OUT</title>
<author>
<name>dave</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/dave</uri>
</author>
<summary>dm_document 0900000180001904</summary>
<updated>2014-12-10T03:41:31.000+00:00</updated>
<published>2014-12-10T03:41:31.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904"/>
</entry>
</feed>
Representation: checked-out-objects
Example:
<feed
xmlns="http://www.w3.org/2005/Atom"
>
<id>http://localhost:8080/dctm-rest/repositories/REPO/checked-out-objects</id>
<title>Checked-out objects</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-19T09:19:17.562+00:00</updated>
<dm:page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">1
</dm:page>
<dm:items-per-page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">100
</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/checked-out-objects"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904</id>
<title>REST-API-TEST-DOC-TO-CHECK-OUT</title>
<author>
<name>dave</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/dave</uri>
</author>
<summary>dm_document 0900000180001904</summary>
<updated>2014-12-10T03:41:31.000+00:00</updated>
<published>2014-12-10T03:41:31.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904"/>
</entry>
</feed>
Representation: formats
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/formats</id>
<title>Formats</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-23T03:26:17.064+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/formats" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/formats?items-per-page=100&page=2" rel="next"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/formats?items-per-page=100&page=1" rel="first"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/formats/123w</id>
<title>123w</title>
<summary>Lotus 1-2-3 r5</summary>
<updated>2015-03-23T03:26:17.064+00:00</updated>
<published>2015-03-23T03:26:17.064+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/formats/123w" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/formats/123w" type="application/xml"/>
</entry>
</feed>
Representation: relations
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/relations</id>
<title>Relations</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-23T03:44:54.122+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relations" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relations?items-per-page=100&page=2" rel="next"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relations?items-per-page=100&page=1" rel="first"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/relations/3700000580000100</id>
<title>dm_bof_dependencies</title>
<summary/>
<updated>2015-03-23T03:44:54.132+00:00</updated>
<published>2015-03-23T03:44:54.132+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relations/3700000580000100" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/relations/3700000580000100" type="application/xml"/>
</entry>
</feed>
Representation: relation-types
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/relation-types</id>
<title>Relation types</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-23T03:51:15.386+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relation-types" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relation-types?items-per-page=100&page=2"
rel="next"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relation-types?items-per-page=100&page=1"
rel="first"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/relation-types/ACL%2BREPLICATION</id>
<title>ACL REPLICATION</title>
<summary>Relation Type for ACL Replication</summary>
<updated>2015-03-23T03:51:15.386+00:00</updated>
<published>2015-03-23T03:51:15.386+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relation-types/ACL%2BREPLICATION" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/relation-types/ACL%2BREPLICATION"
type="application/xml"/>
</entry>
</feed>
Representation: types
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/types</id>
<title>Types</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-23T05:38:12.638+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types?items-per-page=100&page=2" rel="next"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types?items-per-page=100&page=1" rel="first"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl</id>
<title>dm_acl</title>
<author>
<name>REPO_ADMIN</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/REPO_ADMIN</uri>
</author>
<summary>0300000580000101</summary>
<updated>2015-03-23T05:38:12.638+00:00</updated>
<published>2015-03-23T05:38:12.638+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl" type="application/xml"/>
</entry>
</feed>
Representation: network-locations
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/network-locations</id>
<title>Network locations</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-23T05:39:00.278+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:items-per-page>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/network-locations" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/network-locations?items-per-page=100&page=2"
rel="next"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/network-locations?items-per-page=100&page=1"
rel="first"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/network-locations/flaming_moutain</id>
<title>flaming_moutain</title>
<summary>The Flaming Mountain</summary>
<updated>2015-03-03T09:09:52.000+00:00</updated>
<published>2015-03-23T05:39:00.278+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/network-locations/flaming_moutain" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/network-locations/flaming_moutain"
type="application/xml"/>
</entry>
</feed>
Representation: users
Example:
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/users</id>
<title>Users</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-23T05:44:52.129+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/users" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/users?items-per-page=100&page=2" rel="next"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/users?items-per-page=100&page=1" rel="first"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator</id>
<title>Administrator</title>
<summary/>
<updated>2015-03-05T07:55:35.000+00:00</updated>
<published>2015-03-05T07:55:35.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator" type="application/xml"/>
</entry>
</feed>
Representation: groups
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/groups</id>
<title>Groups</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-23T05:45:49.182+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups?items-per-page=100&page=2" rel="next"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups?items-per-page=100&page=1" rel="first"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup</id>
<title>admingroup</title>
<summary/>
<updated>2015-03-03T02:20:31.000+00:00</updated>
<published>2015-03-03T02:20:31.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup" type="application/xml"/>
</entry>
</feed>
Representation: group-member-groups
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/groups</id>
<title>Member groups of group admingroup</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-23T05:49:05.266+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/groups" rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/groups/subgroup</id>
<title>subgroup</title>
<summary/>
<updated>2015-03-03T02:20:31.000+00:00</updated>
<published>2015-03-03T02:20:31.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups/subgroup" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/groups/subgroup" type="application/xml"/>
</entry>
</feed>
Representation: group-member-users
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/users</id>
<title>Member users of group admingroup</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-23T05:49:56.696+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/users" rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator</id>
<title>Administrator</title>
<summary/>
<updated>2015-03-05T07:55:35.000+00:00</updated>
<published>2015-03-05T07:55:35.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator" type="application/xml"/>
</entry>
</feed>
Representation: dql-query
Example:
<feed xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO</id>
<title>DQL query results</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-23T06:11:58.408+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO?dql=select+*+from+dm_user+where+user_name='dmadmin'"
rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO?dql=select+*+from+dm_user+where+user_name='dmadmin'&index=0</id>
<title>1100000580000502</title>
<updated>2015-03-23T06:11:58.408+00:00</updated>
<published>2015-03-23T06:11:58.408+00:00</published>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin" rel="edit"/>
<content>
<dm:query-result
xmlns:dm="http://identifiers.emc.com/vocab/documentum"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_user">
<dm:properties>
<dm:r_object_id>1100000580000502</dm:r_object_id>
<dm:user_name>dmadmin</dm:user_name>
<dm:user_os_name/>
<dm:user_address>dmadmin@opentext.com</dm:user_address>
<dm:user_group_name>docu</dm:user_group_name>
<dm:user_privileges>16</dm:user_privileges>
<dm:owner_def_permit>7</dm:owner_def_permit>
<dm:world_def_permit>3</dm:world_def_permit>
<dm:group_def_permit>1</dm:group_def_permit>
<dm:default_folder>/dmadmin</dm:default_folder>
<dm:user_db_name/>
<dm:description/>
<dm:acl_domain>dmadmin</dm:acl_domain>
<dm:acl_name>dm_4500000580000d08</dm:acl_name>
<dm:user_os_domain/>
<dm:home_docbase>REPO</dm:home_docbase>
<dm:user_state>0</dm:user_state>
<dm:client_capability>8</dm:client_capability>
<dm:globally_managed>0</dm:globally_managed>
<dm:user_delegation/>
<dm:workflow_disabled>0</dm:workflow_disabled>
<dm:alias_set_id>0000000000000000</dm:alias_set_id>
<dm:user_source>inline password</dm:user_source>
<dm:user_ldap_dn/>
<dm:user_xprivileges>0</dm:user_xprivileges>
<dm:failed_auth_attempt>-1</dm:failed_auth_attempt>
<dm:user_admin/>
<dm:user_global_unique_id>REPO:dmadmin</dm:user_global_unique_id>
<dm:user_login_name>dmadmin</dm:user_login_name>
<dm:user_login_domain/>
<dm:user_initials/>
<dm:user_password>****************</dm:user_password>
<dm:user_web_page/>
<dm:first_failed_auth_utc_time xsi:nil="true"/>
<dm:last_login_utc_time>2015-03-23T06:05:52.000+00:00</dm:last_login_utc_time>
<dm:deactivated_utc_time xsi:nil="true"/>
<dm:deactivated_ip_addr/>
<dm:root_log_dir/>
</dm:properties>
<dm:links>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin" rel="self"/>
</dm:links>
</dm:query-result>
</content>
</entry>
</feed>
Representation: search
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/search</id>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-03-27T06:37:04.920+00:00</updated>
<dm:page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">1
</dm:page>
<dm:items-per-page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">100
</dm:items-per-page>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/search.xml?q=rest&facet=r_object_type"/>
<link rel="search"
hreftemplate="http://localhost:8080/dctm-rest/repositories/REPO/search.xml{?collections,facet,include-total,inline,items-per-page,locations,object-type,page,q,sort,timezone,view}"/>
<entry>
<id>0900000580003f01</id>
<title>ObjectWithAspect</title>
<author>
<name>dmadmin</name>
</author>
<updated>2015-03-27T06:19:45.000+00:00</updated>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003f01.xml"/>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003f01.xml"/>
<relevance:score
xmlns:relevance="http://a9.com/-/opensearch/extensions/relevance/1.0/">1.0
</relevance:score>
<dm:terms
xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:term>rest</dm:term>
</dm:terms>
</entry>
<entry>
<id>0900000580003b4b</id>
<title>ObjectWithAspect</title>
<author>
<name>dmadmin</name>
</author>
<updated>2015-03-27T06:08:41.000+00:00</updated>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003b4b.xml"/>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003b4b.xml"/>
<relevance:score
xmlns:relevance="http://a9.com/-/opensearch/extensions/relevance/1.0/">0.9999719262123108
</relevance:score>
<dm:terms
xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:term>rest</dm:term>
</dm:terms>
</entry>
<entry>
<id>09000005800037d2</id>
<title>ObjectWithAspect</title>
<author>
<name>dmadmin</name>
</author>
<updated>2015-03-27T06:01:05.000+00:00</updated>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800037d2.xml"/>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800037d2.xml"/>
<relevance:score
xmlns:relevance="http://a9.com/-/opensearch/extensions/relevance/1.0/">0.9999542236328125
</relevance:score>
<dm:terms
xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:term>rest</dm:term>
</dm:terms>
</entry>
<dm:facet
xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:facet-id>facet_r_object_type</dm:facet-id>
<dm:facet-label>Type</dm:facet-label>
<dm:facet-value>
<dm:facet-value-id>dm_document</dm:facet-value-id>
<dm:facet-value-count>1</dm:facet-value-count>
<dm:facet-id>facet_r_object_type</dm:facet-id>
<dm:facet-value-constraint>dm_document</dm:facet-value-constraint>
<link rel="search"
href="http://localhost:8080/dctm-rest/repositories/REPO/search.xml?q=rest&facet=r_object_type&facet-value-constraints=dm_document"/>
</dm:facet-value>
<dm:facet-value>
<dm:facet-value-id>dm_folder</dm:facet-value-id>
<dm:facet-value-count>1</dm:facet-value-count>
<dm:facet-id>facet_r_object_type</dm:facet-id>
<dm:facet-value-constraint>dm_folder</dm:facet-value-constraint>
<link rel="search"
href="http://localhost:8080/dctm-rest/repositories/REPO/search.xml?q=rest&facet=r_object_type&facet-value-constraints=dm_folder"/>
</dm:facet-value>
<dm:facet-value>
<dm:facet-value-id>rest_core</dm:facet-value-id>
<dm:facet-value-count>1</dm:facet-value-count>
<dm:facet-id>facet_r_object_type</dm:facet-id>
<dm:facet-value-constraint>rest_core</dm:facet-value-constraint>
<link rel="search"
href="http://localhost:8080/dctm-rest/repositories/REPO/search.xml?q=rest&facet=r_object_type&facet-value-constraints=rest_core"/>
</dm:facet-value>
</dm:facet>
</feed>
Representation: saved-searches
Example:
<feed
xmlns="http://www.w3.org/2005/Atom"
>
<id>http://localhost:8080/dctm-rest/repositories/REPO/saved-searches</id>
<title>Saved Searches</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-09-30T03:39:50.265+00:00</updated>
<dm:page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">1
</dm:page>
<dm:items-per-page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">1
</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches.xml?items-per-page=1"/>
<link rel="next"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches.xml?items-per-page=1&page=2"/>
<link rel="first"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches.xml?items-per-page=1&page=1"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562</id>
<title>search iig</title>
<author>
<name>dmadmin</name>
</author>
<summary>this is saved search</summary>
<updated>2015-09-30T01:50:20.000+00:00</updated>
<published>2015-09-30T01:50:20.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562.xml"/>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562.xml"/>
</entry>
</feed>
Representation: saved-search-execution
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/execution",
"title": "Search results",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-09-30T04:16:17.622+00:00",
"page": 1,
"items-per-page": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/execution?items-per-page=1"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/execution?items-per-page=1&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/execution?items-per-page=1&page=1"
}
],
"entries": [
{
"id": "090000058000251c",
"title": "iig86_Wed_Gal905_1430_Mapfre.pdf",
"author": [
{
"name": "dmadmin"
}
],
"summary": ". Evolution of ECM in MAPFRE i. Business Benefits ii. Why Open Text ECD iii....",
"updated": "2015-03-06T02:10:44.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000251c"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000251c"
},
"score": "1.0",
"terms": [
"IIG",
"iig"
]
}
]
}
Representation: saved-search-results
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/results",
"title": "Search results",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-09-30T04:01:15.000+00:00",
"page": 1,
"items-per-page": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/results?items-per-page=1"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/results?items-per-page=1&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/results?items-per-page=1&page=1"
}
],
"entries": [
{
"id": "090000058000251c",
"title": "iig86_Wed_Gal905_1430_Mapfre.pdf",
"author": [
null
],
"summary": ". Evolution of ECM in MAPFRE i. Business Benefits ii. Why Open Text ECD iii.... ",
"updated": "2015-09-30T04:19:50.541+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000251c"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000251c"
},
"score": "1.0",
"terms": [
"IIG",
"iig"
]
}
]
}
Representation: aspect-types
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/aspect-types</id>
<title>Aspect types</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-06-01T07:51:51.525+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/aspect-types?items-per-page=1"/>
<link rel="first" href="http://localhost:8080/dctm-rest/repositories/REPO/aspect-types?items-per-page=1&page=1"/>
<link rel="next" href="http://localhost:8080/dctm-rest/repositories/REPO/aspect-types?items-per-page=1&page=2"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/CompleteTimerAspect</id>
<title>CompleteTimerAspect</title>
<author>
<name>Administrator</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator</uri>
</author>
<summary>null 0b0000058000032a</summary>
<updated>2015-03-03T02:20:00.000+00:00</updated>
<published>2015-03-03T02:20:00.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/CompleteTimerAspect"/>
<content type="application/xml" src="http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/CompleteTimerAspect"/>
</entry>
</feed>
Representation: acls
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/acls</id>
<title>ACLs</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-07-13T05:40:42.051+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">2</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/acls?items-per-page=2"/>
<link rel="next" href="http://localhost:8080/dctm-rest/repositories/REPO/acls?items-per-page=2&page=2"/>
<link rel="first" href="http://localhost:8080/dctm-rest/repositories/REPO/acls?items-per-page=2&page=1"/>
<entry>
<id>4500000580000100</id>
<title>dm_4500000580000100</title>
<updated>2015-07-13T05:40:42.059+00:00</updated>
<published>2015-07-13T05:40:42.059+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000100"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000100"/>
</entry>
<entry>
<id>4500000580000101</id>
<title>dm_4500000580000101</title>
<updated>2015-07-13T05:40:42.059+00:00</updated>
<published>2015-07-13T05:40:42.059+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000101"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000101"/>
</entry>
</feed>
Representation: acl-associations
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07/associations</id>
<title>Objects</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2015-07-13T05:37:44.389+00:00</updated>
<dm:page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">1
</dm:page>
<dm:items-per-page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">2
</dm:items-per-page>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07/associations?items-per-page=2"/>
<link rel="next"
href="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07/associations?items-per-page=2&page=2"/>
<link rel="first"
href="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07/associations?items-per-page=2&page=1"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002626</id>
<title></title>
<author>
<name>dave</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/dave</uri>
</author>
<summary>dm_sysobject 0800000580002626</summary>
<updated>2015-06-04T10:51:49.000+00:00</updated>
<published>2015-06-04T10:51:49.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002626"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002626"/>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002627</id>
<title></title>
<author>
<name>dave</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/dave</uri>
</author>
<summary>dm_sysobject 0800000580002627</summary>
<updated>2015-06-04T10:51:49.000+00:00</updated>
<published>2015-06-04T10:51:49.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002627"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002627"/>
</entry>
</feed>
Representation: lightweight-objects
Example:
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO4/objects/0800024a80001728/lw-objects</id>
<title>Objects</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2016-01-18T10:00:22.785+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO4/objects/0800024a80001728/lw-objects" rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO4/objects/0800024a80001746</id>
<title>new lightweight 29</title>
<author>
<name>dave_4</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO4/users/dave_4</uri>
</author>
<summary>my_lightweight_object 0800024a80001746</summary>
<updated>2016-01-18T09:54:56.000+00:00</updated>
<published>2016-01-18T09:54:56.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO4/objects/0800024a80001746" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO4/objects/0800024a80001746" type="application/xml"/>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO4/objects/0800024a80001745</id>
<title>new lightweight 28</title>
<author>
<name>dave_4</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO4/users/dave_4</uri>
</author>
<summary>my_lightweight_object 0800024a80001745</summary>
<updated>2016-01-18T09:54:56.000+00:00</updated>
<published>2016-01-18T09:54:56.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO4/objects/0800024a80001745" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO4/objects/0800024a80001745" type="application/xml"/>
</entry>
</feed>
Representation: comments
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments</id>
<title>Comments on object: 0900000180143717 under parent comment id: 0</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2016-02-01T21:50:18.768+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800d86ec/comments"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839</id>
<title></title>
<author>
<name>John Doe</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/John%2BDoe</uri>
</author>
<summary><font color= '#363636' ><font size= '2' ><font face= 'Arial' >The spec looks good. Just two comments<br></font></font></font><ol><li><font color= '#363636' ><font size= '2' ><font face= 'Arial' >Please add a diagram to show the flow.</font></font></font></li><li><font color= '#363636' ><font size= '2' ><font face= 'Arial' >Please clarify the filter criteria.<br></font></font></font></li></ol></summary>
<updated>2016-01-26T15:16:16.000+00:00</updated>
<published>2016-01-26T15:16:16.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839"/>
<content type="application/xml" src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839"/>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324841</id>
<title></title>
<author>
<name>Jane Doe</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/Jane%2BDoe</uri>
</author>
<summary><font face= 'Arial' ><font size= '2' ><font color= '#363636' >Should we also support paging?<br></font></font></font></summary>
<updated>2016-01-26T15:19:57.000+00:00</updated>
<published>2016-01-26T15:19:57.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324841"/>
<content type="application/xml" src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324841"/>
</entry>
</feed>
Representation: current-user-preferences
Example:
<?xml version='1.0' encoding='UTF-8' ?>
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences</id>
<title>Preferences</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2016-03-02T04:42:37.166+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-mobile</id>
<title>user preference for Documentum Mobile App</title>
<summary>user preference</summary>
<updated>2016-03-02T04:41:30.000+00:00</updated>
<published>2016-03-02T04:41:30.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-mobile"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-mobile"/>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app</id>
<title>user preference for Documentum HTML5 App</title>
<summary>user preference</summary>
<updated>2016-03-02T04:42:19.000+00:00</updated>
<published>2016-03-02T04:42:19.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app"/>
</entry>
</feed>
Representation: lifecycles
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/lifecycles</id>
<title>Lifecycles</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2017-05-04T01:38:08.043+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles" rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfb</id>
<title>a_docbasic_lifecycle</title>
<author>
<name>dmadmin</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin</uri>
</author>
<updated>2017-05-03T02:15:25.000+00:00</updated>
<published>2017-05-03T02:15:21.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfb" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfb" type="application/vnd.emc.documentum+xml"/>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfc</id>
<title>a_java_lifecycle</title>
<author>
<name>dmadmin</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin</uri>
</author>
<updated>2017-05-03T02:15:24.000+00:00</updated>
<published>2017-05-03T02:15:22.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfc" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfc" type="application/vnd.emc.documentum+xml"/>
</entry>
</feed>
Representation: virtual-document-nodes
Example:
<feed
xmlns="http://www.w3.org/2005/Atom"
>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/vd-nodes</id>
<title>Virtual Document Nodes</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2017-05-10T05:55:42.383+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/vd-nodes"/>
<entry>
<id>090000058000ac2d</id>
<title>REST-API-TEST-VIRTUAL-DOCUMENT-558234e0-a6d7-462e-bb92-af805886325f</title>
<updated>2017-05-10T02:50:50.000+00:00</updated>
<published>2017-05-10T02:50:41.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/_root_node_id_090000058000ac2d"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d"/>
<content type="application/vnd.emc.documentum+xml" src="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/_root_node_id_090000058000ac2d"/>
</entry>
<entry>
<id>090000058000ac2e</id>
<title>REST-API-TEST-VIRTUAL-DOCUMENT-40904d89-4061-4d57-a436-36daf0de1938</title>
<summary>1</summary>
<updated>2017-05-10T02:50:47.000+00:00</updated>
<published>2017-05-10T02:50:42.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2e"/>
<content type="application/vnd.emc.documentum+xml" src="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"/>
</entry>
<entry>
<id>090000058000ac31</id>
<title>REST-API-TEST-VIRTUAL-DOCUMENT-73ad5822-6044-4f50-a588-c9741fee0563</title>
<summary>2</summary>
<updated>2017-05-10T02:50:49.000+00:00</updated>
<published>2017-05-10T02:50:48.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002975"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac31"/>
<content type="application/vnd.emc.documentum+xml" src="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002975"/>
</entry>
</feed>
Representation: snapshots
Example:
<feed
xmlns="http://www.w3.org/2005/Atom"
>
<id>http://localhost:8080/dctm-rest/repositories/REPO/snapshots</id>
<title>Virtual Document Snapshots</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2017-06-07T07:47:45.102+00:00</updated>
<dm:page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">1
</dm:page>
<dm:items-per-page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">100
</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa</id>
<title>virtual doc ef716ecb-e1d2-4cd2-a312-c09baf05f5a1</title>
<summary>Snapshot 08000005800049fa for Virtual Document 0900000580004a02</summary>
<updated>2017-06-05T02:09:53.000+00:00</updated>
<published>2017-06-05T02:09:53.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa"/>
<content type="application/vnd.emc.documentum+xml" src="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa"/>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/snapshots/0800000580004a26</id>
<title>snapshot from scratch</title>
<summary>Snapshot 0800000580004a26 for Virtual Document 0900000580004a02</summary>
<updated>2017-06-05T02:42:19.000+00:00</updated>
<published>2017-06-05T02:42:18.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/0800000580004a26"/>
<content type="application/vnd.emc.documentum+xml" src="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/0800000580004a26"/>
</entry>
</feed>
Representation: snapshot-nodes
Example:
<feed
xmlns="http://www.w3.org/2005/Atom"
>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/vd-nodes</id>
<title>Virtual Document Nodes</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2017-05-10T05:55:42.383+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/vd-nodes"/>
<entry>
<id>090000058000ac2d</id>
<title>REST-API-TEST-VIRTUAL-DOCUMENT-558234e0-a6d7-462e-bb92-af805886325f</title>
<updated>2017-05-10T02:50:50.000+00:00</updated>
<published>2017-05-10T02:50:41.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/_root_node_id_090000058000ac2d"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d"/>
<content type="application/vnd.emc.documentum+xml" src="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/_root_node_id_090000058000ac2d"/>
</entry>
<entry>
<id>090000058000ac2e</id>
<title>REST-API-TEST-VIRTUAL-DOCUMENT-40904d89-4061-4d57-a436-36daf0de1938</title>
<summary>1</summary>
<updated>2017-05-10T02:50:47.000+00:00</updated>
<published>2017-05-10T02:50:42.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2e"/>
<content type="application/vnd.emc.documentum+xml" src="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"/>
</entry>
<entry>
<id>090000058000ac31</id>
<title>REST-API-TEST-VIRTUAL-DOCUMENT-73ad5822-6044-4f50-a588-c9741fee0563</title>
<summary>2</summary>
<updated>2017-05-10T02:50:49.000+00:00</updated>
<published>2017-05-10T02:50:48.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002975"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac31"/>
<content type="application/vnd.emc.documentum+xml" src="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002975"/>
</entry>
</feed>
Media Type: application/home+json
| Representations |
|---|
| home-doc |
Representation: home-doc
Example:
{
"resources": {
"http://identifiers.emc.com/linkrel/repositories": {
"href": "http://localhost:8080/dctm-rest/repositories",
"hints": {
"allow": [ "GET" ],
"representations": [
"application/xml",
"application/json",
"application/atom+xml",
"application/vnd.emc.documentum+json"
]
}
},
"about": {
"href": "http://localhost:8080/dctm-rest/product-info",
"hints": {
"allow": [ "GET" ],
"representations": [
"application/xml",
"application/json",
"application/vnd.emc.documentum+xml",
"application/vnd.emc.documentum+json"
]
}
}
}
}
Media Type: application/home+xml
| Representations |
|---|
| home-doc |
Representation: home-doc
Example:
<resources xmlns="http://identifiers.emc.com/vocab/documentum">
<resource rel="http://identifiers.emc.com/linkrel/repositories">
<link href="http://localhost:8080/dctm-rest/repositories"/>
<hints>
<allow>
<i>GET</i>
</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/atom+xml</i>
<i>application/vnd.emc.documentum+json</i>
</representations>
</hints>
</resource>
<resource rel="about">
<link href="http://localhost:8080/dctm-rest/product-info"/>
<hints>
<allow>
<i>GET</i>
</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.documentum+xml</i>
<i>application/vnd.emc.documentum+json</i>
</representations>
</hints>
</resource>
</resources>
Media Type: application/vnd.emc.documentum+json
Representation: product-info
Example:
{
"name": "documentum-rest-services-product-info",
"properties": {
"product": "Documentum REST Services",
"product_version": "7.2.xxx.yyy",
"major": "7.2",
"minor": "xxx",
"build_number": "yyy",
"revision_number": "zzz"
},
"links": [
{
"rel": "self",
"href": "http://core-rs-demo.lss.opentext.com:8080/dctm-rest/product-info.json"
}
]
}
Representation: repositories
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories",
"title": "Repositories",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-02-04T08:19:08.583+00:00",
"page": 1,
"items-per-page": 1000,
"total": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO",
"title": "REPO",
"summary": "",
"updated": "2015-02-04T08:19:08.583+00:00",
"published": "2015-02-04T08:19:08.583+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO"
}
],
"content": {
"type": "application/json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO"
}
}
]
}
Representation: repository
Example:
{
"id": 5,
"name": "REPO",
"description": "",
"servers": [
{
"name": "REPO",
"host": "RESTCS72GA",
"version": "7.2.0000.0155 Win64.SQLServer",
"docbroker": "RESTCS72GA"
}
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/"
},
{
"rel": "canonical",
"href": "http://localhost:8080/dctm-rest/repositories/REPO"
},
{
"rel": "http://identifiers.emc.com/linkrel/cabinets",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets"
},
{
"rel": "http://identifiers.emc.com/linkrel/checked-out-objects",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/checked-out-objects"
},
{
"rel": "http://identifiers.emc.com/linkrel/current-user",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser"
},
{
"rel": "http://identifiers.emc.com/linkrel/current-user-preferences",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences"
},
{
"rel": "http://identifiers.emc.com/linkrel/users",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users"
},
{
"rel": "http://identifiers.emc.com/linkrel/groups",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups"
},
{
"rel": "http://identifiers.emc.com/linkrel/formats",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/formats"
},
{
"rel": "http://identifiers.emc.com/linkrel/network-locations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/network-locations"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations"
},
{
"rel": "http://identifiers.emc.com/linkrel/relation-types",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relation-types"
},
{
"rel": "http://identifiers.emc.com/linkrel/types",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types"
},
{
"rel": "http://identifiers.emc.com/linkrel/aspect-types",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types"
},
{
"rel": "http://identifiers.emc.com/linkrel/dql",
"hreftemplate": "http://localhost:8080/dctm-rest/repositories/REPO{?dql}"
},
{
"rel": "http://identifiers.emc.com/linkrel/search",
"hreftemplate": "http://localhost:8080/dctm-rest/repositories/REPO/search{?collections,facet,include-total,inline,items-per-page,locations,object-type,page,q,sort,timezone,view}"
},
{
"rel": "http://identifiers.emc.com/linkrel/saved-searches",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches"
},
{
"rel": "http://identifiers.emc.com/linkrel/search-templates",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search-templates"
},
{
"rel": "http://identifiers.emc.com/linkrel/acls",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls"
},
{
"rel": "http://identifiers.emc.com/linkrel/batches",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/batches"
},
{
"rel": "http://identifiers.emc.com/linkrel/batch-capabilities",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/batch-capabilities"
},
{
"rel": "http://identifiers.emc.com/linkrel/lifecycles",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles"
},
{
"rel": "http://identifiers.emc.com/linkrel/snapshots",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots"
},
{
"rel": "http://identifiers.emc.com/linkrel/audit-policies",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/audit-policies"
}
]
}
Representation: cabinets
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets",
"title": "Cabinets",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-02-11T08:02:46.060+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105",
"title": "Administrator",
"author": [
{
"name": "REPO",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/REPO"
}
],
"summary": "dm_cabinet 0c00000180000105",
"updated": "2014-12-04T18:15:35.000+00:00",
"published": "2014-12-04T18:15:35.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105"
}
}
]
}
Representation: cabinet
Example:
{
"name": "cabinet",
"type": "dm_cabinet",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_cabinet",
"properties": {
"object_name": "Administrator",
"r_object_type": "dm_cabinet",
"title": "Super User Cabinet",
"subject": "",
"authors": null,
"keywords": null,
"a_application_type": "",
"a_status": "",
"r_creation_date": "2014-12-04T18:15:35.000+00:00",
"r_modify_date": "2014-12-04T18:15:35.000+00:00",
"r_modifier": "REPO",
"r_access_date": null,
"a_is_hidden": false,
"i_is_deleted": false,
"a_retention_date": null,
"a_archive": false,
"a_compound_architecture": "",
"a_link_resolved": false,
"i_reference_cnt": 1,
"i_has_folder": true,
"i_folder_id": null,
"r_composite_id": null,
"r_composite_label": null,
"r_component_label": null,
"r_order_no": null,
"r_link_cnt": 43,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0000000000000000",
"r_frzn_assembly_cnt": 0,
"r_has_frzn_assembly": false,
"resolution_label": "",
"r_is_virtual_doc": 0,
"i_contents_id": "0000000000000000",
"a_content_type": "",
"r_page_cnt": 0,
"r_content_size": 0,
"a_full_text": true,
"a_storage_type": "",
"i_cabinet_id": "0c00000180000105",
"owner_name": "REPO",
"owner_permit": 7,
"group_name": "docu",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "0c00000180000105",
"i_latest_flag": true,
"r_lock_owner": "",
"r_lock_date": null,
"r_lock_machine": "",
"log_entry": "",
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": false,
"r_frozen_flag": false,
"r_has_events": false,
"acl_domain": "REPO",
"acl_name": "dm_4500000180000100",
"a_special_app": "",
"i_is_reference": false,
"r_creator_name": "REPO",
"r_is_public": true,
"r_policy_id": "0000000000000000",
"r_resume_state": 0,
"r_current_state": 0,
"r_alias_set_id": "0000000000000000",
"a_effective_date": null,
"a_expiration_date": null,
"a_publish_formats": null,
"a_effective_label": null,
"a_effective_flag": null,
"a_category": "",
"language_code": "",
"a_is_template": false,
"a_controlling_app": "",
"r_full_content_size": 0,
"a_extended_properties": null,
"a_is_signed": false,
"a_last_review_date": null,
"i_retain_until": null,
"r_aspect_name": null,
"i_retainer_id": null,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 1,
"r_folder_path": [
"/Administrator"
],
"i_ancestor_id": [
"0c00000180000105"
],
"is_private": false,
"r_object_id": "0c00000180000105"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105"
},
{
"rel": "http://identifiers.emc.com/linkrel/folders",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000105/folders"
},
{
"rel": "http://identifiers.emc.com/linkrel/documents",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000105/documents"
},
{
"rel": "http://identifiers.emc.com/linkrel/objects",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000105/objects"
},
{
"rel": "http://identifiers.emc.com/linkrel/child-links",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000105/child-links"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=0c00000180000105&related-object-role=any"
}
]
}
Representation: folder-child-folders
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/folders",
"title": "Folders under folder 0c00000180000107",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-19T05:42:53.062+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/folders"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/folders?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/folders?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a",
"title": "restFolder-28ed6374-1e72-433b-894b-4cd700cd24b3",
"author": [
{
"name": "dave",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/dave"
}
],
"summary": "dm_folder 0b00000180011a3a",
"updated": "2015-03-19T01:31:53.000+00:00",
"published": "2015-03-19T01:31:53.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a"
}
}
]
}
Representation: folder
Example:
{
"name": "folder",
"type": "dm_folder",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_folder",
"properties": {
"object_name": "restFolder-28ed6374-1e72-433b-894b-4cd700cd24b3",
"r_object_type": "dm_folder",
"title": "",
"subject": "",
"authors": null,
"keywords": null,
"a_application_type": "",
"a_status": "",
"r_creation_date": "2015-03-19T01:31:53.000+00:00",
"r_modify_date": "2015-03-19T01:31:53.000+00:00",
"r_modifier": "dave",
"r_access_date": null,
"a_is_hidden": false,
"i_is_deleted": false,
"a_retention_date": null,
"a_archive": false,
"a_compound_architecture": "",
"a_link_resolved": false,
"i_reference_cnt": 1,
"i_has_folder": true,
"i_folder_id": [
"0c00000180000107"
],
"r_composite_id": null,
"r_composite_label": null,
"r_component_label": null,
"r_order_no": null,
"r_link_cnt": 0,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0000000000000000",
"r_frzn_assembly_cnt": 0,
"r_has_frzn_assembly": false,
"resolution_label": "",
"r_is_virtual_doc": 0,
"i_contents_id": "0000000000000000",
"a_content_type": "",
"r_page_cnt": 0,
"r_content_size": 0,
"a_full_text": true,
"a_storage_type": "",
"i_cabinet_id": "0c00000180000107",
"owner_name": "dave",
"owner_permit": 7,
"group_name": "",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "0b00000180011a3a",
"i_latest_flag": true,
"r_lock_owner": "",
"r_lock_date": null,
"r_lock_machine": "",
"log_entry": "",
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": false,
"r_frozen_flag": false,
"r_has_events": false,
"acl_domain": "dave",
"acl_name": "dm_4500000180000914",
"a_special_app": "",
"i_is_reference": false,
"r_creator_name": "dave",
"r_is_public": true,
"r_policy_id": "0000000000000000",
"r_resume_state": 0,
"r_current_state": 0,
"r_alias_set_id": "0000000000000000",
"a_effective_date": null,
"a_expiration_date": null,
"a_publish_formats": null,
"a_effective_label": null,
"a_effective_flag": null,
"a_category": "",
"language_code": "",
"a_is_template": false,
"a_controlling_app": "",
"r_full_content_size": 0,
"a_extended_properties": null,
"a_is_signed": false,
"a_last_review_date": null,
"i_retain_until": null,
"r_aspect_name": null,
"i_retainer_id": null,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 0,
"r_folder_path": [
"/Temp/restFolder-28ed6374-1e72-433b-894b-4cd700cd24b3"
],
"i_ancestor_id": [
"0b00000180011a3a",
"0c00000180000107"
],
"r_object_id": "0b00000180011a3a"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a"
},
{
"rel": "http://identifiers.emc.com/linkrel/parent-links",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0b00000180011a3a/parent-links"
},
{
"rel": "parent",
"title": "0c00000180000107",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107"
},
{
"rel": "http://identifiers.emc.com/linkrel/folders",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a/folders"
},
{
"rel": "http://identifiers.emc.com/linkrel/documents",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a/documents"
},
{
"rel": "http://identifiers.emc.com/linkrel/objects",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a/objects"
},
{
"rel": "http://identifiers.emc.com/linkrel/child-links",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a/child-links"
},
{
"rel": "http://identifiers.emc.com/linkrel/cabinet",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000107"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=0b00000180011a3a&related-object-role=any"
}
]
}
Representation: folder-child-documents
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/documents",
"title": "Documents under folder 0c00000180000107",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-19T06:22:20.812+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/documents"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/documents?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/documents?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000180011a70",
"title": "obj_with_content",
"author": [
{
"name": "dmadmin",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin"
}
],
"summary": "dm_document 0900000180011a70",
"updated": "2015-03-19T02:25:23.000+00:00",
"published": "2015-03-19T02:24:59.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000180011a70"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000180011a70"
}
}
]
}
Representation: document
Example:
{
"name": "document",
"type": "dm_document",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document",
"properties": {
"object_name": "iig58_Tue_Gal904_1330_Petrofac.pptx",
"r_object_type": "dm_document",
"r_creation_date": "2015-03-06T02:10:04.000+00:00",
"r_modify_date": "2017-05-04T02:56:01.000+00:00",
"r_modifier": "dmadmin",
"r_access_date": "2015-08-15T04:24:07.000+00:00",
"a_is_hidden": false,
"i_is_deleted": false,
"a_archive": false,
"a_link_resolved": false,
"i_reference_cnt": 1,
"i_has_folder": true,
"i_folder_id": [
"0c0000058000211b"
],
"r_link_cnt": 0,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0000000000000000",
"r_frzn_assembly_cnt": 0,
"r_has_frzn_assembly": false,
"r_is_virtual_doc": 0,
"i_contents_id": "0600000580001522",
"a_content_type": "ppt12",
"r_page_cnt": 1,
"r_content_size": 2702978,
"a_full_text": true,
"a_storage_type": "filestore_01",
"i_cabinet_id": "0c0000058000211b",
"owner_name": "dmadmin",
"owner_permit": 7,
"group_name": "docu",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "090000058000250b",
"i_latest_flag": true,
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": false,
"r_frozen_flag": false,
"r_has_events": false,
"acl_domain": "dmadmin",
"acl_name": "dm_4500000580001905",
"i_is_reference": false,
"r_creator_name": "dmadmin",
"r_is_public": true,
"r_policy_id": "4600000580004dfb",
"r_resume_state": -1,
"r_current_state": 0,
"r_alias_set_id": "0000000000000000",
"a_is_template": false,
"r_full_content_size": 2702978,
"a_is_signed": false,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 1,
"r_object_id": "090000058000250b"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/documents/090000058000250b"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/documents/090000058000250b"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/documents/090000058000250b"
},
{
"rel": "http://identifiers.emc.com/linkrel/parent-links",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/parent-links"
},
{
"rel": "parent",
"title": "0c0000058000211b",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c0000058000211b"
},
{
"rel": "http://identifiers.emc.com/linkrel/cabinet",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c0000058000211b"
},
{
"rel": "contents",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/contents"
},
{
"rel": "http://identifiers.emc.com/linkrel/primary-content",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/contents/content"
},
{
"rel": "http://identifiers.emc.com/linkrel/checkout",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/lock"
},
{
"rel": "version-history",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/versions"
},
{
"rel": "http://identifiers.emc.com/linkrel/current-version",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/versions/current"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=090000058000250b&related-object-role=any"
},
{
"rel": "http://identifiers.emc.com/linkrel/object-aspects",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/aspects"
},
{
"rel": "http://identifiers.emc.com/linkrel/permission-set",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/permission-set"
},
{
"rel": "http://identifiers.emc.com/linkrel/permissions",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/permissions"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-conversion",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/vd-nodes"
},
{
"rel": "http://identifiers.emc.com/linkrel/comments",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/comments"
},
{
"rel": "http://identifiers.emc.com/linkrel/attachable-lifecycles",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles?object-id=090000058000250b"
},
{
"rel": "http://identifiers.emc.com/linkrel/lifecycle",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfb"
},
{
"rel": "http://identifiers.emc.com/linkrel/object-lifecycle",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/lifecycle"
}
]
}
Representation: folder-child-objects
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/objects",
"title": "Objects under folder 0c00000180000107",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-19T06:28:09.406+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/objects"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/objects?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/objects?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70",
"title": "obj_with_content",
"author": [
{
"name": "dmadmin",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin"
}
],
"summary": "dm_document 0900000180011a70",
"updated": "2015-03-19T02:25:23.000+00:00",
"published": "2015-03-19T02:24:59.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70"
}
}
]
}
Representation: object
Example:
{
"name": "object",
"type": "dm_document",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document",
"properties": {
"object_name": "REST-API-TEST-VIRTUAL-DOCUMENT-558234e0-a6d7-462e-bb92-af805886325f",
"r_object_type": "dm_document",
"r_creation_date": "2017-05-10T02:50:41.000+00:00",
"r_modify_date": "2017-05-10T02:50:50.000+00:00",
"r_modifier": "dave",
"a_is_hidden": false,
"i_is_deleted": false,
"a_archive": false,
"a_link_resolved": false,
"i_reference_cnt": 1,
"i_has_folder": true,
"i_folder_id": [
"0c00000580001909"
],
"r_link_cnt": 3,
"r_link_high_cnt": 2,
"r_assembled_from_id": "090000058000ac2d",
"r_frzn_assembly_cnt": 0,
"r_has_frzn_assembly": false,
"r_is_virtual_doc": 1,
"i_contents_id": "0000000000000000",
"r_page_cnt": 0,
"r_content_size": 0,
"a_full_text": true,
"i_cabinet_id": "0c00000580001909",
"owner_name": "dave",
"owner_permit": 7,
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "090000058000ac2d",
"i_latest_flag": true,
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": false,
"r_frozen_flag": false,
"r_has_events": false,
"acl_domain": "dave",
"acl_name": "dm_4500000580000d07",
"i_is_reference": false,
"r_creator_name": "dave",
"r_is_public": true,
"r_policy_id": "0000000000000000",
"r_resume_state": 0,
"r_current_state": 0,
"r_alias_set_id": "0000000000000000",
"a_is_template": false,
"r_full_content_size": 0,
"a_is_signed": false,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 5,
"r_object_id": "090000058000ac2d"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d"
},
{
"rel": "canonical",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/documents/090000058000ac2d"
},
{
"rel": "http://identifiers.emc.com/linkrel/parent-links",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/parent-links"
},
{
"rel": "parent",
"title": "0c00000580001909",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001909"
},
{
"rel": "http://identifiers.emc.com/linkrel/cabinet",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000580001909"
},
{
"rel": "contents",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/contents"
},
{
"rel": "http://identifiers.emc.com/linkrel/primary-content",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/contents/content"
},
{
"rel": "http://identifiers.emc.com/linkrel/checkout",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/lock"
},
{
"rel": "version-history",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/versions"
},
{
"rel": "http://identifiers.emc.com/linkrel/current-version",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/versions/current"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-nodes",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/vd-nodes"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=090000058000ac2d&related-object-role=any"
},
{
"rel": "http://identifiers.emc.com/linkrel/object-aspects",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/aspects"
},
{
"rel": "http://identifiers.emc.com/linkrel/permission-set",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/permission-set"
},
{
"rel": "http://identifiers.emc.com/linkrel/permissions",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/permissions"
},
{
"rel": "http://identifiers.emc.com/linkrel/comments",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/comments"
},
{
"rel": "http://identifiers.emc.com/linkrel/attachable-lifecycles",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles?object-id=090000058000ac2d"
},
{
"rel": "http://identifiers.emc.com/linkrel/object-lifecycle",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/lifecycle"
}
]
}
Representation: object-copy-ref
Example:
{
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a6f",
"deep-copy": true,
"replicate-vd-children": true,
"retain-acl": true,
"properties": {
"object_name": "MyDoc Updated"
}
}
Representation: object-ref
Example:
{
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a6f"
}
Representation: child-folder-links
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links",
"title": "Child folder links of folder 0c00000180000107",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-19T07:32:35.718+00:00",
"page": 1,
"items-per-page": 100,
"total": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links/0900000180011a70",
"title": "Folder link between child 0900000180011a70 and parent 0c00000180000107",
"summary": "0900000180011a70",
"updated": "2015-03-19T07:32:35.734+00:00",
"published": "2015-03-19T07:32:35.734+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links/0900000180011a70"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links/0900000180011a70"
}
}
]
}
Representation: child-folder-link
Example:
{
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70",
"child-id": "0900000180011a70",
"parent-id": "0c00000180000107",
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links/0900000180011a70"
}
]
}
Representation: parent-folder-links
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links",
"title": "Parent folder links of object 0900000180011a70",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-19T07:35:11.781+00:00",
"page": 1,
"items-per-page": 100,
"total": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links/0c00000180000107",
"title": "Folder link between child 0900000180011a70 and parent 0c00000180000107",
"summary": "0c00000180000107",
"updated": "2015-03-19T07:35:11.781+00:00",
"published": "2015-03-19T07:35:11.781+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links/0c00000180000107"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links/0c00000180000107"
}
}
]
}
Representation: parent-folder-link
Example:
{
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000107",
"child-id": "0900000180011a70",
"parent-id": "0c00000180000107",
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links/0c00000180000107"
}
]
}
Representation: contents
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents",
"title": "Contents of object Blank PowerPoint Pre-3.0 Presentation",
"author": [
{
"name": "Administrator",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator"
}
],
"updated": "2014-12-04T10:18:20.000+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents/0600000180000114",
"title": "Content [page: 0, format: powerpoint, modifier: ]",
"summary": "0600000180000114",
"updated": "2014-12-04T10:18:20.000+00:00",
"published": "2014-12-04T10:18:20.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents/content?format=powerpoint&modifier=&page=0"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents/content?format=powerpoint&modifier=&page=0"
}
}
]
}
Representation: content
Example:
{
"name": "content",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/",
"properties": {
"object_name": "Blank PowerPoint Pre-3.0 Presentation",
"r_object_id": "0600000180000114",
"rendition": 0,
"full_format": "powerpoint",
"format": "27000001800001ac",
"full_content_size": 14848,
"set_time": "2014-12-04T10:18:20.000+00:00",
"i_vstamp": 0,
"mime_type": "application/vnd.ms-powerpoint",
"dos_extension": "ppt",
"format_name": "powerpoint",
"parent_id": [
"09000001800001da"
],
"page": [
0
],
"page_modifier": [
null
]
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents/content?format=powerpoint&amp;modifier=&amp;page=0"
},
{
"rel": "enclosure",
"title": "ACS",
"href": "http://contentserver72:9080/ACS/servlet/ACS?command=read&version=2.3&docbaseid=000001&...&expire_delta=360"
},
{
"rel": "http://identifiers.emc.com/linkrel/content-media",
"title": "ACS",
"href": "http://contentserver72:9080/ACS/servlet/ACS?command=read&version=2.3&docbaseid=000001&...&expire_delta=360"
},
{
"rel": "parent",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da"
}
]
}
Representation: all-versions
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions",
"title": "All versions of chronicle object 0900000180001904",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-19T09:19:54.156+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904",
"title": "REST-API-TEST-DOC-TO-CHECK-OUT",
"author": [
{
"name": "dave",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/dave"
}
],
"summary": "dm_document 0900000180001904",
"updated": "2014-12-10T03:41:31.000+00:00",
"published": "2014-12-10T03:41:31.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904"
}
}
]
}
Representation: current-version
Example:
{
"name": "object",
"type": "dm_document",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document",
"properties": {
"object_name": "REST-API-TEST-DOC-TO-CHECK-OUT",
"r_object_type": "dm_document",
"title": "",
"subject": "",
"authors": null,
"keywords": null,
"a_application_type": "",
"a_status": "",
"r_creation_date": "2014-12-10T03:41:31.000+00:00",
"r_modify_date": "2014-12-10T03:41:31.000+00:00",
"r_modifier": "dave",
"r_access_date": null,
"a_is_hidden": false,
"i_is_deleted": false,
"a_retention_date": null,
"a_archive": false,
"a_compound_architecture": "",
"a_link_resolved": false,
"i_reference_cnt": 1,
"i_has_folder": true,
"i_folder_id": [
"0c00000180000107"
],
"r_composite_id": null,
"r_composite_label": null,
"r_component_label": null,
"r_order_no": null,
"r_link_cnt": 0,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0000000000000000",
"r_frzn_assembly_cnt": 0,
"r_has_frzn_assembly": false,
"resolution_label": "",
"r_is_virtual_doc": 0,
"i_contents_id": "0000000000000000",
"a_content_type": "",
"r_page_cnt": 0,
"r_content_size": 0,
"a_full_text": true,
"a_storage_type": "",
"i_cabinet_id": "0c00000180000107",
"owner_name": "dave",
"owner_permit": 7,
"group_name": "",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "0900000180001904",
"i_latest_flag": true,
"r_lock_owner": "dmadmin",
"r_lock_date": "2014-12-10T03:41:32.000+00:00",
"r_lock_machine": "minint-mtlda27.corp.opentext.com",
"log_entry": "",
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": false,
"r_frozen_flag": false,
"r_has_events": false,
"acl_domain": "dave",
"acl_name": "dm_4500000180000914",
"a_special_app": "",
"i_is_reference": false,
"r_creator_name": "dave",
"r_is_public": true,
"r_policy_id": "0000000000000000",
"r_resume_state": 0,
"r_current_state": 0,
"r_alias_set_id": "0000000000000000",
"a_effective_date": null,
"a_expiration_date": null,
"a_publish_formats": null,
"a_effective_label": null,
"a_effective_flag": null,
"a_category": "",
"language_code": "",
"a_is_template": false,
"a_controlling_app": "",
"r_full_content_size": 0,
"a_extended_properties": null,
"a_is_signed": false,
"a_last_review_date": null,
"i_retain_until": null,
"r_aspect_name": null,
"i_retainer_id": null,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 1,
"r_object_id": "0900000180001904"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions/current"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904"
},
{
"rel": "canonical",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000180001904"
},
{
"rel": "http://identifiers.emc.com/linkrel/parent-links",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/parent-links"
},
{
"rel": "parent",
"title": "0c00000180000107",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107"
},
{
"rel": "http://identifiers.emc.com/linkrel/cabinet",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000107"
},
{
"rel": "contents",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/contents"
},
{
"rel": "http://identifiers.emc.com/linkrel/primary-content",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/contents/content"
},
{
"rel": "http://identifiers.emc.com/linkrel/checkin-next-major",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions?object-id=0900000180001904&version-policy=next-major"
},
{
"rel": "http://identifiers.emc.com/linkrel/checkin-next-minor",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions?object-id=0900000180001904&version-policy=next-minor"
},
{
"rel": "http://identifiers.emc.com/linkrel/cancel-checkout",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/lock"
},
{
"rel": "version-history",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions"
},
{
"rel": "http://identifiers.emc.com/linkrel/current-version",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions/current"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=0900000180001904&related-object-role=any"
}
]
}
Representation: checked-out-objects
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/checked-out-objects",
"title": "Checked-out objects",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-19T09:18:15.312+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/checked-out-objects"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904",
"title": "REST-API-TEST-DOC-TO-CHECK-OUT",
"author": [
{
"name": "dave",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/dave"
}
],
"summary": "dm_document 0900000180001904",
"updated": "2014-12-10T03:41:31.000+00:00",
"published": "2014-12-10T03:41:31.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904"
}
}
]
}
Representation: formats
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/formats",
"title": "Formats",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-23T03:24:53.694+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/formats"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/formats?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/formats?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/formats/123w",
"title": "123w",
"summary": "Lotus 1-2-3 r5",
"updated": "2015-03-23T03:24:53.694+00:00",
"published": "2015-03-23T03:24:53.694+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/formats/123w"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/formats/123w"
}
}
]
}
Representation: format
Example:
{
"name": "format",
"type": "dm_format",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_format",
"properties": {
"name": "123w",
"description": "Lotus 1-2-3 r5",
"can_index": true,
"topic_transform": false,
"topic_filter": "",
"topic_format": "0000000000000000",
"topic_format_name": "",
"mac_creator": "????",
"mac_type": "LWKS",
"dos_extension": "wk4",
"is_hidden": false,
"win31_app": "",
"com_class_id": "",
"mime_type": "application/vnd.lotus-1-2-3",
"icon_index": 0,
"richmedia_enabled": false,
"asset_class": "",
"default_storage": "0000000000000000",
"filename_modifier": "",
"format_class": null,
"a_page_plugin_name": "",
"i_is_replica": false,
"i_vstamp": 0,
"r_object_id": "2700000580000102"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/formats/123w"
}
]
}
Representation: relations
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/relations",
"title": "Relations",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-23T03:46:03.144+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/relations/3700000580000100",
"title": "dm_bof_dependencies",
"summary": "",
"updated": "2015-03-23T03:46:03.144+00:00",
"published": "2015-03-23T03:46:03.144+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations/3700000580000100"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/relations/3700000580000100"
}
}
]
}
Representation: relation
Example:
{
"name": "relation",
"type": "dm_relation",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_relation",
"properties": {
"relation_name": "dm_bof_dependencies",
"parent_id": "0b0000058000078e",
"child_id": "0b00000580000788",
"child_label": "",
"permanent_link": true,
"order_no": 0,
"effective_date": null,
"expiration_date": null,
"description": "",
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 2,
"r_object_id": "3700000580000100"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations/3700000580000100"
},
{
"rel": "http://identifiers.emc.com/linkrel/relation-type",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relation-types/dm_bof_dependencies"
},
{
"rel": "parent",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b0000058000078e"
},
{
"rel": "child",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000580000788"
}
]
}
Representation: relation-types
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/relation-types",
"title": "Relation types",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-23T03:52:39.344+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relation-types"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relation-types?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relation-types?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/relation-types/ACL%2BREPLICATION",
"title": "ACL REPLICATION",
"summary": "Relation Type for ACL Replication",
"updated": "2015-03-23T03:52:39.344+00:00",
"published": "2015-03-23T03:52:39.344+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relation-types/ACL%2BREPLICATION"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/relation-types/ACL%2BREPLICATION"
}
}
]
}
Representation: relation-type
Example:
{
"name": "relation-type",
"type": "dm_relation_type",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_relation_type",
"properties": {
"relation_name": "ACL REPLICATION",
"security_type": "SYSTEM",
"parent_type": "dm_document",
"child_type": "dm_document",
"description": "Relation Type for ACL Replication",
"direction_kind": 0,
"integrity_kind": 0,
"parent_child_label": null,
"child_parent_label": null,
"permanent_link": false,
"copy_child": 0,
"a_controlling_kind": "",
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 0,
"r_object_id": "3800000580000116"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relation-types/ACL%2BREPLICATION"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations?relation-name=ACL%20REPLICATION"
}
]
}
Representation: types
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/types",
"title": "Types",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-23T05:36:08.247+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl",
"title": "dm_acl",
"author": [
{
"name": "REPO_ADMIN",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/REPO_ADMIN"
}
],
"summary": "0300000580000101",
"updated": "2015-03-23T05:36:08.263+00:00",
"published": "2015-03-23T05:36:08.263+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl"
}
}
]
}
Representation: type
Example:
{
"name" : "dm_sysobject",
"label" : "Sysobject",
"category" : "standard",
"ignore-parent-constraints" : false,
"auditable-system-events" : [
"dm_all",
"dm_checkin",
"dm_checkout",
"dm_destroy",
"dm_fetch",
"dm_lock",
"dm_prune",
"dm_save",
"dm_unlock",
"dm_route",
"dm_forward",
"dm_reverse",
"dm_reassign",
"dm_halt",
"dm_end",
"dm_signoff",
"dm_acquire",
"dm_force",
"dm_pause",
"dm_resume",
"dm_start",
"dm_branch",
"dm_mark",
"dm_archive",
"dm_archive_done",
"dm_restore",
"dm_restore_done",
"dm_link",
"dm_unlink",
"dm_status",
"dm_setfile",
"dm_freeze",
"dm_unfreeze",
"dm_bp_promote",
"dm_bp_demote",
"dm_bp_attach",
"dm_bp_suspend",
"dm_bp_resume",
"dm_addnote",
"dm_removenote",
"dm_assemble",
"dm_jobstart",
"dm_unmark",
"dm_saveasnew",
"dm_getfile",
"dm_removecontent",
"dm_addrendition",
"dm_removerendition",
"dm_appendpart",
"dm_insertpart",
"dm_removepart",
"dm_updatepart",
"dm_checkout_ref",
"dm_checkin_ref",
"dm_checkcan_ref",
"dm_disassemble",
"dm_adddigsignature",
"dm_audit",
"dm_unaudit",
"dm_addesignature",
"dm_move_content",
"dm_addretention",
"dm_removeretention",
"dm_addesignature_failed",
"dm_security_check_failed"
],
"mapping-tables" : [
{
"value" : "dm_info",
"display" : "Info"
},
{
"value" : "dm_general",
"display" : "General"
},
{
"value" : "dm_summary",
"display" : "Summary"
},
{
"value" : "dm_version",
"display" : "Version"
},
{
"value" : "dm_security",
"display" : "Security"
},
{
"value" : "dm_advanced",
"display" : "Advanced"
}
],
"scope-configs" : [
{
"id" : "6c00000580000100",
"scope" : [
"webtop"
],
"category" : [
"application"
],
"display-configs" : [
{
"id" : "6b00000580000100",
"name" : "dm_info",
"attribute-source" : "dm_sysobject",
"fixed-display" : false,
"attribute-hints" : [
{
"attribute" : "object_name",
"display-hint" : 0
},
{
"attribute" : "owner_name",
"display-hint" : 0
},
{
"attribute" : "r_policy_id",
"display-hint" : 0
},
{
"attribute" : "r_current_state",
"display-hint" : 0
},
{
"attribute" : "r_creation_date",
"display-hint" : 2
},
{
"attribute" : "r_creator_name",
"display-hint" : 2
},
{
"attribute" : "r_modify_date",
"display-hint" : 2
},
{
"attribute" : "r_modifier",
"display-hint" : 2
},
{
"attribute" : "a_storage_type",
"display-hint" : 2
},
{
"attribute" : "i_retain_until",
"display-hint" : 2
}
]
}
]
},
{
"id" : "6c00000580000101",
"scope" : [
"DcDesktopClient"
],
"category" : [
"application"
],
"display-configs" : [
{
"id" : "6b00000580000101",
"name" : "dm_general",
"attribute-source" : "dm_sysobject",
"fixed-display" : false,
"attribute-hints" : [
{
"attribute" : "object_name",
"display-hint" : 0
},
{
"attribute" : "r_object_type",
"display-hint" : 0
},
{
"attribute" : "i_folder_id",
"display-hint" : 0
},
{
"attribute" : "r_creation_date",
"display-hint" : 0
},
{
"attribute" : "r_modify_date",
"display-hint" : 0
},
{
"attribute" : "owner_name",
"display-hint" : 0
}
]
},
{
"id" : "6b00000580000102",
"name" : "dm_summary",
"attribute-source" : "dm_sysobject",
"fixed-display" : false,
"attribute-hints" : [
{
"attribute" : "title",
"display-hint" : 0
},
{
"attribute" : "subject",
"display-hint" : 0
}
]
},
{
"id" : "6b00000580000103",
"name" : "dm_security",
"attribute-source" : "dm_sysobject",
"fixed-display" : true
},
{
"id" : "6b00000580000104",
"name" : "dm_advanced",
"attribute-source" : "dm_sysobject",
"fixed-display" : false,
"attribute-hints" : [
{
"attribute" : "r_policy_id",
"display-hint" : 0
},
{
"attribute" : "r_current_state",
"display-hint" : 0
},
{
"attribute" : "a_storage_type",
"display-hint" : 0
},
{
"attribute" : "r_object_id",
"display-hint" : 0
},
{
"attribute" : "a_is_hidden",
"display-hint" : 0
}
]
}
]
}
],
"properties" : [
{
"name" : "object_name",
"repeating" : false,
"type" : "string",
"length" : 255,
"label" : "Name",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_object_type",
"repeating" : false,
"type" : "string",
"length" : 32,
"label" : "Type",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "title",
"repeating" : false,
"type" : "string",
"length" : 400,
"label" : "Title",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "subject",
"repeating" : false,
"type" : "string",
"length" : 192,
"label" : "Subject",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "authors",
"repeating" : true,
"type" : "string",
"length" : 48,
"label" : "Authors",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "keywords",
"repeating" : true,
"type" : "string",
"length" : 48,
"label" : "Keywords",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_application_type",
"repeating" : false,
"type" : "string",
"length" : 32,
"label" : "Application Type",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_status",
"repeating" : false,
"type" : "string",
"length" : 16,
"label" : "Status",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_creation_date",
"repeating" : false,
"type" : "datetime",
"label" : "Created",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_modify_date",
"repeating" : false,
"type" : "datetime",
"label" : "Modified",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_modifier",
"repeating" : false,
"type" : "string",
"length" : 255,
"label" : "Modified By",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_access_date",
"repeating" : false,
"type" : "datetime",
"label" : "Accessed",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "a_is_hidden",
"repeating" : false,
"type" : "boolean",
"label" : "Hidden",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_is_deleted",
"repeating" : false,
"type" : "boolean",
"label" : "Root Deleted",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "a_retention_date",
"repeating" : false,
"type" : "datetime",
"label" : "Estimated Disposition",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "a_archive",
"repeating" : false,
"type" : "boolean",
"label" : "Archive",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "a_compound_architecture",
"repeating" : false,
"type" : "string",
"length" : 16,
"label" : "Compound Architecture",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "a_link_resolved",
"repeating" : false,
"type" : "boolean",
"label" : "Link Resolved",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_reference_cnt",
"repeating" : false,
"type" : "integer",
"label" : "Reference Count",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "i_has_folder",
"repeating" : false,
"type" : "boolean",
"label" : "In Folder",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_folder_id",
"repeating" : true,
"type" : "string",
"length" : 16,
"label" : "Parent Folder IDs",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "r_composite_id",
"repeating" : true,
"type" : "string",
"length" : 16,
"label" : "Composite IDs",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_composite_label",
"repeating" : true,
"type" : "string",
"length" : 32,
"label" : "Composite Version",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_component_label",
"repeating" : true,
"type" : "string",
"length" : 32,
"label" : "Component Version",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_order_no",
"repeating" : true,
"type" : "integer",
"label" : "Position",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_link_cnt",
"repeating" : false,
"type" : "integer",
"label" : "Link Count",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_link_high_cnt",
"repeating" : false,
"type" : "integer",
"label" : "Maximum Link Count",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_assembled_from_id",
"repeating" : false,
"type" : "string",
"length" : 16,
"label" : "Assembled From",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_frzn_assembly_cnt",
"repeating" : false,
"type" : "integer",
"label" : "Frozen Assembly Count",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "r_has_frzn_assembly",
"repeating" : false,
"type" : "boolean",
"label" : "Has Frozen Assembly",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "resolution_label",
"repeating" : false,
"type" : "string",
"length" : 32,
"label" : "Resolution Version",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_is_virtual_doc",
"repeating" : false,
"type" : "integer",
"label" : "Virtual Document",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_contents_id",
"repeating" : false,
"type" : "string",
"length" : 16,
"label" : "Content ID",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_content_type",
"repeating" : false,
"type" : "string",
"length" : 32,
"label" : "Format",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_page_cnt",
"repeating" : false,
"type" : "integer",
"label" : "Content File Count",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_content_size",
"repeating" : false,
"type" : "integer",
"label" : "Size",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_full_text",
"repeating" : false,
"type" : "boolean",
"label" : "Full Text Indexed",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_storage_type",
"repeating" : false,
"type" : "string",
"length" : 64,
"label" : "Storage Type",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "i_cabinet_id",
"repeating" : false,
"type" : "string",
"length" : 16,
"label" : "Primary Cabinet",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "owner_name",
"repeating" : false,
"type" : "string",
"length" : 255,
"label" : "Owner Name",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "owner_permit",
"repeating" : false,
"type" : "integer",
"label" : "Owner Permission",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : true,
"ignore-parent-constraints" : false,
"mapping-tables" : [
{
"value" : "1",
"display" : "None"
},
{
"value" : "2",
"display" : "Browse"
},
{
"value" : "3",
"display" : "Read"
},
{
"value" : "4",
"display" : "Relate"
},
{
"value" : "5",
"display" : "Version"
},
{
"value" : "6",
"display" : "Write"
},
{
"value" : "7",
"display" : "Delete"
}
]
},
{
"name" : "group_name",
"repeating" : false,
"type" : "string",
"length" : 255,
"label" : "Group Name",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "group_permit",
"repeating" : false,
"type" : "integer",
"label" : "Group Permit",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : true,
"ignore-parent-constraints" : false,
"mapping-tables" : [
{
"value" : "1",
"display" : "None"
},
{
"value" : "2",
"display" : "Browse"
},
{
"value" : "3",
"display" : "Read"
},
{
"value" : "4",
"display" : "Relate"
},
{
"value" : "5",
"display" : "Version"
},
{
"value" : "6",
"display" : "Write"
},
{
"value" : "7",
"display" : "Delete"
}
]
},
{
"name" : "world_permit",
"repeating" : false,
"type" : "integer",
"label" : "World Permissions",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : true,
"ignore-parent-constraints" : false,
"mapping-tables" : [
{
"value" : "1",
"display" : "None"
},
{
"value" : "2",
"display" : "Browse"
},
{
"value" : "3",
"display" : "Read"
},
{
"value" : "4",
"display" : "Relate"
},
{
"value" : "5",
"display" : "Version"
},
{
"value" : "6",
"display" : "Write"
},
{
"value" : "7",
"display" : "Delete"
}
]
},
{
"name" : "i_antecedent_id",
"repeating" : false,
"type" : "string",
"length" : 16,
"label" : "Parent Version",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_chronicle_id",
"repeating" : false,
"type" : "string",
"length" : 16,
"label" : "Version Tree Root Object",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_latest_flag",
"repeating" : false,
"type" : "boolean",
"label" : "Latest Version on Branch",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_lock_owner",
"repeating" : false,
"type" : "string",
"length" : 255,
"label" : "Checked Out By",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_lock_date",
"repeating" : false,
"type" : "datetime",
"label" : "Checkout Date",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_lock_machine",
"repeating" : false,
"type" : "string",
"length" : 80,
"label" : "Lock Owner's Host",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "log_entry",
"repeating" : false,
"type" : "string",
"length" : 120,
"label" : "User Comments",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_version_label",
"repeating" : true,
"type" : "string",
"length" : 32,
"label" : "Version Label",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_branch_cnt",
"repeating" : false,
"type" : "integer",
"label" : "Branch Count",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_direct_dsc",
"repeating" : false,
"type" : "boolean",
"label" : "Has Versions",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_immutable_flag",
"repeating" : false,
"type" : "boolean",
"label" : "Is Immutable",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "r_frozen_flag",
"repeating" : false,
"type" : "boolean",
"label" : "Frozen",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "r_has_events",
"repeating" : false,
"type" : "boolean",
"label" : "Has Events",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "acl_domain",
"repeating" : false,
"type" : "string",
"length" : 255,
"label" : "ACL Domain",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "acl_name",
"repeating" : false,
"type" : "string",
"length" : 32,
"label" : "ACL Name",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "a_special_app",
"repeating" : false,
"type" : "string",
"length" : 32,
"label" : "Special Application",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "i_is_reference",
"repeating" : false,
"type" : "boolean",
"label" : "Reference",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_creator_name",
"repeating" : false,
"type" : "string",
"length" : 255,
"label" : "Creator Name",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_is_public",
"repeating" : false,
"type" : "boolean",
"label" : "Public",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_policy_id",
"repeating" : false,
"type" : "string",
"length" : 16,
"label" : "Lifecycle ID",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "r_resume_state",
"repeating" : false,
"type" : "integer",
"label" : "Resume to state",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "r_current_state",
"repeating" : false,
"type" : "integer",
"label" : "Current State",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
},
{
"name" : "r_alias_set_id",
"repeating" : false,
"type" : "string",
"length" : 16,
"label" : "Alias Set",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_effective_date",
"repeating" : true,
"type" : "datetime",
"label" : "Effective Date",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_expiration_date",
"repeating" : true,
"type" : "datetime",
"label" : "Expiration Date",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_publish_formats",
"repeating" : true,
"type" : "string",
"length" : 32,
"label" : "Publish Formats",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_effective_label",
"repeating" : true,
"type" : "string",
"length" : 32,
"label" : "Effective Label",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_effective_flag",
"repeating" : true,
"type" : "string",
"length" : 8,
"label" : "Effective Flag",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_category",
"repeating" : false,
"type" : "string",
"length" : 64,
"label" : "Category",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "language_code",
"repeating" : false,
"type" : "string",
"length" : 5,
"label" : "Language Code",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_is_template",
"repeating" : false,
"type" : "boolean",
"label" : "Template",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_controlling_app",
"repeating" : false,
"type" : "string",
"length" : 32,
"label" : "Controlling Application",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_full_content_size",
"repeating" : false,
"type" : "float",
"label" : "Full Content Size",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_extended_properties",
"repeating" : true,
"type" : "string",
"length" : 32,
"label" : "Extended Properties",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_is_signed",
"repeating" : false,
"type" : "boolean",
"label" : "Is Signed",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "a_last_review_date",
"repeating" : false,
"type" : "datetime",
"label" : "Last Review Date",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : false,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_retain_until",
"repeating" : false,
"type" : "datetime",
"label" : "Retain Content Until",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "r_aspect_name",
"repeating" : true,
"type" : "string",
"length" : 64,
"label" : "Aspect Name",
"hidden" : false,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_retainer_id",
"repeating" : true,
"type" : "string",
"length" : 16,
"label" : "Retainer ID",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_partition",
"repeating" : false,
"type" : "integer",
"label" : "Partition Number",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_is_replica",
"repeating" : false,
"type" : "boolean",
"label" : "Is Replica",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : true,
"ignore-immutable" : false,
"ignore-parent-constraints" : false
},
{
"name" : "i_vstamp",
"repeating" : false,
"type" : "integer",
"label" : "Version Stamp",
"hidden" : true,
"required" : false,
"notnull" : false,
"readonly" : true,
"searchable" : false,
"ignore-immutable" : true,
"ignore-parent-constraints" : false
}
],
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject?include-all=true"
},
{
"rel" : "http://identifiers.emc.com/linkrel/types",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/types?parent-type=dm_sysobject"
},
{
"rel" : "http://identifiers.emc.com/linkrel/assist-values",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject/assist-values"
}
]
}
Representation: network-locations
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/network-locations",
"title": "Network locations",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-23T05:40:32.942+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/network-locations"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/network-locations?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/network-locations?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/network-locations/flaming_moutain",
"title": "flaming_moutain",
"summary": "The Flaming Mountain",
"updated": "2015-03-03T09:09:52.000+00:00",
"published": "2015-03-23T05:40:32.958+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/network-locations/flaming_moutain"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/network-locations/flaming_moutain"
}
}
]
}
Representation: network-location
Example:
{
"name": "network-location",
"type": "dm_network_location_map",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_network_location_map",
"properties": {
"object_name": "The Flaming Mountain",
"r_object_type": "dm_network_location_map",
"title": "",
"subject": "",
"authors": null,
"keywords": null,
"a_application_type": "",
"a_status": "",
"r_creation_date": "2015-03-03T09:09:52.000+00:00",
"r_modify_date": "2015-03-03T09:09:52.000+00:00",
"r_modifier": "dm_bof_registry",
"r_access_date": null,
"a_is_hidden": false,
"i_is_deleted": false,
"a_retention_date": null,
"a_archive": false,
"a_compound_architecture": "",
"a_link_resolved": false,
"i_reference_cnt": 1,
"i_has_folder": true,
"i_folder_id": [
"0b00000580000118"
],
"r_composite_id": null,
"r_composite_label": null,
"r_component_label": null,
"r_order_no": null,
"r_link_cnt": 0,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0000000000000000",
"r_frzn_assembly_cnt": 0,
"r_has_frzn_assembly": false,
"resolution_label": "",
"r_is_virtual_doc": 0,
"i_contents_id": "0000000000000000",
"a_content_type": "",
"r_page_cnt": 0,
"r_content_size": 0,
"a_full_text": true,
"a_storage_type": "",
"i_cabinet_id": "0c00000580000106",
"owner_name": "dm_bof_registry",
"owner_permit": 7,
"group_name": "",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "080000058000190c",
"i_latest_flag": true,
"r_lock_owner": "",
"r_lock_date": null,
"r_lock_machine": "",
"log_entry": "",
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": false,
"r_frozen_flag": false,
"r_has_events": false,
"acl_domain": "dm_bof_registry",
"acl_name": "dm_4500000580000d02",
"a_special_app": "",
"i_is_reference": false,
"r_creator_name": "dm_bof_registry",
"r_is_public": true,
"r_policy_id": "0000000000000000",
"r_resume_state": 0,
"r_current_state": 0,
"r_alias_set_id": "0000000000000000",
"a_effective_date": null,
"a_expiration_date": null,
"a_publish_formats": null,
"a_effective_label": null,
"a_effective_flag": null,
"a_category": "",
"language_code": "",
"a_is_template": false,
"a_controlling_app": "",
"r_full_content_size": 0.0,
"a_extended_properties": null,
"a_is_signed": false,
"a_last_review_date": null,
"i_retain_until": null,
"r_aspect_name": null,
"i_retainer_id": null,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 0,
"netloc_ident": "flaming_moutain",
"netloc_display_name": "The Flaming Mountain",
"default_netloc": false,
"begin_near_ip_address": [
"67.220.50.31",
"69.89.31.2"
],
"end_near_ip_address": [
"67.220.50.42",
"69.89.31.2"
],
"ip_address_range": null,
"r_object_id": "080000058000190c"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/network-locations/flaming_moutain"
}
]
}
Representation: users
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/users",
"title": "Users",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-23T05:43:43.089+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator",
"title": "Administrator",
"summary": "",
"updated": "2015-03-05T07:55:35.000+00:00",
"published": "2015-03-05T07:55:35.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator"
}
}
]
}
Representation: user
Example:
{
"name": "user",
"type": "dm_user",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_user",
"properties": {
"user_name": "dmadmin",
"user_os_name": "",
"user_address": "dmadmin@opentext.com",
"user_group_name": "docu",
"user_privileges": 16,
"owner_def_permit": 7,
"world_def_permit": 3,
"group_def_permit": 1,
"default_folder": "/dmadmin",
"r_is_group": false,
"user_db_name": "",
"description": "",
"acl_domain": "dmadmin",
"acl_name": "dm_4500000580000d08",
"user_os_domain": "",
"home_docbase": "REPO",
"user_state": 0,
"client_capability": 8,
"globally_managed": false,
"r_modify_date": "2015-03-05T07:56:40.000+00:00",
"user_delegation": "",
"workflow_disabled": false,
"alias_set_id": "0000000000000000",
"user_source": "inline password",
"user_ldap_dn": "",
"user_xprivileges": 0,
"r_has_events": false,
"failed_auth_attempt": -1,
"user_admin": "",
"user_global_unique_id": "REPO:dmadmin",
"user_login_name": "dmadmin",
"user_login_domain": "",
"user_initials": "",
"user_web_page": "",
"first_failed_auth_utc_time": null,
"last_login_utc_time": "2015-03-22T21:30:30.000+00:00",
"deactivated_utc_time": null,
"deactivated_ip_addr": "",
"restricted_folder_ids": null,
"root_log_dir": "",
"i_is_replica": false,
"i_vstamp": 2,
"r_object_id": "1100000580000502"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin"
},
{
"rel": "parent",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups?user-name=dmadmin"
},
{
"rel": "http://identifiers.emc.com/linkrel/default-folder",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin/home"
}
]
}
Representation: user-default-folder
Example:
{
"name": "folder",
"type": "dm_cabinet",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_cabinet",
"properties": {
"object_name": "dmadmin",
"r_object_type": "dm_cabinet",
"title": "",
"subject": "",
"authors": null,
"keywords": null,
"a_application_type": "",
"a_status": "",
"r_creation_date": "2015-03-03T09:23:26.000+00:00",
"r_modify_date": "2015-03-03T09:23:26.000+00:00",
"r_modifier": "Administrator",
"r_access_date": null,
"a_is_hidden": false,
"i_is_deleted": false,
"a_retention_date": null,
"a_archive": false,
"a_compound_architecture": "",
"a_link_resolved": false,
"i_reference_cnt": 1,
"i_has_folder": true,
"i_folder_id": null,
"r_composite_id": null,
"r_composite_label": null,
"r_component_label": null,
"r_order_no": null,
"r_link_cnt": 160,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0000000000000000",
"r_frzn_assembly_cnt": 0,
"r_has_frzn_assembly": false,
"resolution_label": "",
"r_is_virtual_doc": 0,
"i_contents_id": "0000000000000000",
"a_content_type": "",
"r_page_cnt": 0,
"r_content_size": 0,
"a_full_text": true,
"a_storage_type": "",
"i_cabinet_id": "0c00000580001914",
"owner_name": "dmadmin",
"owner_permit": 7,
"group_name": "docu",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "0c00000580001914",
"i_latest_flag": true,
"r_lock_owner": "",
"r_lock_date": null,
"r_lock_machine": "",
"log_entry": "",
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": false,
"r_frozen_flag": false,
"r_has_events": false,
"acl_domain": "dmadmin",
"acl_name": "dm_4500000580000d09",
"a_special_app": "",
"i_is_reference": false,
"r_creator_name": "Administrator",
"r_is_public": true,
"r_policy_id": "0000000000000000",
"r_resume_state": 0,
"r_current_state": 0,
"r_alias_set_id": "0000000000000000",
"a_effective_date": null,
"a_expiration_date": null,
"a_publish_formats": null,
"a_effective_label": null,
"a_effective_flag": null,
"a_category": "",
"language_code": "",
"a_is_template": false,
"a_controlling_app": "",
"r_full_content_size": 0.0,
"a_extended_properties": null,
"a_is_signed": false,
"a_last_review_date": null,
"i_retain_until": null,
"r_aspect_name": null,
"i_retainer_id": null,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 1,
"r_folder_path": [
"/dmadmin"
],
"i_ancestor_id": [
"0c00000580001914"
],
"is_private": true,
"r_object_id": "0c00000580001914"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin/home"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914"
},
{
"rel": "canonical",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000580001914"
},
{
"rel": "http://identifiers.emc.com/linkrel/folders",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914/folders"
},
{
"rel": "http://identifiers.emc.com/linkrel/documents",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914/documents"
},
{
"rel": "http://identifiers.emc.com/linkrel/objects",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914/objects"
},
{
"rel": "http://identifiers.emc.com/linkrel/child-links",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914/child-links"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=0c00000580001914&related-object-role=any"
}
]
}
Representation: groups
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/groups",
"title": "Groups",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-23T05:51:45.269+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups?items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups?items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup",
"title": "admingroup",
"summary": "",
"updated": "2015-03-03T02:20:31.000+00:00",
"published": "2015-03-03T02:20:31.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup"
}
}
]
}
Representation: group
Example:
{
"name": "group",
"type": "dm_group",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_group",
"properties": {
"group_name": "admingroup",
"group_address": "",
"users_names": [
"REPO_ADMIN",
"Administrator"
],
"owner_name": "Administrator",
"is_private": false,
"description": "",
"globally_managed": false,
"r_modify_date": "2015-03-03T02:20:31.000+00:00",
"alias_set_id": "0000000000000000",
"group_source": "",
"group_class": "group",
"group_admin": "",
"r_has_events": false,
"is_dynamic": false,
"is_dynamic_default": false,
"group_global_unique_id": "REPO:admingroup",
"group_native_room_id": "0000000000000000",
"group_directory_id": "0000000000000000",
"group_display_name": "admingroup",
"is_protected": false,
"is_module_only": false,
"i_is_replica": false,
"i_vstamp": 0,
"r_object_id": "1200000580000129"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup"
},
{
"rel": "parent",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups?group-name=admingroup"
},
{
"rel": "http://identifiers.emc.com/linkrel/groups",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/groups"
},
{
"rel": "http://identifiers.emc.com/linkrel/users",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/users"
}
]
}
Representation: group-member-groups
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/groups",
"title": "Member groups of group admingroup",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-23T05:51:11.508+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/groups"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/groups/subgroup",
"title": "subgroup",
"summary": "",
"updated": "2015-03-03T02:20:31.000+00:00",
"published": "2015-03-03T02:20:31.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups/subgroup"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/groups/subgroup"
}
}
]
}
Representation: group-member-users
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/users",
"title": "Member users of group admingroup",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-23T05:50:48.713+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/users"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator",
"title": "Administrator",
"summary": "",
"updated": "2015-03-05T07:55:35.000+00:00",
"published": "2015-03-05T07:55:35.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator"
}
}
]
}
Representation: batch-request
Example:
{
"transactional": true,
"sequential": true,
"on-error": "FAIL",
"return-request": false,
"operations": [
{
"id": "id-100",
"description": "get users",
"request": {
"method": "GET",
"uri": "/repositories/REPO/users?items-per-page=1",
"headers": [
{
"name": "Content-Type",
"value": "application/vnd.emc.documentum+json"
},
{
"name": "Accept",
"value": "application/vnd.emc.documentum+json"
}
]
}
},
{
"id": "id-101",
"description": "create a document",
"request": {
"method": "POST",
"uri": "/repositories/REPO/folders/0c00000580000107/documents",
"headers": [
{
"name": "Content-Type",
"value": "application/vnd.emc.documentum+json"
},
{
"name": "Accept",
"value": "application/vnd.emc.documentum+json"
}
],
"entity": "{\"properties\":{\"object_name\":\"my test object 101\"}}"
}
},
{
"id": "id-102",
"description": "create a document",
"request": {
"method": "POST",
"uri": "/repositories/REPO/folders/0c00000580000107/documents",
"headers": [
{
"name": "Content-Type",
"value": "application/vnd.emc.documentum+json"
},
{
"name": "Accept",
"value": "application/vnd.emc.documentum+json"
}
],
"entity": "{\"properties\":{\"object_name\":\"my test object 102\"}}"
}
}
]
}
Representation: batch
Example:
{
"transactional": true,
"sequential": true,
"on-error": "FAIL",
"return-request": false,
"state": "FINISHED",
"submitted": "2015-03-23T06:48:52.295+00:00",
"started": "2015-03-23T06:48:52.295+00:00",
"finished": "2015-03-23T06:48:52.404+00:00",
"owner": "dmadmin",
"operations": [
{
"id": "id-100",
"description": "get users",
"state": "FINISHED",
"started": "2015-03-23T06:48:52.295+00:00",
"finished": "2015-03-23T06:48:52.311+00:00",
"response": {
"status": 200,
"headers": [
{
"name": "Content-Type",
"value": "application/vnd.emc.documentum+json;charset=UTF-8"
}
],
"entity": "{\"id\":\"http://localhost:8080/dctm-rest/repositories/REPO/batches\",\"title\":\"Users\",..."}
},
{
"id": "id-101",
"description": "create a document",
"state": "FINISHED",
"started": "2015-03-23T06:48:52.311+00:00",
"finished": "2015-03-23T06:48:52.373+00:00",
"response": {
"status": 201,
"headers": [
{
"name": "Location",
"value": "http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000580005a35"
},
{
"name": "Content-Type",
"value": "application/vnd.emc.documentum+json;charset=UTF-8"
}
],
"entity": "{\"name\":\"document\",\"type\":\"dm_document\",\"definition\":..."}
},
{
"id": "id-102",
"description": "create a document",
"state": "FINISHED",
"started": "2015-03-23T06:48:52.373+00:00",
"finished": "2015-03-23T06:48:52.404+00:00",
"response": {
"status": 201,
"headers": [
{
"name": "Location",
"value": "http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000580005a36"
},
{
"name": "Content-Type",
"value": "application/vnd.emc.documentum+json;charset=UTF-8"
}
],
"entity": "{\"name\":\"document\",\"type\":\"dm_document\",\"definition\":..."}
}
]
}
Representation: batch-capabilities
Example:
{
"transactions": "both",
"sequence": "both",
"on-error": "both",
"batchable-resources": [
"batch-capabilities",
"cabinet",
"cabinets",
"checked-out-objects",
"child-folder-link",
"child-folder-links",
"content",
"contents",
"current-user",
"current-version",
"default-folder",
"document",
"dql-query",
"folder",
"folder-child-documents",
"folder-child-folders",
"folder-child-objects",
"format",
"formats",
"group",
"group-member-groups",
"group-member-users",
"groups",
"home-document",
"lock",
"network-location",
"network-locations",
"object",
"parent-folder-link",
"parent-folder-links",
"product-info",
"relation",
"relation-type",
"relation-types",
"relations",
"repositories",
"repository",
"search",
"type",
"types",
"user",
"users",
"versions"
],
"non-batchable-resources": [
"batches",
"content-media"
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/batch-capabilities"
}
]
}
Representation: dql-query
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO",
"title": "DQL query results",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-23T06:11:30.482+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO?dql=select+*+from+dm_user+where+user_name='dmadmin'"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO?dql=select+*+from+dm_user+where+user_name='dmadmin'&index=0",
"title": "1100000580000502",
"updated": "2015-03-23T06:11:30.498+00:00",
"published": "2015-03-23T06:11:30.498+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin"
}
],
"content": {
"json-root": "query-result",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_user",
"properties": {
"r_object_id": "1100000580000502",
"user_name": "dmadmin",
"user_os_name": "",
"user_address": "dmadmin@opentext.com",
"user_group_name": "docu",
"user_privileges": 16,
"owner_def_permit": 7,
"world_def_permit": 3,
"group_def_permit": 1,
"default_folder": "/dmadmin",
"user_db_name": "",
"description": "",
"acl_domain": "dmadmin",
"acl_name": "dm_4500000580000d08",
"user_os_domain": "",
"home_docbase": "REPO",
"user_state": 0,
"client_capability": 8,
"globally_managed": 0,
"user_delegation": "",
"workflow_disabled": 0,
"alias_set_id": "0000000000000000",
"user_source": "inline password",
"user_ldap_dn": "",
"user_xprivileges": 0,
"failed_auth_attempt": -1,
"user_admin": "",
"user_global_unique_id": "REPO:dmadmin",
"user_login_name": "dmadmin",
"user_login_domain": "",
"user_initials": "",
"user_password": "****************",
"user_web_page": "",
"first_failed_auth_utc_time": null,
"last_login_utc_time": "2015-03-23T06:05:52.000+00:00",
"deactivated_utc_time": null,
"deactivated_ip_addr": "",
"root_log_dir": ""
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin"
}
]
}
}
]
}
Representation: search
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/search",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-03-27T06:36:41.494+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search.json?q=rest&facet=r_object_type"
},
{
"rel": "search",
"hreftemplate": "http://localhost:8080/dctm-rest/repositories/REPO/search.json{?collections,facet,include-total,inline,items-per-page,locations,object-type,page,q,sort,timezone,view}"
}
],
"entries": [
{
"id": "0900000580003f01",
"title": "ObjectWithAspect",
"author": [
{
"name": "dmadmin"
}
],
"updated": "2015-03-27T06:19:45.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003f01.json"
}
],
"content": {
"type": "application/json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003f01.json"
},
"score": "1.0",
"terms": [
"rest"
]
},
{
"id": "0900000580003b4b",
"title": "ObjectWithAspect",
"author": [
{
"name": "dmadmin"
}
],
"updated": "2015-03-27T06:08:41.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003b4b.json"
}
],
"content": {
"type": "application/json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003b4b.json"
},
"score": "0.999971866607666",
"terms": [
"rest"
]
},
{
"id": "09000005800037d2",
"title": "ObjectWithAspect",
"author": [
{
"name": "dmadmin"
}
],
"updated": "2015-03-27T06:01:05.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800037d2.json"
}
],
"content": {
"type": "application/json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800037d2.json"
},
"score": "0.9999539256095886",
"terms": [
"rest"
]
}
],
"facets": [
{
"facet-id": "facet_r_object_type",
"facet-label": "Type",
"facet-value": [
{
"facet-value-id": "dm_document",
"facet-value-count": 1,
"facet-id": "facet_r_object_type",
"facet-value-constraint": "dm_document",
"link": {
"rel": "search",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search.json?q=rest&facet=r_object_type&facet-value-constraints=dm_document"
}
},
{
"facet-value-id": "dm_folder",
"facet-value-count": 1,
"facet-id": "facet_r_object_type",
"facet-value-constraint": "dm_folder",
"link": {
"rel": "search",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search.json?q=rest&facet=r_object_type&facet-value-constraints=dm_folder"
}
},
{
"facet-value-id": "rest_core",
"facet-value-count": 1,
"facet-id": "facet_r_object_type",
"facet-value-constraint": "rest_core",
"link": {
"rel": "search",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search.json?q=rest&facet=r_object_type&facet-value-constraints=rest_core"
}
}
]
}
]
}
Representation: saved-searches
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches",
"title": "Saved Searches",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-09-30T03:41:08.738+00:00",
"page": 1,
"items-per-page": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches?items-per-page=1"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches?items-per-page=1&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches?items-per-page=1&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562",
"title": "search iig",
"author": [
{
"name": "dmadmin"
}
],
"summary": "this is saved search",
"updated": "2015-09-30T01:50:20.000+00:00",
"published": "2015-09-30T01:50:20.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562"
}
}
]
}
Representation: saved-search
Example:
{
"name": "saved-search",
"type": "dm_smart_list",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_smart_list",
"properties": {
"object_name": "search iig",
"title": "this is saved search",
"r_creation_date": "2015-09-30T01:50:20.000+00:00",
"r_modify_date": "2015-09-30T01:50:20.000+00:00",
"r_modifier": "dmadmin",
"owner_name": "dmadmin",
"r_is_public": true,
"selected_sources": [
"REPO"
],
"has_results": false,
"results_count": -1,
"query_type": "query_builder",
"r_object_id": "0800000580004562"
},
"query-document": "{\"all-versions\":false,\"repositories\":[\"REPO\"],\"types\":[\"dm_document\"],...}",
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562"
},
{
"rel": "http://identifiers.emc.com/linkrel/saved-search-results",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562/results"
},
{
"rel": "http://identifiers.emc.com/linkrel/search-execution",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562/execution"
}
]
}
Representation: saved-search-execution
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/execution",
"title": "Search results",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-09-30T04:16:17.622+00:00",
"page": 1,
"items-per-page": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/execution?items-per-page=1"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/execution?items-per-page=1&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/execution?items-per-page=1&page=1"
}
],
"entries": [
{
"id": "090000058000251c",
"title": "iig86_Wed_Gal905_1430_Mapfre.pdf",
"author": [
{
"name": "dmadmin"
}
],
"summary": ". Evolution of ECM in MAPFRE i. Business Benefits ii. Why Open Text ECD iii....",
"updated": "2015-03-06T02:10:44.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000251c"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000251c"
},
"score": "1.0",
"terms": [
"IIG",
"iig"
]
}
]
}
Representation: saved-search-results
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/results",
"title": "Search results",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-09-30T04:01:15.000+00:00",
"page": 1,
"items-per-page": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/results?items-per-page=1"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/results?items-per-page=1&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004565/results?items-per-page=1&page=1"
}
],
"entries": [
{
"id": "090000058000251c",
"title": "iig86_Wed_Gal905_1430_Mapfre.pdf",
"author": [
null
],
"summary": ". Evolution of ECM in MAPFRE i. Business Benefits ii. Why Open Text ECD iii.... ",
"updated": "2015-09-30T04:19:50.541+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000251c"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000251c"
},
"score": "1.0",
"terms": [
"IIG",
"iig"
]
}
]
}
Representation: aspect-types
Example:
{
"id" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types",
"title" : "Aspect types",
"author" : [
{
"name" : "Open Text Documentum"
}
],
"updated" : "2015-06-01T07:52:09.215+00:00",
"page" : 1,
"items-per-page" : 1,
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types?items-per-page=1"
},
{
"rel" : "next",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types?items-per-page=1&page=2"
},
{
"rel" : "first",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types?items-per-page=1&page=1"
}
],
"entries" : [
{
"id" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/CompleteWorkitemsTimerAspect",
"title" : "CompleteWorkitemsTimerAspect",
"author" : [
{
"name" : "Administrator",
"uri" : "http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator"
}
],
"summary" : "null 0b0000058000032a",
"updated" : "2015-03-03T02:20:00.000+00:00",
"published" : "2015-03-03T02:20:00.000+00:00",
"links" : [
{
"rel" : "edit",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/CompleteWorkitemsTimerAspect"
}
],
"content" : {
"type" : "application/vnd.emc.documentum+json",
"src" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/CompleteWorkitemsTimerAspect"
}
}
]
}
Representation: aspect-type
Example:
{
"name" : "aspect-type",
"type" : "dmc_aspect_type",
"definition" : "http://localhost:8080/dctm-rest/repositories/REPO/types/dmc_aspect_type",
"properties" : {
"group_name" : "docu",
"acl_name" : "BOF_acl",
"world_permit" : 3,
"r_creation_date" : "2015-03-03T02:29:34.000+00:00",
"r_object_type" : "dmc_aspect_type",
"min_dfc_version" : "6.0",
"owner_name" : "Administrator",
"implementation_technology" : "Java",
"primary_class" : "com.documentum.smart.impl.aspect.AnnotatableAspect",
"owner_permit" : 7,
"a_bof_version" : "",
"a_interfaces" : null,
"r_object_id" : "0b000005800005b0",
"r_modify_date" : "2015-03-03T02:30:13.000+00:00",
"group_permit" : 1,
"i_folder_id" : [
"0b00000580000180"
],
"r_folder_path" : [
"/System/Modules/Aspect/dm_annotatable"
],
"object_name" : "dm_annotatable",
"target_object_type" : null,
"r_creator_name" : "Administrator",
"r_modifier" : "Administrator",
"acl_domain" : "REPO_ADMIN",
"a_module_type" : "Aspect",
"attr_name" : [
"annotation_name",
"module_name",
"annotation_metadata",
"i_partition"
],
"attr_repeating" : [
true,
true,
true,
false
],
"attr_type" : [
"string",
"string",
"string",
"integer"
],
"attr_length" : [
255,
255,
1024,
null
]
},
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/dm_annotatable"
},
{
"rel" : "http://identifiers.emc.com/linkrel/type",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/types/dmi_03000005800001d3"
}
]
}
Representation: object-aspects
Example:
{
"aspects" : [
"dm_annotatable",
"dm_checkin_control",
"dm_version_behavior"
],
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003d42/aspects"
},
{
"rel" : "http://identifiers.emc.com/linkrel/delete",
"title" : "dm_annotatable",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003d42/aspects/dm_annotatable"
},
{
"rel" : "http://identifiers.emc.com/linkrel/aspect-type",
"title" : "dm_annotatable",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/dm_annotatable"
},
{
"rel" : "http://identifiers.emc.com/linkrel/delete",
"title" : "dm_checkin_control",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003d42/aspects/dm_checkin_control"
},
{
"rel" : "http://identifiers.emc.com/linkrel/aspect-type",
"title" : "dm_checkin_control",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/dm_checkin_control"
},
{
"rel" : "http://identifiers.emc.com/linkrel/delete",
"title" : "dm_version_behavior",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003d42/aspects/dm_version_behavior"
},
{
"rel" : "http://identifiers.emc.com/linkrel/aspect-type",
"title" : "dm_version_behavior",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/dm_version_behavior"
}
]
}
Representation: acls
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/acls",
"title": "ACLs",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-07-13T05:41:28.835+00:00",
"page": 1,
"items-per-page": 2,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls?items-per-page=2"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls?items-per-page=2&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls?items-per-page=2&page=1"
}
],
"entries": [
{
"id": "4500000580000100",
"title": "dm_4500000580000100",
"updated": "2015-07-13T05:41:28.842+00:00",
"published": "2015-07-13T05:41:28.842+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000100"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000100"
}
},
{
"id": "4500000580000101",
"title": "dm_4500000580000101",
"updated": "2015-07-13T05:41:28.842+00:00",
"published": "2015-07-13T05:41:28.842+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000101"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000101"
}
}
]
}
Representation: acl
Example:
{
"name": "acl",
"type": "dm_acl",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl",
"properties": {
"object_name": "dm_4500000580000d07",
"description": "dm_4500000580000d07",
"owner_name": "dave",
"r_is_internal": true,
"r_accessor_name": [
"dm_world",
"dm_owner",
"dm_group"
],
"r_accessor_permit": [
3,
7,
5
],
"r_accessor_xpermit": [
0,
0,
3
],
"r_is_group": [
false,
false,
false
],
"globally_managed": false,
"acl_class": 0,
"r_has_events": false,
"r_permit_type": [
0,
0,
0
],
"r_application_permit": [
"",
"",
""
],
"i_has_required_groups": false,
"i_has_required_group_set": false,
"i_has_access_restrictions": false,
"r_template_id": "0000000000000000",
"r_alias_set_id": "0000000000000000",
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 0,
"r_object_id": "4500000580000d07"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07"
},
{
"rel": "http://identifiers.emc.com/linkrel/associations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07/associations"
}
]
}
Representation: acl-associations
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07/associations",
"title": "Objects",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2015-07-13T05:39:21.849+00:00",
"page": 1,
"items-per-page": 2,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07/associations?items-per-page=2"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07/associations?items-per-page=2&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07/associations?items-per-page=2&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002626",
"title": "",
"author": [
{
"name": "dave",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/dave"
}
],
"summary": "dm_sysobject 0800000580002626",
"updated": "2015-06-04T10:51:49.000+00:00",
"published": "2015-06-04T10:51:49.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002626"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002626"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002627",
"title": "",
"author": [
{
"name": "dave",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/dave"
}
],
"summary": "dm_sysobject 0800000580002627",
"updated": "2015-06-04T10:51:49.000+00:00",
"published": "2015-06-04T10:51:49.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002627"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0800000580002627"
}
}
]
}
Representation: permission-set
Example:
{
"permitted": [
{
"accessor": "dm_world",
"basic-permission": "Read",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
},
{
"accessor": "dm_owner",
"basic-permission": "Write",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
},
{
"accessor": "docu",
"basic-permission": "Relate",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
},
{
"accessor": "Administrator",
"basic-permission": "Read",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
}
],
"restricted": [
{
"accessor": "dave",
"basic-permission": "Browse",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
}
],
"required-group": [
"docu",
"admingroup"
],
"required-group-set": [
"admingroup"
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250e/permission-set"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250e/permission-set"
},
{
"rel": "http://identifiers.emc.com/linkrel/acl",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580001d3f"
}
]
}
Representation: permissions
Example:
{
"accessor": "dave",
"basic-permission": "Relate",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION",
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580002507/permissions?accessor=dave"
}
]
}
Representation: user-permission-set
Example:
{
"permitted": [
{
"accessor": "dm_world",
"basic-permission": "Read",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
},
{
"accessor": "dm_owner",
"basic-permission": "Write",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
},
{
"accessor": "docu",
"basic-permission": "Relate",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
}
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users/dave/permission-set"
},
{
"rel": "http://identifiers.emc.com/linkrel/acl",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580001d3f"
}
]
}
Representation: comments
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments",
"title": "Comments on object: 0900000180143717 under parent comment id: 0",
"author":[
{
"name": "Open Text Documentum"
}
],
"updated": "2016-02-01T22:07:00.401+00:00",
"page": 1,
"items-per-page": 100,
"links":[
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments"
}
],
"entries":[
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839",
"title": "",
"author":[
{
"name": "John Doe",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/John%2BDoe"
}
],
"summary": "<font color= '#363636' ><font size= '2' ><font face= 'Arial' >The spec looks good. Just two comments<br></font></font></font><ol><li><font color= '#363636' ><font size= '2' ><font face= 'Arial' >Please add a diagram to show the flow.</font></font></font></li><li><font color= '#363636' ><font size= '2' ><font face= 'Arial' >Please clarify the filter criteria.<br></font></font></font></li></ol>",
"updated": "2016-01-26T15:16:16.000+00:00",
"published": "2016-01-26T15:16:16.000+00:00",
"links":[
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839"
}
],
"content":{
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324841",
"title": "",
"author":[
{
"name": "Jane Doe",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/Jane%2BDoe"
}
],
"summary": "<font face= 'Arial' ><font size= '2' ><font color= '#363636' >Should we also support paging?<br></font></font></font>",
"updated": "2016-01-26T15:19:57.000+00:00",
"published": "2016-01-26T15:19:57.000+00:00",
"links":[
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324841"
}
],
"content":{
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324841"
}
}
]
}
Representation: comment
Example:
{
"object-id": "0800000180143727",
"comment-id": "1324839",
"owner-name": "John Doe",
"creation-date": "2016-01-26T15:16:16.000+00:00",
"modified-date": "2016-01-26T15:16:16.000+00:00",
"content-value": "<font color= '#363636' ><font size= '2' ><font face= 'Arial' >The spec looks good. Just two comments<br></font></font></font><ol><li><font color= '#363636' ><font size= '2' ><font face= 'Arial' >Please add a diagram to show the flow.</font></font></font></li><li><font color= '#363636' ><font size= '2' ><font face= 'Arial' >Please clarify the filter criteria.<br></font></font></font></li></ol>",
"parent-id": "0",
"title": "",
"can-delete": true,
"can-reply": true,
"links":[
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839"
},
{
"rel": "parent",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments"
},
{
"rel": "http://identifiers.emc.com/linkrel/replies",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839/replies"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839"
}
]
}
Representation: current-user-preferences
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences",
"title": "Preferences",
"author": [{
"name": "Open Text Documentum"
}],
"updated": "2016-03-02T04:47:36.291+00:00",
"page": 1,
"items-per-page": 100,
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences"
}],
"entries": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-mobile",
"title": "user preference for Documentum Mobile App",
"summary": "user preference",
"updated": "2016-03-02T04:41:30.000+00:00",
"published": "2016-03-02T04:41:30.000+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-mobile"
}],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-mobile"
}
}, {
"id": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app",
"title": "user preference for Documentum HTML5 App",
"summary": "user preference",
"updated": "2016-03-02T04:42:19.000+00:00",
"published": "2016-03-02T04:42:19.000+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app"
}],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app"
}
}]
}
Representation: current-user-preference
Example:
{
"name": "preference",
"client": "dctm-html5-app",
"owner-name": "dmadmin",
"title": "user preference for Documentum HTML5 App",
"subject": "user preference",
"keywords": [
"documentum",
"us"
],
"creation-date": "2016-03-02T03:51:13.000+00:00",
"modify-date": "2016-03-02T03:51:13.000+00:00",
"preference-content": "{\"user-locale\":\"cn\", \"timezone\":\"gmt+8\"}",
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app"
}
]
}
Representation: lifecycles
Example:
{
"id" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles",
"title" : "Lifecycles",
"author" : [
{
"name" : "Open Text Documentum"
}
],
"updated" : "2017-05-04T01:36:36.722+00:00",
"page" : 1,
"items-per-page" : 100,
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles"
}
],
"entries" : [
{
"id" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfb",
"title" : "a_docbasic_lifecycle",
"author" : [
{
"name" : "dmadmin",
"uri" : "http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin"
}
],
"updated" : "2017-05-03T02:15:25.000+00:00",
"published" : "2017-05-03T02:15:21.000+00:00",
"links" : [
{
"rel" : "edit",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfb"
}
],
"content" : {
"type" : "application/vnd.emc.documentum+json",
"src" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfb"
}
},
{
"id" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfc",
"title" : "a_java_lifecycle",
"author" : [
{
"name" : "dmadmin",
"uri" : "http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin"
}
],
"updated" : "2017-05-03T02:15:24.000+00:00",
"published" : "2017-05-03T02:15:22.000+00:00",
"links" : [
{
"rel" : "edit",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfc"
}
],
"content" : {
"type" : "application/vnd.emc.documentum+json",
"src" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfc"
}
}
]
}
Representation: lifecycle
Example:
{
"id" : "4600000580004dfc",
"name" : "a_java_lifecycle",
"owner" : "dmadmin",
"created" : "2017-05-03T02:15:22.000+00:00",
"modified" : "2017-05-03T02:15:24.000+00:00",
"implementation-type" : "JAVA",
"version-labels" : [
"1.0",
"CURRENT"
],
"status" : "INSTALLED",
"type-inclusions" : [
{
"type" : "dm_document",
"include-subtypes" : true
}
],
"user-validation-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-class" : "com.emc.documentum.rest.dfc.lifecycle.RestLifecycleUserProcessor"
},
"states" : [
{
"name" : "draft",
"index" : 0,
"no" : 0,
"exceptional" : false,
"allow-attach" : true,
"allow-schedule" : true,
"allow-return-to-base" : false,
"allow-demote" : false,
"return-conditions" : [
"ALL"
]
},
{
"name" : "review",
"index" : 1,
"no" : 1,
"exceptional" : false,
"exception-state" : "fail",
"allow-attach" : false,
"allow-schedule" : true,
"allow-return-to-base" : true,
"allow-demote" : true,
"return-conditions" : [
"CHECKIN",
"SAVE_AS_NEW",
"BRANCH"
],
"user-criteria-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-class" : "com.emc.documentum.rest.dfc.lifecycle.RestLifecycleUserProcessor"
},
"user-action-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-class" : "com.emc.documentum.rest.dfc.lifecycle.RestLifecycleUserProcessor"
},
"user-post-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-class" : "com.emc.documentum.rest.dfc.lifecycle.RestLifecycleUserProcessor"
}
},
{
"name" : "publish",
"index" : 2,
"no" : 2,
"exceptional" : false,
"allow-attach" : false,
"allow-schedule" : true,
"allow-return-to-base" : true,
"allow-demote" : true,
"return-conditions" : [
"BRANCH"
],
"user-criteria-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-class" : "com.emc.documentum.rest.dfc.lifecycle.RestLifecycleUserProcessor"
},
"user-action-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-class" : "com.emc.documentum.rest.dfc.lifecycle.RestLifecycleUserProcessor"
},
"user-post-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-class" : "com.emc.documentum.rest.dfc.lifecycle.RestLifecycleUserProcessor"
}
},
{
"name" : "fail",
"index" : 3,
"no" : 3,
"exceptional" : true,
"allow-attach" : false,
"allow-schedule" : true,
"allow-return-to-base" : false,
"allow-demote" : false,
"return-conditions" : [
"ALL"
]
}
],
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfc"
},
{
"rel" : "http://identifiers.emc.com/linkrel/owner",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin"
},
{
"rel" : "http://identifiers.emc.com/linkrel/type",
"title" : "dm_document",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document"
}
]
}
Representation: object-lifecycle
Example:
{
"lifecycle-id" : "4600000580004dfc",
"lifecycle-name" : "a_java_lifecycle",
"current-state" : "draft",
"next-state" : "review",
"able-to-promote" : true,
"able-to-demote" : false,
"able-to-suspend" : false,
"able-to-resume" : false,
"schedules" : [ {
"action" : "promote",
"schedule" : "2017-03-29T11:15:38.000+00:00",
"from" : "draft",
"to" : "to-review"
}],
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800061f3/lifecycle"
},
{
"rel" : "http://identifiers.emc.com/linkrel/lifecycle",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfc"
},
{
"rel" : "parent",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800061f3"
},
{
"rel" : "http://identifiers.emc.com/linkrel/promotion",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800061f3/lifecycle/promotion"
}
]
}
Representation: virtual-document-nodes
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/vd-nodes",
"title": "Virtual Document Nodes",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2017-05-10T05:56:32.976+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/vd-nodes"
}
],
"entries": [
{
"id": "090000058000ac2d",
"title": "REST-API-TEST-VIRTUAL-DOCUMENT-558234e0-a6d7-462e-bb92-af805886325f",
"updated": "2017-05-10T02:50:50.000+00:00",
"published": "2017-05-10T02:50:41.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/_root_node_id_090000058000ac2d"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/_root_node_id_090000058000ac2d"
}
},
{
"id": "090000058000ac2e",
"title": "REST-API-TEST-VIRTUAL-DOCUMENT-40904d89-4061-4d57-a436-36daf0de1938",
"summary": "1",
"updated": "2017-05-10T02:50:47.000+00:00",
"published": "2017-05-10T02:50:42.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2e"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"
}
},
{
"id": "090000058000ac31",
"title": "REST-API-TEST-VIRTUAL-DOCUMENT-73ad5822-6044-4f50-a588-c9741fee0563",
"summary": "2",
"updated": "2017-05-10T02:50:49.000+00:00",
"published": "2017-05-10T02:50:48.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002975"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac31"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002975"
}
}
]
}
Representation: virtual-document-relation
Example:
{
"name": "vd-node",
"parent-id": "090000058000ac2d",
"chronicle-id": "090000058000ac2e",
"relation-id": "0500000580002974",
"order-number": 1000,
"binding": "",
"override-late-binding": false,
"copy-behavior": "REFERENCE",
"follow-assembly": true,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2e"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"
}
]
}
Representation: snapshots
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots",
"title": "Virtual Document Snapshots",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2017-06-07T07:42:21.774+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa",
"title": "virtual doc ef716ecb-e1d2-4cd2-a312-c09baf05f5a1",
"summary": "Snapshot 08000005800049fa for Virtual Document 0900000580004a02",
"updated": "2017-06-05T02:09:53.000+00:00",
"published": "2017-06-05T02:09:53.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/0800000580004a26",
"title": "snapshot from scratch",
"summary": "Snapshot 0800000580004a26 for Virtual Document 0900000580004a02",
"updated": "2017-06-05T02:42:19.000+00:00",
"published": "2017-06-05T02:42:18.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/0800000580004a26"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/0800000580004a26"
}
}
]
}
Representation: snapshot
Example:
{
"name": "vd-snapshot",
"type": "dm_sysobject",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject",
"properties": {
"object_name": "virtual doc ef716ecb-e1d2-4cd2-a312-c09baf05f5a1",
"r_object_type": "dm_sysobject",
"r_creation_date": "2017-06-05T02:09:53.000+00:00",
"r_modify_date": "2017-06-05T02:09:53.000+00:00",
"r_modifier": "dmadmin",
"a_is_hidden": false,
"i_is_deleted": false,
"a_archive": false,
"a_link_resolved": false,
"i_reference_cnt": 1,
"i_has_folder": true,
"i_folder_id": [
"0c00000580001914"
],
"r_link_cnt": 0,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0900000580004a02",
"r_frzn_assembly_cnt": 1,
"r_has_frzn_assembly": true,
"r_is_virtual_doc": 0,
"i_contents_id": "0000000000000000",
"r_page_cnt": 0,
"r_content_size": 0,
"a_full_text": true,
"i_cabinet_id": "0c00000580001914",
"owner_name": "dmadmin",
"owner_permit": 7,
"group_name": "docu",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "08000005800049fa",
"i_latest_flag": true,
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": true,
"r_frozen_flag": true,
"r_has_events": false,
"acl_domain": "dmadmin",
"acl_name": "dm_4500000580001e68",
"i_is_reference": false,
"r_creator_name": "dmadmin",
"r_is_public": true,
"r_policy_id": "0000000000000000",
"r_resume_state": 0,
"r_current_state": 0,
"r_alias_set_id": "0000000000000000",
"a_is_template": false,
"r_full_content_size": 0,
"a_is_signed": false,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 5,
"r_object_id": "08000005800049fa"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580004a02"
},
{
"rel": "http://identifiers.emc.com/linkrel/snapshot-nodes",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa/vd-nodes"
},
{
"rel": "http://identifiers.emc.com/linkrel/unfreeze",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa/frozen"
}
]
}
Representation: snapshot-nodes
Example:
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/vd-nodes",
"title": "Virtual Document Nodes",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2017-05-10T05:56:32.976+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/vd-nodes"
}
],
"entries": [
{
"id": "090000058000ac2d",
"title": "REST-API-TEST-VIRTUAL-DOCUMENT-558234e0-a6d7-462e-bb92-af805886325f",
"updated": "2017-05-10T02:50:50.000+00:00",
"published": "2017-05-10T02:50:41.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/_root_node_id_090000058000ac2d"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/_root_node_id_090000058000ac2d"
}
},
{
"id": "090000058000ac2e",
"title": "REST-API-TEST-VIRTUAL-DOCUMENT-40904d89-4061-4d57-a436-36daf0de1938",
"summary": "1",
"updated": "2017-05-10T02:50:47.000+00:00",
"published": "2017-05-10T02:50:42.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2e"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"
}
},
{
"id": "090000058000ac31",
"title": "REST-API-TEST-VIRTUAL-DOCUMENT-73ad5822-6044-4f50-a588-c9741fee0563",
"summary": "2",
"updated": "2017-05-10T02:50:49.000+00:00",
"published": "2017-05-10T02:50:48.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002975"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac31"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002975"
}
}
]
}
Representation: snapshot-frozen
Example:
{
"name": "vd-snapshot",
"type": "dm_sysobject",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject",
"properties": {
"object_name": "virtual doc ef716ecb-e1d2-4cd2-a312-c09baf05f5a1",
"r_object_type": "dm_sysobject",
"r_creation_date": "2017-06-05T02:09:53.000+00:00",
"r_modify_date": "2017-06-05T02:09:53.000+00:00",
"r_modifier": "dmadmin",
"a_is_hidden": false,
"i_is_deleted": false,
"a_archive": false,
"a_link_resolved": false,
"i_reference_cnt": 1,
"i_has_folder": true,
"i_folder_id": [
"0c00000580001914"
],
"r_link_cnt": 0,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0900000580004a02",
"r_frzn_assembly_cnt": 1,
"r_has_frzn_assembly": true,
"r_is_virtual_doc": 0,
"i_contents_id": "0000000000000000",
"r_page_cnt": 0,
"r_content_size": 0,
"a_full_text": true,
"i_cabinet_id": "0c00000580001914",
"owner_name": "dmadmin",
"owner_permit": 7,
"group_name": "docu",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "08000005800049fa",
"i_latest_flag": true,
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": true,
"r_frozen_flag": true,
"r_has_events": false,
"acl_domain": "dmadmin",
"acl_name": "dm_4500000580001e68",
"i_is_reference": false,
"r_creator_name": "dmadmin",
"r_is_public": true,
"r_policy_id": "0000000000000000",
"r_resume_state": 0,
"r_current_state": 0,
"r_alias_set_id": "0000000000000000",
"a_is_template": false,
"r_full_content_size": 0,
"a_is_signed": false,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 5,
"r_object_id": "08000005800049fa"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa/frozen"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580004a02"
},
{
"rel": "canonical",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa"
},
{
"rel": "http://identifiers.emc.com/linkrel/unfreeze",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa/frozen"
}
]
}
Media Type: application/vnd.emc.documentum+xml
Representation: product-info
Example:
<product-info name="documentum-rest-services-product-info">
<properties>
<product>Documentum REST Services</product>
<product_version>7.2.xxx.yyy</product_version>
<major>7.2</major>
<minor>xxx</minor>
<build_number>yyy</build_number>
<revision_number>zzz</revision_number>
</properties>
<links>
<link rel="self" href=
"http://core-rs-demo.lss.opentext.com:8080/dctm-rest/product-info" />
</links>
</product-info>
Representation: repository
Example:
<repository
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>5</id>
<name>REPO</name>
<description></description>
<server>
<name>REPO</name>
<host>RESTCS72GA</host>
<version xml:space="preserve">7.2.0000.0155 Win64.SQLServer</version>
<docbroker>RESTCS72GA</docbroker>
</server>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/"/>
<link rel="canonical" href="http://localhost:8080/dctm-rest/repositories/REPO"/>
<link rel="http://identifiers.emc.com/linkrel/cabinets" href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets"/>
<link rel="http://identifiers.emc.com/linkrel/checked-out-objects" href="http://localhost:8080/dctm-rest/repositories/REPO/checked-out-objects"/>
<link rel="http://identifiers.emc.com/linkrel/current-user" href="http://localhost:8080/dctm-rest/repositories/REPO/currentuser"/>
<link rel="http://identifiers.emc.com/linkrel/current-user-preferences" href="http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences"/>
<link rel="http://identifiers.emc.com/linkrel/users" href="http://localhost:8080/dctm-rest/repositories/REPO/users"/>
<link rel="http://identifiers.emc.com/linkrel/groups" href="http://localhost:8080/dctm-rest/repositories/REPO/groups"/>
<link rel="http://identifiers.emc.com/linkrel/formats" href="http://localhost:8080/dctm-rest/repositories/REPO/formats"/>
<link rel="http://identifiers.emc.com/linkrel/network-locations" href="http://localhost:8080/dctm-rest/repositories/REPO/network-locations"/>
<link rel="http://identifiers.emc.com/linkrel/relations" href="http://localhost:8080/dctm-rest/repositories/REPO/relations"/>
<link rel="http://identifiers.emc.com/linkrel/relation-types" href="http://localhost:8080/dctm-rest/repositories/REPO/relation-types"/>
<link rel="http://identifiers.emc.com/linkrel/types" href="http://localhost:8080/dctm-rest/repositories/REPO/types"/>
<link rel="http://identifiers.emc.com/linkrel/aspect-types" href="http://localhost:8080/dctm-rest/repositories/REPO/aspect-types"/>
<link rel="http://identifiers.emc.com/linkrel/dql" hreftemplate="http://localhost:8080/dctm-rest/repositories/REPO{?dql}"/>
<link rel="http://identifiers.emc.com/linkrel/search" hreftemplate="http://localhost:8080/dctm-rest/repositories/REPO/search{?collections,facet,include-total,inline,items-per-page,locations,object-type,page,q,sort,timezone,view}"/>
<link rel="http://identifiers.emc.com/linkrel/saved-searches" href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches"/>
<link rel="http://identifiers.emc.com/linkrel/search-templates" href="http://localhost:8080/dctm-rest/repositories/REPO/search-templates"/>
<link rel="http://identifiers.emc.com/linkrel/acls" href="http://localhost:8080/dctm-rest/repositories/REPO/acls"/>
<link rel="http://identifiers.emc.com/linkrel/batches" href="http://localhost:8080/dctm-rest/repositories/REPO/batches"/>
<link rel="http://identifiers.emc.com/linkrel/batch-capabilities" href="http://localhost:8080/dctm-rest/repositories/REPO/batch-capabilities"/>
<link rel="http://identifiers.emc.com/linkrel/lifecycles" href="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles"/>
<link rel="http://identifiers.emc.com/linkrel/snapshots" href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots"/>
<link rel="http://identifiers.emc.com/linkrel/audit-policies" href="http://localhost:8080/dctm-rest/repositories/REPO/audit-policies"/>
</links>
</repository>
Representation: cabinet
Example:
<cabinet
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_cabinet"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_cabinet">
<properties>
<object_name>Administrator</object_name>
<r_object_type>dm_cabinet</r_object_type>
<title>Super User Cabinet</title>
<subject></subject>
<authors xsi:nil="true"/>
<keywords xsi:nil="true"/>
<a_application_type></a_application_type>
<a_status></a_status>
<r_creation_date>2014-12-04T18:15:35.000+00:00</r_creation_date>
<r_modify_date>2014-12-04T18:15:35.000+00:00</r_modify_date>
<r_modifier>REPO</r_modifier>
<r_access_date xsi:nil="true"/>
<a_is_hidden>false</a_is_hidden>
<i_is_deleted>false</i_is_deleted>
<a_retention_date xsi:nil="true"/>
<a_archive>false</a_archive>
<a_compound_architecture></a_compound_architecture>
<a_link_resolved>false</a_link_resolved>
<i_reference_cnt>1</i_reference_cnt>
<i_has_folder>true</i_has_folder>
<i_folder_id xsi:nil="true"/>
<r_composite_id xsi:nil="true"/>
<r_composite_label xsi:nil="true"/>
<r_component_label xsi:nil="true"/>
<r_order_no xsi:nil="true"/>
<r_link_cnt>43</r_link_cnt>
<r_link_high_cnt>0</r_link_high_cnt>
<r_assembled_from_id>0000000000000000</r_assembled_from_id>
<r_frzn_assembly_cnt>0</r_frzn_assembly_cnt>
<r_has_frzn_assembly>false</r_has_frzn_assembly>
<resolution_label></resolution_label>
<r_is_virtual_doc>0</r_is_virtual_doc>
<i_contents_id>0000000000000000</i_contents_id>
<a_content_type></a_content_type>
<r_page_cnt>0</r_page_cnt>
<r_content_size>0</r_content_size>
<a_full_text>true</a_full_text>
<a_storage_type></a_storage_type>
<i_cabinet_id>0c00000180000105</i_cabinet_id>
<owner_name>REPO</owner_name>
<owner_permit>7</owner_permit>
<group_name>docu</group_name>
<group_permit>5</group_permit>
<world_permit>3</world_permit>
<i_antecedent_id>0000000000000000</i_antecedent_id>
<i_chronicle_id>0c00000180000105</i_chronicle_id>
<i_latest_flag>true</i_latest_flag>
<r_lock_owner></r_lock_owner>
<r_lock_date xsi:nil="true"/>
<r_lock_machine></r_lock_machine>
<log_entry></log_entry>
<r_version_label>
<item>1.0</item>
<item>CURRENT</item>
</r_version_label>
<i_branch_cnt>0</i_branch_cnt>
<i_direct_dsc>false</i_direct_dsc>
<r_immutable_flag>false</r_immutable_flag>
<r_frozen_flag>false</r_frozen_flag>
<r_has_events>false</r_has_events>
<acl_domain>REPO</acl_domain>
<acl_name>dm_4500000180000100</acl_name>
<a_special_app></a_special_app>
<i_is_reference>false</i_is_reference>
<r_creator_name>REPO</r_creator_name>
<r_is_public>true</r_is_public>
<r_policy_id>0000000000000000</r_policy_id>
<r_resume_state>0</r_resume_state>
<r_current_state>0</r_current_state>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<a_effective_date xsi:nil="true"/>
<a_expiration_date xsi:nil="true"/>
<a_publish_formats xsi:nil="true"/>
<a_effective_label xsi:nil="true"/>
<a_effective_flag xsi:nil="true"/>
<a_category></a_category>
<language_code></language_code>
<a_is_template>false</a_is_template>
<a_controlling_app></a_controlling_app>
<r_full_content_size>0.0</r_full_content_size>
<a_extended_properties xsi:nil="true"/>
<a_is_signed>false</a_is_signed>
<a_last_review_date xsi:nil="true"/>
<i_retain_until xsi:nil="true"/>
<r_aspect_name xsi:nil="true"/>
<i_retainer_id xsi:nil="true"/>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>1</i_vstamp>
<r_folder_path>
<item>/Administrator</item>
</r_folder_path>
<i_ancestor_id>
<item>0c00000180000105</item>
</i_ancestor_id>
<is_private>false</is_private>
<r_object_id>0c00000180000105</r_object_id>
</properties>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000105"/>
<link rel="http://identifiers.emc.com/linkrel/folders"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000105/folders"/>
<link rel="http://identifiers.emc.com/linkrel/documents"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000105/documents"/>
<link rel="http://identifiers.emc.com/linkrel/objects"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000105/objects"/>
<link rel="http://identifiers.emc.com/linkrel/child-links"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000105/child-links"/>
<link rel="http://identifiers.emc.com/linkrel/relations"
href="http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=0c00000180000105"/>
</links>
</cabinet>
Representation: folder
Example:
<folder
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://identifiers.emc.com/vocab/documentum" xsi:type="dm_folder"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_folder">
<properties>
<object_name>restFolder-28ed6374-1e72-433b-894b-4cd700cd24b3</object_name>
<r_object_type>dm_folder</r_object_type>
<title></title>
<subject></subject>
<authors xsi:nil="true"/>
<keywords xsi:nil="true"/>
<a_application_type></a_application_type>
<a_status></a_status>
<r_creation_date>2015-03-19T01:31:53.000+00:00</r_creation_date>
<r_modify_date>2015-03-19T01:31:53.000+00:00</r_modify_date>
<r_modifier>dave</r_modifier>
<r_access_date xsi:nil="true"/>
<a_is_hidden>false</a_is_hidden>
<i_is_deleted>false</i_is_deleted>
<a_retention_date xsi:nil="true"/>
<a_archive>false</a_archive>
<a_compound_architecture></a_compound_architecture>
<a_link_resolved>false</a_link_resolved>
<i_reference_cnt>1</i_reference_cnt>
<i_has_folder>true</i_has_folder>
<i_folder_id>
<item>0c00000180000107</item>
</i_folder_id>
<r_composite_id xsi:nil="true"/>
<r_composite_label xsi:nil="true"/>
<r_component_label xsi:nil="true"/>
<r_order_no xsi:nil="true"/>
<r_link_cnt>0</r_link_cnt>
<r_link_high_cnt>0</r_link_high_cnt>
<r_assembled_from_id>0000000000000000</r_assembled_from_id>
<r_frzn_assembly_cnt>0</r_frzn_assembly_cnt>
<r_has_frzn_assembly>false</r_has_frzn_assembly>
<resolution_label></resolution_label>
<r_is_virtual_doc>0</r_is_virtual_doc>
<i_contents_id>0000000000000000</i_contents_id>
<a_content_type></a_content_type>
<r_page_cnt>0</r_page_cnt>
<r_content_size>0</r_content_size>
<a_full_text>true</a_full_text>
<a_storage_type></a_storage_type>
<i_cabinet_id>0c00000180000107</i_cabinet_id>
<owner_name>dave</owner_name>
<owner_permit>7</owner_permit>
<group_name></group_name>
<group_permit>5</group_permit>
<world_permit>3</world_permit>
<i_antecedent_id>0000000000000000</i_antecedent_id>
<i_chronicle_id>0b00000180011a3a</i_chronicle_id>
<i_latest_flag>true</i_latest_flag>
<r_lock_owner></r_lock_owner>
<r_lock_date xsi:nil="true"/>
<r_lock_machine></r_lock_machine>
<log_entry></log_entry>
<r_version_label>
<item>1.0</item>
<item>CURRENT</item>
</r_version_label>
<i_branch_cnt>0</i_branch_cnt>
<i_direct_dsc>false</i_direct_dsc>
<r_immutable_flag>false</r_immutable_flag>
<r_frozen_flag>false</r_frozen_flag>
<r_has_events>false</r_has_events>
<acl_domain>dave</acl_domain>
<acl_name>dm_4500000180000914</acl_name>
<a_special_app></a_special_app>
<i_is_reference>false</i_is_reference>
<r_creator_name>dave</r_creator_name>
<r_is_public>true</r_is_public>
<r_policy_id>0000000000000000</r_policy_id>
<r_resume_state>0</r_resume_state>
<r_current_state>0</r_current_state>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<a_effective_date xsi:nil="true"/>
<a_expiration_date xsi:nil="true"/>
<a_publish_formats xsi:nil="true"/>
<a_effective_label xsi:nil="true"/>
<a_effective_flag xsi:nil="true"/>
<a_category></a_category>
<language_code></language_code>
<a_is_template>false</a_is_template>
<a_controlling_app></a_controlling_app>
<r_full_content_size>0.0</r_full_content_size>
<a_extended_properties xsi:nil="true"/>
<a_is_signed>false</a_is_signed>
<a_last_review_date xsi:nil="true"/>
<i_retain_until xsi:nil="true"/>
<r_aspect_name xsi:nil="true"/>
<i_retainer_id xsi:nil="true"/>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>0</i_vstamp>
<r_folder_path>
<item>/Temp/restFolder-28ed6374-1e72-433b-894b-4cd700cd24b3</item>
</r_folder_path>
<i_ancestor_id>
<item>0b00000180011a3a</item>
<item>0c00000180000107</item>
</i_ancestor_id>
<r_object_id>0b00000180011a3a</r_object_id>
</properties>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a"/>
<link rel="http://identifiers.emc.com/linkrel/parent-links"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0b00000180011a3a/parent-links"/>
<link rel="parent" title="0c00000180000107"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107"/>
<link rel="http://identifiers.emc.com/linkrel/folders"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a/folders"/>
<link rel="http://identifiers.emc.com/linkrel/documents"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a/documents"/>
<link rel="http://identifiers.emc.com/linkrel/objects"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a/objects"/>
<link rel="http://identifiers.emc.com/linkrel/child-links"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000180011a3a/child-links"/>
<link rel="http://identifiers.emc.com/linkrel/cabinet"
href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000107"/>
<link rel="http://identifiers.emc.com/linkrel/relations"
href="http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=0b00000180011a3a&related-object-role=any"/>
</links>
</folder>
Representation: document
Example:
<document
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="dm_document"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document">
<properties>
<object_name>iig58_Tue_Gal904_1330_Petrofac.pptx</object_name>
<r_object_type>dm_document</r_object_type>
<r_creation_date>2015-03-06T02:10:04.000+00:00</r_creation_date>
<r_modify_date>2017-05-04T02:56:01.000+00:00</r_modify_date>
<r_modifier>dmadmin</r_modifier>
<r_access_date>2015-08-15T04:24:07.000+00:00</r_access_date>
<a_is_hidden>false</a_is_hidden>
<i_is_deleted>false</i_is_deleted>
<a_archive>false</a_archive>
<a_link_resolved>false</a_link_resolved>
<i_reference_cnt>1</i_reference_cnt>
<i_has_folder>true</i_has_folder>
<i_folder_id>
<item>0c0000058000211b</item>
</i_folder_id>
<r_link_cnt>0</r_link_cnt>
<r_link_high_cnt>0</r_link_high_cnt>
<r_assembled_from_id>0000000000000000</r_assembled_from_id>
<r_frzn_assembly_cnt>0</r_frzn_assembly_cnt>
<r_has_frzn_assembly>false</r_has_frzn_assembly>
<r_is_virtual_doc>0</r_is_virtual_doc>
<i_contents_id>0600000580001522</i_contents_id>
<a_content_type>ppt12</a_content_type>
<r_page_cnt>1</r_page_cnt>
<r_content_size>2702978</r_content_size>
<a_full_text>true</a_full_text>
<a_storage_type>filestore_01</a_storage_type>
<i_cabinet_id>0c0000058000211b</i_cabinet_id>
<owner_name>dmadmin</owner_name>
<owner_permit>7</owner_permit>
<group_name>docu</group_name>
<group_permit>5</group_permit>
<world_permit>3</world_permit>
<i_antecedent_id>0000000000000000</i_antecedent_id>
<i_chronicle_id>090000058000250b</i_chronicle_id>
<i_latest_flag>true</i_latest_flag>
<r_version_label>
<item>1.0</item>
<item>CURRENT</item>
</r_version_label>
<i_branch_cnt>0</i_branch_cnt>
<i_direct_dsc>false</i_direct_dsc>
<r_immutable_flag>false</r_immutable_flag>
<r_frozen_flag>false</r_frozen_flag>
<r_has_events>false</r_has_events>
<acl_domain>dmadmin</acl_domain>
<acl_name>dm_4500000580001905</acl_name>
<i_is_reference>false</i_is_reference>
<r_creator_name>dmadmin</r_creator_name>
<r_is_public>true</r_is_public>
<r_policy_id>4600000580004dfb</r_policy_id>
<r_resume_state>-1</r_resume_state>
<r_current_state>0</r_current_state>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<a_is_template>false</a_is_template>
<r_full_content_size>2702978.0</r_full_content_size>
<a_is_signed>false</a_is_signed>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>1</i_vstamp>
<r_object_id>090000058000250b</r_object_id>
</properties>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/documents/090000058000250b"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/documents/090000058000250b"/>
<link rel="http://identifiers.emc.com/linkrel/delete" href="http://localhost:8080/dctm-rest/repositories/REPO/documents/090000058000250b"/>
<link rel="http://identifiers.emc.com/linkrel/parent-links" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/parent-links"/>
<link rel="parent" title="0c0000058000211b" href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c0000058000211b"/>
<link rel="http://identifiers.emc.com/linkrel/cabinet" href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c0000058000211b"/>
<link rel="contents" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/contents"/>
<link rel="http://identifiers.emc.com/linkrel/primary-content" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/contents/content"/>
<link rel="http://identifiers.emc.com/linkrel/checkout" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/lock"/>
<link rel="version-history" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/versions"/>
<link rel="http://identifiers.emc.com/linkrel/current-version" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/versions/current"/>
<link rel="http://identifiers.emc.com/linkrel/relations" href="http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=090000058000250b&related-object-role=any"/>
<link rel="http://identifiers.emc.com/linkrel/object-aspects" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/aspects"/>
<link rel="http://identifiers.emc.com/linkrel/permission-set" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/permission-set"/>
<link rel="http://identifiers.emc.com/linkrel/permissions" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/permissions"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-conversion" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/vd-nodes"/>
<link rel="http://identifiers.emc.com/linkrel/comments" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/comments"/>
<link rel="http://identifiers.emc.com/linkrel/attachable-lifecycles" href="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles?object-id=090000058000250b"/>
<link rel="http://identifiers.emc.com/linkrel/lifecycle" href="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfb"/>
<link rel="http://identifiers.emc.com/linkrel/object-lifecycle" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250b/lifecycle"/>
</links>
</document>
Representation: object
Example:
<object
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="dm_document"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document">
<properties>
<object_name>REST-API-TEST-VIRTUAL-DOCUMENT-558234e0-a6d7-462e-bb92-af805886325f</object_name>
<r_object_type>dm_document</r_object_type>
<r_creation_date>2017-05-10T02:50:41.000+00:00</r_creation_date>
<r_modify_date>2017-05-10T02:50:50.000+00:00</r_modify_date>
<r_modifier>dave</r_modifier>
<a_is_hidden>false</a_is_hidden>
<i_is_deleted>false</i_is_deleted>
<a_archive>false</a_archive>
<a_link_resolved>false</a_link_resolved>
<i_reference_cnt>1</i_reference_cnt>
<i_has_folder>true</i_has_folder>
<i_folder_id>
<item>0c00000580001909</item>
</i_folder_id>
<r_link_cnt>3</r_link_cnt>
<r_link_high_cnt>2</r_link_high_cnt>
<r_assembled_from_id>090000058000ac2d</r_assembled_from_id>
<r_frzn_assembly_cnt>0</r_frzn_assembly_cnt>
<r_has_frzn_assembly>false</r_has_frzn_assembly>
<r_is_virtual_doc>1</r_is_virtual_doc>
<i_contents_id>0000000000000000</i_contents_id>
<r_page_cnt>0</r_page_cnt>
<r_content_size>0</r_content_size>
<a_full_text>true</a_full_text>
<i_cabinet_id>0c00000580001909</i_cabinet_id>
<owner_name>dave</owner_name>
<owner_permit>7</owner_permit>
<group_permit>5</group_permit>
<world_permit>3</world_permit>
<i_antecedent_id>0000000000000000</i_antecedent_id>
<i_chronicle_id>090000058000ac2d</i_chronicle_id>
<i_latest_flag>true</i_latest_flag>
<r_version_label>
<item>1.0</item>
<item>CURRENT</item>
</r_version_label>
<i_branch_cnt>0</i_branch_cnt>
<i_direct_dsc>false</i_direct_dsc>
<r_immutable_flag>false</r_immutable_flag>
<r_frozen_flag>false</r_frozen_flag>
<r_has_events>false</r_has_events>
<acl_domain>dave</acl_domain>
<acl_name>dm_4500000580000d07</acl_name>
<i_is_reference>false</i_is_reference>
<r_creator_name>dave</r_creator_name>
<r_is_public>true</r_is_public>
<r_policy_id>0000000000000000</r_policy_id>
<r_resume_state>0</r_resume_state>
<r_current_state>0</r_current_state>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<a_is_template>false</a_is_template>
<r_full_content_size>0.0</r_full_content_size>
<a_is_signed>false</a_is_signed>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>5</i_vstamp>
<r_object_id>090000058000ac2d</r_object_id>
</properties>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d"/>
<link rel="http://identifiers.emc.com/linkrel/delete" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d"/>
<link rel="canonical" href="http://localhost:8080/dctm-rest/repositories/REPO/documents/090000058000ac2d"/>
<link rel="http://identifiers.emc.com/linkrel/parent-links" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/parent-links"/>
<link rel="parent" title="0c00000580001909" href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001909"/>
<link rel="http://identifiers.emc.com/linkrel/cabinet" href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000580001909"/>
<link rel="contents" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/contents"/>
<link rel="http://identifiers.emc.com/linkrel/primary-content" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/contents/content"/>
<link rel="http://identifiers.emc.com/linkrel/checkout" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/lock"/>
<link rel="version-history" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/versions"/>
<link rel="http://identifiers.emc.com/linkrel/current-version" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/versions/current"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-nodes" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/vd-nodes"/>
<link rel="http://identifiers.emc.com/linkrel/relations" href="http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=090000058000ac2d&related-object-role=any"/>
<link rel="http://identifiers.emc.com/linkrel/object-aspects" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/aspects"/>
<link rel="http://identifiers.emc.com/linkrel/permission-set" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/permission-set"/>
<link rel="http://identifiers.emc.com/linkrel/permissions" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/permissions"/>
<link rel="http://identifiers.emc.com/linkrel/comments" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/comments"/>
<link rel="http://identifiers.emc.com/linkrel/attachable-lifecycles" href="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles?object-id=090000058000ac2d"/>
<link rel="http://identifiers.emc.com/linkrel/object-lifecycle" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2d/lifecycle"/>
</links>
</object>
Representation: object-copy-ref
Example:
<object xmlns="http://identifiers.emc.com/vocab/documentum"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a6f" deep-copy="true" replicate-vd-children="true" retain-acl="true">
<properties>
<object_name>MyDoc Updated</object_name>
</properties>
</object>
Representation: object-ref
Example:
<object xmlns="http://identifiers.emc.com/vocab/documentum"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a6f"/>
Representation: child-folder-link
Example:
<folder-link
xmlns="http://identifiers.emc.com/vocab/documentum"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70"
child-id="0900000180011a70"
parent-id="0c00000180000107">
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107/child-links/0900000180011a70"/>
</links>
</folder-link>
Representation: parent-folder-link
Example:
<folder-link
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000107"
child-id="0900000180011a70"
parent-id="0c00000180000107">
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a70/parent-links/0c00000180000107"/>
</links>
</folder-link>
Representation: content
Example:
<content
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://identifiers.emc.com/vocab/documentum"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/">
<properties>
<object_name>Blank PowerPoint Pre-3.0 Presentation</object_name>
<r_object_id>0600000180000114</r_object_id>
<rendition>0</rendition>
<full_format>powerpoint</full_format>
<format>27000001800001ac</format>
<full_content_size>14848.0</full_content_size>
<set_time>2014-12-04T10:18:20.000+00:00</set_time>
<i_vstamp>0</i_vstamp>
<mime_type>application/vnd.ms-powerpoint</mime_type>
<dos_extension>ppt</dos_extension>
<format_name>powerpoint</format_name>
<parent_id>
<item>09000001800001da</item>
</parent_id>
<page>
<item>0</item>
</page>
<page_modifier>
<item xsi:nil="true"/>
</page_modifier>
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da/contents/content?format=powerpoint&modifier=&page=0"/>
<link rel="enclosure" title="ACS"
href="http://contentserver72:9080/ACS/servlet/ACS?command=read&version=2.3&docbaseid=&...&expire_delta=360"/>
<link rel="http://identifiers.emc.com/linkrel/content-media" title="ACS"
href="http://contentserver72:9080/ACS/servlet/ACS?command=read&version=2.3&docbaseid=000001&...&expire_delta=360"/>
<link rel="parent" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800001da"/>
</links>
</content>
Representation: current-version
Example:
<object
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="dm_document"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document">
<properties>
<object_name>REST-API-TEST-DOC-TO-CHECK-OUT</object_name>
<r_object_type>dm_document</r_object_type>
<title></title>
<subject></subject>
<authors xsi:nil="true"/>
<keywords xsi:nil="true"/>
<a_application_type></a_application_type>
<a_status></a_status>
<r_creation_date>2014-12-10T03:41:31.000+00:00</r_creation_date>
<r_modify_date>2014-12-10T03:41:31.000+00:00</r_modify_date>
<r_modifier>dave</r_modifier>
<r_access_date xsi:nil="true"/>
<a_is_hidden>false</a_is_hidden>
<i_is_deleted>false</i_is_deleted>
<a_retention_date xsi:nil="true"/>
<a_archive>false</a_archive>
<a_compound_architecture></a_compound_architecture>
<a_link_resolved>false</a_link_resolved>
<i_reference_cnt>1</i_reference_cnt>
<i_has_folder>true</i_has_folder>
<i_folder_id>
<item>0c00000180000107</item>
</i_folder_id>
<r_composite_id xsi:nil="true"/>
<r_composite_label xsi:nil="true"/>
<r_component_label xsi:nil="true"/>
<r_order_no xsi:nil="true"/>
<r_link_cnt>0</r_link_cnt>
<r_link_high_cnt>0</r_link_high_cnt>
<r_assembled_from_id>0000000000000000</r_assembled_from_id>
<r_frzn_assembly_cnt>0</r_frzn_assembly_cnt>
<r_has_frzn_assembly>false</r_has_frzn_assembly>
<resolution_label></resolution_label>
<r_is_virtual_doc>0</r_is_virtual_doc>
<i_contents_id>0000000000000000</i_contents_id>
<a_content_type></a_content_type>
<r_page_cnt>0</r_page_cnt>
<r_content_size>0</r_content_size>
<a_full_text>true</a_full_text>
<a_storage_type></a_storage_type>
<i_cabinet_id>0c00000180000107</i_cabinet_id>
<owner_name>dave</owner_name>
<owner_permit>7</owner_permit>
<group_name></group_name>
<group_permit>5</group_permit>
<world_permit>3</world_permit>
<i_antecedent_id>0000000000000000</i_antecedent_id>
<i_chronicle_id>0900000180001904</i_chronicle_id>
<i_latest_flag>true</i_latest_flag>
<r_lock_owner>dmadmin</r_lock_owner>
<r_lock_date>2014-12-10T03:41:32.000+00:00</r_lock_date>
<r_lock_machine>minint-mtlda27.corp.opentext.com</r_lock_machine>
<log_entry></log_entry>
<r_version_label>
<item>1.0</item>
<item>CURRENT</item>
</r_version_label>
<i_branch_cnt>0</i_branch_cnt>
<i_direct_dsc>false</i_direct_dsc>
<r_immutable_flag>false</r_immutable_flag>
<r_frozen_flag>false</r_frozen_flag>
<r_has_events>false</r_has_events>
<acl_domain>dave</acl_domain>
<acl_name>dm_4500000180000914</acl_name>
<a_special_app></a_special_app>
<i_is_reference>false</i_is_reference>
<r_creator_name>dave</r_creator_name>
<r_is_public>true</r_is_public>
<r_policy_id>0000000000000000</r_policy_id>
<r_resume_state>0</r_resume_state>
<r_current_state>0</r_current_state>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<a_effective_date xsi:nil="true"/>
<a_expiration_date xsi:nil="true"/>
<a_publish_formats xsi:nil="true"/>
<a_effective_label xsi:nil="true"/>
<a_effective_flag xsi:nil="true"/>
<a_category></a_category>
<language_code></language_code>
<a_is_template>false</a_is_template>
<a_controlling_app></a_controlling_app>
<r_full_content_size>0.0</r_full_content_size>
<a_extended_properties xsi:nil="true"/>
<a_is_signed>false</a_is_signed>
<a_last_review_date xsi:nil="true"/>
<i_retain_until xsi:nil="true"/>
<r_aspect_name xsi:nil="true"/>
<i_retainer_id xsi:nil="true"/>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>1</i_vstamp>
<r_object_id>0900000180001904</r_object_id>
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions/current"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904"/>
<link rel="canonical" href="http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000180001904"/>
<link rel="http://identifiers.emc.com/linkrel/parent-links"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/parent-links"/>
<link rel="parent" title="0c00000180000107"
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000180000107"/>
<link rel="http://identifiers.emc.com/linkrel/cabinet"
href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000180000107"/>
<link rel="contents"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/contents"/>
<link rel="http://identifiers.emc.com/linkrel/primary-content"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/contents/content"/>
<link rel="http://identifiers.emc.com/linkrel/checkin-next-major"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions?object-id=0900000180001904&version-policy=next-major"/>
<link rel="http://identifiers.emc.com/linkrel/checkin-next-minor"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions?object-id=0900000180001904&version-policy=next-minor"/>
<link rel="http://identifiers.emc.com/linkrel/cancel-checkout"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/lock"/>
<link rel="version-history"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions"/>
<link rel="http://identifiers.emc.com/linkrel/current-version"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180001904/versions/current"/>
<link rel="http://identifiers.emc.com/linkrel/relations"
href="http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=0900000180001904&related-object-role=any"/>
</links>
</object>
Representation: format
Example:
<format
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_format"
xmlns="http://identifiers.emc.com/vocab/documentum" xsi:type="dm_format">
<properties>
<name>123w</name>
<description>Lotus 1-2-3 r5</description>
<can_index>true</can_index>
<topic_transform>false</topic_transform>
<topic_filter/>
<topic_format>0000000000000000</topic_format>
<topic_format_name/>
<mac_creator>????</mac_creator>
<mac_type>LWKS</mac_type>
<dos_extension>wk4</dos_extension>
<is_hidden>false</is_hidden>
<win31_app/>
<com_class_id/>
<mime_type>application/vnd.lotus-1-2-3</mime_type>
<icon_index>0</icon_index>
<richmedia_enabled>false</richmedia_enabled>
<asset_class/>
<default_storage>0000000000000000</default_storage>
<filename_modifier/>
<format_class xsi:nil="true"/>
<a_page_plugin_name/>
<i_is_replica>false</i_is_replica>
<i_vstamp>0</i_vstamp>
<r_object_id>2700000580000102</r_object_id>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/formats/123w" rel="self"/>
</links>
</format>
Representation: relation
Example:
<relation
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_relation"
xmlns="http://identifiers.emc.com/vocab/documentum" xsi:type="dm_relation">
<properties>
<relation_name>dm_bof_dependencies</relation_name>
<parent_id>0b0000058000078e</parent_id>
<child_id>0b00000580000788</child_id>
<child_label/>
<permanent_link>true</permanent_link>
<order_no>0</order_no>
<effective_date xsi:nil="true"/>
<expiration_date xsi:nil="true"/>
<description/>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>2</i_vstamp>
<r_object_id>3700000580000100</r_object_id>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relations/3700000580000100" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relation-types/dm_bof_dependencies"
rel="http://identifiers.emc.com/linkrel/relation-type"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0b0000058000078e" rel="parent"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0b00000580000788" rel="child"/>
</links>
</relation>
Representation: relation-type
Example:
<relation-type
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_relation_type"
xmlns="http://identifiers.emc.com/vocab/documentum" xsi:type="dm_relation_type">
<properties>
<relation_name>ACL REPLICATION</relation_name>
<security_type>SYSTEM</security_type>
<parent_type>dm_document</parent_type>
<child_type>dm_document</child_type>
<description>Relation Type for ACL Replication</description>
<direction_kind>0</direction_kind>
<integrity_kind>0</integrity_kind>
<parent_child_label xsi:nil="true"/>
<child_parent_label xsi:nil="true"/>
<permanent_link>false</permanent_link>
<copy_child>0</copy_child>
<a_controlling_kind/>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>0</i_vstamp>
<r_object_id>3800000580000116</r_object_id>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relation-types/ACL%2BREPLICATION" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relations?relation-name=ACL%20REPLICATION"
rel="http://identifiers.emc.com/linkrel/relations"/>
</links>
</relation-type>
Representation: type
Example:
<type category="standard" ignore-parent-constraints="false"
label="Sysobject" name="dm_sysobject"
xmlns="http://identifiers.emc.com/vocab/documentum" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<auditable-system-events>
<event>dm_all</event>
<event>dm_checkin</event>
<event>dm_checkout</event>
<event>dm_destroy</event>
<event>dm_fetch</event>
<event>dm_lock</event>
<event>dm_prune</event>
<event>dm_save</event>
<event>dm_unlock</event>
<event>dm_route</event>
<event>dm_forward</event>
<event>dm_reverse</event>
<event>dm_reassign</event>
<event>dm_halt</event>
<event>dm_end</event>
<event>dm_signoff</event>
<event>dm_acquire</event>
<event>dm_force</event>
<event>dm_pause</event>
<event>dm_resume</event>
<event>dm_start</event>
<event>dm_branch</event>
<event>dm_mark</event>
<event>dm_archive</event>
<event>dm_archive_done</event>
<event>dm_restore</event>
<event>dm_restore_done</event>
<event>dm_link</event>
<event>dm_unlink</event>
<event>dm_status</event>
<event>dm_setfile</event>
<event>dm_freeze</event>
<event>dm_unfreeze</event>
<event>dm_bp_promote</event>
<event>dm_bp_demote</event>
<event>dm_bp_attach</event>
<event>dm_bp_suspend</event>
<event>dm_bp_resume</event>
<event>dm_addnote</event>
<event>dm_removenote</event>
<event>dm_assemble</event>
<event>dm_jobstart</event>
<event>dm_unmark</event>
<event>dm_saveasnew</event>
<event>dm_getfile</event>
<event>dm_removecontent</event>
<event>dm_addrendition</event>
<event>dm_removerendition</event>
<event>dm_appendpart</event>
<event>dm_insertpart</event>
<event>dm_removepart</event>
<event>dm_updatepart</event>
<event>dm_checkout_ref</event>
<event>dm_checkin_ref</event>
<event>dm_checkcan_ref</event>
<event>dm_disassemble</event>
<event>dm_adddigsignature</event>
<event>dm_audit</event>
<event>dm_unaudit</event>
<event>dm_addesignature</event>
<event>dm_move_content</event>
<event>dm_addretention</event>
<event>dm_removeretention</event>
<event>dm_addesignature_failed</event>
<event>dm_security_check_failed</event>
</auditable-system-events>
<mapping-tables>
<mapping-table>
<value>dm_info</value>
<display>Info</display>
</mapping-table>
<mapping-table>
<value>dm_general</value>
<display>General</display>
</mapping-table>
<mapping-table>
<value>dm_summary</value>
<display>Summary</display>
</mapping-table>
<mapping-table>
<value>dm_version</value>
<display>Version</display>
</mapping-table>
<mapping-table>
<value>dm_security</value>
<display>Security</display>
</mapping-table>
<mapping-table>
<value>dm_advanced</value>
<display>Advanced</display>
</mapping-table>
</mapping-tables>
<scope-configs>
<scope-config>
<id>6c00000580000100</id>
<scope>
<item>webtop</item>
</scope>
<category>
<item>application</item>
</category>
<display-configs>
<display-config>
<id>6b00000580000100</id>
<name>dm_info</name>
<attribute-source>dm_sysobject</attribute-source>
<fixed-display>false</fixed-display>
<attribute-hints>
<attribute-hint>
<attribute>object_name</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>owner_name</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>r_policy_id</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>r_current_state</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>r_creation_date</attribute>
<display-hint>2</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>r_creator_name</attribute>
<display-hint>2</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>r_modify_date</attribute>
<display-hint>2</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>r_modifier</attribute>
<display-hint>2</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>a_storage_type</attribute>
<display-hint>2</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>i_retain_until</attribute>
<display-hint>2</display-hint>
</attribute-hint>
</attribute-hints>
</display-config>
</display-configs>
</scope-config>
<scope-config>
<id>6c00000580000101</id>
<scope>
<item>DcDesktopClient</item>
</scope>
<category>
<item>application</item>
</category>
<display-configs>
<display-config>
<id>6b00000580000101</id>
<name>dm_general</name>
<attribute-source>dm_sysobject</attribute-source>
<fixed-display>false</fixed-display>
<attribute-hints>
<attribute-hint>
<attribute>object_name</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>r_object_type</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>i_folder_id</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>r_creation_date</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>r_modify_date</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>owner_name</attribute>
<display-hint>0</display-hint>
</attribute-hint>
</attribute-hints>
</display-config>
<display-config>
<id>6b00000580000102</id>
<name>dm_summary</name>
<attribute-source>dm_sysobject</attribute-source>
<fixed-display>false</fixed-display>
<attribute-hints>
<attribute-hint>
<attribute>title</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>subject</attribute>
<display-hint>0</display-hint>
</attribute-hint>
</attribute-hints>
</display-config>
<display-config>
<id>6b00000580000103</id>
<name>dm_security</name>
<attribute-source>dm_sysobject</attribute-source>
<fixed-display>true</fixed-display>
</display-config>
<display-config>
<id>6b00000580000104</id>
<name>dm_advanced</name>
<attribute-source>dm_sysobject</attribute-source>
<fixed-display>false</fixed-display>
<attribute-hints>
<attribute-hint>
<attribute>r_policy_id</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>r_current_state</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>a_storage_type</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>r_object_id</attribute>
<display-hint>0</display-hint>
</attribute-hint>
<attribute-hint>
<attribute>a_is_hidden</attribute>
<display-hint>0</display-hint>
</attribute-hint>
</attribute-hints>
</display-config>
</display-configs>
</scope-config>
</scope-configs>
<properties>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Name" length="255"
name="object_name" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Type" length="32"
name="r_object_type" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Title" length="400"
name="title" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Subject"
length="192" name="subject" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Authors"
length="48" name="authors" notnull="false" readonly="false"
repeating="true" required="false" searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Keywords"
length="48" name="keywords" notnull="false" readonly="false"
repeating="true" required="false" searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Application Type"
length="32" name="a_application_type" notnull="false"
readonly="false" repeating="false" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Status" length="16"
name="a_status" notnull="false" readonly="false"
repeating="false" required="false" searchable="false" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Created"
name="r_creation_date" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="datetime"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Modified"
name="r_modify_date" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="datetime"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Modified By"
length="255" name="r_modifier" notnull="false"
readonly="true" repeating="false" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Accessed"
name="r_access_date" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="datetime"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Hidden"
name="a_is_hidden" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="boolean"/>
<property hidden="true" ignore-immutable="true"
ignore-parent-constraints="false" label="Root Deleted"
name="i_is_deleted" notnull="false" readonly="true"
repeating="false" required="false" searchable="false" type="boolean"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false"
label="Estimated Disposition" name="a_retention_date"
notnull="false" readonly="false" repeating="false"
required="false" searchable="true" type="datetime"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Archive"
name="a_archive" notnull="false" readonly="false"
repeating="false" required="false" searchable="false" type="boolean"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false"
label="Compound Architecture" length="16"
name="a_compound_architecture" notnull="false"
readonly="false" repeating="false" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Link Resolved"
name="a_link_resolved" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="boolean"/>
<property hidden="true" ignore-immutable="true"
ignore-parent-constraints="false" label="Reference Count"
name="i_reference_cnt" notnull="false" readonly="true"
repeating="false" required="false" searchable="false" type="integer"/>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false" label="In Folder"
name="i_has_folder" notnull="false" readonly="true"
repeating="false" required="false" searchable="false" type="boolean"/>
<property hidden="true" ignore-immutable="true"
ignore-parent-constraints="false" label="Parent Folder IDs"
length="16" name="i_folder_id" notnull="false"
readonly="true" repeating="true" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Composite IDs"
length="16" name="r_composite_id" notnull="false"
readonly="true" repeating="true" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Composite Version"
length="32" name="r_composite_label" notnull="false"
readonly="true" repeating="true" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Component Version"
length="32" name="r_component_label" notnull="false"
readonly="true" repeating="true" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Position"
name="r_order_no" notnull="false" readonly="true"
repeating="true" required="false" searchable="false" type="integer"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Link Count"
name="r_link_cnt" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="integer"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Maximum Link Count"
name="r_link_high_cnt" notnull="false" readonly="true"
repeating="false" required="false" searchable="false" type="integer"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Assembled From"
length="16" name="r_assembled_from_id" notnull="false"
readonly="true" repeating="false" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false"
label="Frozen Assembly Count" name="r_frzn_assembly_cnt"
notnull="false" readonly="true" repeating="false"
required="false" searchable="false" type="integer"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false"
label="Has Frozen Assembly" name="r_has_frzn_assembly"
notnull="false" readonly="true" repeating="false"
required="false" searchable="true" type="boolean"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Resolution Version"
length="32" name="resolution_label" notnull="false"
readonly="false" repeating="false" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Virtual Document"
name="r_is_virtual_doc" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="integer"/>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false" label="Content ID"
length="16" name="i_contents_id" notnull="false"
readonly="true" repeating="false" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Format" length="32"
name="a_content_type" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Content File Count"
name="r_page_cnt" notnull="false" readonly="true"
repeating="false" required="false" searchable="false" type="integer"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Size"
name="r_content_size" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="integer"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Full Text Indexed"
name="a_full_text" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="boolean"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Storage Type"
length="64" name="a_storage_type" notnull="false"
readonly="false" repeating="false" required="false"
searchable="false" type="string"/>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false" label="Primary Cabinet"
length="16" name="i_cabinet_id" notnull="false"
readonly="true" repeating="false" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Owner Name"
length="255" name="owner_name" notnull="false"
readonly="false" repeating="false" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Owner Permission"
name="owner_permit" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="integer">
<mapping-tables>
<mapping-table>
<value>1</value>
<display>None</display>
</mapping-table>
<mapping-table>
<value>2</value>
<display>Browse</display>
</mapping-table>
<mapping-table>
<value>3</value>
<display>Read</display>
</mapping-table>
<mapping-table>
<value>4</value>
<display>Relate</display>
</mapping-table>
<mapping-table>
<value>5</value>
<display>Version</display>
</mapping-table>
<mapping-table>
<value>6</value>
<display>Write</display>
</mapping-table>
<mapping-table>
<value>7</value>
<display>Delete</display>
</mapping-table>
</mapping-tables>
</property>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Group Name"
length="255" name="group_name" notnull="false"
readonly="false" repeating="false" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Group Permit"
name="group_permit" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="integer">
<mapping-tables>
<mapping-table>
<value>1</value>
<display>None</display>
</mapping-table>
<mapping-table>
<value>2</value>
<display>Browse</display>
</mapping-table>
<mapping-table>
<value>3</value>
<display>Read</display>
</mapping-table>
<mapping-table>
<value>4</value>
<display>Relate</display>
</mapping-table>
<mapping-table>
<value>5</value>
<display>Version</display>
</mapping-table>
<mapping-table>
<value>6</value>
<display>Write</display>
</mapping-table>
<mapping-table>
<value>7</value>
<display>Delete</display>
</mapping-table>
</mapping-tables>
</property>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="World Permissions"
name="world_permit" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="integer">
<mapping-tables>
<mapping-table>
<value>1</value>
<display>None</display>
</mapping-table>
<mapping-table>
<value>2</value>
<display>Browse</display>
</mapping-table>
<mapping-table>
<value>3</value>
<display>Read</display>
</mapping-table>
<mapping-table>
<value>4</value>
<display>Relate</display>
</mapping-table>
<mapping-table>
<value>5</value>
<display>Version</display>
</mapping-table>
<mapping-table>
<value>6</value>
<display>Write</display>
</mapping-table>
<mapping-table>
<value>7</value>
<display>Delete</display>
</mapping-table>
</mapping-tables>
</property>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false" label="Parent Version"
length="16" name="i_antecedent_id" notnull="false"
readonly="true" repeating="false" required="false"
searchable="false" type="string"/>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false"
label="Version Tree Root Object" length="16"
name="i_chronicle_id" notnull="false" readonly="true"
repeating="false" required="false" searchable="false" type="string"/>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false"
label="Latest Version on Branch" name="i_latest_flag"
notnull="false" readonly="true" repeating="false"
required="false" searchable="true" type="boolean"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Checked Out By"
length="255" name="r_lock_owner" notnull="false"
readonly="true" repeating="false" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Checkout Date"
name="r_lock_date" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="datetime"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Lock Owner's Host"
length="80" name="r_lock_machine" notnull="false"
readonly="true" repeating="false" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="User Comments"
length="120" name="log_entry" notnull="false"
readonly="false" repeating="false" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Version Label"
length="32" name="r_version_label" notnull="false"
readonly="true" repeating="true" required="false"
searchable="true" type="string"/>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false" label="Branch Count"
name="i_branch_cnt" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="integer"/>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false" label="Has Versions"
name="i_direct_dsc" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="boolean"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Is Immutable"
name="r_immutable_flag" notnull="false" readonly="true"
repeating="false" required="false" searchable="false" type="boolean"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Frozen"
name="r_frozen_flag" notnull="false" readonly="true"
repeating="false" required="false" searchable="false" type="boolean"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Has Events"
name="r_has_events" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="boolean"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="ACL Domain"
length="255" name="acl_domain" notnull="false"
readonly="false" repeating="false" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="ACL Name"
length="32" name="acl_name" notnull="false" readonly="false"
repeating="false" required="false" searchable="false" type="string"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false"
label="Special Application" length="32" name="a_special_app"
notnull="false" readonly="false" repeating="false"
required="false" searchable="false" type="string"/>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false" label="Reference"
name="i_is_reference" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="boolean"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Creator Name"
length="255" name="r_creator_name" notnull="false"
readonly="true" repeating="false" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Public"
name="r_is_public" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="boolean"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Lifecycle ID"
length="16" name="r_policy_id" notnull="false"
readonly="true" repeating="false" required="false"
searchable="false" type="string"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Resume to state"
name="r_resume_state" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="integer"/>
<property hidden="false" ignore-immutable="true"
ignore-parent-constraints="false" label="Current State"
name="r_current_state" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="integer"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Alias Set"
length="16" name="r_alias_set_id" notnull="false"
readonly="true" repeating="false" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Effective Date"
name="a_effective_date" notnull="false" readonly="false"
repeating="true" required="false" searchable="true" type="datetime"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Expiration Date"
name="a_expiration_date" notnull="false" readonly="false"
repeating="true" required="false" searchable="true" type="datetime"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Publish Formats"
length="32" name="a_publish_formats" notnull="false"
readonly="false" repeating="true" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Effective Label"
length="32" name="a_effective_label" notnull="false"
readonly="false" repeating="true" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Effective Flag"
length="8" name="a_effective_flag" notnull="false"
readonly="false" repeating="true" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Category"
length="64" name="a_category" notnull="false"
readonly="false" repeating="false" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Language Code"
length="5" name="language_code" notnull="false"
readonly="false" repeating="false" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Template"
name="a_is_template" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="boolean"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false"
label="Controlling Application" length="32"
name="a_controlling_app" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Full Content Size"
name="r_full_content_size" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="float"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false"
label="Extended Properties" length="32"
name="a_extended_properties" notnull="false"
readonly="false" repeating="true" required="false"
searchable="true" type="string"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Is Signed"
name="a_is_signed" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="boolean"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Last Review Date"
name="a_last_review_date" notnull="false" readonly="false"
repeating="false" required="false" searchable="true" type="datetime"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false"
label="Retain Content Until" name="i_retain_until"
notnull="false" readonly="true" repeating="false"
required="false" searchable="true" type="datetime"/>
<property hidden="false" ignore-immutable="false"
ignore-parent-constraints="false" label="Aspect Name"
length="64" name="r_aspect_name" notnull="false"
readonly="true" repeating="true" required="false"
searchable="false" type="string"/>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false" label="Retainer ID"
length="16" name="i_retainer_id" notnull="false"
readonly="true" repeating="true" required="false"
searchable="true" type="string"/>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false" label="Partition Number"
name="i_partition" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="integer"/>
<property hidden="true" ignore-immutable="false"
ignore-parent-constraints="false" label="Is Replica"
name="i_is_replica" notnull="false" readonly="true"
repeating="false" required="false" searchable="true" type="boolean"/>
<property hidden="true" ignore-immutable="true"
ignore-parent-constraints="false" label="Version Stamp"
name="i_vstamp" notnull="false" readonly="true"
repeating="false" required="false" searchable="false" type="integer"/>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject?include-all=true" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types?parent-type=dm_sysobject" rel="http://identifiers.emc.com/linkrel/types"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject/assist-values" rel="http://identifiers.emc.com/linkrel/assist-values"/>
</links>
</type>
Representation: network-location
Example:
<network-location
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_network_location_map"
xmlns="http://identifiers.emc.com/vocab/documentum" xsi:type="dm_network_location_map">
<properties>
<object_name>The Flaming Mountain</object_name>
<r_object_type>dm_network_location_map</r_object_type>
<title/>
<subject/>
<authors xsi:nil="true"/>
<keywords xsi:nil="true"/>
<a_application_type/>
<a_status/>
<r_creation_date>2015-03-03T09:09:52.000+00:00</r_creation_date>
<r_modify_date>2015-03-03T09:09:52.000+00:00</r_modify_date>
<r_modifier>dm_bof_registry</r_modifier>
<r_access_date xsi:nil="true"/>
<a_is_hidden>false</a_is_hidden>
<i_is_deleted>false</i_is_deleted>
<a_retention_date xsi:nil="true"/>
<a_archive>false</a_archive>
<a_compound_architecture/>
<a_link_resolved>false</a_link_resolved>
<i_reference_cnt>1</i_reference_cnt>
<i_has_folder>true</i_has_folder>
<i_folder_id>
<item>0b00000580000118</item>
</i_folder_id>
<r_composite_id xsi:nil="true"/>
<r_composite_label xsi:nil="true"/>
<r_component_label xsi:nil="true"/>
<r_order_no xsi:nil="true"/>
<r_link_cnt>0</r_link_cnt>
<r_link_high_cnt>0</r_link_high_cnt>
<r_assembled_from_id>0000000000000000</r_assembled_from_id>
<r_frzn_assembly_cnt>0</r_frzn_assembly_cnt>
<r_has_frzn_assembly>false</r_has_frzn_assembly>
<resolution_label/>
<r_is_virtual_doc>0</r_is_virtual_doc>
<i_contents_id>0000000000000000</i_contents_id>
<a_content_type/>
<r_page_cnt>0</r_page_cnt>
<r_content_size>0</r_content_size>
<a_full_text>true</a_full_text>
<a_storage_type/>
<i_cabinet_id>0c00000580000106</i_cabinet_id>
<owner_name>dm_bof_registry</owner_name>
<owner_permit>7</owner_permit>
<group_name/>
<group_permit>5</group_permit>
<world_permit>3</world_permit>
<i_antecedent_id>0000000000000000</i_antecedent_id>
<i_chronicle_id>080000058000190c</i_chronicle_id>
<i_latest_flag>true</i_latest_flag>
<r_lock_owner/>
<r_lock_date xsi:nil="true"/>
<r_lock_machine/>
<log_entry/>
<r_version_label>
<item>1.0</item>
<item>CURRENT</item>
</r_version_label>
<i_branch_cnt>0</i_branch_cnt>
<i_direct_dsc>false</i_direct_dsc>
<r_immutable_flag>false</r_immutable_flag>
<r_frozen_flag>false</r_frozen_flag>
<r_has_events>false</r_has_events>
<acl_domain>dm_bof_registry</acl_domain>
<acl_name>dm_4500000580000d02</acl_name>
<a_special_app/>
<i_is_reference>false</i_is_reference>
<r_creator_name>dm_bof_registry</r_creator_name>
<r_is_public>true</r_is_public>
<r_policy_id>0000000000000000</r_policy_id>
<r_resume_state>0</r_resume_state>
<r_current_state>0</r_current_state>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<a_effective_date xsi:nil="true"/>
<a_expiration_date xsi:nil="true"/>
<a_publish_formats xsi:nil="true"/>
<a_effective_label xsi:nil="true"/>
<a_effective_flag xsi:nil="true"/>
<a_category/>
<language_code/>
<a_is_template>false</a_is_template>
<a_controlling_app/>
<r_full_content_size>0.0</r_full_content_size>
<a_extended_properties xsi:nil="true"/>
<a_is_signed>false</a_is_signed>
<a_last_review_date xsi:nil="true"/>
<i_retain_until xsi:nil="true"/>
<r_aspect_name xsi:nil="true"/>
<i_retainer_id xsi:nil="true"/>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>0</i_vstamp>
<netloc_ident>flaming_moutain</netloc_ident>
<netloc_display_name>The Flaming Mountain</netloc_display_name>
<default_netloc>false</default_netloc>
<begin_near_ip_address>
<item>67.220.50.31</item>
<item>69.89.31.2</item>
</begin_near_ip_address>
<end_near_ip_address>
<item>67.220.50.42</item>
<item>69.89.31.2</item>
</end_near_ip_address>
<ip_address_range xsi:nil="true"/>
<r_object_id>080000058000190c</r_object_id>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/network-locations/flaming_moutain" rel="self"/>
</links>
</network-location>
Representation: user
Example:
<user
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_user"
xmlns="http://identifiers.emc.com/vocab/documentum" xsi:type="dm_user">
<properties>
<user_name>dmadmin</user_name>
<user_os_name/>
<user_address>dmadmin@opentext.com</user_address>
<user_group_name>docu</user_group_name>
<user_privileges>16</user_privileges>
<owner_def_permit>7</owner_def_permit>
<world_def_permit>3</world_def_permit>
<group_def_permit>1</group_def_permit>
<default_folder>/dmadmin</default_folder>
<r_is_group>false</r_is_group>
<user_db_name/>
<description/>
<acl_domain>dmadmin</acl_domain>
<acl_name>dm_4500000580000d08</acl_name>
<user_os_domain/>
<home_docbase>REPO</home_docbase>
<user_state>0</user_state>
<client_capability>8</client_capability>
<globally_managed>false</globally_managed>
<r_modify_date>2015-03-05T07:56:40.000+00:00</r_modify_date>
<user_delegation/>
<workflow_disabled>false</workflow_disabled>
<alias_set_id>0000000000000000</alias_set_id>
<user_source>inline password</user_source>
<user_ldap_dn/>
<user_xprivileges>0</user_xprivileges>
<r_has_events>false</r_has_events>
<failed_auth_attempt>-1</failed_auth_attempt>
<user_admin/>
<user_global_unique_id>REPO:dmadmin</user_global_unique_id>
<user_login_name>dmadmin</user_login_name>
<user_login_domain/>
<user_initials/>
<user_web_page/>
<first_failed_auth_utc_time xsi:nil="true"/>
<last_login_utc_time>2015-03-22T21:30:30.000+00:00</last_login_utc_time>
<deactivated_utc_time xsi:nil="true"/>
<deactivated_ip_addr/>
<restricted_folder_ids xsi:nil="true"/>
<root_log_dir/>
<i_is_replica>false</i_is_replica>
<i_vstamp>2</i_vstamp>
<r_object_id>1100000580000502</r_object_id>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups?user-name=dmadmin" rel="parent"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin/home"
rel="http://identifiers.emc.com/linkrel/default-folder"/>
</links>
</user>
Representation: user-default-folder
Example:
<?xml version="1.0" encoding="UTF-8"?>
<folder
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_cabinet"
xmlns="http://identifiers.emc.com/vocab/documentum" xsi:type="dm_cabinet">
<properties>
<object_name>dmadmin</object_name>
<r_object_type>dm_cabinet</r_object_type>
<title/>
<subject/>
<authors xsi:nil="true"/>
<keywords xsi:nil="true"/>
<a_application_type/>
<a_status/>
<r_creation_date>2015-03-03T09:23:26.000+00:00</r_creation_date>
<r_modify_date>2015-03-03T09:23:26.000+00:00</r_modify_date>
<r_modifier>Administrator</r_modifier>
<r_access_date xsi:nil="true"/>
<a_is_hidden>false</a_is_hidden>
<i_is_deleted>false</i_is_deleted>
<a_retention_date xsi:nil="true"/>
<a_archive>false</a_archive>
<a_compound_architecture/>
<a_link_resolved>false</a_link_resolved>
<i_reference_cnt>1</i_reference_cnt>
<i_has_folder>true</i_has_folder>
<i_folder_id xsi:nil="true"/>
<r_composite_id xsi:nil="true"/>
<r_composite_label xsi:nil="true"/>
<r_component_label xsi:nil="true"/>
<r_order_no xsi:nil="true"/>
<r_link_cnt>160</r_link_cnt>
<r_link_high_cnt>0</r_link_high_cnt>
<r_assembled_from_id>0000000000000000</r_assembled_from_id>
<r_frzn_assembly_cnt>0</r_frzn_assembly_cnt>
<r_has_frzn_assembly>false</r_has_frzn_assembly>
<resolution_label/>
<r_is_virtual_doc>0</r_is_virtual_doc>
<i_contents_id>0000000000000000</i_contents_id>
<a_content_type/>
<r_page_cnt>0</r_page_cnt>
<r_content_size>0</r_content_size>
<a_full_text>true</a_full_text>
<a_storage_type/>
<i_cabinet_id>0c00000580001914</i_cabinet_id>
<owner_name>dmadmin</owner_name>
<owner_permit>7</owner_permit>
<group_name>docu</group_name>
<group_permit>5</group_permit>
<world_permit>3</world_permit>
<i_antecedent_id>0000000000000000</i_antecedent_id>
<i_chronicle_id>0c00000580001914</i_chronicle_id>
<i_latest_flag>true</i_latest_flag>
<r_lock_owner/>
<r_lock_date xsi:nil="true"/>
<r_lock_machine/>
<log_entry/>
<r_version_label>
<item>1.0</item>
<item>CURRENT</item>
</r_version_label>
<i_branch_cnt>0</i_branch_cnt>
<i_direct_dsc>false</i_direct_dsc>
<r_immutable_flag>false</r_immutable_flag>
<r_frozen_flag>false</r_frozen_flag>
<r_has_events>false</r_has_events>
<acl_domain>dmadmin</acl_domain>
<acl_name>dm_4500000580000d09</acl_name>
<a_special_app/>
<i_is_reference>false</i_is_reference>
<r_creator_name>Administrator</r_creator_name>
<r_is_public>true</r_is_public>
<r_policy_id>0000000000000000</r_policy_id>
<r_resume_state>0</r_resume_state>
<r_current_state>0</r_current_state>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<a_effective_date xsi:nil="true"/>
<a_expiration_date xsi:nil="true"/>
<a_publish_formats xsi:nil="true"/>
<a_effective_label xsi:nil="true"/>
<a_effective_flag xsi:nil="true"/>
<a_category/>
<language_code/>
<a_is_template>false</a_is_template>
<a_controlling_app/>
<r_full_content_size>0.0</r_full_content_size>
<a_extended_properties xsi:nil="true"/>
<a_is_signed>false</a_is_signed>
<a_last_review_date xsi:nil="true"/>
<i_retain_until xsi:nil="true"/>
<r_aspect_name xsi:nil="true"/>
<i_retainer_id xsi:nil="true"/>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>1</i_vstamp>
<r_folder_path>
<item>/dmadmin</item>
</r_folder_path>
<i_ancestor_id>
<item>0c00000580001914</item>
</i_ancestor_id>
<is_private>true</is_private>
<r_object_id>0c00000580001914</r_object_id>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin/home" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914" rel="edit"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914"
rel="http://identifiers.emc.com/linkrel/delete"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/cabinets/0c00000580001914" rel="canonical"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914/folders"
rel="http://identifiers.emc.com/linkrel/folders"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914/documents"
rel="http://identifiers.emc.com/linkrel/documents"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914/objects"
rel="http://identifiers.emc.com/linkrel/objects"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/folders/0c00000580001914/child-links"
rel="http://identifiers.emc.com/linkrel/child-links"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/relations?related-object-id=0c00000580001914&related-object-role=any"
rel="http://identifiers.emc.com/linkrel/relations"/>
</links>
</folder>
Representation: group
Example:
<group
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_group"
xmlns="http://identifiers.emc.com/vocab/documentum" xsi:type="dm_group">
<properties>
<group_name>admingroup</group_name>
<group_address/>
<users_names>
<item>REPO_ADMIN</item>
<item>Administrator</item>
</users_names>
<owner_name>Administrator</owner_name>
<is_private>false</is_private>
<description/>
<globally_managed>false</globally_managed>
<r_modify_date>2015-03-03T02:20:31.000+00:00</r_modify_date>
<alias_set_id>0000000000000000</alias_set_id>
<group_source/>
<group_class>group</group_class>
<group_admin/>
<r_has_events>false</r_has_events>
<is_dynamic>false</is_dynamic>
<is_dynamic_default>false</is_dynamic_default>
<group_global_unique_id>REPO:admingroup</group_global_unique_id>
<group_native_room_id>0000000000000000</group_native_room_id>
<group_directory_id>0000000000000000</group_directory_id>
<group_display_name>admingroup</group_display_name>
<is_protected>false</is_protected>
<is_module_only>false</is_module_only>
<i_is_replica>false</i_is_replica>
<i_vstamp>0</i_vstamp>
<r_object_id>1200000580000129</r_object_id>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups?group-name=admingroup" rel="parent"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/groups"
rel="http://identifiers.emc.com/linkrel/groups"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/groups/admingroup/users"
rel="http://identifiers.emc.com/linkrel/users"/>
</links>
</group>
Representation: batch-request
Example:
<batch xmlns="http://identifiers.emc.com/vocab/documentum">
<transactional>true</transactional>
<sequential>true</sequential>
<on-error>FAIL</on-error>
<return-request>false</return-request>
<operations>
<operation id="id-100">
<description>get users</description>
<request method="GET" uri="/repositories/REPO/users?items-per-page=1">
<header name="Content-Type" value="application/vnd.emc.documentum+xml"/>
<header name="Accept" value="application/atom+xml"/>
</request>
</operation>
<operation id="id-101">
<description>create a document</description>
<request method="POST" uri="/repositories/REPO/folders/0c00000580000107/documents">
<header name="Content-Type" value="application/vnd.emc.documentum+xml"/>
<header name="Accept" value="application/vnd.emc.documentum+xml"/>
<entity>
<![CDATA[
<document type="dm_document">
<properties>
<object_name>batch document 1</object_name>
</properties>
</document>
]]>
</entity>
</request>
</operation>
<operation id="id-102">
<description>create a document</description>
<request method="POST" uri="/repositories/REPO/folders/0c00000580000107/documents">
<header name="Content-Type" value="application/vnd.emc.documentum+xml"/>
<header name="Accept" value="application/vnd.emc.documentum+xml"/>
<entity>
<![CDATA[
<document type="dm_document">
<properties>
<object_name>batch document 2</object_name>
</properties>
</document>
]]>
</entity>
</request>
</operation>
</operations>
</batch>
Representation: batch
Example:
<batch xmlns="http://identifiers.emc.com/vocab/documentum">
<transactional>true</transactional>
<sequential>true</sequential>
<on-error>FAIL</on-error>
<return-request>false</return-request>
<state>FINISHED</state>
<submitted>2015-03-23T06:49:47.306+00:00</submitted>
<started>2015-03-23T06:49:47.306+00:00</started>
<finished>2015-03-23T06:49:47.385+00:00</finished>
<owner>dmadmin</owner>
<operations>
<operation id="id-100">
<description>get users</description>
<state>FINISHED</state>
<started>2015-03-23T06:49:47.306+00:00</started>
<finished>2015-03-23T06:49:47.307+00:00</finished>
<response status="200">
<header name="Content-Type" value="application/vnd.emc.documentum+json;charset=UTF-8"/>
<entity>{"id":"http://localhost:8080/dctm-rest/repositories/REPO/batches","title":"Users","author":...</entity>
</response>
</operation>
<operation id="id-101">
<description>create a document</description>
<state>FINISHED</state>
<started>2015-03-23T06:49:47.307+00:00</started>
<finished>2015-03-23T06:49:47.354+00:00</finished>
<response status="201">
<header name="Location"
value="http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000580005a37.xml"/>
<header name="Content-Type" value="application/vnd.emc.documentum+json;charset=UTF-8"/>
<entity>{"name":"document","type":"dm_document","definition":...</entity>
</response>
</operation>
<operation id="id-102">
<description>create a document</description>
<state>FINISHED</state>
<started>2015-03-23T06:49:47.354+00:00</started>
<finished>2015-03-23T06:49:47.385+00:00</finished>
<response status="201">
<header name="Location"
value="http://localhost:8080/dctm-rest/repositories/REPO/documents/0900000580005a38.xml"/>
<header name="Content-Type" value="application/vnd.emc.documentum+json;charset=UTF-8"/>
<entity>{"name":"document","type":"dm_document","definition":...</entity>
</response>
</operation>
</operations>
</batch>
Representation: batch-capabilities
Example:
<batch-capabilities xmlns="http://identifiers.emc.com/vocab/documentum"
>
<transactions>both</transactions>
<sequence>both</sequence>
<on-error>both</on-error>
<batchable-resources>
<batchable-resource>batch-capabilities</batchable-resource>
<batchable-resource>cabinet</batchable-resource>
<batchable-resource>cabinets</batchable-resource>
<batchable-resource>checked-out-objects</batchable-resource>
<batchable-resource>child-folder-link</batchable-resource>
<batchable-resource>child-folder-links</batchable-resource>
<batchable-resource>content</batchable-resource>
<batchable-resource>contents</batchable-resource>
<batchable-resource>current-user</batchable-resource>
<batchable-resource>current-version</batchable-resource>
<batchable-resource>default-folder</batchable-resource>
<batchable-resource>document</batchable-resource>
<batchable-resource>dql-query</batchable-resource>
<batchable-resource>folder</batchable-resource>
<batchable-resource>folder-child-documents</batchable-resource>
<batchable-resource>folder-child-folders</batchable-resource>
<batchable-resource>folder-child-objects</batchable-resource>
<batchable-resource>format</batchable-resource>
<batchable-resource>formats</batchable-resource>
<batchable-resource>group</batchable-resource>
<batchable-resource>group-member-groups</batchable-resource>
<batchable-resource>group-member-users</batchable-resource>
<batchable-resource>groups</batchable-resource>
<batchable-resource>home-document</batchable-resource>
<batchable-resource>lock</batchable-resource>
<batchable-resource>network-location</batchable-resource>
<batchable-resource>network-locations</batchable-resource>
<batchable-resource>object</batchable-resource>
<batchable-resource>parent-folder-link</batchable-resource>
<batchable-resource>parent-folder-links</batchable-resource>
<batchable-resource>product-info</batchable-resource>
<batchable-resource>relation</batchable-resource>
<batchable-resource>relation-type</batchable-resource>
<batchable-resource>relation-types</batchable-resource>
<batchable-resource>relations</batchable-resource>
<batchable-resource>repositories</batchable-resource>
<batchable-resource>repository</batchable-resource>
<batchable-resource>search</batchable-resource>
<batchable-resource>type</batchable-resource>
<batchable-resource>types</batchable-resource>
<batchable-resource>user</batchable-resource>
<batchable-resource>users</batchable-resource>
<batchable-resource>versions</batchable-resource>
</batchable-resources>
<non-batchable-resources>
<non-batchable-resource>batches</non-batchable-resource>
<non-batchable-resource>content-media</non-batchable-resource>
</non-batchable-resources>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/batch-capabilities" rel="self"/>
</links>
</batch-capabilities>
Representation: aspect-type
Example:
<aspect-type
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dmc_aspect_type"
xmlns="http://identifiers.emc.com/vocab/documentum" xsi:type="dmc_aspect_type">
<properties>
<group_name>docu</group_name>
<acl_name>BOF_acl</acl_name>
<world_permit>3</world_permit>
<r_creation_date>2015-03-03T02:29:34.000+00:00</r_creation_date>
<r_object_type>dmc_aspect_type</r_object_type>
<min_dfc_version>6.0</min_dfc_version>
<owner_name>Administrator</owner_name>
<implementation_technology>Java</implementation_technology>
<primary_class>com.documentum.smart.impl.aspect.AnnotatableAspect</primary_class>
<owner_permit>7</owner_permit>
<a_bof_version/>
<a_interfaces xsi:nil="true"/>
<r_object_id>0b000005800005b0</r_object_id>
<r_modify_date>2015-03-03T02:30:13.000+00:00</r_modify_date>
<group_permit>1</group_permit>
<i_folder_id>
<item>0b00000580000180</item>
</i_folder_id>
<r_folder_path>
<item>/System/Modules/Aspect/dm_annotatable</item>
</r_folder_path>
<object_name>dm_annotatable</object_name>
<target_object_type xsi:nil="true"/>
<r_creator_name>Administrator</r_creator_name>
<r_modifier>Administrator</r_modifier>
<acl_domain>REPO_ADMIN</acl_domain>
<a_module_type>Aspect</a_module_type>
<attr_name>
<item>annotation_name</item>
<item>module_name</item>
<item>annotation_metadata</item>
<item>i_partition</item>
</attr_name>
<attr_repeating>
<item>true</item>
<item>true</item>
<item>true</item>
<item>false</item>
</attr_repeating>
<attr_type>
<item>string</item>
<item>string</item>
<item>string</item>
<item>integer</item>
</attr_type>
<attr_length>
<item>255</item>
<item>255</item>
<item>1024</item>
<item xsi:nil="true"/>
</attr_length>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/dm_annotatable" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types/dmi_03000005800001d3"
rel="http://identifiers.emc.com/linkrel/type"/>
</links>
</aspect-type>
Representation: object-aspects
Example:
<object-aspects xmlns="http://identifiers.emc.com/vocab/documentum">
<aspect>dm_annotatable</aspect>
<aspect>dm_checkin_control</aspect>
<aspect>dm_version_behavior</aspect>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003d42/aspects" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003d42/aspects/dm_annotatable"
rel="http://identifiers.emc.com/linkrel/delete" title="dm_annotatable"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/dm_annotatable"
rel="http://identifiers.emc.com/linkrel/aspect-type" title="dm_annotatable"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003d42/aspects/dm_checkin_control"
rel="http://identifiers.emc.com/linkrel/delete" title="dm_checkin_control"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/dm_checkin_control"
rel="http://identifiers.emc.com/linkrel/aspect-type" title="dm_checkin_control"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580003d42/aspects/dm_version_behavior"
rel="http://identifiers.emc.com/linkrel/delete" title="dm_version_behavior"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/dm_version_behavior"
rel="http://identifiers.emc.com/linkrel/aspect-type" title="dm_version_behavior"/>
</links>
</object-aspects>
Representation: acl
Example:
<acl
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://identifiers.emc.com/vocab/documentum" xsi:type="dm_acl"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl">
<properties>
<object_name>dm_4500000580000d07</object_name>
<description>dm_4500000580000d07</description>
<owner_name>dave</owner_name>
<r_is_internal>true</r_is_internal>
<r_accessor_name>
<item>dm_world</item>
<item>dm_owner</item>
<item>dm_group</item>
</r_accessor_name>
<r_accessor_permit>
<item>3</item>
<item>7</item>
<item>5</item>
</r_accessor_permit>
<r_accessor_xpermit>
<item>0</item>
<item>0</item>
<item>3</item>
</r_accessor_xpermit>
<r_is_group>
<item>false</item>
<item>false</item>
<item>false</item>
</r_is_group>
<globally_managed>false</globally_managed>
<acl_class>0</acl_class>
<r_has_events>false</r_has_events>
<r_permit_type>
<item>0</item>
<item>0</item>
<item>0</item>
</r_permit_type>
<r_application_permit>
<item></item>
<item></item>
<item></item>
</r_application_permit>
<i_has_required_groups>false</i_has_required_groups>
<i_has_required_group_set>false</i_has_required_group_set>
<i_has_access_restrictions>false</i_has_access_restrictions>
<r_template_id>0000000000000000</r_template_id>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>0</i_vstamp>
<r_object_id>4500000580000d07</r_object_id>
</properties>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07"/>
<link rel="http://identifiers.emc.com/linkrel/associations"
href="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580000d07/associations"/>
</links>
</acl>
Representation: permission-set
Example:
<permission-set xmlns="http://identifiers.emc.com/vocab/documentum">
<permitted>
<permission accessor="dm_world" basic-permission="Read" extend-permissions="EXECUTE_PROC,CHANGE_LOCATION"/>
<permission accessor="dm_owner" basic-permission="Write" extend-permissions="EXECUTE_PROC,CHANGE_LOCATION"/>
<permission accessor="docu" basic-permission="Relate" extend-permissions="EXECUTE_PROC,CHANGE_LOCATION"/>
<permission accessor="Administrator" basic-permission="Read" extend-permissions="EXECUTE_PROC,CHANGE_LOCATION"/>
</permitted>
<restricted>
<permission accessor="dave" basic-permission="Browse" extend-permissions="EXECUTE_PROC,CHANGE_LOCATION"/>
</restricted>
<required-group>
<group>docu</group>
<group>admingroup</group>
</required-group>
<required-group-set>
<group>admingroup</group>
</required-group-set>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250e/permission-set"/>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000250e/permission-set"/>
<link rel="http://identifiers.emc.com/linkrel/acl"
href="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580001d3d"/>
</links>
</permission-set>
Representation: permissions
Example:
<permission
xmlns="http://identifiers.emc.com/vocab/documentum"
accessor="dave" basic-permission="Relate" extend-permissions="EXECUTE_PROC,CHANGE_LOCATION">
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580002507/permissions?accessor=dave"/>
</links>
</permission>
Representation: saved-search
Example:
<saved-search
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="dm_smart_list"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_smart_list.xml">
<properties>
<object_name>search iig</object_name>
<title>this is saved search</title>
<r_creation_date>2015-09-30T01:50:20.000+00:00</r_creation_date>
<r_modify_date>2015-09-30T01:50:20.000+00:00</r_modify_date>
<r_modifier>dmadmin</r_modifier>
<owner_name>dmadmin</owner_name>
<r_is_public>true</r_is_public>
<selected_sources>
<item>REPO</item>
</selected_sources>
<has_results>false</has_results>
<results_count>-1</results_count>
<query_type>query_builder</query_type>
<r_object_id>0800000580004562</r_object_id>
</properties>
<query-document><?xml version='1.0' encoding='UTF-8'?><search...</search>
</query-document>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562.xml"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562.xml"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562.xml"/>
<link rel="http://identifiers.emc.com/linkrel/saved-search-results"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562/results.xml"/>
<link rel="http://identifiers.emc.com/linkrel/search-execution"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/0800000580004562/execution.xml"/>
</links>
</saved-search>
Representation: user-permission-set
Example:
<permission-set xmlns="http://identifiers.emc.com/vocab/documentum">
<permitted>
<permission accessor="dm_world" basic-permission="Read" extend-permissions="EXECUTE_PROC,CHANGE_LOCATION"/>
<permission accessor="dm_owner" basic-permission="Write" extend-permissions="EXECUTE_PROC,CHANGE_LOCATION"/>
<permission accessor="docu" basic-permission="Relate" extend-permissions="EXECUTE_PROC,CHANGE_LOCATION"/>
</permitted>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/users/dave/permission-set"/>
<link rel="http://identifiers.emc.com/linkrel/acl"
href="http://localhost:8080/dctm-rest/repositories/REPO/acls/4500000580001d3d"/>
</links>
</permission-set>
Representation: lightweight-object-reparent
Example:
<object xmlns="http://identifiers.emc.com/vocab/documentum"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180011a6f"/>
Representation: comments
Example:
<feed xmlns="http://www.w3.org/2005/Atom">
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments</id>
<title>Comments on object: 0900000180143717 under parent comment id: 0</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2016-02-01T21:50:18.768+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>
<dm:items-per-page xmlns:dm="http://identifiers.emc.com/vocab/documentum">100</dm:items-per-page>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000001800d86ec/comments"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839</id>
<title></title>
<author>
<name>John Doe</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/John%2BDoe</uri>
</author>
<summary><font color= '#363636' ><font size= '2' ><font face= 'Arial' >The spec looks good. Just two comments<br></font></font></font><ol><li><font color= '#363636' ><font size= '2' ><font face= 'Arial' >Please add a diagram to show the flow.</font></font></font></li><li><font color= '#363636' ><font size= '2' ><font face= 'Arial' >Please clarify the filter criteria.<br></font></font></font></li></ol></summary>
<updated>2016-01-26T15:16:16.000+00:00</updated>
<published>2016-01-26T15:16:16.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839"/>
<content type="application/xml" src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839"/>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324841</id>
<title></title>
<author>
<name>Jane Doe</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/Jane%2BDoe</uri>
</author>
<summary><font face= 'Arial' ><font size= '2' ><font color= '#363636' >Should we also support paging?<br></font></font></font></summary>
<updated>2016-01-26T15:19:57.000+00:00</updated>
<published>2016-01-26T15:19:57.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324841"/>
<content type="application/xml" src="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324841"/>
</entry>
</feed>
Representation: comment
Example:
<comment xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://identifiers.emc.com/vocab/documentum">
<object-id>0800000180143727</object-id>
<comment-id>1324839</comment-id>
<owner-name>John Doe</owner-name>
<creation-date>2016-01-26T15:16:16.000+00:00</creation-date>
<modified-date>2016-01-26T15:16:16.000+00:00</modified-date>
<content-value><font color= '#363636' ><font size= '2' ><font face= 'Arial' >The spec looks good.&nbsp; Just two comments<br></font></font></font><ol><li><font color= '#363636' ><font size= '2' ><font face= 'Arial' >Please add a diagram to show the flow.</font></font></font></li><li><font color= '#363636' ><font size= '2' ><font face= 'Arial' >Please clarify the filter criteria.<br></font></font></font></li></ol></content-value>
<parent-id>0</parent-id>
<title/>
<can-delete>true</can-delete>
<can-reply>true</can-reply>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839"/>
<link rel="parent" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments"/>
<link rel="http://identifiers.emc.com/linkrel/replies"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839/replies"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000180143717/comments/1324839"/>
</links>
</comment>
Representation: current-user-preference
Example:
<?xml version='1.0' encoding='UTF-8' ?>
<preference xmlns="http://identifiers.emc.com/vocab/documentum">
<client>dctm-html5-app</client>
<owner-name>dmadmin</owner-name>
<title>user preference for Documentum HTML5 App</title>
<subject>user preference</subject>
<keywords>
<item>documentum</item>
<item>us</item>
</keywords>
<creation-date>2016-03-02T03:51:13.000+00:00</creation-date>
<modify-date>2016-03-02T03:51:13.000+00:00</modify-date>
<preference-content>{"user-locale":"cn", "timezone":"gmt+8"}</preference-content>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/currentuser-preferences/dctm-html5-app"/>
</links>
</preference>
Representation: lifecycle
Example:
<lifecycle xmlns="http://identifiers.emc.com/vocab/documentum" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>4600000580004dfb</id>
<name>a_docbasic_lifecycle</name>
<owner>dmadmin</owner>
<created>2017-05-03T02:15:21.000+00:00</created>
<modified>2017-05-03T02:15:25.000+00:00</modified>
<implementation-type>DOCBASIC</implementation-type>
<version-labels>
<version-label>1.0</version-label>
<version-label>CURRENT</version-label>
</version-labels>
<status>INSTALLED</status>
<type-inclusions>
<type-inclusion>
<type>dm_document</type>
<include-subtypes>true</include-subtypes>
</type-inclusion>
</type-inclusions>
<states>
<state>
<name>draft</name>
<index>0</index>
<no>0</no>
<exceptional>false</exceptional>
<allow-attach>true</allow-attach>
<allow-schedule>true</allow-schedule>
<allow-return-to-base>false</allow-return-to-base>
<allow-demote>false</allow-demote>
<return-conditions>
<return-condition>ALL</return-condition>
</return-conditions>
</state>
<state>
<name>review</name>
<index>1</index>
<no>1</no>
<exceptional>false</exceptional>
<exception-state>fail</exception-state>
<allow-attach>false</allow-attach>
<allow-schedule>true</allow-schedule>
<allow-return-to-base>true</allow-return-to-base>
<allow-demote>true</allow-demote>
<return-conditions>
<return-condition>CHECKIN</return-condition>
<return-condition>SAVE_AS_NEW</return-condition>
<return-condition>BRANCH</return-condition>
</return-conditions>
<entry-criteria>
<id>550000058000093b</id>
<expression>(((subject = "ok") Or (subject = "action fail")) Or (subject = "post fail"))</expression>
</entry-criteria>
<action>
<id>0800000580004e05</id>
<name>review_fmuzh1p0kpq8ilz5ifvexz actionset procedure for policy a_docbasic_lifecycle</name>
</action>
</state>
<state>
<name>publish</name>
<index>2</index>
<no>2</no>
<exceptional>false</exceptional>
<allow-attach>false</allow-attach>
<allow-schedule>true</allow-schedule>
<allow-return-to-base>true</allow-return-to-base>
<allow-demote>true</allow-demote>
<return-conditions>
<return-condition>BRANCH</return-condition>
</return-conditions>
<entry-criteria>
<id>550000058000093c</id>
<expression>(((subject = "ok") Or (subject = "action fail")) Or (subject = "post fail"))</expression>
</entry-criteria>
<action>
<id>0800000580004e06</id>
<name>publish_2cp0x50b4s+anynusyzqm5 actionset procedure for policy a_docbasic_lifecycle</name>
</action>
</state>
<state>
<name>fail</name>
<index>3</index>
<no>3</no>
<exceptional>true</exceptional>
<allow-attach>false</allow-attach>
<allow-schedule>true</allow-schedule>
<allow-return-to-base>false</allow-return-to-base>
<allow-demote>false</allow-demote>
<return-conditions>
<return-condition>ALL</return-condition>
</return-conditions>
</state>
</states>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfb" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin" rel="http://identifiers.emc.com/linkrel/owner"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document"
rel="http://identifiers.emc.com/linkrel/type" title="dm_document"/>
</links>
</lifecycle>
Representation: object-lifecycle
Example:
<object-lifecycle xmlns="http://identifiers.emc.com/vocab/documentum" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<lifecycle-id>4600000580004dfc</lifecycle-id>
<lifecycle-name>a_java_lifecycle</lifecycle-name>
<current-state>draft</current-state>
<next-state>review</next-state>
<able-to-promote>true</able-to-promote>
<able-to-demote>false</able-to-demote>
<able-to-suspend>false</able-to-suspend>
<able-to-resume>false</able-to-resume>
<schedules>
<schedule action="promote" from="review" to="publish">2017-03-29T11:15:38.000+00:00</schedule>
</schedules>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800061f3/lifecycle" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/4600000580004dfc" rel="http://identifiers.emc.com/linkrel/lifecycle"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800061f3" rel="parent"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800061f3/lifecycle/promotion" rel="http://identifiers.emc.com/linkrel/promotion"/>
</links>
</object-lifecycle>
Representation: virtual-document-relation
Example:
<vd-node
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<parent-id>090000058000ac2d</parent-id>
<chronicle-id>090000058000ac2e</chronicle-id>
<relation-id>0500000580002974</relation-id>
<order-number>1000</order-number>
<binding></binding>
<override-late-binding>false</override-late-binding>
<copy-behavior>REFERENCE</copy-behavior>
<follow-assembly>true</follow-assembly>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ac2e"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"/>
<link rel="http://identifiers.emc.com/linkrel/delete" href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/0500000580002974"/>
</links>
</vd-node>
Representation: snapshot
Example:
<vd-snapshot
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="dm_sysobject" definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject">
<properties>
<object_name>virtual doc ef716ecb-e1d2-4cd2-a312-c09baf05f5a1</object_name>
<r_object_type>dm_sysobject</r_object_type>
<r_creation_date>2017-06-05T02:09:53.000+00:00</r_creation_date>
<r_modify_date>2017-06-05T02:09:53.000+00:00</r_modify_date>
<r_modifier>dmadmin</r_modifier>
<a_is_hidden>false</a_is_hidden>
<i_is_deleted>false</i_is_deleted>
<a_archive>false</a_archive>
<a_link_resolved>false</a_link_resolved>
<i_reference_cnt>1</i_reference_cnt>
<i_has_folder>true</i_has_folder>
<i_folder_id>
<item>0c00000580001914</item>
</i_folder_id>
<r_link_cnt>0</r_link_cnt>
<r_link_high_cnt>0</r_link_high_cnt>
<r_assembled_from_id>0900000580004a02</r_assembled_from_id>
<r_frzn_assembly_cnt>1</r_frzn_assembly_cnt>
<r_has_frzn_assembly>true</r_has_frzn_assembly>
<r_is_virtual_doc>0</r_is_virtual_doc>
<i_contents_id>0000000000000000</i_contents_id>
<r_page_cnt>0</r_page_cnt>
<r_content_size>0</r_content_size>
<a_full_text>true</a_full_text>
<i_cabinet_id>0c00000580001914</i_cabinet_id>
<owner_name>dmadmin</owner_name>
<owner_permit>7</owner_permit>
<group_name>docu</group_name>
<group_permit>5</group_permit>
<world_permit>3</world_permit>
<i_antecedent_id>0000000000000000</i_antecedent_id>
<i_chronicle_id>08000005800049fa</i_chronicle_id>
<i_latest_flag>true</i_latest_flag>
<r_version_label>
<item>1.0</item>
<item>CURRENT</item>
</r_version_label>
<i_branch_cnt>0</i_branch_cnt>
<i_direct_dsc>false</i_direct_dsc>
<r_immutable_flag>true</r_immutable_flag>
<r_frozen_flag>true</r_frozen_flag>
<r_has_events>false</r_has_events>
<acl_domain>dmadmin</acl_domain>
<acl_name>dm_4500000580001e68</acl_name>
<i_is_reference>false</i_is_reference>
<r_creator_name>dmadmin</r_creator_name>
<r_is_public>true</r_is_public>
<r_policy_id>0000000000000000</r_policy_id>
<r_resume_state>0</r_resume_state>
<r_current_state>0</r_current_state>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<a_is_template>false</a_is_template>
<r_full_content_size>0.0</r_full_content_size>
<a_is_signed>false</a_is_signed>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>5</i_vstamp>
<r_object_id>08000005800049fa</r_object_id>
</properties>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580004a02"/>
<link rel="http://identifiers.emc.com/linkrel/snapshot-nodes" href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa/vd-nodes"/>
<link rel="http://identifiers.emc.com/linkrel/unfreeze" href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa/frozen"/>
</links>
</vd-snapshot>
Representation: snapshot-frozen
Example:
<vd-snapshot
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="dm_sysobject" definition="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject">
<properties>
<object_name>virtual doc ef716ecb-e1d2-4cd2-a312-c09baf05f5a1</object_name>
<r_object_type>dm_sysobject</r_object_type>
<r_creation_date>2017-06-05T02:09:53.000+00:00</r_creation_date>
<r_modify_date>2017-06-05T02:09:53.000+00:00</r_modify_date>
<r_modifier>dmadmin</r_modifier>
<a_is_hidden>false</a_is_hidden>
<i_is_deleted>false</i_is_deleted>
<a_archive>false</a_archive>
<a_link_resolved>false</a_link_resolved>
<i_reference_cnt>1</i_reference_cnt>
<i_has_folder>true</i_has_folder>
<i_folder_id>
<item>0c00000580001914</item>
</i_folder_id>
<r_link_cnt>0</r_link_cnt>
<r_link_high_cnt>0</r_link_high_cnt>
<r_assembled_from_id>0900000580004a02</r_assembled_from_id>
<r_frzn_assembly_cnt>1</r_frzn_assembly_cnt>
<r_has_frzn_assembly>true</r_has_frzn_assembly>
<r_is_virtual_doc>0</r_is_virtual_doc>
<i_contents_id>0000000000000000</i_contents_id>
<r_page_cnt>0</r_page_cnt>
<r_content_size>0</r_content_size>
<a_full_text>true</a_full_text>
<i_cabinet_id>0c00000580001914</i_cabinet_id>
<owner_name>dmadmin</owner_name>
<owner_permit>7</owner_permit>
<group_name>docu</group_name>
<group_permit>5</group_permit>
<world_permit>3</world_permit>
<i_antecedent_id>0000000000000000</i_antecedent_id>
<i_chronicle_id>08000005800049fa</i_chronicle_id>
<i_latest_flag>true</i_latest_flag>
<r_version_label>
<item>1.0</item>
<item>CURRENT</item>
</r_version_label>
<i_branch_cnt>0</i_branch_cnt>
<i_direct_dsc>false</i_direct_dsc>
<r_immutable_flag>true</r_immutable_flag>
<r_frozen_flag>true</r_frozen_flag>
<r_has_events>false</r_has_events>
<acl_domain>dmadmin</acl_domain>
<acl_name>dm_4500000580001e68</acl_name>
<i_is_reference>false</i_is_reference>
<r_creator_name>dmadmin</r_creator_name>
<r_is_public>true</r_is_public>
<r_policy_id>0000000000000000</r_policy_id>
<r_resume_state>0</r_resume_state>
<r_current_state>0</r_current_state>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<a_is_template>false</a_is_template>
<r_full_content_size>0.0</r_full_content_size>
<a_is_signed>false</a_is_signed>
<i_partition>0</i_partition>
<i_is_replica>false</i_is_replica>
<i_vstamp>5</i_vstamp>
<r_object_id>08000005800049fa</r_object_id>
</properties>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa/frozen"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580004a02"/>
<link rel="canonical" href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa"/>
<link rel="http://identifiers.emc.com/linkrel/unfreeze" href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/08000005800049fa/frozen"/>
</links>
</vd-snapshot>
Media Type: application/www-form-urlencoded
| Representations |
|---|
| dql-query-request |
Representation: dql-query-request
Example:
dql=select%20r_object_id,object_name%20from%20dm_document&items-per-page=100&page=1
Media Type: multipart/form-data
| Representations |
|---|
| create-contentful-object-request |
| create-contentful-document-request |
Representation: create-contentful-object-request
The request body is a multipart message that must conform to RFC 2046. A multipart/form-data or multipart/mixed message contains a series of parts. This series must conform to the following rules:
- The series must cotnain two parts.
-
The first part in the series must contain the metadata for the document to
be created. Content-Type for the first part must be one of
the following values:
- appliction/vnd.emc.documentum+json (default)
- application/vnd.emc.documentum+xml
- Each part in the series must contain a Content-Disposition header. The header's disposition type must be form-data. The disposition must contain a parameter titled name, which specifices the name of this part.
Example:
--frontier
Content-Disposition: form-data; name="object"
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8
{"properties":{"r_object_type": "dm_sysobject", "object_name": "readme.txt"}}
--frontier
Content-Disposition: form-data; name="content"
Content-Type: plain/text; charset=UTF-8
Hello, ReSTer!
--frontier--
Example:
--frontier
Content-Disposition: form-data; name="object"
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8
<object xmlns="http://identifiers.emc.com/vocab/documentum">
<properties>
<object_name>readme.txt</object_name>
<r_object_type>dm_sysobject</r_object_type>
</properties>
</object>
--frontier
Content-Disposition: form-data; name="content"
Content-Type: plain/text; charset=UTF-8
Hello, ReSTer!
--frontier--
Representation: create-contentful-document-request
Example:
--frontier
Content-Disposition: form-data; name="object"
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8
{"properties":{"r_object_type": "dm_document", "object_name": "readme.txt"}}
--frontier
Content-Disposition: form-data; name="content"
Content-Type: plain/text; charset=UTF-8
Hello, ReSTer!
--frontier--
Example:
--frontier
Content-Disposition: form-data; name="object"
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8
<document xmlns="http://identifiers.emc.com/vocab/documentum">
<properties>
<object_name>readme.txt</object_name>
<r_object_type>dm_document</r_object_type>
</properties>
</document>
--frontier
Content-Disposition: form-data; name="content"
Content-Type: plain/text; charset=UTF-8
Hello, ReSTer!
--frontier--
Media Type: multipart/related
| Representations |
|---|
| batch-request |
Representation: batch-request
Operations embedded in a batch request may have binary contents attached, such as content creation, and content checkin. Documentum REST Services leverages the XML-binary Optimized Packaging (XPO) protocol to support multipart operations in batches. As defined in XPO, a multipart batch request must have the Multipart/Related Content-type header. Typically, a multipart batch request contains several portions as shown in the following pattern:
-- boundary
Content-Type: ...
Content-ID: ...
Content-disposition: ...
<batch>
<operations>
<operation id="id-1">
<request>
...
<entity>
...
</entity>
<attachment>
<xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include'
href='cid:id-1-content'/>
</attachment>
</request>
</operation>
<operation id="id-2">
<request>
...
<entity>
...
</entity>
<attachment>
<xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include'
href='cid:id-2-content'/>
</attachment>
</request>
</operation>
...
</operations>
</batch>
-- boundary
Content-Type: ...
Content-ID: id-1-content
Content-disposition: ...
Attachment 1
-- boundary
Content-Type: ...
Content-ID: id-2-content
Content-disposition: ...
Attachment 2
-- boundary
...
-- boundary --
The first portion batch is identical to its counterpart in standard batch requests with the only
addition of an extra attachment element in the request block of each embedded operation. The
attachment element contains a content ID (cid) specifying the binary content to be attached which
is defined in the subsequent portions of the batch request. The sequence of the portions
holding
binary contents must be identical to the sequence they are referenced in the batch portion.Multipart/Related Content-Type Header
The Multipart/Related Content-Type header contains the following parameters:
| Parameters | Descriptions | Required or Not |
|---|---|---|
| boundary | Specifies the boundary used to separate each portion | Required |
| type |
Specifies the media type of the batch request. Valid
values are:
|
Required |
| start | Specified the portion to be processed first by Content ID. If not specified, the first portion is processed first. In a multipart batch request, the start portion must be a batch block. | Not Required |
| start-info |
The media type of the start portion. Valid values are:
|
Required |
Portion Header Set
A portion header set contains the following headers:
| Headers | Descriptions | Required or Not |
|---|---|---|
| Content-Type |
For the start portion batch, this parameter specifies
the media type of the batch request together with
the media type of the start portion in the type
property, for example:
Content-Type: application/xop+xml; type="application/vnd.emc.documentum+xml"
For portions holding binary contents, this parameter
specifies the media type, for example:
Content-Type: text/plain
|
Required |
| Content-ID | Specifies the Content ID of the portion. | Required |
| Content-disposition |
This parameter must be set with the following
pattern:
Content-disposition: form-data;
name=Content ID
Example:
Content-disposition:
form-data; name=id-01-content
|
Required |
Headers in an operation block describe the entity block next to it. Typically, the header set includes a Content-Type header indicating the media type of the content in the entity block and an Accept header indicating the expected media type of the response. A header set in a binary content block also contains a Content-Type header. This Content Type header indicates media type of the binary content. The following excerpt illustrates a multipart request that contains both an entity block and binary content:
...
<operation id="id-100">
<request method="POST"
uri="/repositories/REPO/folders/0c00208080000107/objects">
<header name="Content-Type" value="application/vnd.emc.documentum+xml"/>
<header name="Accept" value="application/vnd.emc.documentum+xml"/>
<entity>
<object><properties><object_name>my-test-doc</object_name>
</properties></object>
</entity>
<attachment><xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include'
href='cid:id-100-content'/></attachment>
</request>
</operation>
...
--frontier
Content-Type: text/plain
Content-ID: id-100-content
Content-disposition: form-data; name=id-100-content
This is the content of id-100
In a scenario where a multipart request does not include an entity block (for example, you upload
binary content without updating any resource property), headers in operation blocks are used
to describe the binary content. In the binary content block, all headers except Content-ID
and
Content-disposition are ignored. As a result, you must specify the media type of the
binary content in
the Content-Type header of the operation block.
In the following example, the media type of this individual request is text/plain
and the REST
server returns the response in application/vnd.emc.documentum+xml as specified in the
operation block.
<operation id="id-100">
<request method="POST"
uri="/repositories/REPO/folders/0c00208080000107/objects">
<header name="Content-Type" value="text/plain"/>
<header name="Accept" value="application/vnd.emc.documentum+xml"/>
<attachment><xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include'
href='cid:id-100-content'/></attachment>
</request>
</operation>
--frontier
Content-Type: text/html
Accept: text/application/vnd.emc.documentum+json
Content-ID: id-100-content
Content-disposition: form-data; name=id-100-content
This is the content of id-100
In a Multipart/Related batch request, you are also allowed to embed requests that
do not contain
attachments. In this scenario, the headers in the operation block describe the entity
block next to them
and no binary content block pertains to the request.
<operation id="id-100">
<request method="POST"
uri="/repositories/REPO/folders/0c00208080000107/objects">
<header name="Content-Type" value="application/vnd.emc.documentum+xml"/>
<header name="Accept" value="application/vnd.emc.documentum+xml"/>
<entity>
<object><properties><object_name>my-test-doc</object_name>
</properties></object>
</entity>
</request>
</operation>
Example:
--frontier
Content-Type: application/jop+json; type="application/vnd.emc.documentum+json"
Content-ID: batch
Content-disposition: form-data; name=batch
{
"return-request" : true,
"operations" :
[
{
"id" : "id-100",
"description" : "create object with content",
"request" :
{
"method" : "POST",
"uri" : "/repositories/REPO/folders/0c00208080000107/objects",
"headers" :
[
{
"name" : "Content-Type",
"value" : "application/vnd.emc.documentum+json"
},
{
"name" : "Accept",
"value" : "application/vnd.emc.documentum+json"
}
],
"entity" : "{\"properties\":{\"object_name\":\"my test object\"}}",
"attachment" : {
"Include" : {
"href" : "cid:id-100-content"
}
}
}
},
{
"id" : "id-100",
"description" : "create object with content",
"request" :
{
"method" : "POST",
"uri" : "/repositories/REPO/folders/0c00208080000107/objects",
"headers" :
[
{
"name" : "Content-Type",
"value" : "application/vnd.emc.documentum+json"
},
{
"name" : "Accept",
"value" : "application/vnd.emc.documentum+json"
}
],
"entity" : "{\"properties\":{\"object_name\":\"my test object\"}}",
"attachment" : {
"Include" : {
"href" : "cid:id-101-content"
}
}
}
}
]
}
--frontier
Content-Type: text/plain
Content-ID: id-100-content
Content-disposition: form-data; name=id-100-content
i'm the content of id-100
--frontier
Content-Type: text/plain
Content-ID: id-101-content
Content-disposition: form-data; name=id-101-content
i'm the content of id-101
--frontier--
Example:
--frontier
Content-Type: application/xop+xml; type="application/vnd.emc.documentum+xml"
Content-ID: batch
Content-disposition: form-data; name=batch
<?xml version="1.0" encoding="UTF-8"?>
<batch>
<transactional>true</transactional>
<sequential>true</sequential>
<operations>
<operation id="id-100">
<request method="POST" uri="/repositories/REPO/folders/0c00000180000107/documents">
<header name="Content-Type" value="application/vnd.emc.documentum+xml"/>
<header name="Accept" value="application/vnd.emc.documentum+xml"/>
<entity>
<document><properties><object_name>my-test-doc</object_name></properties></document>
</entity>
<attachment><xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include' href='cid:id-100-content'/></attachment>
</request>
</operation>
<operation id="id-101">
<request method="POST" uri="/repositories/REPO/folders/0c00000180000107/documents">
<header name="Content-Type" value="application/vnd.emc.documentum+xml"/>
<header name="Accept" value="application/vnd.emc.documentum+xml"/>
<entity>
<document><properties><object_name>my-test2-doc</object_name></properties></document>
</entity>
<attachment><xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include' href='cid:id-101-content'/></attachment>
</request>
</operation>
</operations>
</batch>
--frontier
Content-Type: text/plain
Content-ID: id-100-content
Content-disposition: form-data; name=id-100-content
i'm the content of id-100
--frontier
Content-Type: text/plain
Content-ID: id-101-content
Content-disposition: form-data; name=id-101-content
i'm the content of id-101
--frontier--
Example:
Request header:
{Multipart/Related;boundary=frontier;
type="application/jop+json";
start="batch";
start-info="application/vnd.emc.documentum+json"}
Payload:
--frontier
Content-Type: application/jop+json; type="application/vnd.emc.documentum+json"
Content-ID: batch
Content-disposition: form-data; name=batch
{
"return-request" : true,
"operations" :
[
{
"id" : "id-100",
"description" : "create object with content",
"request" :
{
"method" : "POST",
"uri" : "/repositories/REPO/folders/0c00208080000107/objects",
"headers" :
[
{
"name" : "Content-Type",
"value" : "application/vnd.emc.documentum+json"
},
{
"name" : "Accept",
"value" : "application/vnd.emc.documentum+json"
}
],
"entity" : "{\"properties\":{\"object_name\":\"my test object\"}}",
"attachment" : {
"Include" : {
"href" : "cid:id-100-content"
}
}
}
},
{
"id" : "id-101",
"description" : "create object with content",
"request" :
{
"method" : "POST",
"uri" : "/repositories/REPO/folders/0c00208080000107/objects",
"headers" :
[
{
"name" : "Content-Type",
"value" : "application/vnd.emc.documentum+json"
},
{
"name" : "Accept",
"value" : "application/vnd.emc.documentum+json"
}
],
"entity" : "{\"properties\":{\"object_name\":\"my test object\"}}",
"attachment" : {
"Include" : {
"href" : "cid:id-101-content"
}
}
}
}
]
}
--frontier
Content-Type: text/plain
Content-ID: id-100-content
Content-disposition: form-data; name=id-100-content
i'm the content of id-100
--frontier
Content-Type: text/plain
Content-ID: id-101-content
Content-disposition: form-data; name=id-101-content
i'm the content of id-101
--frontier--
Example:
Request header:
{Multipart/Related;boundary=frontier;
type="application/xop+xml";
start="batch";
start-info="application/vnd.emc.documentum+xml"}
Payload:
--frontier
Content-Type: application/xop+xml; type="application/vnd.emc.documentum+xml"
Content-ID: batch
Content-disposition: form-data; name=batch
<?xml version="1.0" encoding="UTF-8"?>
<batch>
<transactional>true</transactional>
<sequential>true</sequential>
<operations>
<operation id="id-100">
<request method="POST"
uri="/repositories/REPO/folders/0c00208080000107/objects">
<header name="Content-Type" value="application/vnd.emc.documentum+xml"/>
<header name="Accept" value="application/vnd.emc.documentum+xml"/>
<entity>
<object><properties><object_name>my-doc1</object_name>
</properties></object>
</entity>
<attachment><xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include'
href='cid:id-100-content'/></attachment>
</request>
</operation>
<operation id="id-101">
<request method="POST" uri="/repositories/REPO/folders/0c00208080000107/objects">
<header name="Content-Type" value="application/vnd.emc.documentum+xml"/>
<header name="Accept" value="application/vnd.emc.documentum+xml"/>
<entity>
<object><properties><object_name>my-doc2</object_name>
</properties></object>
</entity>
<attachment><xop:Include xmlns:xop='http://www.w3.org/2004/08/xop/include'
href='cid:id-101-content'/></attachment>
</request>
</operation>
</operations>
</batch>
--frontier
Content-Type: text/plain
Content-ID: id-100-content
Content-disposition: form-data; name=id-100-content
This is the content of id-100
--frontier
Content-Type: text/plain
Content-ID: id-101-content
Content-disposition: form-data; name=id-101-content
This is the content of id-101
--frontier--
Resources
| Resource | Description | Methods |
|---|---|---|
| home-doc |
The home document serves as the entry point for the entire REST services. Its billboard
URI is
|
GET |
| product-info |
The product info provides the basic product information about the REST services. |
GET |
| repositories |
The repositories resource models the collection of repositories. |
GET |
| repository |
The Repository resource models the attributes of a repository. |
GET |
| cabinets |
The cabinets resource models the collection of cabinets in the repository. |
GET POST |
| cabinet |
The cabinet resource models a single cabinet in the repository. |
GET POST DELETE |
| folder-child-folders |
The folders resource models the collection of folders under a parent folder. |
GET POST |
| folder |
The folder resource models a single folder in the repository. |
GET POST DELETE |
| folder-child-documents |
The documents resource models the collection of documents under a parent folder. |
GET POST |
| document |
The document resource models a single document in the repository. |
GET POST DELETE |
| folder-child-objects |
The SysObjects resource models the collection of SysObjects under a parent folder. |
GET POST |
| object |
The SysObject resource models a single folder in the repository. |
GET POST DELETE |
| child-folder-links |
The child folder links resource models the collection of folder links under a parent folder. |
GET POST |
| child-folder-link |
The parent folder link resource represents the folder containment relationship between a parent folder and one of its child objects. |
GET DELETE |
| parent-folder-links |
The parent folder links resource models the collection of parent folder links for a specified SysObject. |
GET POST |
| parent-folder-link |
The parent folder link resource models the folder containment relationships between a SysObject and its parent folder. |
GET PUT DELETE |
| contents |
The cabinets resource models the collection of cabinets in the repository. |
GET POST |
| content |
The content resource contains both content attributes and link to the content media. |
GET DELETE |
| content-media |
The content media resource models the media of the primary content or rendition downloading from the REST server, other than from an ACS server or a BOCS server. This resource is especially useful when ACS server or BOCS server is unavailable. |
GET |
| all-versions |
The all versions resource represents a collection of all versions for a given non-folder SysObject. |
GET POST |
| current-version |
The current version resource refers to the CURRENT version of whole object version tree. A version tree have only one CURRENT version. |
GET |
| lock |
The lock resource models the checked out state of a SysObject. |
PUT DELETE |
| checked-out-objects |
The cabinets resource models the collection of cabinets in the repository. |
GET |
| dql-query |
The dql-query resource executes the dql query. |
GET POST |
| default-folder |
The user default folder resource represents the default folder (typically, the home cabinet) for a given user. |
GET |
| batches |
The batches resource models how to create and execute a batch operation. |
POST |
| batch-capabilities |
The batch-capabilities resource models what batch features are implemented. |
GET |
| groups |
The groups resource models the collection of groups in the repository. |
GET POST |
| group |
The group resource models a single group in the repository. |
GET POST DELETE |
| group-member-groups |
The group member groups resrouce represents a collection of sub groups that directly belong to a specified group. |
GET POST |
| group-member-group |
The group member group resource represents a sub group that belong to a specified group. |
DELETE |
| group-member-users |
The group member users resrouce represents a collection of users that belong to a specified group. |
GET POST |
| group-member-user |
The group member user resource represents a group user that belong to a specified group. |
DELETE |
| users |
The users resource models the collection of users in the repository. |
GET POST |
| user |
The user resource models a single user in the repository. |
GET POST DELETE |
| current-user |
The current user resource represents the metadata of a current login user in a repository. |
GET POST |
| formats |
The formats resource represents a collection of dm_format instances stored in a repository. |
GET |
| format |
The format resource models a single format in the repository. |
GET |
| relation-types |
The relation types resource represents a collection of relation type (dm_relation_type and its subtypes) instances in a repository. |
GET |
| relation-type |
The relation-type resource models a single user in the repository. |
GET |
| types |
The types collection resource represents the collection of type objects in a repository. |
GET |
| type |
The type resource represents a type object in a repository. |
GET |
| relations |
The relations resource represents a collection of relations in a repository. |
GET POST |
| relation |
The relation resource represents a single relation instance in a repository. |
GET DELETE |
| network-locations |
The network locations collection resource represents the collection of network locations (instances of dm_network_location_map) in a repository. |
GET |
| network-location |
The network location resource models a single user in the repository. |
GET |
| search |
The search resource can execute full-text search against meta data and contents. |
GET POST |
| aspect-types |
The aspect types collection resource represents the collection of aspect type objects in a repository. |
GET |
| aspect-type |
The aspect type resource represents an aspect type object in a repository. |
GET |
| object-aspects |
The object aspects resource models the attached aspects of an object in the repository. |
GET POST |
| object-aspect |
The object aspect resource models the specified attached aspect of an object in the repository. |
DELETE |
| virtual-document-nodes |
The virtual document nodes resource models the nodes of an virtual document in the repository. |
GET POST |
| saved-searches |
The saved searches resource models collection of saved searches. |
GET POST |
| saved-search |
The saved search resource models a saved search in the repository. |
GET POST DELETE |
| saved-search-results |
The saved search results resource models the cached results of a saved search in the repository. |
GET PUT DELETE |
| saved-search-execution |
The saved search execution resource models the real time results of a saved search in the repository. |
GET |
| acl |
The ACL resource models a single acl in the repository. |
GET POST DELETE |
| acl-associations |
The ACL associations resource models the collection of all the SysObjects that associated with a specified ACL in the repository. |
GET |
| acls |
The ACLs collection resource models the collection of all available ACLs in the repository for the current login user. |
GET POST |
| permission-set |
The permission set resource models the permission set instance of a specific SysObject in the repository. |
GET PUT |
| permissions |
The permission view resource models the computed permissions on a specific SysObject for a specified accessor. |
GET |
| user-permission-set |
The associated permission set resource models the permission set instance of a specified user in the repository. |
GET |
| search-template |
The search template resource models a search template in the repository. |
GET DELETE |
| search-templates |
The search templates resource models collection of search templates. |
GET POST POST |
| search-template-execution |
The search template execution resource models the real time results of a search template in the repository. |
POST |
| current-user-preferences |
The current user preferences resource models the preferences for current user in the repository. |
GET POST |
| current-user-preference |
The current user preference resource models the specified preference for current user in the repository. |
GET POST DELETE |
| type-value-assistances |
The type value assistances resource models the assist values for specified type in the repository. |
POST |
| object-lightweight-objects |
The object lightweight objects resource models the collection of lightweight SysObjects of a shared parent. |
GET POST |
| object-parent |
The object parent resource models the parent shared object of a given lightweight SysObject. |
GET POST |
| materialization |
The materialization resource models the materialization state of a lightweight SysObject. |
PUT DELETE |
| comments |
The cmments resource represents a collection of all comments for a given SysObject. |
GET POST |
| comment |
The comment resource models a comment or a reply. |
GET DELETE |
| comment-replies |
The cabinet resource models a single cabinet in the repository. |
GET POST |
| lifecycles |
The lifecycles resource represents a collection of dm_policy instances stored in a repository. |
GET |
| lifecycle |
The lifecycle resource models a single lifecycle in the repository. |
GET |
| object-lifecycle |
The object lifecycle resource models the attached lifecycle of an object in the repository. |
GET PUT DELETE |
| object-lifecycle-promotion |
The object lifecycle promotion resource models the object lifecycle promotion. |
PUT DELETE |
| object-lifecycle-demotion |
The object lifecycle demotion resource models the object lifecycle demotion. |
PUT DELETE |
| object-lifecycle-suspension |
The object lifecycle suspension resource models the object lifecycle suspension. |
PUT DELETE |
| object-lifecycle-resumption |
The object lifecycle resumption resource models the object lifecycle resumption. |
PUT DELETE |
| virtual-document-relation |
The virtual document relation resource models the virtual document node in the repository, it contains attributes from not only DFC virtual document node but also DFC containment. |
GET POST DELETE |
| virtual-document-snapshots |
The virtual document snapshots resource models the virtual document snapshots in the repository. |
GET POST |
| virtual-document-snapshot |
The virtual document snapshot resource models a snapshot in the repository. |
GET DELETE |
| virtual-document-snapshot-nodes |
The virtual document snapshot nodes resource models the components of a snapshot in the repository. |
GET |
| virtual-document-snapshot-frozen |
The virtual document snapshot frozen resource allows users to freeze an unfrozen snapshot or unfreeze a frozen snapshot. |
PUT DELETE |
| archived-contents |
The archived-contents resource uses a DEFLATE compression algorithm to download the contents of multiple objects, and returns that content to the client as a ZIP file formatted stream. This resource can download the content media of all content from the REST server using one Request instead of an ACS server or a BOCS server.This resource downloads the CURRENT version of an object. When a folder, or a subtype of dm_folder, has been specified, the request to the REST server downloads the contents of the objects that are directly under the specified folder. However, sub folders of the object contents do not get downloaded. |
GET POST |
| audit-trail |
The audit trail resource models a record of trailing details. |
GET DELETE |
| audit-trails |
The audit trails models the collection of audit trails in the repository. |
GET |
| subscription |
The subscription models single object states of subscription by the current user. |
PUT DELETE |
| subscriptions |
The subscriptions resource models the collection of all subscribed objects by the current user in the repository. |
GET |
Resource: home-doc
The home document serves as the entry point for the entire REST services. Its billboard
URI is
/services.
No authentication is required to access the home document.
HTTP Methods:
- Method GET
-
Get the home document.
- Transitions:
-
- Entry point : → home-doc
- Response:
-
- Result States:
- Media Types:
Resource: product-info
The product info provides the basic product information about the REST services.
No authentication is
required to access the product information.
HTTP Methods:
- Method GET
-
Get the product information.
- Transitions:
- Response:
-
- Result States:
- Media Types:
Resource: repositories
The repositories resource models the collection of repositories.
No authentication
is required to access the repository collection.
HTTP Methods:
- Method GET
-
Get the collection of repositories.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: repository
The Repository resource models the attributes of a repository.
HTTP Methods:
- Method GET
-
Get the repository.
- Transitions:
- Response:
-
- Result States:
- Media Types:
Resource: cabinets
The cabinets resource models the collection of cabinets in the repository.
HTTP Methods:
- Method GET
-
Get the collection of cabinets in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a new cabinet in the repository.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: cabinet
The cabinet resource models a single cabinet in the repository.
HTTP Methods:
- Method GET
-
Retrieves properties, and other information of the Cabinet resource.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Updates the properties for the Cabinet resource.
- Transitions:
- Request:
- Response:
-
- Result States:
- Headers:
-
- Location (optional)
- Media Types:
- Method DELETE
-
Deletes the Cabinet resource from a repository.
- Transitions:
- Request:
-
- URI Parameters:
Resource: folder-child-folders
The folders resource models the collection of folders under a parent folder.
HTTP Methods:
- Method GET
-
Get the collection of folders under a parent folder.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a new folder under a parent folder.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: folder
The folder resource models a single folder in the repository.
HTTP Methods:
- Method GET
-
Get the specified folder.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Modify the specified folder.
- Transitions:
- Request:
- Response:
-
- Result States:
- Headers:
-
- Location (optional)
- Media Types:
- Method DELETE
-
Remove the specified folder.
- Transitions:
- Request:
-
- URI Parameters:
Resource: folder-child-documents
The documents resource models the collection of documents under a parent folder.
HTTP Methods:
- Method GET
-
Get the collection of folders under a parent folder.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a new document under a parent folder. The request can create a contentless document which only puts properties in the XML or JSON request. It can also create a contentful document which includes both properties and content binary within a multipart media type.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: document
The document resource models a single document in the repository.
HTTP Methods:
- Method GET
-
Get the specified document.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Modify the specified document.
- Transitions:
- Request:
- Response:
-
- Result States:
- Headers:
-
- Location (optional)
- Media Types:
- Method DELETE
-
Remove the specified document.
- Transitions:
- Request:
-
- URI Parameters:
Resource: folder-child-objects
The SysObjects resource models the collection of SysObjects under a parent folder.
HTTP Methods:
- Method GET
-
Get the collection of child objects under the given folder. You can specify any folder types, including dm_folder, dm_cabinet or a custom type.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a new SysObject under a parent folder.The request can create a contentless SysObject which only puts properties in the XML or JSON request. It can also create a contentful SysObject which includes both properties and content binary within a multipart media type.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: object
The SysObject resource models a single folder in the repository.
HTTP Methods:
- Method GET
-
Get the specified SysObject. Retrieve properties, and other information of the SysObject resource. Properties are returned as embedded elements in the response message body. Other information, such as relationships, versions, and contents, is referenced via link relations in the response message body.
- Transitions:
-
- Find SysObject : folder-child-objects → object
- Find acl associated object : acl-associated-objects → object
- Find checked out object : checked-out-objects → object
- Find revision : all-versions → object
- Find subscribed object : subscriptions → object
- Get canonical SysObject : current-version → object
- Get child object : relation → object
- Get parent object : content → object
- Get parent object : relation → object
- Get precedent version : document → document
- Get precedent version : object → object
- Get snapshot associated virtual document : snapshot → object
- Get snapshot associated virtual document : snapshot-frozen → object
- Get the virtual document node object : virtual-document-relation → object
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Modify the specified SysObject.
- Transitions:
- Request:
- Response:
-
- Result States:
- Headers:
-
- Location (optional)
- Media Types:
- Method DELETE
-
Remove the specified SysObject. For a folder object, folder children deletions are controlled by query parameters. If a deletion fails, an exception is thrown and the SysObject resource (including the folder tree and version history) is reverted to the original state. For a document object, the version policy is controlled by query parameters. HTTP 204 No Content status upon a successful delete operation. The response body contains no content. If the resource typ is not dm_SysObject or its subtype, the error code 400 with the invalid parameter is returned.
- Transitions:
- Request:
-
- URI Parameters:
Resource: child-folder-links
The child folder links resource models the collection of folder links under a parent folder.
HTTP Methods:
- Method GET
-
Get the collection of folder links under a parent folder.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Link a new object to a given folder or cabinet. The first execution of link on an object defines the object's primary link, which is the place where the object is stored in the repository. Subsequent executions of link associate the object to other folders or cabinets. These links are called secondary links. This operation only allows you to create a new secondary link for an object. The existing folder links for this object do not change. For more information about how to create primary link during the object creation. To create a secondary link, you have at least the Browse permission and the Change Location permission on the object. If the repository is running under folder security, you must also have at least the Write permission on the folder or cabinet to which the object is linked. Note: You cannot link a cabinet to a folder.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: child-folder-link
The parent folder link resource represents the folder containment relationship between a parent folder and one of its child objects.
HTTP Methods:
- Method GET
-
Get the specified folder link.
- Transitions:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Unlink the child SysObject from the the folder.
Note:- To unlink an object from a primary link, you must have at least the Write permission and the Change Location permission on the object.
- To unlink an object from a secondary link, you must have at least the Browse permission and the Change Location permission on the object.
- If the repository is running under folder security, you must also have at least the Write permission on the folder or cabinet from which the object is being unlinked.
- Documents and folders must have at least one link to a folder or cabinet. Therefore, you cannot unlink an object from its only linked folder or cabinet.
- Transitions:
Resource: parent-folder-links
The parent folder links resource models the collection of parent folder links for a specified SysObject.
HTTP Methods:
- Method GET
-
Get the collection of parent folder links for a specified SysObject.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Link the SysObject to a new folder or cabinet. The first execution of link on an object defines the object's primary link, which is the place where the object is stored in the repository. Subsequent executions of link associate the object to other folders or cabinets. These links are called secondary links. This operation only allows you to create a new secondary link for an object. The existing folder links for this object do not change. For more information about how to create primary link during the object creation. To create a secondary link, you have at least the Browse permission and the Change Location permission on the object. If the repository is running under folder security, you must also have at least the Write permission on the folder or cabinet to which the object is linked.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: parent-folder-link
The parent folder link resource models the folder containment relationships between a SysObject and its parent folder.
HTTP Methods:
- Method GET
-
Get the specified folder link.
- Transitions:
- Response:
-
- Result States:
- Media Types:
- Method PUT
-
Move the SysObject from an existing folder to a new folder.
Note:- If the object is a folder, this operation also moves the objects under the folder to the destination folder.
- Cabinet is not allowed to be moved.
- Transitions:
- Request:
-
- URI Parameters:
- Media Types:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Unlink the SysObject from the the parent folder.
Note:- To unlink an object from a primary link, you must have at least the Write permission and the Change Location permission on the object.
- To unlink an object from a secondary link, you must have at least the Browse permission and the Change Location permission on the object.
- If the repository is running under folder security, you must also have at least the Write permission on the folder or cabinet from which the object is being unlinked.
- Documents and folders must have at least one link to a folder or cabinet. Therefore, you cannot unlink an object from its only linked folder or cabinet.
- Transitions:
Resource: contents
The cabinets resource models the collection of cabinets in the repository.
HTTP Methods:
- Method GET
-
Get the collection of contents for a SysObject.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a new content or rendition for the SysObject. The request body shall be the content binary.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: content
The content resource contains both content attributes and link to the content media.
HTTP Methods:
- Method GET
-
Get the specified content.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Remove the content from the SysObject. Delete primary content and/or rendition content for a document object. By default, when a primary content is deleted, the renditions on the same page are deleted at the same time. Renditions created by Documentum REST Services are always deleted if the corresponding primary content is deleted. However, under some circumstances, renditions created via other approaches can remain when the primary content is deleted.
- Transitions:
- Request:
Resource: content-media
The content media resource models the media of the primary content or rendition downloading from the REST server, other than from an ACS server or a BOCS server. This resource is especially useful when ACS server or BOCS server is unavailable.
HTTP Methods:
- Method GET
-
Get the specified cabinet.
- Transitions:
- Request:
-
- Headers:
-
- If-None-Match (optional)
- URI Parameters:
- Response:
-
- Result States:
- Headers:
-
- ETag (optional)
- Media Types:
Resource: all-versions
The all versions resource represents a collection of all versions for a given non-folder SysObject.
HTTP Methods:
- Method GET
-
Retrieves all versions of a given SysObject.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Check in a checked out document locked by current user.
- Transitions:
-
- Check in as branch : checked-out-object → object
- Check in as next major : checked-out-object → object
- Check in as next minor : checked-out-object → object
- Check in with content as branch : checked-out-object → object
- Check in with content as next major : checked-out-object → object
- Check in with content as next minor : checked-out-object → object
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: current-version
The current version resource refers to the CURRENT version of whole object version tree. A version tree have only one CURRENT version.
HTTP Methods:
- Method GET
-
Get the current version of the specified SysObject.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: lock
The lock resource models the checked out state of a SysObject.
HTTP Methods:
- Method PUT
-
Checkout the SysObject.
- Transitions:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Cancel checkout the locked SysObject. HTTP 204 No Content status upon a successful unlock operation. The response body contains no content.
- Transitions:
Resource: checked-out-objects
The cabinets resource models the collection of cabinets in the repository.
HTTP Methods:
- Method GET
-
Get the collection of checked out objects in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: dql-query
The dql-query resource executes the dql query.
HTTP Methods:
- Method GET
-
Execute the dql query
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Execute the dql query
- Transitions:
- Request:
-
- Media Types:
- Response:
-
- Result States:
- Media Types:
Resource: default-folder
The user default folder resource represents the default folder (typically, the home cabinet) for a given user.
HTTP Methods:
- Method GET
-
Get the user default folder. Retrieve information about the default folder for a given user. Typically, the default folder is a cabinet(dm_cabinet) and is called "home cabinet". The default folder can also be an instance of dm_folder or its subtypes.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: batches
The batches resource models how to create and execute a batch operation.
HTTP Methods:
- Method POST
-
Create and execute a batch request.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: batch-capabilities
The batch-capabilities resource models what batch features are implemented.
HTTP Methods:
- Method GET
-
Retrieve supported batch properties, the list of batchable resources, and the list of non-batchable resources.
- Transitions:
- Response:
-
- Result States:
- Media Types:
Resource: groups
The groups resource models the collection of groups in the repository.
HTTP Methods:
- Method GET
-
Get the collection of groups in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
create a group
- Transitions:
-
- Create group : groups → group
- Request:
- Response:
-
- Result States:
- Headers:
-
- Location (optional)
- Media Types:
Resource: group
The group resource models a single group in the repository.
HTTP Methods:
- Method GET
-
Get the specified group.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Modify the specified group.
- Transitions:
-
- Modify group : group → group
- Request:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Delete the specified group.
- Transitions:
Resource: group-member-groups
The group member groups resrouce represents a collection of sub groups that directly belong to a specified group.
HTTP Methods:
- Method GET
-
Get the collection of sub groups in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Add a group member to specified group
- Transitions:
- Request:
Resource: group-member-group
The group member group resource represents a sub group that belong to a specified group.
HTTP Methods:
- Method DELETE
-
Remove the group member from the parent group.
- Transitions:
Resource: group-member-users
The group member users resrouce represents a collection of users that belong to a specified group.
HTTP Methods:
- Method GET
-
Get the collection of group users in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Add a user member to specified group
- Transitions:
- Request:
Resource: group-member-user
The group member user resource represents a group user that belong to a specified group.
HTTP Methods:
- Method DELETE
-
Remove the user member from the parent group.
- Transitions:
Resource: users
The users resource models the collection of users in the repository.
HTTP Methods:
- Method GET
-
Get the collection of users in the repository.
- Transitions:
-
- Get users : repository → users
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a user
- Transitions:
-
- Create user : users → user
- Request:
- Response:
-
- Result States:
- Headers:
-
- Location (optional)
- Media Types:
Resource: user
The user resource models a single user in the repository.
HTTP Methods:
- Method GET
-
Get the specified user.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Modify the specified user.
- Transitions:
-
- Modify user : user → user
- Request:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Remove the specified user.
- Transitions:
Resource: current-user
The current user resource represents the metadata of a current login user in a repository.
HTTP Methods:
- Method GET
-
Get the current user.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Modify current user.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: formats
The formats resource represents a collection of dm_format instances stored in a repository.
HTTP Methods:
- Method GET
-
Get the collection of formats in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: format
The format resource models a single format in the repository.
HTTP Methods:
- Method GET
-
Get the specified format.
- Transitions:
-
- Find format : formats → format
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: relation-types
The relation types resource represents a collection of relation type (dm_relation_type and its subtypes) instances in a repository.
HTTP Methods:
- Method GET
-
Get the collection of relation types in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: relation-type
The relation-type resource models a single user in the repository.
HTTP Methods:
- Method GET
-
Get the specified relation type.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: types
The types collection resource represents the collection of type objects in a repository.
HTTP Methods:
- Method GET
-
Get the collection of types in the repository.
- Transitions:
-
- Get lightweight types : type → types
- Get parent types : type → types
- Get types : repository → types
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: type
The type resource represents a type object in a repository.
HTTP Methods:
- Method GET
-
Get the specified type.
- Transitions:
-
- Find type : types → type
- Get parent sharable type : type → type
- Get parent type : type → type
- Get type : aspect-type → type
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: relations
The relations resource represents a collection of relations in a repository.
HTTP Methods:
- Method GET
-
Get the collection of relations in the repository.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a relation between two objects in a repository. Note: To create a sub type of the relation instance, specify the xsi:type property in XML or the type property in the JSON.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: relation
The relation resource represents a single relation instance in a repository.
HTTP Methods:
- Method GET
-
Get the specified relation.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Remove the specified relation. HTTP 204 No Content status upon a successful delete operation. The response body contains no content.
- Transitions:
Resource: network-locations
The network locations collection resource represents the collection of network locations (instances of dm_network_location_map) in a repository.
HTTP Methods:
- Method GET
-
Get the collection of network locations in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: network-location
The network location resource models a single user in the repository.
HTTP Methods:
- Method GET
-
Get the specified network location.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: search
The search resource can execute full-text search against meta data and contents.
HTTP Methods:
- Method GET
-
Execute a full-text search with simple search language and facet conditions.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Execute a full-text search with abstract query language.
- Transitions:
- Request:
-
- URI Parameters:
- Media Types:
- Response:
-
- Result States:
- Media Types:
Resource: aspect-types
The aspect types collection resource represents the collection of aspect type objects in a repository.
HTTP Methods:
- Method GET
-
Get the collection of aspect types in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: aspect-type
The aspect type resource represents an aspect type object in a repository.
HTTP Methods:
- Method GET
-
Get the specified aspect type.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: object-aspects
The object aspects resource models the attached aspects of an object in the repository.
HTTP Methods:
- Method GET
-
Get all the attached aspects of an object.
- Transitions:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Attach one or more aspects to the specified object.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: object-aspect
The object aspect resource models the specified attached aspect of an object in the repository.
HTTP Methods:
- Method DELETE
-
Detach the specified aspect from an object.
- Transitions:
Resource: virtual-document-nodes
The virtual document nodes resource models the nodes of an virtual document in the repository.
HTTP Methods:
- Method GET
-
Get nodes of an virtual document.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Add direct child node to virtual or simple document, or post empty request body to convert simple document to childless virtual document.
- Transitions:
- Request:
- Response:
Resource: saved-searches
The saved searches resource models collection of saved searches.
HTTP Methods:
- Method GET
-
Get the collection of saved searches.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Save a saved search.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: saved-search
The saved search resource models a saved search in the repository.
HTTP Methods:
- Method GET
-
Get the specified saved search.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Modify the specified saved search.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Remove the specified saved search.
- Transitions:
Resource: saved-search-results
The saved search results resource models the cached results of a saved search in the repository.
HTTP Methods:
- Method GET
-
Get saved search results.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method PUT
-
Enable or refresh results.
- Transitions:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Disable results.
- Transitions:
Resource: saved-search-execution
The saved search execution resource models the real time results of a saved search in the repository.
HTTP Methods:
- Method GET
-
Execute a saved search.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: acl
The ACL resource models a single acl in the repository.
HTTP Methods:
- Method GET
-
Get the specified acl.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Modify the specified acl.
- Transitions:
-
- Modify acl : acl → acl
- Request:
-
- Media Types:
- Response:
-
- Result States:
- Headers:
-
- Location (optional)
- Media Types:
- Method DELETE
-
Remove the specified acl.
- Transitions:
- Request:
-
- URI Parameters:
Resource: acl-associations
The ACL associations resource models the collection of all the SysObjects that associated with a specified ACL in the repository.
HTTP Methods:
- Method GET
-
Get a collection of SysObjects that associated with an specified acl.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: acls
The ACLs collection resource models the collection of all available ACLs in the repository for the current login user.
HTTP Methods:
- Method GET
-
List all available ACLs in the repository for the current login user.
- Transitions:
-
- Get acls : repository → acls
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a new ACL in the repository.
- Transitions:
-
- Create acl : acls → acl
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: permission-set
The permission set resource models the permission set instance of a specific SysObject in the repository.
HTTP Methods:
- Method GET
-
Get a specified SysObject's permissions in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method PUT
-
Modify the permissions.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: permissions
The permission view resource models the computed permissions on a specific SysObject for a specified accessor.
HTTP Methods:
- Method GET
-
Get the computed permissions on a specific SysObject for the current accessor, the default accessor is the current login user.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: user-permission-set
The associated permission set resource models the permission set instance of a specified user in the repository.
HTTP Methods:
- Method GET
-
Get the permission set of a specified user in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
Resource: search-template
The search template resource models a search template in the repository.
HTTP Methods:
- Method GET
-
Get the specified search template.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Remove the specified search template.
- Transitions:
Resource: search-templates
The search templates resource models collection of search templates.
HTTP Methods:
- Method GET
-
Get the collection of search templates.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Save a search template.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a search template from an existing saved search.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: search-template-execution
The search template execution resource models the real time results of a search template in the repository.
HTTP Methods:
- Method POST
-
Execute a search template.
- Transitions:
- Request:
-
- URI Parameters:
- Media Types:
- Response:
-
- Result States:
- Media Types:
Resource: current-user-preferences
The current user preferences resource models the preferences for current user in the repository.
HTTP Methods:
- Method GET
-
Get current user preferences
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a new user preference for current user
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: current-user-preference
The current user preference resource models the specified preference for current user in the repository.
HTTP Methods:
- Method GET
-
Get current user preference
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Modify the specified user preference
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Remove the specified user preference
- Transitions:
Resource: type-value-assistances
The type value assistances resource models the assist values for specified type in the repository.
HTTP Methods:
- Method POST
-
Get the assist values of a specified type
- Transitions:
- Request:
-
- URI Parameters:
- Media Types:
- Response:
-
- Result States:
- Media Types:
Resource: object-lightweight-objects
The object lightweight objects resource models the collection of lightweight SysObjects of a shared parent.
HTTP Methods:
- Method GET
-
Get the collection of lightweight objects of the given shared parent. You can specify any shared object of a shareable type.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a lightweight object which share the given shared object. The request can create a contentless lightweight object, which only puts properties in the XML or JSON request. It can also create a contentful lightweight object which includes both properties and content binary within a multipart media type.
- Transitions:
- Request:
-
- URI Parameters:
- Media Types:
- Response:
-
- Result States:
- Media Types:
Resource: object-parent
The object parent resource models the parent shared object of a given lightweight SysObject.
HTTP Methods:
- Method GET
-
Get the shared parent object of the lightweight SysObject.
- Transitions:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Reparent the lightweight SysObject to another shared parent object.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: materialization
The materialization resource models the materialization state of a lightweight SysObject.
HTTP Methods:
- Method PUT
-
Materialze the lightweight SysObject
- Transitions:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Dematerialize the lightweight SysObject. HTTP 204 No Content status upon a successful dematerialize operation. The response body contains no content.
- Transitions:
Resource: comments
The cmments resource represents a collection of all comments for a given SysObject.
HTTP Methods:
- Method GET
-
Retrieves comments of a given SysObject.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Add a root level comment. User requires RELATE permission on the object to add a comment. However there is a limitation in the Collaboration Service, thus user currently requires WRITE permission on the object to start a comment thread. In another words, user requires WRITE permission to create the first comment and the user only requires RELATE permission to add subsequent comments. Collaboration service team is working on removing this limitation. The content of the comment can be either plain text or rich text. The content will be sanitized before saving it to the repository.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: comment
The comment resource models a comment or a reply.
HTTP Methods:
- Method GET
-
Retrieves the comment resource.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Deletes the comment resource from a SysObject. Only the user who created the comment can delete that comment. The delete link for the comment will only be provided if the user can delete that comment.
- Transitions:
- Request:
-
Resource: comment-replies
The cabinet resource models a single cabinet in the repository.
HTTP Methods:
- Method GET
-
Retrieves the replies of the comment resource.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Add a reply to the comment resource. User requires RELATE permission to add a reply. The content of the comment can be either plain text or rich text. The content will be sanitized before saving it to the repository.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: lifecycles
The lifecycles resource represents a collection of dm_policy instances stored in a repository.
HTTP Methods:
- Method GET
-
Get the collection of lifecycles in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: lifecycle
The lifecycle resource models a single lifecycle in the repository.
HTTP Methods:
- Method GET
-
Get the specified lifecycle.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: object-lifecycle
The object lifecycle resource models the attached lifecycle of an object in the repository.
HTTP Methods:
- Method GET
-
Get the attached lifecycle current status of an object.
- Transitions:
- Response:
-
- Result States:
- Media Types:
- Method PUT
-
Attach a lifecycle to the specified object.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Detach the lifecycle from the object.
- Transitions:
Resource: object-lifecycle-promotion
The object lifecycle promotion resource models the object lifecycle promotion.
HTTP Methods:
- Method PUT
-
Promote the object lifecycle to the next normal state.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Cancel the scheduled lifecycle promotion of the object.
- Transitions:
- Request:
-
- URI Parameters:
Resource: object-lifecycle-demotion
The object lifecycle demotion resource models the object lifecycle demotion.
HTTP Methods:
- Method PUT
-
Demote the object lifecycle to the previous normal state.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Cancel the scheduled lifecycle demotion of the object.
- Transitions:
- Request:
-
- URI Parameters:
Resource: object-lifecycle-suspension
The object lifecycle suspension resource models the object lifecycle suspension.
HTTP Methods:
- Method PUT
-
Suspend the object lifecycle to the exceptional state.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Cancel the scheduled lifecycle suspension of the object.
- Transitions:
- Request:
-
- URI Parameters:
Resource: object-lifecycle-resumption
The object lifecycle resumption resource models the object lifecycle resumption.
HTTP Methods:
- Method PUT
-
Resume the object lifecycle to the normal state.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Cancel the scheduled lifecycle resumption of the object.
- Transitions:
- Request:
-
- URI Parameters:
Resource: virtual-document-relation
The virtual document relation resource models the virtual document node in the repository, it contains attributes from not only DFC virtual document node but also DFC containment.
HTTP Methods:
- Method GET
-
Get a virtual document node relation with parent virtual document.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
- Method POST
-
Update the virtual document node relation with parent virtual document.
- Transitions:
- Request:
- Response:
- Method DELETE
-
Remove a virtual document node from the parent virtual document
- Transitions:
Resource: virtual-document-snapshots
The virtual document snapshots resource models the virtual document snapshots in the repository.
HTTP Methods:
- Method GET
-
Get virtual document snapshots in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Create a snapshot for a virtual document.
- Transitions:
- Request:
- Response:
-
- Result States:
- Media Types:
Resource: virtual-document-snapshot
The virtual document snapshot resource models a snapshot in the repository.
HTTP Methods:
- Method GET
-
Get a virtual document snapshot object.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Remove a virtual document snapshot.
- Transitions:
Resource: virtual-document-snapshot-nodes
The virtual document snapshot nodes resource models the components of a snapshot in the repository.
HTTP Methods:
- Method GET
-
Get components of an virtual document snapshot.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: virtual-document-snapshot-frozen
The virtual document snapshot frozen resource allows users to freeze an unfrozen snapshot or unfreeze a frozen snapshot.
HTTP Methods:
- Method PUT
-
Freeze an unfrozen snapshot.
- Transitions:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Unfreeze a frozen snapshot.
- Transitions:
Resource: archived-contents
The archived-contents resource uses a DEFLATE compression algorithm to download the contents of multiple objects, and returns that content to the client as a ZIP file formatted stream. This resource can download the content media of all content from the REST server using one Request instead of an ACS server or a BOCS server.This resource downloads the CURRENT version of an object. When a folder, or a subtype of dm_folder, has been specified, the request to the REST server downloads the contents of the objects that are directly under the specified folder. However, sub folders of the object contents do not get downloaded.
HTTP Methods:
- Method GET
-
Get all contents of a single object in ZIP file format.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method POST
-
Get the first page of the contents, or all of the contents, from multiple objects in ZIP file format.
- Transitions:
- Request:
-
- URI Parameters:
- Media Types:
- Response:
-
- Result States:
- Media Types:
Resource: audit-trail
The audit trail resource models a record of trailing details.
HTTP Methods:
- Method GET
-
Retrieve the audit trail resource
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Delete the audit trail resource.
- Transitions:
Resource: audit-trails
The audit trails models the collection of audit trails in the repository.
HTTP Methods:
- Method GET
-
Retrieve audit trails in the given repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Resource: subscription
The subscription models single object states of subscription by the current user.
HTTP Methods:
- Method PUT
-
Subscribe the object for current user or for other user(s) as well
- Transitions:
- Response:
-
- Result States:
- Media Types:
- Method DELETE
-
Unsubscribe the object for the current user
- Transitions:
Resource: subscriptions
The subscriptions resource models the collection of all subscribed objects by the current user in the repository.
HTTP Methods:
- Method GET
-
Get the collection of subscribed objects in the repository.
- Transitions:
- Request:
-
- URI Parameters:
- Response:
-
- Result States:
- Media Types:
Authentication
Identity Providers
| Mechanism | Description |
|---|---|
| basic |
Documentum repository as the identity provider to support Documentum basic authentication. |
| negotiate |
Kerberos domain controller as the identity provider. |
| cas |
Authentication provider behind the CAS server as the identity provider. |
| rsa |
RSA access manager as the identity provider. |
| siteminder |
SiteMinder access manager as the identity provider. |
| saml2 |
SAML 2.0 compliant identity provider. |
| preauth |
Web Access Management system as the identity provider to provide pre-authenticated login. |
| oauth2 |
OAuth 2.0 compliant identity provider. |
Mechanisms
- basic (HTTP Basic):
-
Scheme Description Parameters basic HTTP basic authentication for Content Server inline users and LDAP users synced to Content Server.
basic-ct HTTP basic authentication for Content Server inline users with Documentum Client Token cookie support.
- negotiate (Kerberos SSO):
-
Scheme Description Parameters kerberos SPNEGO-based Kerberos authentication for Active Directory domain users synced to Content Server.
ct-kerberos SPNEGO-based Kerberos authentication with Documentum Client Token cookie support.
basic-kerberos SPNEGO-based Kerberos authentication in combination with HTTP Basic authentication support.
basic-ct-kerberos SPNEGO-based Kerberos authentication with Documentum Client Token cookie support, in combination with HTTP Basic authentication.
basic-dual_ct-kerberos SPNEGO-based Kerberos authentication, in combination with HTTP Basic authentication support. Documentum Client Token cookie is supported on both authentication types.
- cas (CAS Web SSO):
-
Scheme Description Parameters ct-cas CAS SSO authentication with Documentum Client Token cookie support.
- rsa (RSA ClearTrust SSO):
-
Scheme Description Parameters rsa RSA ClearTrust SSO authentication with Documentum Client Token cookie support.
- siteminder (CA SiteMinder SSO):
-
Scheme Description Parameters siteminder CA SiteMinder SSO authentication with Documentum Client Token cookie support.
- saml2 (SAML 2.0 Web SSO):
-
Scheme Description Parameters ct-saml2 SAML 2.0 Web SSO authentication with Documentum Client Token cookie support.
- preauth (Pre-authenticated authentication):
-
Scheme Description Parameters preauth Pre-authenticated login for Web Access Management systems.
ct-preauth Pre-authenticated login for Web Access Management systems with Documentum Client Token cookie support.
- oauth2 (OAuth 2.0 authentication):
-
Scheme Description Parameters oauth2 OAuth 2.0 authentication framework.
ct-oauth2 OAuth 2.0 authentication framework with Documentum Client Token cookie support.