OpenText™ Documentum™ REST

Services

Reference Guide

This document is the resource reference that is shipped in

OpenText Documentum REST Services (also known as the core
resources). It is intended for software developers and architects
who are building REST web services APIs or clients that interact
with the Documentum platform. The document provides
information on how to use each resource and their inherent
operations.

For general information about OpenText Documentum REST

Services, including how to develop your own REST resources,
see OpenText Documentum REST Services Development Guide.

Experimental API documentation, which is written in RADL, is

available to users in both the SDK and the REST war file.

EDCPKRST220200-PRE-EN-01
OpenText™ Documentum™ REST Services
Reference Guide
EDCPKRST220200-PRE-EN-01
Rev.: 2022-May-09
This documentation has been created for OpenText™ Documentum™ REST Services CE 22.2.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com

Copyright © 2022 Open Text. All Rights Reserved.

Trademarks owned by Open Text.

One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.

Disclaimer

No Warranties and Limitation of Liability

Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
 Table of Contents
1 Overview ................................................................................... 13
1.1 Hypermedia-driven API ................................................................... 13

2 Resources ................................................................................ 17
2.1 Organization of Resource Reference Documentation ........................ 17
2.2 Installing Additional Services ............................................................ 18
2.2.1 Collaboration services ..................................................................... 18
2.2.2 Search services .............................................................................. 19
2.2.3 Contextual Content Engine services ................................................. 19
2.2.4 Documentum Process Builder services ............................................. 20
2.3 All Versions .................................................................................... 20
2.3.1 Resource relationships .................................................................... 20
2.3.2 Feed .............................................................................................. 21
2.3.3 Link relations .................................................................................. 21
2.3.4 Operations ...................................................................................... 21
2.4 ACL ............................................................................................... 42
2.4.1 ACL ............................................................................................... 42
2.4.2 ACLs Collection .............................................................................. 55
2.5 ACL Associations ............................................................................ 65
2.5.1 Resource relationships .................................................................... 65
2.5.2 Feed .............................................................................................. 66
2.5.3 Link relations .................................................................................. 66
2.5.4 Operations ...................................................................................... 66
2.6 Archived Contents ........................................................................... 70
2.6.1 Resource relationships .................................................................... 70
2.6.2 Feed .............................................................................................. 70
2.6.3 Link relations .................................................................................. 70
2.6.4 Operations ...................................................................................... 70
2.7 Aspect Type (s) ............................................................................... 78
2.7.1 Aspect Type ................................................................................... 78
2.7.2 Aspect Types .................................................................................. 83
2.8 Audit Policy (ies) ............................................................................. 86
2.8.1 Audit Policy ..................................................................................... 86
2.8.2 Audit Policies .................................................................................. 93
2.9 Audit Trail (s) ................................................................................ 100
2.9.1 Audit Trail ..................................................................................... 100
2.9.2 Audit Trails ................................................................................... 107
2.10 Available Audit Events ................................................................... 112
2.10.1 Resource relationships .................................................................. 112
2.10.2 Feed ............................................................................................ 112

EDCPKRST220200-PRE-EN-01 Reference Guide iii

Table of Contents

2.10.3 Link relations ................................................................................ 112

2.10.4 Operations .................................................................................... 112
2.11 Batches ........................................................................................ 115
2.11.1 Resource relationships .................................................................. 116
2.11.2 Feed ............................................................................................ 116
2.11.3 Link relations ................................................................................ 116
2.11.4 Operations .................................................................................... 116
2.12 Batch Capabilities ......................................................................... 133
2.12.1 Resource relationships .................................................................. 133
2.12.2 Feed ............................................................................................ 133
2.12.3 Link relations ................................................................................ 133
2.12.4 Operations .................................................................................... 134
2.13 Cabinet (s) .................................................................................... 137
2.13.1 Cabinet ........................................................................................ 137
2.13.2 Cabinets ....................................................................................... 143
2.14 Checked Out Objects .................................................................... 148
2.14.1 Resource relationships .................................................................. 149
2.14.2 Feed ............................................................................................ 149
2.14.3 Link relations ................................................................................ 149
2.14.4 Operations .................................................................................... 150
2.15 Comment (s) ................................................................................. 154
2.15.1 Comment ..................................................................................... 154
2.15.2 Comments .................................................................................... 159
2.16 Comment Replies ......................................................................... 166
2.16.1 Feed ............................................................................................ 166
2.16.2 Link relations ................................................................................ 166
2.16.3 Operations .................................................................................... 167
2.17 Content (s) ................................................................................... 174
2.17.1 Content ........................................................................................ 174
2.17.2 Contents ....................................................................................... 180
2.18 Content Media .............................................................................. 188
2.18.1 Resource relationships .................................................................. 188
2.18.2 Feed ............................................................................................ 189
2.18.3 Link relations ................................................................................ 189
2.18.4 Operations .................................................................................... 189
2.19 Current User ................................................................................. 191
2.19.1 Resource relationships .................................................................. 191
2.19.2 Feed ............................................................................................ 191
2.19.3 Link relations ................................................................................ 191
2.19.4 Operations .................................................................................... 192
2.20 Current User Preference (s) ........................................................... 193
2.20.1 Current User Preference ................................................................ 193

iv OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 Table of Contents

2.20.2 Current User Preferences .............................................................. 201

2.21 Current Version ............................................................................. 208
2.21.1 Resource relationships .................................................................. 208
2.21.2 Feed ............................................................................................ 208
2.21.3 Link relations ................................................................................ 209
2.21.4 Operations .................................................................................... 209
2.22 Custom Facets .............................................................................. 210
2.22.1 Resource relationships .................................................................. 210
2.22.2 Feed ............................................................................................ 211
2.22.3 Link relations ................................................................................ 211
2.22.4 Operations .................................................................................... 211
2.23 Document ..................................................................................... 217
2.23.1 Resource relationships .................................................................. 217
2.23.2 Feed ............................................................................................ 217
2.23.3 Link relations ................................................................................ 217
2.23.4 Operations .................................................................................... 219
2.24 DQL ............................................................................................. 227
2.24.1 Resource relationships .................................................................. 228
2.24.2 Feed ............................................................................................ 228
2.24.3 Link relations ................................................................................ 228
2.24.4 Operations .................................................................................... 229
2.25 Folder .......................................................................................... 236
2.25.1 Resource relationships .................................................................. 236
2.25.2 Feed ............................................................................................ 236
2.25.3 Link relations ................................................................................ 237
2.25.4 Operations .................................................................................... 237
2.26 Folder Child Documents ................................................................ 243
2.26.1 Resource relationships .................................................................. 244
2.26.2 Feed ............................................................................................ 244
2.26.3 Link relations ................................................................................ 244
2.26.4 Operations .................................................................................... 244
2.27 Folder Child Folders ...................................................................... 271
2.27.1 Resource relationships .................................................................. 271
2.27.2 Feed ............................................................................................ 272
2.27.3 Link relations ................................................................................ 272
2.27.4 Operations .................................................................................... 272
2.28 Folder Child Link (s) ...................................................................... 277
2.28.1 Folder Child Link ........................................................................... 277
2.28.2 Folder Child Links ......................................................................... 280
2.29 Folder Child Objects ...................................................................... 285
2.29.1 Resource relationships .................................................................. 285
2.29.2 Feed ............................................................................................ 285

EDCPKRST220200-PRE-EN-01 Reference Guide v

Table of Contents

2.29.3 Link relations ................................................................................ 286

2.29.4 Operations .................................................................................... 286
2.30 Format (s) ..................................................................................... 305
2.30.1 Format ......................................................................................... 305
2.30.2 Formats ........................................................................................ 308
2.31 Group (s) ...................................................................................... 311
2.31.1 Group ........................................................................................... 311
2.31.2 Groups ......................................................................................... 320
2.32 Group User (s) .............................................................................. 325
2.32.1 Group User ................................................................................... 325
2.32.2 Group Users ................................................................................. 327
2.33 Home Document ........................................................................... 331
2.33.1 Resource relationships .................................................................. 331
2.33.2 Feed ............................................................................................ 332
2.33.3 Link relations ................................................................................ 332
2.33.4 Operations .................................................................................... 332
2.34 Inbox ............................................................................................ 335
2.34.1 Resource relationships .................................................................. 335
2.34.2 Feed ............................................................................................ 335
2.34.3 Link relations ................................................................................ 336
2.34.4 Operations .................................................................................... 336
2.35 Inbox Item .................................................................................... 340
2.35.1 Resource relationships .................................................................. 340
2.35.2 Feed ............................................................................................ 340
2.35.3 Link relations ................................................................................ 340
2.35.4 Operations .................................................................................... 340
2.36 Job(s) ........................................................................................... 350
2.36.1 Job ............................................................................................... 350
2.36.2 Jobs ............................................................................................. 357
2.37 Lifecycle (s) .................................................................................. 367
2.37.1 Lifecycle ....................................................................................... 367
2.37.2 Lifecycles ..................................................................................... 382
2.38 Lightweight Objects ....................................................................... 397
2.38.1 Resource relationships .................................................................. 397
2.38.2 Feed ............................................................................................ 397
2.38.3 Link relations ................................................................................ 398
2.38.4 Operations .................................................................................... 398
2.39 Lightweight Object Parent .............................................................. 405
2.39.1 Resource relationships .................................................................. 405
2.39.2 Feed ............................................................................................ 405
2.39.3 Link relations ................................................................................ 405
2.39.4 Operations .................................................................................... 405

vi OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 Table of Contents

2.40 Lightweight Object Materialization .................................................. 410

2.40.1 Feed ............................................................................................ 410
2.40.2 Resource relationships .................................................................. 410
2.40.3 Link relations ................................................................................ 410
2.40.4 Operations .................................................................................... 410
2.41 Lock ............................................................................................. 413
2.41.1 Resource relationships .................................................................. 414
2.41.2 Feed ............................................................................................ 414
2.41.3 Link relations ................................................................................ 414
2.41.4 Operations .................................................................................... 414
2.42 Module(s) ..................................................................................... 417
2.42.1 Module ......................................................................................... 417
2.42.2 Modules ....................................................................................... 422
2.43 Multiple Repository Search ............................................................ 429
2.43.1 Resource relationships .................................................................. 430
2.43.2 Feed ............................................................................................ 430
2.43.3 Link relations ................................................................................ 430
2.43.4 Operations .................................................................................... 431
2.43.5 Authentication ............................................................................... 442
2.44 Network Location (s) ..................................................................... 443
2.44.1 Network Location .......................................................................... 443
2.44.2 Network Locations ......................................................................... 446
2.45 Object Aspect (s) .......................................................................... 449
2.45.1 Object Aspect ............................................................................... 449
2.45.2 Object Aspects .............................................................................. 451
2.46 Object Lifecycle ............................................................................ 457
2.46.1 Resource relationships .................................................................. 457
2.46.2 Feed ............................................................................................ 458
2.46.3 Link relations ................................................................................ 458
2.46.4 Operations .................................................................................... 458
2.47 Object Lifecycle Demotion ............................................................. 466
2.47.1 Resource relationships .................................................................. 466
2.47.2 Feed ............................................................................................ 467
2.47.3 Link relations ................................................................................ 467
2.47.4 Operations .................................................................................... 467
2.48 Object Lifecycle Promotion ............................................................ 473
2.48.1 Resource relationships .................................................................. 473
2.48.2 Feed ............................................................................................ 473
2.48.3 Link relations ................................................................................ 473
2.48.4 Operations .................................................................................... 473
2.49 Object Lifecycle Resumption .......................................................... 479
2.49.1 Resource relationships .................................................................. 479

EDCPKRST220200-PRE-EN-01 Reference Guide vii

Table of Contents

2.49.2 Feed ............................................................................................ 479

2.49.3 Link relations ................................................................................ 479
2.49.4 Operations .................................................................................... 479
2.50 Object Lifecycle Suspension .......................................................... 484
2.50.1 Resource relationships .................................................................. 485
2.50.2 Feed ............................................................................................ 485
2.50.3 Link relations ................................................................................ 485
2.50.4 Operations .................................................................................... 485
2.51 Parent Link (s) .............................................................................. 490
2.51.1 Parent Link ................................................................................... 490
2.51.2 Parent Links ................................................................................. 496
2.52 Permissions .................................................................................. 501
2.52.1 Resource relationships .................................................................. 501
2.52.2 Feed ............................................................................................ 501
2.52.3 Link relations ................................................................................ 501
2.52.4 Operations .................................................................................... 502
2.53 Permission Set .............................................................................. 505
2.53.1 Resource relationships .................................................................. 506
2.53.2 Feed ............................................................................................ 506
2.53.3 Link relations ................................................................................ 506
2.53.4 Operations .................................................................................... 506
2.54 Product Information ....................................................................... 515
2.54.1 Resource relationships .................................................................. 515
2.54.2 Feed ............................................................................................ 516
2.54.3 Link relations ................................................................................ 516
2.54.4 Operations .................................................................................... 516
2.55 Registered Audit Event (s) ............................................................. 518
2.55.1 Registered Audit Event .................................................................. 518
2.55.2 Registered Audit Events ................................................................ 522
2.56 Relation (s) ................................................................................... 532
2.56.1 Relation ........................................................................................ 533
2.56.2 Relations ...................................................................................... 536
2.57 Related Documents ....................................................................... 540
2.57.1 Resource relationships .................................................................. 540
2.57.2 Feed ............................................................................................ 540
2.57.3 Link relations ................................................................................ 540
2.57.4 Operations .................................................................................... 541
2.58 Related SME ................................................................................ 548
2.58.1 Resource relationships .................................................................. 548
2.58.2 Feed ............................................................................................ 548
2.58.3 Link relations ................................................................................ 549
2.58.4 Operations .................................................................................... 549

viii OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 Table of Contents

2.59 Relation Type (s) ........................................................................... 554

2.59.1 Relation Type ............................................................................... 554
2.59.2 Relation Types .............................................................................. 556
2.60 Repository .................................................................................... 562
2.60.1 Resource relationships .................................................................. 562
2.60.2 Feed ............................................................................................ 562
2.60.3 Link relations ................................................................................ 562
2.60.4 Operations .................................................................................... 564
2.61 Repositories ................................................................................. 571
2.61.1 Resource relationships .................................................................. 571
2.61.2 Feed ............................................................................................ 571
2.61.3 Link relations ................................................................................ 572
2.61.4 Operations .................................................................................... 572
2.62 Saved Search (es) ........................................................................ 573
2.62.1 Saved Search ............................................................................... 573
2.62.2 Saved Searches ........................................................................... 584
2.62.3 Saved Search Execution ............................................................... 594
2.62.4 Saved Search Results ................................................................... 601
2.63 Saved Search Template (s) ........................................................... 609
2.63.1 Saved Search Template ................................................................ 609
2.63.2 Saved Search Templates ............................................................... 619
2.63.3 Search Template Execution ........................................................... 635
2.64 Search ......................................................................................... 643
2.64.1 Resource relationships .................................................................. 643
2.64.2 Feed ............................................................................................ 643
2.64.3 Link relations ................................................................................ 644
2.64.4 Operations .................................................................................... 644
2.65 Significant Terms .......................................................................... 668
2.65.1 Resource relationships .................................................................. 668
2.65.2 Feed ............................................................................................ 668
2.65.3 Link relations ................................................................................ 668
2.65.4 Operations .................................................................................... 669
2.66 Sub-Group (s) ............................................................................... 673
2.66.1 Sub Group .................................................................................... 673
2.66.2 Sub Groups .................................................................................. 675
2.67 Synonyms .................................................................................... 680
2.67.1 Resource relationships .................................................................. 680
2.67.2 Feed ............................................................................................ 680
2.67.3 Link relations ................................................................................ 680
2.67.4 Operations .................................................................................... 681
2.68 Synonym Categories ..................................................................... 684
2.68.1 Resource relationships .................................................................. 685

EDCPKRST220200-PRE-EN-01 Reference Guide ix

Table of Contents

2.68.2 Feed ............................................................................................ 685

2.68.3 Link relations ................................................................................ 685
2.68.4 Operations .................................................................................... 686
2.69 SysObject ..................................................................................... 690
2.69.1 Resource relationships .................................................................. 690
2.69.2 Feed ............................................................................................ 691
2.69.3 Link relations ................................................................................ 691
2.69.4 Operations .................................................................................... 695
2.69.5 Example ....................................................................................... 707
2.70 Task Package (s) .......................................................................... 707
2.70.1 Task Package ............................................................................... 707
2.70.2 Task Packages ............................................................................. 718
2.71 Task Package Documents ............................................................. 722
2.71.1 Resource relationships .................................................................. 722
2.71.2 Feed ............................................................................................ 722
2.71.3 Link relations ................................................................................ 722
2.71.4 Operations .................................................................................... 723
2.72 Task Package Note ....................................................................... 724
2.72.1 Resource relationships .................................................................. 724
2.72.2 Feed ............................................................................................ 724
2.72.3 Link relations ................................................................................ 724
2.72.4 Operations .................................................................................... 725
2.73 Type (s) ........................................................................................ 726
2.73.1 Type ............................................................................................. 726
2.73.2 Types ........................................................................................... 754
2.74 User (s) ........................................................................................ 765
2.74.1 User ............................................................................................. 765
2.74.2 Users ........................................................................................... 774
2.75 User Default Folder ....................................................................... 779
2.75.1 Resource relationships .................................................................. 779
2.75.2 Feed ............................................................................................ 779
2.75.3 Link relations ................................................................................ 779
2.75.4 Operations .................................................................................... 779
2.76 User Permission Set ...................................................................... 783
2.76.1 Resource relationships .................................................................. 783
2.76.2 Feed ............................................................................................ 784
2.76.3 Link relations ................................................................................ 784
2.76.4 Operations .................................................................................... 784
2.77 User Subscription (s) ..................................................................... 786
2.77.1 User Subscription .......................................................................... 786
2.77.2 User Subscriptions ........................................................................ 797
2.78 Value Assistances ......................................................................... 801

x OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 Table of Contents

2.78.1 Resource relationships .................................................................. 801

2.78.2 Feed ............................................................................................ 801
2.78.3 Link relations ................................................................................ 801
2.78.4 Operations .................................................................................... 801
2.79 Virtual Document Node (s) ............................................................. 805
2.79.1 Virtual Document Node ................................................................. 805
2.79.2 Virtual Document Nodes ................................................................ 820
2.80 Virtual Document Snapshot(s) ....................................................... 832
2.80.1 Virtual Document Snapshot ........................................................... 832
2.80.2 Virtual Document Snapshots .......................................................... 838
2.81 Virtual Document Snapshot Nodes ................................................. 848
2.81.1 Resource relationships .................................................................. 848
2.81.2 Feed ............................................................................................ 849
2.81.3 Operations .................................................................................... 849
2.82 Virtual Document Snapshot Frozen ................................................ 853
2.82.1 Resource relationships .................................................................. 854
2.82.2 Feed ............................................................................................ 854
2.82.3 Operations .................................................................................... 854
2.83 Word Suggestions ......................................................................... 863
2.83.1 Resource relationships .................................................................. 863
2.83.2 Feed ............................................................................................ 863
2.83.3 Link relations ................................................................................ 864
2.83.4 Operations .................................................................................... 864
2.84 Work Item(s) ................................................................................. 869
2.84.1 Work Item ..................................................................................... 869
2.84.2 Work Items ................................................................................... 873
2.85 Work Queue(s) ............................................................................. 879
2.85.1 Work Queue ................................................................................. 879
2.85.2 Work Queues ................................................................................ 882
2.86 Work Queue Task(s) ..................................................................... 887
2.86.1 Work Queue Task ......................................................................... 887
2.86.2 Work Queue Tasks ....................................................................... 898
2.87 Workflow(s) .................................................................................. 906
2.87.1 Workflow ...................................................................................... 906
2.87.2 Workflows ..................................................................................... 920
2.88 Workflow Activity (ies) ................................................................... 935
2.88.1 Workflow Activity ........................................................................... 935
2.88.2 Workflow Activities ........................................................................ 946
2.89 Workflow Attachment(s) ................................................................. 950
2.89.1 Workflow Attachment .................................................................... 950
2.89.2 Workflow Attachments ................................................................... 952
2.90 Workflow Template(s) .................................................................... 959

EDCPKRST220200-PRE-EN-01 Reference Guide xi

Table of Contents

2.90.1 Workflow Template ....................................................................... 959

2.90.2 Workflow Templates ...................................................................... 970

A Link Relations ........................................................................ 975

B REST Common Definition - URI Request Query

Parameters ............................................................................. 979

C REST Common Definition - HTTP Status Codes ................ 985

D REST Common Definition - HTTP Headers ......................... 987

E AQL ......................................................................................... 991

E.1 Expressions in AQL ....................................................................... 996
E.1.1 Fulltext expression ........................................................................ 998
E.1.2 Property expression ...................................................................... 998
E.1.3 Property list expression ............................................................... 1000
E.1.4 Property range expression ........................................................... 1001
E.1.5 Relative date expression ............................................................. 1002
E.2 Facet in AQL .............................................................................. 1003
E.2.1 Grouping strategy ....................................................................... 1004
E.2.2 Facet ordering ............................................................................ 1007

F Events Audited by Default .................................................. 1009

xii OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

Chapter 1
Overview

OpenText Documentum REST Services, which is also referred to as Documentum

REST Services, is a set of RESTful web service interfaces that interact with the
Documentum platform.

Being developed in a purely RESTful style, Documentum REST Services is

hypertext-driven, server-side stateless, and content negotiable. This provides you
with high efficiency and simplicity in programming, and it also makes all services
easy to consume. These advantages make Documentum REST Services the optimal
choice for Web 2.0 applications and mobile applications to interact with
Documentum repositories.

Documentum REST Services models objects in Documentum repositories as

resources and identifies resources by Uniform Resource Identifiers (URIs). It defines
specific media types to represent resources and drives application state transfers by
using link relations. Documentum REST Services uses a number of HTTP standard
methods (GET, PUT, POST, and DELETE) to manipulate resources over the HTTP
protocol.

This guide is designed as a resource catalog that focuses on how resources are
related to one another. It gives you a general description of each resource and also
discusses the operations that you can perform on each resource.

1.1 Hypermedia-driven API

Documentum REST Services is a purely hypermedia-driven REST API. The physical
Uniform Resource Identifiers (URI) used to access the service's resources are
discoverable at runtime by using link relations instead of using hard-coded values.
Hypermedia is an important aspect of REST because it allows you to build services
where clients and servers are decoupled. This allows those clients and servers to
evolve independently of each other.

Before consuming Documentum REST Services, a REST client requires the URI of
the service’s Home document. This Home document is the entry point for the whole
REST service The Home document URI is the only permanent URI path that the
REST client must bookmark: For example /services.

Issuing an HTTP GET Request for the entry point returns the Home Document,
which contains the link relations for all of the top-level resources that are exposed by
the Documentum REST Service. By default, the resources exposed include the
Repositories collection and the Product Information resource.

Example 1-1: The Home document

Here is an example of a default Home Document:

EDCPKRST220200-PRE-EN-01 Reference Guide 13

Chapter 1 Overview

{
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"
}
}
}
}

The key for each resource is an immutable link relation name that defines the
relation to the target resource. Each resource has an href attribute that contains the
URI of the resource.

Note: An href does not have to be the same from one Documentum REST API
version to another and may change without notice. This underscores the
importance of avoiding hard-coded URIs in your client applications.

Each link relation name, such as self, edit, and about, provides the client with
unchangeable identifiers that identify specific resources.

Example 1-2: Delete Request

This code sample illustrates the delete link relation in the rel element. It also
demonstrates that the purpose of the href link is to delete the current resource,
which in this case is acme02.
"links": [
{
"rel": " http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/acme02"
}
]

14 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 1.1. Hypermedia-driven API

The logical relations between Documentum Core resources are managed using
either link relations or feed-to-entry containership. The following diagram lists
Documentum Core resources from a logical relation point of view.

Figure 1-1: Core Resources in Documentum REST Services

As you can see in the diagram above, the Home Document resource is the starting
point for everything. For example, to obtain the representation of the Repository
resource, you must following these steps:

1. Issue a GET Request for the Home Document to discover the Repositories
collection.

EDCPKRST220200-PRE-EN-01 Reference Guide 15

Chapter 1 Overview

2. Issue a GET Request for the Repositories collection, which returns all of the links
pointing to single Repository resources.
3. Search the returned links for one that points to the Repository resource that you
want and use to perform your task.

The link relations in the Repository resource give you information about what
operations you can perform on that resource. This approach determines the way that
a hypermedia RESTful web service interacts with REST clients.

Note: The above diagram provides a visual overview of Documentum Core

resources and their relationships. It is not intended to be used as a reference to
all relationships between Documentum Core resources. For example, a
Document resource contains a link relation to the type resource, but this
relationship does not appear in the diagram. Furthermore, it does not mean
that you must traverse the path shown in the diagram to get to a resource. For
example, you can also get to a SysObject resource from the DQL Query
resource.

The Explore Documentum REST Services and Tutorial: Consume REST Services
Programmatically chapters, which are in the OpenText Documentum REST Services
Development Guide, provide you with detailed examples on how hypermedia links
work in resource discovery and operation execution.

16 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

Chapter 2

Resources

2.1 Organization of Resource Reference

Documentation
The following guidelines apply to each resource reference documentation entry:

• All method parameters are optional unless otherwise noted.

• The DELETE and GET methods do not have a request body.

About the resource URIs:

Resource URIs are used to identify the physical locations of server resources.
According to REST services best practices, resource URIs should be discovered using
hypermedia, such as link relations and the response Location header. The only
exception is the root entry URI of the Home Document resource.

You are encouraged to use hypermedia to discover your Documentum resources

from the client side. Using hypermedia is far better than attempting to construct the
URI in your client code. To help you with your REST client programming, see
Documentum client samples available on the GitHub website.

About the diagrams in resource relationships

• The target resource is shown in bold.

• Link relationships are shown as strings on arrows.

• The resource to the left of the target resource (resource 0 in the sample) is the
resource that you can use to navigate to the target resource using the link relation
presented on the arrow. There can be more than one resource you can use to
navigate to the target resource. However, only one resource is shown.

• Resources to the right of the target resource (resources 1 to 4 in the sample) are
those that you can reach from the target resource. The diagrams displays at most
four resources to the right of the target resource. Other resources, if they exist,
are shown as suspension points such as (…).
• The string labelled as more on arrows is not a link relation. It is an indication that
you can reach more than four resources from the target resource.

• The string <feed-entry> on arrows is not a link relation. It is an indication that

two resources are linked using feed-to-entry containership.

EDCPKRST220200-PRE-EN-01 Reference Guide 17

Chapter 2 Resources

Figure 2-1: Resource relationships sample

Note: The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”,

“SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”,
and “OPTIONAL” in this document are to be interpreted as described in
RFC2119.

2.2 Installing Additional Services

Most of Documentum REST Services can be used out-of-the-box when the OpenText
Documentum Server repositories and the REST server are installed. However, the
following REST services require the installation of additional services on
Documentum Server:

• Collaboration services
• Search services
• Contextual Content Engine (CCE) services
• Documentum Process Builder services

2.2.1 Collaboration services

The commenting function is dependent on the Collaboration Services module.
Therefore, the Collaboration Services Archive (DAR) files must be installed in
the repository before using the following resources:

• “Comment” on page 154

• “Comments” on page 159
• “Comment Replies” on page 166

18 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.2. Installing Additional Services

2.2.2 Search services

The full-text search function is dependent on the deployment and configuration of
full-text indexing on Documentum repositories. The following resources are only
available when full-text indexing is enabled on the target repositories:

• “Search” on page 643

• “Saved Searches” on page 584
• “Saved Search” on page 573
• “Saved Search Execution” on page 594
• “Saved Search Templates” on page 619
• “Saved Search Template” on page 609
• “Search Template Execution” on page 635
• DQL with full-text query using the parameter q with “Get versions”
on page 21, “Get checked out objects” on page 150, “Get child objects from a
folder” on page 286, and “Get all documents of a folder” on page 245
• “Custom Facets” on page 210

2.2.3 Contextual Content Engine services

The Contextual Content Engine (CCE) is a content recommendation system that
adds contextual intelligence to Documentum Server. Before using the following CCE
related services, a CCE instance must be installed and its URL and repository
configured in the REST runtime. The following are the CCE related resources:

• “Related SME” on page 548

• “Related Documents” on page 540
• “Significant Terms” on page 668
• “Synonyms” on page 680
• “Synonym Categories” on page 684
• “Word Suggestions” on page 863

For detailed description about CCE related runtime property configuration, see to
the Contextual Content Engine (CCE) Service Configuration section of the rest-
api-runtime.properties.template file in the dctm-rest.war\WEB-INF\classes
folder.

EDCPKRST220200-PRE-EN-01 Reference Guide 19

Chapter 2 Resources

2.2.4 Documentum Process Builder services

Documentum Server supports two user interfaces, Documentum Process Builder
and Workflow Manager, for creating and managing workflows.

Workflow Manager (WFM) supports basic workflow functionality. Documentum

Process Builder, which requires an additional license, supports basic functionality,
but it also supports additional features not supported by the WFM.

Therefore, the following resources are only available when the process engine is
enabled on the target repositories:

• Work Queue
• Work Queues
• Work Queue Task
• Work Queue Tasks

Complete descriptions of the additional features supported in Documentum Process

Builder and their use and implementation are found in the Business Process
Manager documentation.

2.3 All Versions

The All Versions resource represents a collection of all versions for a given non-
folder SysObject.

2.3.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “SysObject” on page 690 and About the Diagram on page 17.

20 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.3. All Versions

2.3.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the versions

• Feed Title: All versions
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: Each entry represents a specific version of the given SysObject
• Entry ID: URI of the version
• Entry Title: object_name for the specific version of the object
• Entry Updated: r_modify_date for the specific version of the object

2.3.3 Link relations

Link relation Description Resource reference
self This All Versions resource “All Versions” on page 20
first, last, next, previous Pagination links “All Versions” on page 20

2.3.4 Operations
2.3.4.1 Supported HTTP methods

Method Description
GET Retrieves all versions of a given SysObject.
POST Checks in a given >SysObject.

2.3.4.2 Get versions

Retrieve all versions of a SysObject.

2.3.4.2.1 HTTP Request method and query parameters

EDCPKRST220200-PRE-EN-01 Reference Guide 21

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
GET version- Specifies the string N/A null
label versions with
the specified
version label
only.

A request can
contain
multiple
version-
label
variables.
Objects
whose
version-
label
matches any
of those are
returned.
latest- Specifies string true, false false
versions- whether or
only not to show
the latest
versions only.

22 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.3. All Versions

HTTP Query Description Data type Value range Default value

method parameters
q Specifies the string N/A No search
search criteria is
criterion with used for the
a full-text search.
expression in
Simple
Search
Language.

You must
encode
parameter q
because it
may contain
non-English
locale
characters.

Note:
Internat
ional
charact
ers that
are
used in
this
query
parame
ter
must be
sent
with
URL
encode
d by
the
UTF-8
charset.
Otherw
ise, the
result
may be
incorre
ct.

This method also supports the following common query parameters:

• inline
• sort
• page

EDCPKRST220200-PRE-EN-01 Reference Guide 23

Chapter 2 Resources

• items-per-page
• include-total
• view
• links
• filter

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.3.4.2.2 Request media types

None

2.3.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.3.4.2.4 Request body

None

2.3.4.2.5 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.3.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

24 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.3. All Versions

2.3.4.2.7 Response statuses

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.3.4.2.8 Response body

XML or JSON representation of all or a subset of versions of a given SysObject.

• Each object may contain all or a set of properties of the versions, depending on
the setting of the view query parameter.
• The returned child objects collection only contains those items to which you have
access.
• Pagination is supported.
• By default, the results are sorted by the i_latest_flag and creation-date
properties in descending order.

2.3.4.3 Check in an object

Check in the SysObject resource that has been checked out.

2.3.4.3.1 HTTP Request method and query parameters

EDCPKRST220200-PRE-EN-01 Reference Guide 25

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
POST content- Specifies how integer >=0 0
count many pieces
of content are
submitted.
The metadata
is excluded
from the
count.

When more
than one
piece of
content
exists, the
total content
count must
be provided.
Otherwise,
only the first
content type
is used. For
example,
when you
import an
object with
one object
metadata and
five binary
content types,
then the
value of the
content-
count
parameter is
5.

26 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.3. All Versions

HTTP Query Description Data type Value range Default value

method parameters
all- Specifies string true or true
primary whether to false
import all
contents
using the
same type as
the primary
content type
for different
pages (page
0, 1, 2...), or
one primary
content type,
and others as
renditions for
the first page,
which is page
0.

EDCPKRST220200-PRE-EN-01 Reference Guide 27

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
content- Specifies the string Comma null
length byte count of separated
the contents string of
to be integer
uploaded. number
values
This
parameter is
optional.

A comma
separated list
can be used
to specify
multiple
values for
this
parameter.
For example:
content-
length=
1024,2048,
,4096. The
blank value
shown above
is 0.

When the
all-
primary
parameter is
false, the
first value in
the comma
separated list
is used for
the
content-
length of
the primary
content, and
all other
values in the
list are
ignored.

28 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.3. All Versions

HTTP Query Description Data type Value range Default value

method parameters
version- Specifies the string A string null
policy version containing
policy by any one of
using one of the valid
the following values:
valid values: next-
major,
• next-
major: next-
The object minor,
receives branch-
the next version, or
major none.
version
number.
• next-
minor:
The object
receives
the next
minor
version
number.
• branch-
version:
The object
receives a
branch
version
number.
• none: No
version
policy is
specified.
Document
um Server
makes the
decision.

EDCPKRST220200-PRE-EN-01 Reference Guide 29

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
retain- Specifies string true or false
lock whether to false
keep the
object
checked out
and locked
by the user
after the new
version is
saved.
• true:
Keep the
lock after
the new
version is
saved.
• false:
The object
is not
locked
after the
new
version is
saved.

30 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.3. All Versions

HTTP Query Description Data type Value range Default value

method parameters
version- Specifies one string One or more null
label * or more version labels
on page 37 version labels of the
of the checked in
checked in object
object with
the following
constraints:
• By
default,
numeric
version
labels,
such as
1.1,
2.1.0.1, 5.0
are not
allowed.
• You
cannot set
this
parameter
to
CURRENT.
To make
this check-
in the
current
version,
use the
make-
current
operation.
comment Specifies the string Any valid null
comment for string
a check-in
operation.
page Specifies the integer >=0 0
content page
number with
any non-
negative
number
adhering to
the
constraints
defined by
Documentum
Server.

EDCPKRST220200-PRE-EN-01 Reference Guide 31

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
format Specifies the string Comma null
format when separated
checking in string
more than
one type of
content. A
comma
separated
string can be
used to
specify
multiple
values for the
format
parameter.
For example:
format=
crtext,
html,pub_
html.

The format
list must
match the
content
sequence.
When you
don't want to
specify the
format for a
piece of
content you
can leave it
blank in the
comma
separated list
but you must
still include
the comma as
a placeholder.

For example:
format=
crtext,,
html

When the
format for a
piece of
content is not
defined, the
server uses

32 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.3. All Versions

HTTP Query Description Data type Value range Default value

method parameters
the content
media type to
select the
format.

When the
all-
primary
parameter is
true and
page=0, all
primary
content types
must have
the same
format. In
this case,
when you
define more
than one
format, they
must be the
same.

For example:
format=
crtext,
crtext,
crtext.

When the
all-
primary
parameter is
true and the
page
parameter is
greater than
0, you can
define one
format for all
of the
primary
content. For
example:
format=
crtext. In
this case, all
format values
must be the
same as the
format of the
primary

EDCPKRST220200-PRE-EN-01 Reference Guide 33

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
content of the
first page,
which is page
0.
make- Determines string true or true
current whether or false
not to make
this check-in
the current
version.

34 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.3. All Versions

HTTP Query Description Data type Value range Default value

method parameters
content- This string Comma null
charset parameter separated
defines the string of
parse integer
behavior of number
the server values
when
sanitizing
content. A
comma
separated
string can be
used to
specify
multiple
values for
this
parameter.
For example:
content-
charset=
UTF-8,GBK,
ISO-8859-1

When the
content-
charset
parameter is
not set and
content is in
HTML
format, the
server tries to
get a value
for the
content-
charset
parameter
from the
metadata
information
of the content
itself.

When the
metadata has
a valid
charset, then
it is used to
sanitize the
content.
Otherwise,

EDCPKRST220200-PRE-EN-01 Reference Guide 35

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
the
configuration
default
charset is
used for the
content-
charset
parameter
when a value
for this
parameter
and the
metadata
information
are not
found.

Note:
When
the
charset
and
content
do not
match,
the
upload
ed
content
may
have an
incorre
ctly
encode
d value.

36 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.3. All Versions

HTTP Query Description Data type Value range Default value

method parameters
modifier Specifies the string Comma null
modifier of separated
the contents. string
For the
primary
content, the
modifier is
ignored.

For example,
when you
import with
the all-
primary
parameter set
to false, the
value of the
modifier can
be: modifier
=,mod1,
mod2,mod3 .

That means
the first (or
primary)
content type
has no
modifier, and
the second
rendition’s
modifier is
mod1, the
third is mod2
and so on.

Setting the
all-
primary
parameter to
true , or when
content-
count<=1
causes all
modifiers to
be ignored.

* Repeatable parameter

Note: Here are some additional details about the variables listed above:

• format

EDCPKRST220200-PRE-EN-01 Reference Guide 37

Chapter 2 Resources

The format list must match the content sequence. When you don't want to
specify the format for a piece of content you can leave it blank in the comma
separated list but you must still include the comma as a placeholder.
For example: format=crtext,,html
When the format for contents is not defined, the server uses the content
media type to select the format.
When the all-primary parameter is true, all primary content types must
have the same format. In this case, when you define more than one format,
they must be the same
For example: format=crtext,crtext,crtext. You can also define one
format for all of the primary content: format=crtext

• content-charset
When the metadata has a valid charset, then it is used to sanitize the content.
When the content-charset is not provided and the content is in HTML
format, the server tries to get a value for the content-charset parameter
from the metadata information of the content itself.
The configuration default charset is used when the content-charset
parameter and the metadata information are not found
When the charset and the content do not match, the uploaded content may
have an incorrectly encoded value.

• content-length
When the all-primary parameter is set to false, the first value of in the
content-length parameter is used for the primary piece of content, the
other values in the comma separated string are ignored.
When storing content to Centera storage, the content-length parameter is
mandatory and must be provided.
For other storage mediums, such as harddisk, the content-length
parameter is optional.
In all cases, including when the content-length parameter is not required,
if a value for it is set, the value must be an accurate byte count of the
contents to be uploaded.

• content-count
When you import more than one piece of contents, the REST server must
know how many content pieces there are in total. The total number of
content pieces cannot be obtained until the end of the multipart stream.
Therefore, the client must specify this number in the value of the content-
count parameter.

When the value set in the content-count parameter is greater than the
actual number of content pieces, an exception is thrown because the system
expects more content pieces.

38 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.3. All Versions

When the value set in the content-count parameter is less than the actual
number of content pieces, all content pieces that exist in addition to the
number of pieces set in the content-count parameter are ignored.
The value provided by the content-count must be accurate.

2.3.4.3.2 Request media types

When the client tries to check in both the metadata and one or more pieces of
content, the Content-Type must be one of the following:

• multipart/form-data
• multipart/mixed

In addition to the above, the Content-Type of the first part must either:

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

When the client tries to check in more than one piece of content without metadata,
the Content-Type must be one of the following:

• multipart/form-data
• multipart/mixed

When the client tries to check in the metadata only, the Content-Type must be one
of the following:

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

For content types other than any of the types mentioned above, the server treats the
operation as a single content-only check-in.

2.3.4.3.3 Request headers

• Authorization
• Accept
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 39

Chapter 2 Resources

2.3.4.3.4 Request body

The Request body contains one of or both of the following:

• The object metadata in XML or JSON

• The pieces of binary content

2.3.4.3.4.1 Request payload samples

Example 2-1: Metadata and binary content in XML

Content-Type: multipart/form-data; boundary=314159265358979

--314159265358979
Content-Type: application/vnd.emc.documentum+xml
<document xsi:type="dm_document"
definition="http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/
acme01/types/dm_document">
<properties xsi:type="dm_document-properties">
<object_name>Blank PowerPoint Presentation</object_name>
…
</properties>
</document>

--314159265358979
Content-Disposition: form-data; name=binary1
Content-Type: text/plain

This is content
--314159265358979--

Example 2-2: Check in metadata and binary content in XML

--314159265358979
Content-Disposition: form-data; name=metadata
Content-Type: application/vnd.emc.documentum+xml

<object>
<properties>
<object_name>xyz</object_name>
</properties>
</object>

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the first content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the second content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

40 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.3. All Versions

This is the third content part

--314159265358979--

Example 2-3: Check in metadata and binary content in JSON

--314159265358979
Content-Disposition: form-data; name=metadata
Content-Type: application/vnd.emc.documentum+json
{
"properties":{
"object_name":"xyz"
}
}

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the first content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the second content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the third content part

--314159265358979--

2.3.4.3.4.2 Request payload samples

Example 2-4: Check in binary content without metadata

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the first content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the second content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

EDCPKRST220200-PRE-EN-01 Reference Guide 41

Chapter 2 Resources

This is the third content part

--314159265358979--

2.3.4.3.5 Response headers

• Content-Type
• Location

2.3.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.3.4.3.7 Response status

• 201 - Checked in successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.3.4.3.8 Response body

This is an XML or JSON representation of the object instance. The successful

response contains all properties of the checked in object. A permission set is not
returned.

2.4 ACL
2.4.1 ACL
The ACL resource represents the object instance for an Access Control List (ACL).

42 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.4. ACL

2.4.1.1 Resource relationships

The following diagram shows how the ACL resource is related to other resources:

See Also: “ACLs Collection” on page 55 and About the Diagram on page 17.

2.4.1.2 Feed
No feed support.

2.4.1.3 Link relations

Link relation Description Resource reference

self This ACL resource “ACL” on page 42
edit Edit this ACL resource “ACL” on page 42
delete [1] Delete this ACL resource “ACL” on page 42
associations [1] Retrieve the sysobjects “ACL Associations”
associated with the ACL on page 65
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.4.1.4 Operations
2.4.1.4.1 Supported HTTP methods

Method Description
POST Updates the attributes of the ACL object
instance
GET Retrieves the attributes and other
information of the ACL object instance
DELETE Deletes the ACL object instance from the
repository

EDCPKRST220200-PRE-EN-01 Reference Guide 43

Chapter 2 Resources

2.4.1.4.2 Get an ACL object instance

Retrieves the attributes and other information of the ACL object instance. Attributes
are returned as embedded elements in the response message body. Other
information is available within the link relations of the response message body.

2.4.1.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• view
• links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.4.1.4.2.2 Request media types

N/A

2.4.1.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.4.1.4.2.4 Request body

N/A

2.4.1.4.2.5 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

44 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.4. ACL

2.4.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.4.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.4.1.4.2.8 Response body

The properties block contains the following two sets of data:

• The metadata of this ACL

• ACL entries.
ACL entries are not presented one by one. Instead, an ACL resource displays the
details of the entries in the following six elements:

– r_accessor_name
– r_accessor_permit
– r_accessor_xpermit
– r_is_group
– r_permit_type
– r_application_permit

These six elements contain the same number of items, which is also the number
of entries in the ACL. The combination of items and elements positioning creates
a key value pair that represents one ACL entry.

In the following code sample, the combination of all first items indicates that the
accessor <dm_world>, which is an individual user where <r_is_group> is false, has
Read basic permission (<r_accessor_permit> is 3), as well as EXECUTE_PROCEDURE and
CHANGE_LOCATION extended permissions (<r_accesor_xpermit> is 0) on the objects to
which this ACL is attached. It also indicates that the entry’s permit type is
<AccessPermit> (r_permit_type is 0).

Example 2-5: XML response

Status Code: 200 OK

EDCPKRST220200-PRE-EN-01 Reference Guide 45

Chapter 2 Resources

Content-Type: application/vnd.emc.documentum+xml;charset=UTF-8

<?xml version='1.0' encoding='UTF-8'?>

<acl
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 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/associations"

46 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.4. ACL

href="http://localhost:8080/dctm-rest/repositories/
REPO/acls/4500000580000d07/associations"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/
REPO/acls/4500000580000d07"/>
</links>
</acl>

Example 2-6: JSON response

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+json;charset=UTF-8
{
"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,

EDCPKRST220200-PRE-EN-01 Reference Guide 47

Chapter 2 Resources

"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"
}
]
}

2.4.1.4.3 Update the ACL object instance

Updates the ACL with specified attributes. When a client provides a request body
that contains undefined or read only attributes, the server throws an exception. An
ACL object can only be modified by its owner or the SuperUser.

The server throws an exception when the update request provides attributes whose
values do not have matching positions in the repeating attributes, such as r_
accessor_name and r_accessor_permit.

2.4.1.4.3.1 HTTP Request method and query parameters

POST

48 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.4. ACL

2.4.1.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.4.1.4.3.3 Request headers

• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.4.1.4.3.4 Request body

A single XML or JSON object instance. Only the following properties can be put into
the request message body:

• <description>
• <acl_class>
• <r_accessor_name>
• <r_accessor_permit>
• <r_accessor_xpermit>
• <r_application_permit>
• <r_permit_type>

Notes

• Except for <description> and <acl_class>, all editable properties are prefixed
with <r_>, and must contain the same number of items. Otherwise, the REST
server throws an exception.
• Every ACL has two built-in accessors: <dm_world> and <dm_owner>. The
default permission value of these two accessors is defined by the
Documentum Server configuration.
• To update an ACL template instance (acl_class=2), you must change it to a
regular (acl_class=0) ACL, public (acl_class=3) ACL, or template (acl_class=1)
ACL first. Additionally, you cannot change a regular, public, or template
ACL into an ACL template instance.

Example 2-7: XML request

<?xml version='1.0' encoding='UTF-8'?>

<acl xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:type="dm_acl">
<properties>
<r_accessor_name>
<item>{accessor-name_1}</item>

EDCPKRST220200-PRE-EN-01 Reference Guide 49

Chapter 2 Resources

<item>{accessor-name_2}</item>
</r_accessor_name>
<r_accessor_permit>
<item>{accessor-permit_1}</item>
<item>{accessor-permit_1}</item>
</r_accessor_permit>
<r_permit_type>
<item>{permit-type_1}</item>
<item>{permit-type_1}</item>
</r_permit_type>
...
</properties>
</acl>

Example 2-8: JSON request

{
"name": "acl",
"type": "dm_acl",
"properties": {
"r_accessor_name": [
"{accessor-name_1}",
"{accessor-name_1}"
],
"r_accessor_permit": [
{accessor-permit_1},
{accessor-permit_2}
],
"r_permit_type": [
{permit-type_1},
{permit-type_2}
]
...
}
}

2.4.1.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

50 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.4. ACL

2.4.1.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.4.1.4.3.7 Response status

• 200 - Updated successfully

• 400, 401, 403, 404, 406, 409, 415, 500

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.4.1.4.3.8 Response body

When the response is successful, it contains all the attributes of the updated object.

Example 2-9: XML response

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+xml;charset=UTF-8

<?xml version='1.0' encoding='UTF-8'?>

<acl xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_acl" definition="{typeResourceUri}">
<properties>
<object_name>{object-name}</object_name>
<description>{description of this object}</description>
<owner_name>{object-owner}</owner_name>
<r_accessor_name>
<item>dm_world</item>
<item>dm_owner</item>
<item>{accessor-name_1}</item>
<item>{accessor-name_2}</item>
</r_accessor_name>
<r_accessor_permit>
<item>3</item>
<item>7</item>
<item>{accessor-permit_1}</item>
<item>{accessor-permit_2}</item>
</r_accessor_permit>
<r_permit_type>
<item>0</item>
<item>0</item>
<item>{permit-type_1}</item>
<item>{permit-type_2}</item>
</r_permit_type>
...
</properties>
<links>
<link rel="self" href="{aclResourceUri}"/>
<link rel="edit" href="{aclResourceUri}"/>

EDCPKRST220200-PRE-EN-01 Reference Guide 51

Chapter 2 Resources

<link rel="http://identifiers.emc.com/linkrel/delete"
href="{aclResourceUri}"/>
<link rel="http://identifiers.emc.com/linkrel/associations"
href="{aclAssociationsResourceUri}"/>
</links>
</acl>

Example 2-10: JSON response

Status Code: 200 OK
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"name": "acl",
"type": "dm_acl",
"definition": "{typeResourceUri}",
"properties": {
"object_name": "{object-name}",
"description": "{description of this object}",
"owner_name": "{object-owner}",
"r_accessor_name": [
"dm_world",
"dm_owner",
"{accessor-name_1}",
"{accessor-name_2}"
],
"r_accessor_permit": [
3,
7,
{accessor-permit_1},
{accessor-permit_2}
],
"r_permit_type": [
0,
0,
{permit-type_1},
{permit-type_2}
],
...
},
"links": [
{
"rel": "self",
"href": "{aclResourceUri}"
},
{
"rel": "edit",
"href": "{aclResourceUri}"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "{aclResourceUri}"
},
{
"rel": "http://identifiers.emc.com/linkrel/associations",
"href": "{aclAssociationsResourceUri}"
}

52 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.4. ACL

]
}

2.4.1.4.4 Delete the ACL object instance

Deletes the ACL object instance. When deletion fails, an exception is thrown.

2.4.1.4.4.1 HTTP Request method and query parameters

EDCPKRST220200-PRE-EN-01 Reference Guide 53

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
DELETE force Indicates string true: false
whether or Destroys the
not to delete ACL object
the ACL even even if it is
when it is referenced by
associated other objects
with other in the
objects in the repository.
repository. Only the
super user
After the has the
deletion, necessary
objects permissions
associated to force
with this delete an
ACL have no ACL object.
referenced
ACL, which false: Does
means that not destroy
the following the ACL
constraints object if it is
apply to these referenced by
objects: other objects.
• These
objects
become
read-only
• These
objects are
accessible
only to
the
object's
owner
and users
with the
SuperUs
er
privilege.
• Only
users with
the
SuperUs
er
privilege
can delete
these
objects.

54 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.4. ACL

2.4.1.4.4.2 Request media types

N/A

2.4.1.4.4.3 Request headers

Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.4.1.4.4.4 Request body

N/A

2.4.1.4.4.5 Response headers

N/A

2.4.1.4.4.6 Response media types

N/A

2.4.1.4.4.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 500

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.4.1.4.4.8 Response body

N/A

2.4.2 ACLs Collection

The ACLs Collection represents the collection of all Access Control Lists (ACLs) in
the repository that are available to the user that is currently logged into the system.

EDCPKRST220200-PRE-EN-01 Reference Guide 55

Chapter 2 Resources

2.4.2.1 Resource relationships

The following diagram illustrates how this resource is related with other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.4.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: <Feed URI>

• Feed Title: ACLs
• Feed Updated: The server's current time
• Supports POST: Yes
• Entry: Each entry represents an ACL object
• Entry ID: The object ID of the ACL entry
• Entry Title: The object name of the ACL entry
• Entry Updated: The server's current time

2.4.2.3 Link relations

Link relation Description Resource reference

self This ACL resource “ACLs Collection”
on page 55
first, last, next, previous Pagination links “ACLs Collection”
on page 55

2.4.2.4 Operations

56 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.4. ACL

2.4.2.4.1 Supported HTTP methods

Method Description
POST Creates an ACL
GET Retrieves ACLs that are available to the
current user from a repository

2.4.2.4.2 Get the ACLs Collection

Lists all the available ACLs in the repository for the current user.

2.4.2.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• inline

• sort

• page

• items-per-page

• include-total

• view

• links

• filter

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.4.2.4.2.2 Request media types

N/A

2.4.2.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 57

Chapter 2 Resources

2.4.2.4.2.4 Request body

N/A

2.4.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.4.2.4.2.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.4.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.4.2.4.2.8 Response body

Example 2-11: XML response

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+xml;charset=UTF-8

<?xml version='1.0' encoding='UTF-8'?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/acls</id>
<title>Acls</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2015-06-09T10:20:41.905+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?filter=owner_name=%27dave%27%20and%20r_is_internal=false
&items-per-page=2"/>
<link rel="next" href="http://localhost:8080/dctm-rest/repositories/REPO/
acls?filter=owner_name=%27dave%27%20and%20r_is_internal=false

58 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.4. ACL

&items-per-page=2&page=2"/>
<link rel="first" href="http://localhost:8080/dctm-rest/repositories/REPO/
acls?filter=owner_name=%27dave%27%20and%20r_is_internal=false
&items-per-page=2&page=1"/>
<entry>
<id>4500000580001d18</id>
<title>test_acl_1377352452</title>
<updated>2015-06-09T10:20:41.906+00:00</updated>
<published>2015-06-09T10:20:41.906+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/
acls/
4500000580001d18"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/acls/
4500000580001d18"/>
</entry>
<entry>
<id>4500000580001d58</id>
<title>3fb1de-8f77-4064-92a8-90d8950676</title>
<updated>2015-06-09T10:20:41.906+00:00</updated>
<published>2015-06-09T10:20:41.906+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/
acls/
4500000580001d58"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/acls/
4500000580001d58"/>
</entry>
</feed>

Example 2-12: JSON response

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+json;charset=UTF-8
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/acls",
"title": "ACLs",
"author": [
{
"name": "OpenText Documentum"
}
],
"updated": "2015-06-11T03:29:15.085+00:00",
"page": 1,
"items-per-page": 2,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls?
filter=owner_name=%27dave%27%20and%20r_is_internal=false
&items-per-page=2"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls?
filter=owner_name=%27dave%27%20and%20r_is_internal=false
&items-per-page=2&page=2"

EDCPKRST220200-PRE-EN-01 Reference Guide 59

Chapter 2 Resources

},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/acls?
filter=owner_name=%27dave%27%20and%20r_is_internal=false
&items-per-page=2&page=1"
}
],
"entries": [
{
"id": "4500000580001d37",
"title": "test_acl_1913536617",
"updated": "2015-06-11T03:29:15.127+00:00",
"published": "2015-06-11T03:29:15.127+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
acls/
4500000580001d37"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/acls/
4500000580001d37"
}
},
{
"id": "4500000580001d58",
"title": "restAcl8f62ed43-f9",
"updated": "2015-06-11T03:29:15.130+00:00",
"published": "2015-06-11T03:29:15.130+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
acls/
4500000580001d58"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/acls/
4500000580001d58"
}
}
]
}

60 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.4. ACL

2.4.2.4.3 Create an ACL

Create a new ACL in the repository.

2.4.2.4.3.1 HTTP Request method and query parameters

POST

2.4.2.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.4.2.4.3.3 Request headers

• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.4.2.4.3.4 Request body

• An XML or JSON message representing the ACL object that is created.

• The server throws an exception when undefined or read-only attributes are
provided by the client.
• An ACL instance cannot be created manually. In other words, you cannot create
an ACL with the value of the acl_class attribute set to 2. An ACL instance is
automatically created when an ACL template is applied to a SysObject by the
owner of the repository.
• The r_object_type attribute is not set because its value is dm_acl by default.

Example 2-13: XML request

<?xml version='1.0' encoding='UTF-8'?>

<acl xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:type="dm_acl"
definition="{typeResourceUri}">
<properties>
<object_name>{object-name}</object_name>
<description>{description of this object}</description>
<owner_name>{object-owner}</owner_name>
<r_accessor_name>
<item>dm_world</item>
<item>dm_owner</item>
<item>{accessor-name_1}</item>
<item>{accessor-name_2}</item>
</r_accessor_name>
<r_accessor_permit>
<item>3</item>
<item>7</item>
<item>{accessor-permit_1}</item>

EDCPKRST220200-PRE-EN-01 Reference Guide 61

Chapter 2 Resources

<item>{accessor-permit_2}</item>
</r_accessor_permit>
<r_permit_type>
<item>0</item>
<item>0</item>
<item>{permit-type_1}</item>
<item>{permit-type_2}</item>
</r_permit_type>
... ...
</properties>
</acl>

Example 2-14: JSON request

{
"name": "acl",
"type": "dm_acl",
"definition": "{typeResourceUri}",
"properties": {
"object_name": "{object-name}",
"description": "{description of this object}",
"owner_name": "{object-owner}",
"r_accessor_name": [
"dm_world",
"dm_owner",
"{accessor-name_1}",
"{accessor-name_2}"
],
"r_accessor_permit": [
3,
7,
{accessor-permit_1},
{accessor-permit_2}
],
"r_permit_type": [
0,
0,
{permit-type_1},
{permit-type_2}
],
... ...
}
}

62 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.4. ACL

2.4.2.4.3.5 Response headers

• Content-Type
• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.4.2.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.4.2.4.3.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.4.2.4.3.8 Response body

Every ACL has two built-in accessors:

• dm_world
• dm_owner

Even when these two accessors and their permissions are not provided by the client,
the server grants them default permissions in the ACL object. The default
permission value for each of these two accessors is defined by the configuration of
the Documentum Server.

Example 2-15: XML response

Status Code: 201 Created

Location: http://localhost/dctm-rest/repositories/REPO/acls/
45000005800019c1

Content-Type: application/vnd.emc.documentum+json;charset=UTF-8
<?xml version='1.0' encoding='UTF-8'?>
<acl xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:type="dm_acl"
definition="{typeResourceUri}">
<properties>
<object_name>{object-name}</object_name>

EDCPKRST220200-PRE-EN-01 Reference Guide 63

Chapter 2 Resources

<description>{description of this object}</description>

<owner_name>{object-owner}</owner_name>
<r_accessor_name>
<item>dm_world</item>
<item>dm_owner</item>
<item>{accessor-name_1}</item>
<item>{accessor-name_2}</item>
</r_accessor_name>
<r_accessor_permit>
<item>3</item>
<item>7</item>
<item>{accessor-permit_1}</item>
<item>{accessor-permit_2}</item>
</r_accessor_permit>
<r_permit_type>
<item>0</item>
<item>0</item>
<item>{permit-type_1}</item>
<item>{permit-type_2}</item>
</r_permit_type>
... ...
</properties>
<links>
<link rel="self" href="{aclResourceUri}"/>
<link rel="edit" href="{aclResourceUri}"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="{aclResourceUri}"/>
<link rel="http://identifiers.emc.com/linkrel/associations"
href="{aclAssociationsResourceUri}"/>
</links>
</acl>

Example 2-16: JSON response

Status Code: 201 Created
Location: http://localhost/dctm-rest/repositories/REPO/acls/45000005800019c1
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"name": "acl",
"type": "dm_acl",
"definition": "{typeResourceUri}",
"properties": {
"object_name": "{object-name}",
"description": "{description of this object}",
"owner_name": "{object-owner}",
"r_accessor_name": [
"dm_world",
"dm_owner",
"{accessor-name_1}",
"{accessor-name_2}"
],
"r_accessor_permit": [
3,
7,
{accessor-permit_1},
{accessor-permit_2}
],

64 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.5. ACL Associations

"r_permit_type": [
0,
0,
{permit-type_1},
{permit-type_2}
],
... ...
},
"links": [
{
"rel": "self",
"href": "{aclResourceUri}"
},
{
"rel": "edit",
"href": "{aclResourceUri}"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "{aclResourceUri}"
},
{
"rel": "http://identifiers.emc.com/linkrel/associations",
"href": "{aclAssociationsResourceUri}"
}
]
}

2.5 ACL Associations

The ACL Associations resource represents a collection of all the sysobjects that are
associated with a specified ACL.

2.5.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “ACL” on page 42 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 65

Chapter 2 Resources

2.5.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the ACL Associations resource

• Feed Title: Objects
• Feed Updated: The server's current time
• Supports POST: No
• Entry: “SysObject” on page 690
• Entry ID: The <ObjectID> of a SysObject
• Entry Title: The object name of SysObject
• Entry Updated: The value of the <r_modify_date>

2.5.3 Link relations

The following table lists general link relations in the ACL Associations resource:

Link relation Description Resource reference

self The ACL Associations “ACL Associations”
collection on page 65
first, last, next, previous Pagination links “ACL Associations”
on page 65

2.5.4 Operations
2.5.4.1 Supported HTTP methods

Method Description
GET GET all SysObjects associated with a
specific ACL object.

2.5.4.2 List all available SysObjects associated with an ACL object

This method lists all available SysObjects that are associated with a specific ACL
object.

66 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.5. ACL Associations

2.5.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• inline
• sort
• page
• items-per-page
• include-total
• view
• links
• filter

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.5.4.2.2 Request media types

N/A.

2.5.4.2.3 Request headers

• Accept
• Authorization

2.5.4.2.4 Request body

N/A.

2.5.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 67

Chapter 2 Resources

2.5.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.5.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.5.4.2.8 Response body

Example 2-17: XML response

<?xml version='1.0' encoding='UTF-8'?>

<feed
xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>{aclAssociationsResourceUri}</id>
<title>Objects</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>{current_time}</updated>
<dm:page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">{page}
</dm:page>
<dm:items-per-page
xmlns:dm="http://identifiers.emc.com/vocab/documentum">{items-per-page}
</dm:items-per-page>
<link rel="self" href="{aclAssociationsResourceUri}"/>
... pagination links ...
<entry>
<id>{objectResourceUri}</id>
<title>{object_name}</title>
<author>
<name>{author_name}</name>
<uri>{userResourceUri}</uri>
</author>
<summary>{r_object_type} {r_object_id}</summary>
<updated>{r_modify_date} or {current_time}</updated>
<published>{creation-date} or {current_time}</published>
<link rel="edit" href="{objectResourceUri}"/>
<content type="application/vnd.emc.documentum+xml"
src="{objectResourceUri}"/>
</entry>
...
</feed>

68 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.5. ACL Associations

Example 2-18: JSON response

{
"id": "{aclAssociationsResourceUri}",
"title": "Objects",
"author": [
{
"name": "OpenText Documentum"
}
],
"updated": "{current_time}",
"page": {page},
"items-per-page": {items-per-page},
"links": [
{
"rel": "self",
"href": "{aclAssociationsResourceUri}"
},
... pagination links ...
],
"entries": [
{
"id": "{objectResourceUri}",
"title": "{object_name}",
"author": [
{
"name": "{author_name}",
"uri": "{userResourceUri}"
}
],
"summary": "{r_object_type} {r_object_id}",
"updated": "{r_modify_date} or {current_time}",
"published": "{creation-date} or {current_time}",
"links": [
{
"rel": "edit",
"href": "{objectResourceUri}"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "{objectResourceUri}"
}
},
...
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 69

Chapter 2 Resources

2.6 Archived Contents

This 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, the object contents of sub folder are downloaded.

2.6.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.6.2 Feed
Is this resource a feed? Yes.

2.6.3 Link relations

N/A

2.6.4 Operations
2.6.4.1 Supported HTTP methods

Method Description
GET Using a ZIP file format, this method retrieves
all of the contents from a single object.
POST Using a ZIP file format, this method retrieves
the first page of the contents, or all of the
contents, from multiple objects.

70 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.6. Archived Contents

2.6.4.1.1 rest.archive.contents.threshold

In order to prevent potential performance issues caused by attempting to download

huge files, the REST server uses a runtime property called rest.archive.
contents.threshold to set the maximum file size allowed for content. The
maximum allowed file size defaults to 20 GB and is set using <kilobytes>. Exceeding
the maximum file size causes an error to be returned by the REST server, and
archiving fails.

Example 2-19: rest-api-runtime.properties

# Sets the maximum size, in megabytes, of the contents that are allowed to be
archived.
# When the sum of all the contents' original size is greater than the value of
# ${rest.archive.contents.threshold} megabytes, then that contents will not be
archived
# and an error is returned by the REST server.
# The value of this runtime property defaults to 20971520 kilobytes, which is
20GB.
#
rest.archive.contents.threshold=20971520

2.6.4.2 Get a single object’s contents

Retrieves all of the contents of a single object. The specified object can be a simple
document, a folder, or a virtual document. When the object is a folder, or a subtype
of <dm_folder>, then the REST server retrieves all of the objects contents
(<dm_sysobject> ) that are directly under that folder, in this case, any virtual
documents that exist under this folder are treated as simple documents. When the
specified object is a virtual document, you can use the <include-children> parameter
to determine whether or not contents that are in its child objects is also downloaded.

2.6.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET object-id Defines the string N/A null
object ID of
the object
whose
contents the
client wants
to get.
format Specifies the string Any format null
file format of that is
the contents registered in
that is the Format
retrieved. table of the
repository.

EDCPKRST220200-PRE-EN-01 Reference Guide 71

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
include- When the string true, false false
children object is a
virtual
document
this
parameter
determines
whether or
not to get the
content from
its children.
include- Determines string true, false false
broken whether or
not to include
nodes with
broken
bindings for a
virtual
document.
binding- Determines string CURRENT
label the version
label that is
used to
resolve late
bound nodes
for a virtual
document.
depth Defines to integer -1 or >= 0 1
what depth
level in the
virtual
document
hierarchy will
be returned.

A value of -1
is used to
return the
whole virtual
document
tree.

Note: The <include-broken>, <binding-label>, and <depth> parameters only work

when the object is a virtual document and the <include-children> parameter has
a value of true.

72 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.6. Archived Contents

2.6.4.2.2 Request media types

N/A

2.6.4.2.3 Request headers

• Authorization
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.6.4.2.4 Request body

N/A

2.6.4.2.5 Response headers

• Content-Type: application/zip
• Content-Disposition: attachment;filename={object-name}_content.zip

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.6.4.2.6 Response media types

N/A

2.6.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.6.4.2.8 Response body

2.6.4.2.8.1 Naming conventions

Each item in a ZIP file must have a unique name. To ensure that each content object
item in the ZIP file has a unique name, the REST server follows these naming
conventions to generate each content object name:

• By default, each content object is named using the following pattern: {object-
name}.{extension}

• Here’s an example to illustrate the naming conventions.

– Let’s say that there is a folder named <mmtm_deck> in the home cabinet, and
the folder id is <0b0000058000951d>.

EDCPKRST220200-PRE-EN-01 Reference Guide 73

Chapter 2 Resources

– The above folder has 7 documents in it. Some of those documents have a file
name and extension and others do not. The following image shows this
folder:

In the above image, we have numbered the files so we can see the resulting
file names in the next image. Take particular note of files number 3 and 4
above, they both have the same file name and file extension.
– At this point, we use the REST API to download the above folder’s contents to
our local file system using the following GET method statement:
/dctm-rest/repositories/REPO/archived-contents?object-
id=0b0000058000951d

– The response is a ZIP file that we can save to our local file system. The
suggested name for the resulting ZIP file is mmtm_deck_content.zip.
– When we extract the ZIP file and examine the folder contents, we see the
folder structure shown in the image below. Note the resulting names for files
that would have caused a name duplication, such as file number 4
(NetTopology), which has had its name generated using its object ID.

74 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.6. Archived Contents

2.6.4.2.8.2 Special cases

• When an object name is null or empty, the string “<_EMPTY_>” is used to

replace the variable <{object-name}> , which results in the name <_EMPTY_.
{extension}>.
• Since ZIP uses slashes as reserved characters to mark directories, all forward
slash (“\”) characters in object names are replaced with their Unicode equivalent
of “%2F”, and all back slash (“\”) characters are replaced with “%5C”.
• When the content format parameter is empty or null, the “<.{extension}>” portion
of the object name is not used or displayed.
• When a duplication of any ZIP entry with <{object-name}.{extension}> occurs, the
content object id is appended to the name to ensure that it is unique. For
example, a duplicated <{object-name}.{extension}> entry name would be changed
into <{object-name}({content-id}).{extension}> to make it unique.

2.6.4.2.9 Code samples

Example 2-20: Request and response

// Request

GET /dctm-rest/repositories/REPO/archived-contents?object-id=0b0004d2800060e6
HTTP/1.1
Host: localhost:8080
Authorization: Basic ZG1hZG1pbjpwYXNzd29yZA==

// Response

Status 200 OK

content-disposition →attachment; filename="test-folder-1_content.zip"

content-type →application/zip

... zip file format stream ...

2.6.4.3 Get multiple object’s contents

2.6.4.3.1 HTTP Request method and query parameters

Retrieves the first page of contents or all of the contents for multiple objects in ZIP
file format. When an object is a folder (or a subtype of <dm_folder>), the REST server
gets the contents of those objects (<dm_sysobject>) that are under that folder. When
this is the case, virtual documents are treated as simple documents.

EDCPKRST220200-PRE-EN-01 Reference Guide 75

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
POST format Specifies the string Any format null
file format of that is
the contents registered in
that is the Format
retrieved. table of the
repository
all-contents Determines string true, false false
whether to
retrieve all of
the object’s
contents, or
only retrieve
the first page
contents.

2.6.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.6.4.3.3 Request headers

• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.6.4.3.4 Request body

The Request body contains a list of URLs for the object, document, or folder that the
client wants to download. The contents of the object is downloaded only once, even
when a duplicated object id is provided by the client.

Example 2-21: XML request

<?xml version="1.0" encoding="UTF-8"?>

<content>
<hrefs>
<href>http://localhost:8080/dctm-rest/repositories/REPO/objects/
090004d280005520</href>
<href>http://localhost:8080/dctm-rest/repositories/REPO/documents/
090004d280005521</href>
<href>http://localhost:8080/dctm-rest/repositories/REPO/folders/
0b0004d2800060e8</href>
</hrefs>
</content>

76 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.6. Archived Contents

Example 2-22: JSON request

{
"hrefs":
[
"http://localhost:8080/dctm-rest/repositories/REPO/objects/
090004d280005520",
"http://localhost:8080/dctm-rest/repositories/REPO/documents/
090004d280005521",
"http://localhost:8080/dctm-rest/repositories/REPO/folders/
0b0004d2800060e8"
]
}

2.6.4.3.5 Response headers

• Content-Type: application/zip
• Content-Disposition: attachment;filename=multiple_objects_contents.zip

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.6.4.3.6 Response media types

N/A

2.6.4.3.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.6.4.3.8 Response body

The Response returns a formatted stream of the object contents as a ZIP file. When
the specified object is a folder, then all of the contents of the specified object are
located within a folder with the same name as the object in the ZIP file.

When an object name duplication exists within the ZIP file, the folder’s name is
generated using the object-id. For example, a folder called test-folder, whose id
is 0b0004d2800060e7 would be named test-folder(0b0004d2800060e7) . Each
file name within the ZIP file must be unique and must also comply with the naming
conventions listed in “Get a single object’s contents” on page 71.

EDCPKRST220200-PRE-EN-01 Reference Guide 77

Chapter 2 Resources

2.6.4.3.9 More samples

Example 2-23: Request and response

// Request
POST /dctm-rest/repositories/REPO/archived-contents?all-contents=true HTTP/1.1
Host: localhost:8080
Authorization: Basic ZG1hZG1pbjpwYXNzd29yZA==
Content-Type: application/vnd.emc.documentum+json

{
"hrefs":
[
"http://localhost:8080/dctm-rest/repositories/REPO/objects/
090004d280005520",
"http://localhost:8080/dctm-rest/repositories/REPO/objects/
090004d280005521",
"http://localhost:8080/dctm-rest/repositories/REPO/documents/
090004d28000555d"
]
}

// Response
Status 200 OK

content-disposition attachment; filename="multiple_object_contents.zip"

content-type application/zip

... zip file format stream ...

2.7 Aspect Type (s)

2.7.1 Aspect Type
The Aspect Type resource represents an aspect type in Documentum Server.

2.7.1.1 Resource relationships

The following diagram illustrates how this resource is related with other resources:

See Also: “Aspect Types” on page 83 and About the Diagram on page 17.

78 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.7. Aspect Type (s)

2.7.1.2 Feed
No feed support.

2.7.1.3 Link relations

The following table lists general link relations in the Aspect Type resource.

Link relation Description Resource reference

self This aspect type. “Aspect Type” on page 78
type [1] When an aspect type defines its “Type” on page 726
own properties, this link relation
points to those properties.
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.7.1.4 Operations

2.7.1.4.1 Supported HTTP methods

Method Description
GET GET an aspect type.

2.7.1.4.2 Get an aspect type

GET the metadata of an Aspect Type resource.

2.7.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

methods parameters
GET locale Specifies the string null
value of a
valid locale
for the
Request. For
example, it
can be used
to get the
label text of
an aspect
type object.
inline For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
view

EDCPKRST220200-PRE-EN-01 Reference Guide 79

Chapter 2 Resources

2.7.1.4.2.2 Request media types

N/A

2.7.1.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.7.1.4.2.4 Request body

N/A

2.7.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.7.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.7.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.7.1.4.2.8 Response body

XML or JSON representation of the Aspect Type resource:

• When the aspect type defines additional properties, the type link relation points
to the Type resource that contains the properties that this Aspect Type resource
defines.
• The properties block contains the following two sets of data:

– The metadata of this Aspect Type resource.

– The properties that this Aspect Type resource defines. These properties are
not presented one by one. Instead, an Aspect Type resource displays the

80 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.7. Aspect Type (s)

metadata of these properties in eight elements, all of which are prefixed with
attr_ as shown here:

○ Name of the property as shown in the attr_name element

○ Whether the property is a repeating property as shown in the attr_
repeating element

○ Data type of the properties as shown in the attr_type element

○ Length of the properties as shown in the attr_length element
○ Label of the property as shown in the attr_label element
○ Whether the property is a hidden property as shown in the attr_hidden
element
○ Whether the property is a non-null property as shown in the attr_
notnull element

○ Whether the property is a read-only property as shown in the attr_

readonly element

These eight elements contain the same number of items, which is also the
number of properties this aspect type defines. The combination of items in the
same position of these elements represents one property this aspect type
defines. In the following sample, the combination of all first items indicates
that this resource defines a string property named annotation_name. The
property annotation_name is a repeating property with a maximum length
of 225.

Note: When the value of an element that is prefixed with attr_ is null,
that element is not shown in the Response. That is why the following code
sample only contains four elements.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<aspect-type
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/
dmc_aspect_type.xml"
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="dmc_aspect_type">
<properties>
<group_name>docu</group_name>
<acl_name>BOF_acl</acl_name>
<world_permit>3</world_permit>
<creation-date>2015-03-03T02:29:34.000+00:00</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>

EDCPKRST220200-PRE-EN-01 Reference Guide 81

Chapter 2 Resources

</i_folder_id>
<r_folder_path>
<item>/System/Modules/Aspect/my_aspect_1</item>
</r_folder_path>
<object_name>my_aspect_1</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/
my_aspect_1"
rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types/
dmi_03000005800001d3"
rel="http://identifiers.emc.com/linkrel/type"/>
</links>
</aspect-type>

JSON response
{
"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,
"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,

82 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.7. Aspect Type (s)

"i_folder_id" : [
"0b00000580000180"
],
"r_folder_path" : [
"/System/Modules/Aspect/my_aspect_1"
],
"object_name" : "my_aspect_1",
"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/
my_aspect_1"
},
{
"rel" : "http://identifiers.emc.com/linkrel/type",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/types/
dmi_03000005800001d3"
}
]
}

2.7.2 Aspect Types

The Aspect Types resource represents a collection of aspect type resources.

EDCPKRST220200-PRE-EN-01 Reference Guide 83

Chapter 2 Resources

2.7.2.1 Resource relationships

The following diagram illustrates how this resource is related with other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.7.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the Aspect Types resource without the file extension
• Feed Title: Aspect types
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “Aspect Type” on page 78
• Entry ID: URI of the Aspect Type
• Entry Title: Aspect Type name
• Entry Updated: r_modify_date of the Aspect Type

2.7.2.3 Link relations

The following table lists general link relations in the Aspect Types resource.

Link relation Description Resource reference

self This Aspect Types resource “Aspect Types” on page 83
first, last, next, previous Pagination links “Aspect Types” on page 83

2.7.2.4 Operations

84 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.7. Aspect Type (s)

2.7.2.4.1 Supported HTTP methods

Method Description
GET GET all aspect types in a repository

2.7.2.4.2 Get aspect types

GET all aspect types in a repository.

2.7.2.4.2.1 HTTP Request method and query parameters

HTTP methods Query parameters

GET inline
sort
page
items-per-page
include-total
view
filter
links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.7.2.4.2.2 Request media types

N/A

2.7.2.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 85

Chapter 2 Resources

2.7.2.4.2.4 Request body

N/A

2.7.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.7.2.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json (For compatible viewing)

2.7.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.7.2.4.2.8 Response body

XML or JSON representation of the Aspect Types collection.

Properties that an Aspect Type resource defines, which are prefixed with attr_ are
not displayed in the response. Additionally, these properties do not take effect in the
view, filter, and sort parameters.

2.8 Audit Policy (ies)

2.8.1 Audit Policy
The Audit Policy resource displays the deletion policy that applies to audit records
for a specific user or group. Only an authorized user or group can delete an audit
record. When there are multiple policies that apply to the same user, the policy with
the greatest permission priority is in effect. All users can view audit policies, but
only a user who is in the Install Owner role can access, create, update, or delete an
audit policy.

If an unauthorized user or group attempts to delete an audit record, the

Documentum Server throws an exception and error message.

86 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.8. Audit Policy (ies)

2.8.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Audit Policies” on page 93 and About the Diagram on page 17.

2.8.1.2 Feed
No feed support.

2.8.1.3 Link relations

Link relation Description Resource reference

self This resource “Audit Policy” on page 86
delete [1] Delete this Audit Policy object “Audit Policy” on page 86
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/

2.8.1.4 Operations
2.8.1.4.1 Supported HTTP methods

Method Description
GET Retrieves a single Audit Policy object
using its ID.
POST Update the current Audit Policy for
specified attributes.
DELETE Delete the current Audit Policy object.

EDCPKRST220200-PRE-EN-01 Reference Guide 87

Chapter 2 Resources

2.8.1.4.2 Get an audit policy

This operation retrieves a specified audit policy object.

2.8.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

methods parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

Note: The view parameter is invalid because this

resource displays information in a customized manner.

2.8.1.4.2.2 Request media types

N/A

2.8.1.4.2.3 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.8.1.4.2.4 Request body

N/A

2.8.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.8.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

88 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.8. Audit Policy (ies)

2.8.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.8.1.4.2.8 Response body

Example 2-24: XML

<?xml version='1.0' encoding='UTF-8'?>
<audit-policy xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<object-id>0002791780000d00</object-id>
<name>AuditAdminCanPurgeDocument</name>
<accessor-name>auditadmin</accessor-name>
<is-group>false</is-group>
<attribute-rules>
<time_stamp_utc>2017-06-20 16:00:00</time_stamp_utc>
<object_type>dm_user</object_type>
</attribute-rules>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d00"/>
</links>
</audit-policy>

Example 2-25: JSON

{
"object-id": "0002791780000d00",
"name": "AuditAdminCanPurgeDocument",
"accessor-name": "auditadmin",
"is-group": false,
"attribute-rules": {
"time_stamp_utc": "2017-06-20 16:00:00",
"object_type": "dm_user"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d00"
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 89

Chapter 2 Resources

2.8.1.4.3 Update an audit policy

This operation updates a specified Audit Policy object.

2.8.1.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

methods parameters
POST N/A For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.8.1.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.8.1.4.3.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.8.1.4.3.4 Request body

Example 2-26: XML

<?xml version='1.0' encoding='UTF-8'?>

<audit-policy xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_audit_policy"
definition="http://localhost:8080/dctm-rest/repositories/repo/
types/
dm_audit_policy">
<name>testPolicy</name>
<accessor_name>auditadmin</accessor_name>
<attribute-rules>
<time_stamp_utc>2017-06-20 16:00:00</time_stamp_utc>
<object_type>dm_user</object_type>
</attribute-rules>
</audit-policy>

Example 2-27: JSON

{
"name": "AuditAdminCanPurgeDocument",
"accessor-name": "auditadmin",
"attribute-rules": {
"time_stamp_utc": "2017-06-20 16:00:00",
"object_type": "dm_user"

90 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.8. Audit Policy (ies)

}
}

2.8.1.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.8.1.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.8.1.4.3.7 Response status

• 200 - Updated successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.8.1.4.3.8 Response body

Example 2-28: XML

<?xml version='1.0' encoding='UTF-8'?>

<audit-policy xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<object-id>0002791780000d00</object-id>
<name>AuditAdminCanPurgeDocument</name>
<accessor-name>auditadmin</accessor-name>
<is-group>false</is-group>
<attribute-rules>
<time_stamp_utc>2017-06-20 16:00:00</time_stamp_utc>
<object_type>dm_user</object_type>
</attribute-rules>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d00"/>
</links>
</audit-policy>

EDCPKRST220200-PRE-EN-01 Reference Guide 91

Chapter 2 Resources

Example 2-29: JSON

{
"object-id": "0002791780000d00",
"name": "AuditAdminCanPurgeDocument",
"accessor-name": "auditadmin",
"is-group": false,
"attribute-rules": {
"time_stamp_utc": "2017-06-20 16:00:00",
"object_type": "dm_user"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d00"
}
]
}

2.8.1.4.4 Delete an Audit Policy

This operation deletes a specified Audit Policy object.

2.8.1.4.4.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

methods parameters
DELETE N/A For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

Note: The view parameter is invalid because this

resource displays information in a customized manner.

2.8.1.4.4.2 Request media types

N/A

2.8.1.4.4.3 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

92 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.8. Audit Policy (ies)

2.8.1.4.4.4 Request body

N/A

2.8.1.4.4.5 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.8.1.4.4.6 Response media types

N/A

2.8.1.4.4.7 Response status

• 204 - Delete successful

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.8.1.4.4.8 Response body

N/A

2.8.2 Audit Policies

The Audit Policies resource shows all audit policies that apply to the repository.
Only a user with the Install Owner role can access, create, update, or delete an
audit policy. All other users may only view the audit policy.

2.8.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 93

Chapter 2 Resources

2.8.2.2 Feed
Is this resource a feed? Yes

• Feed ID: Feed URI

• Feed Title: Audit Policies
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: Audit Policy
• Entry ID: URI of the audit policy
• Entry Title: The ID of a specified audit policy
• Entry Updated: Current server time

2.8.2.3 Link relations

Link relation Description Resource reference

self This resource “Audit Policies” on page 93

2.8.2.4 Operations
2.8.2.4.1 Supported HTTP methods

Method Description
GET Retrieves all Audit Policies from the
repository.
POST Create a new Audit Policy.

2.8.2.4.2 Get all audit policies

This operation retrieves all Audit Policies from the repository.

2.8.2.4.2.1 HTTP Request method and query parameters

94 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.8. Audit Policy (ies)

HTTP Query Description Data type Value range Default value

methods parameters
GET • inline For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
• page
• items- Note: The view parameter is not supported because
per- this resource displays information in a customized
page manner.
• include
-total
• filter
• links

2.8.2.4.2.2 Request media types

N/A

2.8.2.4.2.3 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.8.2.4.2.4 Request body

N/A

2.8.2.4.2.5 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.8.2.4.2.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

EDCPKRST220200-PRE-EN-01 Reference Guide 95

Chapter 2 Resources

2.8.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.8.2.4.2.8 Response body

Example 2-30: XML

<?xml version='1.0' encoding='UTF-8'?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/repo/audit-policies</id>
<title>Audit Policies</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2017-06-05T09:29:00.096+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/audit-
policies"/>
<entry>
<id>
http://localhost:8080/dctm-rest/repositories/repo/audit-policies/
0002791780000d17
</id>
<title>0002791780000d17</title>
<summary>Audit Purge Policy</summary>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d17"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d17"/>
</entry>
<entry>
<id>
http://localhost:8080/dctm-rest/repositories/repo/audit-policies/
0002791780000d19
</id>
<title>0002791780000d19</title>
<summary>Audit Purge Policy</summary>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d19"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d19"/>

96 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.8. Audit Policy (ies)

</entry>
</feed>

Example 2-31: JSON

{
"id": "http://localhost:8080/dctm-rest/repositories/repo/audit-policies",
"title": "Audit Policies",
"author": [
{
"name": "OpenText Documentum"
}
],
"updated": "2017-06-05T09:28:33.094+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/repo/audit-
policies"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/repo/audit-policies/
0002791780000d17",
"title": "0002791780000d17",
"summary": "Audit Purge Policy",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d17"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d17"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/repo/audit-policies/
0002791780000d19",
"title": "0002791780000d19",
"summary": "Audit Purge Policy",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d19"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",

EDCPKRST220200-PRE-EN-01 Reference Guide 97

Chapter 2 Resources

"src": "http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d19"
}
}
]
}

2.8.2.4.3 Create an audit policy

This operation creates a specified Audit Policy object.

2.8.2.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

methods parameters
POST N/A For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.8.2.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.8.2.4.3.3 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.8.2.4.3.4 Request body

Example 2-32: XML

<?xml version='1.0' encoding='UTF-8'?>

<audit-policy xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_audit_policy"
definition="http://localhost:8080/dctm-rest/repositories/repo/
types/
dm_audit_policy">
<name>testPolicy</name>
<accessor-name>auditadmin</accessor-name>
<attribute-rules>
<time_stamp_utc>2017-06-20 16:00:00</time_stamp_utc>
<object_type>dm_user</object_type>
</attribute-rules>
</audit-policy>

98 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.8. Audit Policy (ies)

Example 2-33: JSON

{
"name": "AuditAdminCanPurgeDocument",
"accessor-name": "auditadmin",
"attribute-rules": {
"time_stamp_utc": "2017-06-20 16:00:00",
"object_type": "dm_user"
}
}

2.8.2.4.3.5 Response headers

• Content-Type
• Location
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.8.2.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.8.2.4.3.7 Response status

• 201 - Create successful

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.8.2.4.3.8 Response body

Example 2-34: XML

<?xml version='1.0' encoding='UTF-8'?>

<audit-policy xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<object-id>0002791780000d00</object-id>
<name>AuditAdminCanPurgeDocument</name>
<accessor-name>auditadmin</accessor-name>
<is-group>false</is-group>
<attribute-rules>
<time_stamp_utc>2017-06-20 16:00:00</time_stamp_utc>
<object_type>dm_user</object_type>
</attribute-rules>
<links>
<link rel="self"

EDCPKRST220200-PRE-EN-01 Reference Guide 99

Chapter 2 Resources

href="http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d00"/>
</links>
</audit-policy>

Example 2-35: JSON

{
"object-id": "0002791780000d00",
"name": "AuditAdminCanPurgeDocument",
"accessor-name": "auditadmin",
"is-group": false,
"attribute-rules": {
"time_stamp_utc": "2017-06-20 16:00:00",
"object_type": "dm_user"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/repo/audit-
policies/
0002791780000d00"
}
]
}

2.9 Audit Trail (s)

2.9.1 Audit Trail
The Audit Trail resource is a record of user operations that occurred within the
repository of “Registered Audit Events” on page 522 and certain “Audit Policies”
on page 93 resources.

Logged in users must have VIEW privileges in their extended user privileges to
access to this resource. In addition, logged in users must have PURGE privileges to
gain access to the DELETE link for certain Audit Trail objects. Otherwise, the
DELETE link is not visible in those Audit Trail objects.

100 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.9. Audit Trail (s)

2.9.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Audit Trails” on page 107 and About the Diagram on page 17.

2.9.1.2 Feed
No feed support.

2.9.1.3 Link relations

Link relation Description Resource reference

self This resource “Audit Trail” on page 100
delete [1] Delete this audit trail N/A
author The author of this audit trail “User” on page 765
audited-object The audited object of this audit trail “SysObject” on page 690
[1]
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.9.1.4 Operations
2.9.1.4.1 Supported HTTP methods

Method Description
GET Retrieves the audit trail object.
DELETE Purges the audit trail object.

EDCPKRST220200-PRE-EN-01 Reference Guide 101

Chapter 2 Resources

2.9.1.4.2 Get an audit trail

2.9.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

methods parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.9.1.4.2.2 Request media types

N/A

2.9.1.4.2.3 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.9.1.4.2.4 Request body

N/A

2.9.1.4.2.5 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.9.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

102 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.9. Audit Trail (s)

2.9.1.4.2.7 Response status

• 200 - Retrieved successfully.

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.9.1.4.2.8 Response body

Example 2-36: XML

<?xml version='1.0' encoding='UTF-8'?>

<audit-trail xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_audittrail"
definition="http://localhost:8080/dctm-rest/repositories/REPO/
types/
dm_audittrail"
<properties>
<event_name>dm_save</event_name>
<event_source>System Unspecific</event_source>
<r_gen_source>1</r_gen_source>
<user_name>Administrator</user_name>
<audited_obj_id>0900000580000ce9</audited_obj_id>
<time_stamp>2015-03-03T02:34:20.000+00:00</time_stamp>
<string_1>Create</string_1>
<id_1>0000000000000000</id_1>
<id_2>0000000000000000</id_2>
<id_3>0000000000000000</id_3>
<id_4>0000000000000000</id_4>
<id_5>0000000000000000</id_5>
<chronicle_id>0900000580000ce9</chronicle_id>
<object_name>Result.dm_FTQBS_HOURLY</object_name>
<version_label>1.0</version_label>
<object_type>dm_document</object_type>
<event_description>Default Event Set</event_description>
<policy_id>0000000000000000</policy_id>
<workflow_id>0000000000000000</workflow_id>
<session_id>010000058000015b</session_id>
<user_id>1100000580000102</user_id>
<owner_name>Administrator</owner_name>
<acl_name>dm_4500000580000101</acl_name>
<acl_domain>Administrator</acl_domain>
<attribute_list>
acl_name="dm_4500000580000101",
acl_domain="Administrator",
world_permit=3,
group_permit=5,
group_name="docu",
owner_permit=7,
owner_name="Administrator",
a_storage_type="filestore_01",
a_full_text=0,
a_content_type="crtext",
subject="Result of dm_method(dm_FTQBS_HOURLY) with command line:
-method_verb
com.documentum.server.impl.method.fulltext.qbs.FTQBSJob
-__dm_docbase__ REPO -__dm_server_config__ REPO -docbase_name
R....",
title="Result of dm_method(dm_FTQBS_HOURLY) with status code

EDCPKRST220200-PRE-EN-01 Reference Guide 103

Chapter 2 Resources

(0)",
object_name="Result.dm_FTQBS_HOURLY"
</attribute_list>
<attribute_list_id>0000000000000000</attribute_list_id>
<audit_version>4</audit_version>
<host_name>restcs72ga</host_name>
<time_stamp_utc>2015-03-03T02:34:20.000+00:00</time_stamp_utc>
<i_audited_obj_class>0</i_audited_obj_class>
<registry_id>2600000580000101</registry_id>
<i_is_archived>false</i_is_archived>
<audited_obj_vstamp>0</audited_obj_vstamp>
<attribute_list_aspect_id>0000000000000000</attribute_list_aspect_id>
<r_object_sequence>4</r_object_sequence>
<i_is_replica>false</i_is_replica>
<i_vstamp>0</i_vstamp>
<r_object_id>5f00000580000103</r_object_id>
</properties>
<audit-data-list>
<audit-data>
<attr-name>owner_name</attr-name>
<value-pairs>
<value-pair>
<old-value></old-value>
<new-value>Administrator</new-value>
</value-pair>
</value-pairs>
</audit-data>
...
</audit-data-list>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/audit-trails/
5f00000580000103"/>
<link rel="author"
href="http://localhost:8080/dctm-rest/repositories/REPO/users/
Administrator"/>
<link rel="http://identifiers.emc.com/linkrel/audited-object"
title="document"
href="http://localhost:8080/dctm-rest/repositories/REPO/documents/
0900000580000ce9"/>
</links>
</audit-trail>

Example 2-37: JSON

{
"type": "dm_audittrail",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_audittrail",
"properties": {
"event_name": "dm_save",
"event_source": "System Unspecific",
"r_gen_source": 1,
"user_name": "Administrator",
"audited_obj_id": "0900000580000ce9",
"time_stamp": "2015-03-03T02:34:20.000+00:00",
"string_1": "Create",
"id_1": "0000000000000000",
"id_2": "0000000000000000",
"id_3": "0000000000000000",
"id_4": "0000000000000000",
"id_5": "0000000000000000",

104 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.9. Audit Trail (s)

"chronicle_id": "0900000580000ce9",
"object_name": "Result.dm_FTQBS_HOURLY",
"version_label": "1.0",
"object_type": "dm_document",
"event_description": "Default Event Set",
"policy_id": "0000000000000000",
"workflow_id": "0000000000000000",
"session_id": "010000058000015b",
"user_id": "1100000580000102",
"owner_name": "Administrator",
"acl_name": "dm_4500000580000101",
"acl_domain": "Administrator",
"attribute_list": "acl_name=\"dm_4500000580000101\",
acl_domain=\"Administrator\",
world_permit=3,
group_permit=5,
group_name=\"docu\",
owner_permit=7,
owner_name=\"Administrator\",
a_storage_type=\"filestore_01\",
a_full_text=0,
a_content_type=\"crtext\",
subject=\"Result of dm_method(dm_FTQBS_HOURLY) with command line:
-method_verb com.documentum.server.impl.method.fulltext
.qbs.FTQBSJob -__dm_docbase__ REPO
-__dm_server_config__ REPO -docbase_name
R....\",
title=\"Result of dm_method(dm_FTQBS_HOURLY) with status code
(0)\",
object_name=\"Result.dm_FTQBS_HOURLY\"",
"attribute_list_id": "0000000000000000",
"audit_version": 4,
"host_name": "restcs72ga",
"time_stamp_utc": "2015-03-03T02:34:20.000+00:00",
"i_audited_obj_class": 0,
"registry_id": "2600000580000101",
"i_is_archived": false,
"audited_obj_vstamp": 0,
"attribute_list_aspect_id": "0000000000000000",
"r_object_sequence": 4,
"i_is_replica": false,
"i_vstamp": 0,
"r_object_id": "5f00000580000103"
},
"audit-data-list": [
{
"attr-name": "owner_name",
"value-pairs": [
{
"old-value": "",
"new-value": "Administrator"
}
]
},
{
"attr-name": "a_content_type",
"value-pairs": [
{
"old-value": "",
"new-value": "crtext"
}
]
}
...
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/audit-trails/
5f00000580000103"

EDCPKRST220200-PRE-EN-01 Reference Guide 105

Chapter 2 Resources

},
{
"rel": "author",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator"
},
{
"rel": "http://identifiers.emc.com/linkrel/audited-object",
"title": "document",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/documents/
0900000580000ce9"
}
]
}

2.9.1.4.3 Delete an audit trail

This operation is used to delete an audit trail. Only logged in users with PURGE
privileges in their extended user privileges can perform this operation.

2.9.1.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

methods parameters
DELETE trace This string true, false false
parameter
determines
whether or
not this purge
operation is
traceable.

2.9.1.4.3.2 Request media types

N/A

2.9.1.4.3.3 Request headers

• Authorization
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

106 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.9. Audit Trail (s)

2.9.1.4.3.4 Request body

N/A

2.9.1.4.3.5 Response headers

N/A

2.9.1.4.3.6 Response media types

N/A

2.9.1.4.3.7 Response status

• 204 - Delete successful

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.9.1.4.3.8 Response body

N/A

2.9.2 Audit Trails

The Audit Trails resource provides a collection of user operations that occurred
within the repository of “Registered Audit Events” on page 522 and “Audit
Policies” on page 93. This resource allows a logged in user to view their most recent
audit trails. However, if a logged in user has VIEW privileges in their extended user
privileges, then they can view all of the audit trails that are within the repository.

2.9.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 107

Chapter 2 Resources

2.9.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: Audit Trails
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “Audit Trail” on page 100 resource
• Entry ID: The Audit Trail resource URI
• Entry Title: The id of the specified Audit Trail
• Entry Updated: The creation date of the specified Audit Trail

2.9.2.3 Link relations

Link relation Description Resource reference

self This resource “Audit Trails” on page 107

2.9.2.4 Operations
2.9.2.4.1 Supported HTTP methods

Method Description
GET Retrieves all of the audit trails in a specified
repository.

2.9.2.4.2 Get all audit trails

This operation retrieves all of the audit trails from a specified repository.

2.9.2.4.2.1 HTTP Request method and query parameters

108 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.9. Audit Trail (s)

HTTP Query Description Data type Value range Default value

methods parameters
GET • inline For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
• page
• items-
per-
page
• include
-total
• filter
• links
• view
• sort

2.9.2.4.2.2 Request media types

N/A

2.9.2.4.2.3 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.9.2.4.2.4 Request body

N/A

2.9.2.4.2.5 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.9.2.4.2.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

EDCPKRST220200-PRE-EN-01 Reference Guide 109

Chapter 2 Resources

2.9.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.9.2.4.2.8 Response body

Example 2-38: XML

<?xml version='1.0' encoding='UTF-8'?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/audit-trails</id>
<title>Audit Trails</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2017-04-11T02:44:37.048+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/audit-trails"/>
<link rel="next"
href="http://localhost:8080/dctm-rest/repositories/REPO/audit-trails?
items-per-page=100&amp;page=2"/>
<link rel="first"
href="http://localhost:8080/dctm-rest/repositories/REPO/audit-trails?
items-per-page=100&amp;page=1"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/audit-trails/
5f00000580000100</id>
<title>5f00000580000100</title>
<summary>Logon Failure</summary>
<updated>2015-03-03T02:28:26.000+00:00</updated>
<published>2015-03-03T02:28:26.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/audit-trails/
5f00000580000100"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/audit-
trails/
5f00000580000100"/>
</entry>
...
</feed>

Example 2-39: JSON

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/audit-trails",
"title": "Audit Trails",
"author": [
{

110 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.9. Audit Trail (s)

"name": "OpenText Documentum"

}
],
"updated": "2017-04-11T02:43:01.502+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/audit-trails"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/audit-trails?
items-per-page=100&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/audit-trails?
items-per-page=100&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/audit-trails/
5f00000580000100",
"title": "5f00000580000100",
"summary": "Logon Failure",
"updated": "2015-03-03T02:28:26.000+00:00",
"published": "2015-03-03T02:28:26.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/audit-
trails/
5f00000580000100"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/audit-trails/
5f00000580000100"
}
}
...
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 111

Chapter 2 Resources

2.10 Available Audit Events

The Available Audit Events resource displays all of the audit events that are
registered for the specified object, type, or repository. This resource forms part of the
audit management resources and closely relates to other resources, such as the Audit
Trailresource, Audit Trailsresource, and so on. Logged in users must have
CONFIG permissions in their User Extended Privileges to gain access to this resource.

2.10.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.10.2 Feed
Is this resource a feed? Yes.

• Feed ID: /repositories/<repositoryName>/available-audit-events

• Feed Title: AvailableAuditEvents
• Feed Updated: Server’s current time
• Supports POST?: No

2.10.3 Link relations

Link relations Description Resource reference
self This resource “Available Audit Events”
on page 112

2.10.4 Operations

112 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.10. Available Audit Events

2.10.4.1 Supported HTTP methods

Method Description
GET GET all available audit events from a
specified path.

2.10.4.2 Get all registered audit events

2.10.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameter
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
object-id The ID of the string Any valid null
specified <r_object_id>
object that is in
requested for Documentum
its available Server
audit events.
type The name of string Any valid null
the type that name of a
is requested <dm_type> in
for its Documentum
available Server
audit events.

Note: When no query parameter, object-ID, or type is specified, a list of the

available audit events of the repository are returned.

2.10.4.2.2 Request media types

N/A

2.10.4.2.3 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 113

Chapter 2 Resources

2.10.4.2.4 Request body

N/A

2.10.4.2.5 Response headers

• Content-Type
• Location
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.10.4.2.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.10.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.10.4.2.8 Response body

Example 2-40: XML

<?xml version='1.0' encoding='UTF-8'?>

<audit-event-list xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<event-list>
<event>dm_assume</event>
<event>dm_authenticate</event>
<event>dm_connect</event>
<event>dm_disconnect</event>
<event>dm_destroy</event>
<event>dm_getlogin</event>
<event>dm_logon_failure</event>
<event>dm_save</event>
<event>dm_audit</event>
<event>dm_unaudit</event>
<event>dm_security_check_failed</event>
</event-list>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/
available-audit-events/?object-id=1100000580000900"/>
<link rel="http://identifiers.emc.com/linkrel/registered-audit-events"
href="http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events/?object-id=1100000580000900"/>

114 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.11. Batches

</links>
</audit-event-list>

Example 2-41: JSON

{
"json-root": "audit-event-list",
"event-list": [
"dm_assume",
"dm_authenticate",
"dm_connect",
"dm_disconnect",
"dm_destroy",
"dm_getlogin",
"dm_logon_failure",
"dm_save",
"dm_audit",
"dm_unaudit",
"dm_security_check_failed"
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
available-audit-events/?object-id=1100000580000900"
},
{
"rel": "http://identifiers.emc.com/linkrel/registered-audit-events",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events/?object-id=1100000580000900"
}
]
}

2.11 Batches
The Batches resource enables you to perform multiple operations using a single
HTTP request. For example, you can create 10 cabinets, modify 5 folders, and delete
30 documents using one request. All resources except the Batches resource itself
and the Content Media resource can be embedded in a batch request.

Note: The rest.batch.operations.max.count property in rest-api-

runtime.properties determines the maximum number of operations allowed
to be embedded in one batch request, which defaults to 1,000. To embed more
operations in one batch request, specify a larger value for rest.batch.
operations.max.count. However, the performance may degrade when the
number of operations grows.

In addition to rest.batch.operations.max.count, how the system handles batch

requests also depends on the following runtime properties in rest-api-runtime.
properties.

EDCPKRST220200-PRE-EN-01 Reference Guide 115

Chapter 2 Resources

Property Description Default

rest.batch.running.tasks. Specifies the maximum number of batch 50
max.count requests that can be executed
simultaneously.

The system rejects new batch requests if the

maximum number is reached.
rest.batch.core.thread. Specifies the size of the thread pool used to 5
pool.size execute background tasks.
rest.batch.multipart. Specifies the maximum cache size in 20
cache.max.size megabyte for a multipart batch request.

Setting the value of this property to 0

disables caching for the multipart batch
requests.

2.11.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.11.2 Feed
No feed support.

2.11.3 Link relations

N/A

2.11.4 Operations

116 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.11. Batches

2.11.4.1 Supported HTTP methods

Method Description
POST Create and execute a batch request.

2.11.4.2 Create and execute a batch request

A POST request to the Batches resource creates a Batche resource, which enables
you to perform multiple operations in a single HTTP request. The request contains
the details of each embedded operation. Additionally, you can control how the REST
server processes the batch request (such as transactional verses, non-transactional
verses, sequential verses. and non-sequential verses) by specifying the required
properties in the initial request.

2.11.4.2.1 HTTP Request method and query parameters

POST

2.11.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• multipart/related

2.11.4.2.3 Request headers

• Authorization
The Authorization header (user credential token) is applied to all operations
within the batch request. Embedded operations in the batch request cannot set
their own Authorization headers.
• Accept
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.11.4.2.4 Request body

The request body contains properties of the batch request, which controls how the
REST server processes the request along with the properties of each operation that is
embedded in the request.

Batch request properties

Property Data type Description

description string Description of the batch request.

EDCPKRST220200-PRE-EN-01 Reference Guide 117

Chapter 2 Resources

Property Data type Description

transactional string 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

sequential string 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

on-error string 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.

Default value: FAIL

return-request string Determines whether to return the request for each
operation.

Default value: false

Operation properties

118 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.11. Batches

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.

Property Data type Description

id * string 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 string Description of the operation.
request * string HTTP method and target URI of the operation.

The URI can be either an absolute URI you get from a certain
response or a relative URI, which starts with a slash (/).

Example (absolute URI):

<request method="POST" uri="http://localhost:

8080/repositories/REPO/folders/
0c00208080000107/objects">

Example (relative URI):

<request method="POST" uri="/repositories/

REPO/folders/0c00208080000107/objects">

The repository in the URI must be the same repository

where the Batches resource is located.
Content-Type string MIME type of the request body.
header
Example: <header name="Content-Type"
value="application/vnd.emc.documentum+xml"/>
Accept header string Acceptable media type for the response. Example: <header
name="Accept" value="application/vnd.emc.
documentum+xml"/>

EDCPKRST220200-PRE-EN-01 Reference Guide 119

Chapter 2 Resources

Property Data type Description

Entity CDATA/ Request body of the operation.
Escaped
String For XML representation, the request body is presented in a
CDATA block or escaped.
<entity>
<![CDATA[ <document type=”dm_document”>
<properties>
<object_name>readme</object_name>
<title>Readme for indexing</title>
</properties>
</document>
]]>
</entity>

For JSON representation, the request body is presented as a

string.
{
"entity" : "{\"properties\":{\"object_name\":\"my test
object\"}}"
}

Yes *

2.11.4.2.4.1 Request samples

Example 2-42: XML representation

<?xml version="1.0" encoding="UTF-8"?>

<batch xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<description>batch for indexing</description>
<transactional>false</transactional>
<sequential>false</sequential>
<on-error>CONTINUE</on-error>
<return-request>true</return-request>
<operations>
<operation id="operation_1">
<description>create a document operation</description>
<request method="PUT" uri="<base URI>/objects">
<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>readme</object_name>
<title>Readme for indexing</title>
</properties>
</document>
]]>
</entity>
</request>
</operation>
...
<operations>
</batch>

120 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.11. Batches

Example 2-43: JSON representation

{
"transactional" : true,
"sequential" : false,
"on-error" : "CONTINUE",
"return-request" : true,
"operations" : [ {
"id" : "id-001",
"description" : "create a document",
"request" : {
"method" : "POST",
"uri" : "/<base URI>/objects",
"headers" : [ {
"name" : "Content-Type",
"value" : "application/vnd.emc.documentum+json"
} ],
"entity" : "{\"properties\":{\"object_name\":\"my test object\"}}"
}
} ]
}

2.11.4.2.4.2 Multipart 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>
…

EDCPKRST220200-PRE-EN-01 Reference Guide 121

Chapter 2 Resources

</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 batch element 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 element.

Multipart/Related content-type header

The Multipart/Related Content-Type header contains the following parameters:

Parameters Descriptions Required

boundary Specifies the boundary used to separate each portion Yes
type Specifies the media type of the batch request. Valid values Yes
are:
• application/xop+xml (for XML)
• application/jop+json (for JSON)
start Specified the portion to be processed first by Content ID. If No
not specified, the first portion is processed first. In a
multipart batch request, the start portion must be a batch
block.
start-info The media type of the start portion. Valid values are: Yes
• application/vnd.emc.documentum+xml (for
XML)
• application/vnd.emc.documentum+json (for
JSON)

Portion header set

122 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.11. Batches

A portion header set contains the following headers:

Headers Descriptions Required

Content-Type For the start portion batch, this parameter specifies the Yes
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

Content-ID Specifies the Content ID of the portion. Yes

Content- This parameter must be set with the following pattern: Yes
disposition
Content-disposition: form-data; name=<Content ID>

Example: Content-disposition: form-data;

name=id-01-content

Headers in operation blocks versus headers in binary content blocks

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

EDCPKRST220200-PRE-EN-01 Reference Guide 123

Chapter 2 Resources

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>

Multipart request samples

Example 2-44: Request in application/xop+xml

Request header:
{Multipart/Related;boundary=frontier;

124 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.11. Batches

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--

EDCPKRST220200-PRE-EN-01 Reference Guide 125

Chapter 2 Resources

Example 2-45: Request in application/jop+json

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"
}

126 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.11. Batches

],
"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--

2.11.4.2.5 Response headers

• Content-Type

2.11.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.11.4.2.7 Response status

• 201 - Batch executed successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 127

Chapter 2 Resources

2.11.4.2.8 Exceptions

Error Code Description

E_ILLEGAL_TASK_OPERATIONS The number of operations embedded in the
batch request exceeds the threshold specified
in rest.batch.operations.max.count.
E_BATCH_NO_OPERATION No operation in the request.
E_BATCH_NO_OPERATION_ID One or more operations in the batch request
do not contain an identifier.
E_BATCH_OPERATION_ID_DUPLICATED The batch request contains duplicated
operation identifiers.
E_BATCH_NO_OPERATION_REQUEST One or more operations in the batch request
do not have a request defined.
E_BATCH_NO_REQUEST_URI One or more operations in the batch request
do not have a URI defined.
E_BATCH_NO_REQUEST_METHOD One or more operations in the batch request
do not have a method defined.
E_METHOD_NOT_ALLOWED One or more operations in the batch request
do not have an invalid method defined.
E_BATCH_REQUEST_INVALID_URI The request URI is invalid.
E_BATCH_REQUEST_URI_ROOT The relative URI does not start with “/”.
E_BATCH_PROHIBITION There are operations on resources with the
BatchProhibition annotation defined.
E_BATCH_TRANSACTION_PROHIBITION There are resources with the
TransactionProhibition annotation
defined in a transactional batch request.

2.11.4.2.9 Response body

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 contains the following:

• Batch properties. In addition to those described in Batch Request Properties

on page 117, the response also includes:

– state: Indicates the state of the batch operation. In synchronous mode, the
value of this property is always Finished.
– sub-state: Indicates the sub-state of a finished batch operation. Valid values
are:

○ failed: The REST server completes the batch operation. However, all the
operations fail. Generally, this value is returned for transactional batch
requests.

128 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.11. Batches

○ 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: Indicates the user submitting the batch request.
– submitted: Indicates the time point when the batch request is submitted.
– started: Indicates the time point when the server starts processing the batch
request.
– finished: Indicates the time point when the batch operation is completed.

• Each embedded request if return-request is true.

• The response of each embedded operation.

Example 2-46: XML representation

<?xml version="1.0" encoding="UTF-8"?>

<batch xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<transactional>true</transactional>
<sequential>false</sequential>
<on-error>CONTINUE</on-error>
<return-request>true</return-request>
<state>FINISHED</state>
<submitted>2014-07-03T16:37:32.147+08:00</submitted>
<started>2014-07-03T16:37:32.147+08:00</started>
<finished>2014-07-03T16:37:32.246+08:00</finished>
<owner>dmadmin</owner>
<operations>
<operation id="id-100">
<description>get users</description>
<state>FINISHED</state>
<started>2014-07-03T16:37:32.147+08:00</started>
<finished>2014-07-03T16:37:32.158+08:00</finished>
<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>
<response status="200">
<header name="Content-Type" value="application/atom
+xml;charset=UTF-8"/>
<entity><?xml version="1.0" encoding="UTF-8"?><feed
xmlns="http:
//www.w3.org/2005/Atom" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-insta
nce" xmlns:dm="http://identifiers.emc.com/vocab/
documentum"><id>
http://localhost:8080/dctm-rest/repositories/REPO/users</
id><titl
e>Users</title><author><name>OpenText Documentum</name&
gt;</author><dm:page>1</dm:page><dm:items-per-page>
1</dm:items-per-page><link rel="self" href="http://localhost:
8080/
dctm-rest/repositories/REPO/users?items-per-page=1"/><link
rel="next"
href="http://localhost:8080/dctm-rest/repositories/REPO/users?
items-per-page

EDCPKRST220200-PRE-EN-01 Reference Guide 129

Chapter 2 Resources

=1&amp;page=2"/><link rel="first" href="http://localhost:8080/

dctm-rest
/repositories/REPO/users?items-per-page=1&amp;page=1"/
><entry><id
>http://localhost:8080/dctm-rest/repositories/REPO/users/
Administrator<
/id><title>Administrator</title><updated>2014-01-21T12:24
:16.000+08:00</updated><summary/><content type="application/vnd
.emc.documentum+xml" src="http://localhost:8080/dctm-rest/
repositories/REPO/us
ers/Administrator"/><link rel="edit" href="http://localhost:
8080/dctm-res
t/repositories/REPO/users/Administrator"/></entry></feed>
</entity>
</response>
</operation>
<operation id="id-1001">
<description>get cabinets</description>
<state>FINISHED</state>
<started>2014-07-03T16:37:32.158+08:00</started>
<finished>2014-07-03T16:37:32.244+08:00</finished>
<request method="GET" uri="/repositories/REPO/cabinets?items-per-
page=1">
<header name="Content-Type" value="application/
vnd.emc.documentum+xml"/>
<header name="Accept" value="application/atom+xml"/>
</request>
<response status="200">
<header name="Content-Type" value="application/atom
+xml;charset=UTF-8"/>
<entity><?xml version="1.0" encoding="UTF-8"?><feed
xmlns="http://
www.w3.org/2005/Atom" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance"
xmlns:dm="http://identifiers.emc.com/vocab/
documentum"><id>http://
localhost:8080/dctm-rest/repositories/REPO/cabinets</id><title>
Cabinets</title><updated>2014-07-03T16:37:32.238+08:00</updat
ed><author><name>OpenText Documentum</name></author>&lt
;dm:page>1</dm:page><dm:items-per-page>1</dm:items-per-page
><link rel="self" href="http://localhost:8080/dctm-rest/
repositories/RE
PO/cabinets?items-per-page=1"/><link rel="next" href="http://
localhost:8
080/dctm-rest/repositories/REPO/cabinets?items-per-
page=1&amp;page=2"/><
link rel="first" href="http://localhost:8080/dctm-rest/
repositories/REPO/cabine
ts?items-per-page=1&amp;page=1"/><entry><id>http://localhost:
808
0/dctm-rest/repositories/REPO/objects/0c0020808000dfc6</
id><title>"
+ cabinet + "</title><updated>2014-06-30T16:13:52.000+08:00</
upd
ated><summary>dm_cabinet 0c0020808000dfc6</summary><author>
<name>dmadmin</name><uri>http://localhost:8080/dctm-rest/repos
itories/REPO/users/dmadmin</uri></author><content
type="applicati
on/vnd.emc.documentum+xml" src="http://localhost:8080/dctm-
rest/repositories/REP
O/cabinets/0c0020808000dfc6"/><link rel="edit" href="http://
localhost:8080/

130 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.11. Batches

dctm-rest/repositories/REPO/cabinets/0c0020808000dfc6"/></
entry></fee
d></entity>
</response>
</operation>
</operations>
</batch>

Example 2-47: JSON representation

{
"transactional" : true,
"sequential" : false,
"on-error" : "CONTINUE",
"return-request" : true,
"state" : "FINISHED",
"submitted" : "2014-07-03T16:34:45.989+08:00",
"started" : "2014-07-03T16:34:45.989+08:00",
"finished" : "2014-07-03T16:34:46.107+08:00",
"owner" : "dmadmin",
"operations" : [ {
"id" : "id-100",
"description" : "get users",
"state" : "FINISHED",
"started" : "2014-07-03T16:34:45.989+08:00",
"finished" : "2014-07-03T16:34:46.020+08:00",
"request" : {
"name" : "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"
} ]
},
"response" : {
"name" : "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/
users
\",\"title\":\"Users\",\"author\":[{\"name\":\"OpenText Documentum\"}],
\"page\":1,\
"items-per-page\":1,\"links\":[{\"rel\":\"self\",\"href\":\"http://
localhost:8
080/dctm-rest/repositories/REPO/users?items-per-page=1\"},{\"rel\":\"next
\",\"h
ref\":\"http://localhost:8080/dctm-rest/repositories/REPO/users?items-
per-page=
1&page=2\"},{\"rel\":\"first\",\"href\":\"http://localhost:8080/dctm-
rest/reposi
tories/REPO/users?items-per-page=1&page=1\"}],\"entries\":[{\"id\":

EDCPKRST220200-PRE-EN-01 Reference Guide 131

Chapter 2 Resources

\"http://loca
lhost:8080/dctm-rest/repositories/REPO/users/Administrator\",\"title\":
\"Adminis
trator\",\"updated\":\"2014-01-21T12:24:16.000+08:00\",\"summary\":\"\",
\"content
\":{\"content-type\":\"application/vnd.emc.documentum+json\",\"src
\":\"http://loc
alhost:8080/dctm-rest/repositories/REPO/users/Administrator\"},\"links\":
[{\"rel\
":\"edit\",\"href\":\"http://localhost:8080/dctm-rest/repositories/REPO/
users/Admi
nistrator\"}]}]}"
}
}, {
"id" : "id-101",
"description" : "get cabinets",
"state" : "FINISHED",
"started" : "2014-07-03T16:34:46.020+08:00",
"finished" : "2014-07-03T16:34:46.105+08:00",
"request" : {
"name" : "request",
"method" : "GET",
"uri" : "/repositories/REPO/cabinets?items-per-page=1",
"headers" : [ {
"name" : "Content-Type",
"value" : "application/vnd.emc.documentum+json"
}, {
"name" : "Accept",
"value" : "application/vnd.emc.documentum+json"
} ]
},
"response" : {
"name" : "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/
cabinets\"
,\"title\":\"Cabinets\",\"updated\":\"2014-07-03T16:34:46.103+08:00\",
\"author\":[
{\"name\":\"OpenText Documentum\"}],\"page\":1,\"items-per-page\":
1,\"links\":[{\"rel\"
:\"self\",\"href\":\"http://localhost:8080/dctm-rest/repositories/REPO/
cabinets?it
ems-per-page=1\"},{\"rel\":\"next\",\"href\":\"http://localhost:8080/
dctm-rest/rep
ositories/REPO/cabinets?items-per-page=1&page=2\"},{\"rel\":\"first\",
\"href\":\"h
ttp://localhost:8080/dctm-rest/repositories/REPO/cabinets?items-per-
page=1&page=1\"
}],\"entries\":[{\"id\":\"http://localhost:8080/dctm-rest/repositories/
REPO/objects
/0c0020808000dfc6\",\"title\":\"\\\" + cabinet + \\\"\",\"updated\":
\"2014-06-30T16
:13:52.000+08:00\",\"summary\":\"dm_cabinet 0c0020808000dfc6\",\"author
\":[{\"name\
":\"dmadmin\",\"uri\":\"http://localhost:8080/dctm-rest/repositories/
REPO/users/dma
dmin\"}],\"content\":{\"content-type\":\"application/vnd.emc.

132 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.12. Batch Capabilities

documentum+json\",\"sr
c\":\"http://localhost:8080/dctm-rest/repositories/REPO/cabinets/
0c0020808000dfc6\"}
,\"links\":[{\"rel\":\"edit\",\"href\":\"http://localhost:8080/dctm-rest/
repositori
es/REPO/cabinets/0c0020808000dfc6\"}]}]}"
}
} ]
}

2.12 Batch Capabilities

The Batch Capabilities resource indicates what batch features are implemented in
Documentum REST Services. This includes the supported batch properties, such as
transactional/non-transactional, the list of batchable resources, and the list of non-
batchable resources.

2.12.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.12.2 Feed
No feed support.

2.12.3 Link relations

Link relation Description Resource reference
self The Batch Capabilities “Batch Capabilities”
resource on page 133

EDCPKRST220200-PRE-EN-01 Reference Guide 133

Chapter 2 Resources

2.12.4 Operations
2.12.4.1 Supported HTTP methods

Method Description
GET Retrieve supported batch properties, the list
of batchable resources, and the list of non-
batchable resources.

2.12.4.2 Get Batch Capabilities

Retrieves supported batch properties, the list of batchable resources, and the list of
non-batchable resources.

2.12.4.2.1 HTTP Request method and query parameters

GET

2.12.4.2.2 Request media types

N/A

2.12.4.2.3 Request headers

• Authorization

• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.12.4.2.4 Request body

N/A

2.12.4.2.5 Response headers

• Content-Type

2.12.4.2.6 Response media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

134 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.12. Batch Capabilities

2.12.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.12.4.2.8 Response body

XML or JSON representation that describes the supported batch features and
provides the lists of batchable and non-batchable resources.

Example 2-48: XML representation

<?xml version="1.0" encoding="UTF-8"?>

<batch-capabilities xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<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>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-links</batchable-resource>
<batchable-resource>folder-child-objects</batchable-resource>
<batchable-resource>folder-link</batchable-resource>
<batchable-resource>folder-parent-links</batchable-resource>
<batchable-resource>format</batchable-resource>
<batchable-resource>formats</batchable-resource>
<batchable-resource>group</batchable-resource>
<batchable-resource>group-members</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>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>

EDCPKRST220200-PRE-EN-01 Reference Guide 135

Chapter 2 Resources

<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.xml" rel="self"/>
</links>
</batch-capabilities>

Example 2-49: JSON representation

{ "transactions" : "both",
"sequence" : "both",
"on-error" : "both",
"batchable-resources" : [
"batch-capabilities",
"cabinet", "cabinets",
"checked-out-objects",
"content",
"contents",
"current-user",
"current-version",
"default-folder",
"document",
"dql-query",
"folder",
"folder-child-links",
"folder-child-objects",
"folder-link",
"folder-parent-links",
"format",
"formats",
"group",
"group-members",
"groups",
"home-document",
"lock",
"network-location",
"network-locations",
"object",
"product-info",
"relation",
"relation-type",
"relation-types",
"relations",
"repositories",
"repository",
"search",
"type",
"types",
"user",
"users",
"versions" ],
"non-batchable-resources" : [
"batches",

136 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.13. Cabinet (s)

"content-media" ],
"links" : [ {"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/
REPO/batch-capabilities" } ]}

2.13 Cabinet (s)

2.13.1 Cabinet
TheCabinet resource represents a cabinet in the repository.

2.13.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Cabinets” on page 143 and About the Diagram on page 17.

2.13.1.2 Feed
No feed support.

2.13.1.3 Link relations

Link relation Description Resource reference

self Link to this cabinet. “Cabinet” on page 137
folders [1] Collection of folders linked to “Folder Child Folders” on page 271
this cabinet.
relations [1] Collection of relations related “Cabinets” on page 143
to this cabinet.
documents [1] Collection of documents “Folder Child Documents” on page 243
associated to this cabinet.

EDCPKRST220200-PRE-EN-01 Reference Guide 137

Chapter 2 Resources

Link relation Description Resource reference

objects [1] Collection of objects of this “Folder Child Objects” on page 285
cabinet.
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.13.1.4 Operations
2.13.1.4.1 Supported HTTP methods

Method Description
GET Retrieves properties, and other information of the Cabinet resource.
POST Updates the properties for the Cabinet resource.
DELETE Deletes the Cabinet resource from a repository.

2.13.1.4.2 Get a Cabinet

GET properties, and other information of the Cabinet resource. Properties are
returned as embedded elements in the response message body. Other information,
such as relationships, is referenced from the link relations of the response message
body.

2.13.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET view For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
links
check- Determines string true, false false
subscripti whether or
on not to check if
the current
user is
subscribed to
the requested
instance.

138 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.13. Cabinet (s)

2.13.1.4.2.2 Request media types

N/A

2.13.1.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.13.1.4.2.4 Request body

N/A

2.13.1.4.2.5 Response headers

• Content-Type

2.13.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.13.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.13.1.4.2.8 Response body

XML or JSON message that represents the cabinet.

EDCPKRST220200-PRE-EN-01 Reference Guide 139

Chapter 2 Resources

2.13.1.4.3 Update a Cabinet

Update the cabinet with given properties. If the client provides undefined properties
in the request body, the server throws an exception.

2.13.1.4.3.1 HTTP Request method and query parameters

POST

2.13.1.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.13.1.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.13.1.4.3.4 Request body

XML or JSON representation of the Cabinet resource. Only properties that can be
updated should be put in the message body.

2.13.1.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.13.1.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

140 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.13. Cabinet (s)

2.13.1.4.3.7 Response status

• 200 - Cabinet updated successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.13.1.4.3.8 Response body

XML or JSON representation of the Cabinet resource. The successful response

contains all properties of the updated cabinet.

2.13.1.4.4 Delete a cabinet

Deletes the Cabinet resource from the repository.

If the deletion fails, an exception is thrown and the Cabinet resource (including the
cabinet tree and version history) is reverted to the original state.

2.13.1.4.4.1 HTTP Request method and query parameters

HTTP Query Description Data type Value Default

method parameters range value
DELETE del-non- Specifies whether this string true, false
empty operation deletes a non- false
empty cabinet or not
• true - The cabinet and
all its descendants are
deleted.
• false - Only this
cabinet is deleted.
Deleting a non-empty
cabinet results in an
error.

(boolean)

EDCPKRST220200-PRE-EN-01 Reference Guide 141

Chapter 2 Resources

HTTP Query Description Data type Value Default

method parameters range value
del-all- Specifies whether a multi- string true, false
links linked descendant is false
deleted or unlinked from
this specified cabinet.
• true - This operation
deletes a multi-linked
descendant along with
all its folder links.
• false - This operation
only deletes a
descendant's link to
this cabinet. The
descendant is still
linked to other folders.

Note: Virtual
documents are not
supported.

2.13.1.4.4.2 Request media types

N/A

2.13.1.4.4.3 Request headers

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.13.1.4.4.4 Request body

N/A

2.13.1.4.4.5 Response headers

N/A

142 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.13. Cabinet (s)

2.13.1.4.4.6 Response media types

N/A

2.13.1.4.4.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.13.1.4.4.8 Response body

HTTP 204 No Content status upon a successful delete operation. The response body
contains no content.

2.13.2 Cabinets
The Cabinets resource represents a collection of cabinets in a repository.

2.13.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.13.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the Cabinets resource without the file extension
• Feed Title: List of cabinets
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: “Cabinet” on page 137
• Entry ID: URI of the cabinet
• Entry Title: Cabinet name
• Entry Summary: Cabinet description
• Entry Updated: r_modify_date of the cabinet

EDCPKRST220200-PRE-EN-01 Reference Guide 143

Chapter 2 Resources

2.13.2.3 Link relations

Link relation Description Resource reference

self URI for cabinets collection “Cabinets” on page 143
feed
first, last, next, previous Pagination links “Cabinets” on page 143

2.13.2.4 Operations
2.13.2.4.1 Supported HTTP methods

Method Description
GET Lists all available cabinets in the repository
for the current user
POST Create a new cabinet in the repository.

2.13.2.4.2 Get Cabinets

List all available cabinets in the repository for the current user.

2.13.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET object- Specifies the string N/A null
type exact sub
type name to
get from the
collection of
this type.

144 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.13. Cabinet (s)

HTTP Query Description Data type Value range Default value

method parameters
thumbnail Specifies string false
whether this
operation
deletes a non-
empty folder
or not.
• true -
Return the
thumbnail
link for
each entry
in the
collection
resource.
• false -
Do not
return the
thumbnail
link for
each entry
in the
collection
resource.

This method supports the following common query parameters:

• inline
• page
• items-per-page
• include-total
• view
• links
• filter

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

EDCPKRST220200-PRE-EN-01 Reference Guide 145

Chapter 2 Resources

2.13.2.4.2.2 Request media types

N/A

2.13.2.4.2.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.13.2.4.2.4 Request body

N/A

2.13.2.4.2.5 Response headers

• Content-Length
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.13.2.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json (For compatible viewing

2.13.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

146 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.13. Cabinet (s)

2.13.2.4.2.8 Response body

XML or JSON representation of the cabinets collection.

• 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
relations” on page 691 in SysObject resource to view the links that are available
to the dm_cabinet object type.

2.13.2.4.3 Create a cabinet

Create a new cabinet or a subtype of cabinet in the repository.

2.13.2.4.3.1 HTTP Request method and query parameters

POST

2.13.2.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.13.2.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 147

Chapter 2 Resources

2.13.2.4.3.4 Request body

XML or JSON representation of the cabinet to create.

The r_object_type property for the cabinets must be dm_cabinet or its subtype,
otherwise, the Request is considered as a bad request and rejected. If this property is
not specified in a client request, it is set to dm_cabinet by default.

2.13.2.4.3.5 Response headers

• Location
• Content-Length
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.13.2.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.13.2.4.3.7 Response status

• 201 - Cabinet created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.13.2.4.3.8 Response body

XML or JSON representation of the cabinet created.

2.14 Checked Out Objects

The Checked Out Objects resource represents a collection of checked out objects in
a repository.

148 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.14. Checked Out Objects

2.14.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.14.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the checked out objects

• Feed Title: Checked out objects
• Feed Updated: Server's current time
• Supports POST: No
• Entry: Each entry represents a checked out object.
• Entry ID: URI of the version
• Entry Title: object_name of the object
• Entry Updated: r_modify_date for the object

2.14.3 Link relations

Link relation Description Resource reference
self This All Versions resource “Checked Out Objects”
on page 148
first, last, next, previous Pagination links “Checked Out Objects”
on page 148

EDCPKRST220200-PRE-EN-01 Reference Guide 149

Chapter 2 Resources

2.14.4 Operations
2.14.4.1 Supported HTTP methods

Method Description
GET Retrieves a collection of checked out objects.

2.14.4.2 Get checked out objects

Retrieve a collection of checked out objects according to the query parameters
specified in the request.

2.14.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET checked- Specifies the enum N/A current-user
out-by lock owner of
the checked
out objects
with the
following
valid values:
• current-
user
• specific-
user
• any

Only checked
out objects
with the
specified lock
owner are
returned in
the result.
user-name Specifies the string N/A null
user name of
the lock
owner.

Only works
when the
checked-
out-by
parameter is
set to
specific-
user

150 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.14. Checked Out Objects

HTTP Query Description Data type Value range Default value

method parameters
thumbnail Specifies string true, false false
whether this
operation
deletes a non-
empty folder
or not.
• true -
Return the
thumbnail
link for
each entry
in the
collection
resource.
• false -
Do not
return the
thumbnail
link for
each entry
in the
collection
resource.
include- Specifies string true, false false
all- whether or
versions not to list all
versions of
the child
object's link.
• true -
Return all
versions.
• false -
Only
return the
current
version.

EDCPKRST220200-PRE-EN-01 Reference Guide 151

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
q Specifies the string N/A No search
search criteria is
criterion with used for the
a full-text search.
expression in
Simple
Search
Language.

Parameter q
must be
encoded
because it
may contain
non-English
locale
characters.

Note:
Internat
ional
charact
ers that
are
used in
this
query
parame
ter
must be
sent
with
URL
encode
d by
the
UTF-8
charset.
Otherw
ise, the
result
may be
incorre
ct.

This method supports the following common query parameters:

• inline
• page
• items-per-page

152 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.14. Checked Out Objects

• include-total
• links
• filter
• view

The q parameter is supported for full text searching with a subset of the Simple
Search Language, however the parenthesis is not supported.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.14.4.2.2 Request media types

N/A

2.14.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.14.4.2.4 Request body

N/A

2.14.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.14.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

EDCPKRST220200-PRE-EN-01 Reference Guide 153

Chapter 2 Resources

2.14.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.14.4.2.8 Response body

XML or JSON representation of the 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.

2.15 Comment (s)

2.15.1 Comment
This resource allows you to work with comment objects.

2.15.1.1 Link relations

Link relation Description Resource reference

self This resource “Comment” on page 154
parent The parent Comment “Comment” on page 154
replies [1] The replies to the Comment “Comment Replies”
on page 166
delete [1] Delete the Comment
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

154 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.15. Comment (s)

2.15.1.2 Feed
No feed support.

2.15.1.3 Operations
2.15.1.3.1 Supported HTTP methods

Method Description
GET Retrieves the comment
DELETE Deletes the comment

2.15.1.3.2 Get a comment

Retrieves a comment.

2.15.1.3.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.15.1.3.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.15.1.3.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 155

Chapter 2 Resources

2.15.1.3.2.4 Request body

N/A

2.15.1.3.2.5 Response headers

N/A

2.15.1.3.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.15.1.3.2.7 Response status

• 200 - Comment retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.15.1.3.2.8 Response body

Example 2-50: XML response

<comment xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<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>The spec looks good.&amp;nbsp;
Just two comments&lt;br&gt;&lt;ol&gt;&lt;li&gt;Please add a diagram
to show the
flow.lt;/li&gt;&lt;li&gt;Please clarify the filter
criteria.&lt;br&gt;&lt;/li&gt;
&lt;/ol&gt;
</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"

156 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.15. Comment (s)

href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000180143717/comments/1324839"/>
</links>
</comment>

Example 2-51: JSON response

{
"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": "The spec looks good.&nbsp;Just two
comments&lt;br&gt;&lt;ol&gt;&lt;li&gt;
Please add a diagram to show the flow.&lt;/font&gt;&lt;/font&gt;&lt;/
font&gt;
&lt;/li&gt;&lt;li&gt;Please clarify the filter criteria.&lt;br&gt;&lt;/
li&gt;
&lt;/ol&gt;",
"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"
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 157

Chapter 2 Resources

2.15.1.3.3 Delete a comment

This method allows the user who created the comment to delete the comment. The
delete link for a comment is available only when a user can delete that comment.

2.15.1.3.3.1 HTTP Request method and query parameters

DELETE

2.15.1.3.3.2 Request media types

N/A

2.15.1.3.3.3 Request headers

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.15.1.3.3.4 Request body

N/A

2.15.1.3.3.5 Response headers

N/A

2.15.1.3.3.6 Response media types

N/A

2.15.1.3.3.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.15.1.3.3.8 Response body

N/A

158 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.15. Comment (s)

2.15.2 Comments
This resource allows you to work with a comment objects collection.

2.15.2.1 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: Comments on object {objectId}
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: “Comments” on page 159
• Entry ID: Comment resource URI
• Entry Title: Comment's title
• Entry Summary: Comment {commentId} on object {objectId}
• Entry Updated: Comment's modification date
• Entry Published: Comment's creation date

2.15.2.2 Link relations

Link relation Description Resource reference

self This resource “Comments” on page 159

2.15.2.3 Operations
2.15.2.3.1 Supported HTTP methods

Method Description
GET Retrieves a list of root-level comments
POST Create a root-level comment

EDCPKRST220200-PRE-EN-01 Reference Guide 159

Chapter 2 Resources

2.15.2.3.2 Get root-level comments

Retrieves the list of root level comments for the object.

2.15.2.3.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• inline
• page
• items-per-page
• include-total
• filter
• links
• sort

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.15.2.3.2.2 Request media types

N/A

2.15.2.3.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.15.2.3.2.4 Request body

N/A

160 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.15. Comment (s)

2.15.2.3.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.15.2.3.2.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.15.2.3.2.7 Response status

• 200 - Comments retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.15.2.3.2.8 Response body

Example 2-52: XML response

<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>OpenText 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>&lt;font color= '#363636' &gt;&lt;font size= '2' &gt;
&lt;font face= 'Arial' &gt;The spec looks good.& Just two
comments&lt;br&gt;

EDCPKRST220200-PRE-EN-01 Reference Guide 161

Chapter 2 Resources

&lt;/font&gt;&lt;/font&gt;&lt;/font&gt;&lt;ol&gt;&lt;li&gt;
&lt;font color= '#363636' &gt;&lt;font size= '2' &gt;
&lt;font face= 'Arial' &gt;Please add a diagram to show the
flow.&lt;/font&gt;
&lt;/font&gt;&lt;/font&gt;&lt;/li&gt;&lt;li&gt;&lt;font color=
'#363636' &gt;
&lt;font size= '2' &gt;&lt;font face= 'Arial' &gt;Please clarify
the filter
criteria.&lt;br&gt;&lt;/font&gt;&lt;/font&gt;&lt;/font&gt;&lt;/
li&gt;
&lt;/ol&gt;</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>
&lt;summary&gt;&lt;font face= 'Arial' &gt;&lt;font size= '2' &gt;
&lt;font color= '#363636' &gt;Should we also support paging?
&lt;br&gt;
&lt;/font&gt;&lt;/font&gt;&lt;/font&gt;&lt;/summary&gt;
<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>

Example 2-53: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000180143717/comments",
"title": "Comments on object: 0900000180143717 under parent comment id: 0",
"author":[
{
"name": "OpenText Documentum"
}
],
"updated": "2016-02-01T22:07:00.401+00:00",
"page": 1,
"items-per-page": 100,
"links":[

162 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.15. Comment (s)

{
"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": "&lt;font color= '#363636' &gt;&lt;font size= '2'
&gt;&lt;font face= 'Arial' &gt;
The spec looks good. Just two comments&lt;br&gt;&lt;/font&gt;&lt;/
font&gt;&lt;/font&gt;
&lt;ol&gt;&lt;li&gt;&lt;font color= '#363636' &gt;&lt;font
size= '2' &gt;
&lt;font face= 'Arial' &gt;Please add a diagram to show the
flow.&lt;/font&gt;
&lt;/font&gt;&lt;/font&gt;&lt;/li&gt;&lt;li&gt;&lt;font color=
'#363636' &gt;
&lt;font size= '2' &gt;
&lt;font face= 'Arial' &gt;Please clarify the filter
criteria.&lt;br&gt;
&lt;/font&gt;&lt;/font&gt;&lt;/font&gt;&lt;/li&gt;&lt;/ol&gt;",
"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": "&lt;font face= 'Arial' &gt;&lt;font size= '2' &gt;
&lt;font color= '#363636' &gt;Should we also support paging?

EDCPKRST220200-PRE-EN-01 Reference Guide 163

Chapter 2 Resources

&lt;br&gt;&lt;/font&gt;
&lt;/font&gt;&lt;/font&gt;",
"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"
}
}
]
}

2.15.2.3.3 Create a root-level comment

You can use this method to add a root-level comment. You must have <RELATE>
permission on the object to add a comment. The content value of a comment can be
either plain text or rich text. All content is sanitized before it is saved to the
repository.

Note: There is a limitation in the Collaboration Service that requires you to

have <WRITE> permission on the object in order to start a comment thread. In
other words, a user requires <WRITE> permission to create the first comment,
but only requires <RELATE> permission to add subsequent comments.

2.15.2.3.3.1 HTTP Request method and query parameters

POST

2.15.2.3.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

164 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.15. Comment (s)

2.15.2.3.3.3 Request headers

• Authorization
• Content-Type
• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.15.2.3.3.4 Request body

The content-value tag contains the rich text content of the comment. It's required for
comment creation.

2.15.2.3.3.5 Response headers

N/A

2.15.2.3.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.15.2.3.3.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.15.2.3.3.8 Response body

Example 2-54: XML response

<comment xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<content-value>
The spec looks good. Just two comments:&lt;br&gt;
&lt;ol&gt;
&lt;li&gt;Please add a diagram to show the flow.&lt;/li&gt;
&lt;li&gt;Please clarify the filter criteria.&lt;br&gt;&lt;/li&gt;
&lt;/ol&gt;
</content-value>
</comment>

EDCPKRST220200-PRE-EN-01 Reference Guide 165

Chapter 2 Resources

Example 2-55: JSON response

{
"content-value": "The spec looks good. Just two comments:&lt;br&gt;
&lt;ol&gt;&lt;li&gt;Please add a diagram to show the flow.&lt;/li&gt;
&lt;li&gt;Please clarify the filter criteria.&lt;br&gt;&lt;/li&gt;
&lt;/ol&gt;"
}

2.16 Comment Replies

This resource allows you to work with a list of comment replies.

2.16.1 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: Comments on object {objectId} in reply to comment
{parentCommentId}
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: A reply comment to the object
• Entry ID: Comment resource URI
• Entry Title: Comment's title
• Entry Summary: Comment {commentId} on object {objectId} in reply to comment
{parentCommentId}
• Entry Published: Comment's creation date
• Entry Updated: Comment's modification date

2.16.2 Link relations

Link relation Description Resource reference
self This resource “Comment Replies”
on page 166

166 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.16. Comment Replies

2.16.3 Operations
2.16.3.1 Supported HTTP methods

Method Description
GET Retrieves a list of replies for a comment
POST Create a reply for a comment

2.16.3.2 Get replies

Retrieves the list of replies to a comment.

2.16.3.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• inline

• page

• items-per-page

• include-total

• filter

• links

• sort

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.16.3.2.2 Request media types

N/A

2.16.3.2.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 167

Chapter 2 Resources

2.16.3.2.4 Request body

N/A

2.16.3.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.16.3.2.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.16.3.2.7 Response status

• 200 - Replies retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.16.3.2.8 Response body

Example 2-56: XML response

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000180143717/
comments/1324839/replies</id>
<title>Comments on object: 0900000180143717 under parent comment id:
1324839</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2016-02-12T19:47:24.307+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>
<linkrel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/
objects/
0900000180143717/comments/1324839/replies"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000180143717/
comments/1324840</id>
<title/>
<author>
<name>John Doe</name>

168 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.16. Comment Replies

<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/John
%2BDoe</uri>
</author>
<summary>
&li;font face= 'Arial' &gt;
&li;font size= '2' &gt;
&li;font color= '#363636' &gt;Thanks for reviewing it.& I'll update the
spec.
&li;br&gt;
&li;/font&gt;&li;/font&gt;&li;/font&gt;
</summary>
<updated>2016-01-26T15:19:21.000+00:00</updated>
<published>2016-01-26T15:19:21.000+00:00</published>
<linkrel="edit" href="http://localhost:8080/dctm-rest/repositories/
REPO/objects/
0900000180143717/comments/1324840"/>
<contenttype="application/xml" src="http://localhost:8080/dctm-rest/
repositories/
REPO/objects/0900000180143717/comments/1324840"/>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000180143717/
comments/1324842</id>
<title/>
<author>
<name>Jane Doe</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/Jane
%2BDoe</uri>
</author>
<summary>Do we need to expose this feature through REST api?
&li;br&gt;</summary>
<updated>2016-01-26T15:27:50.000+00:00</updated>
<published>2016-01-26T15:27:50.000+00:00</published>
<linkrel="edit" href="http://localhost:8080/dctm-rest/repositories/
REPO/objects/
0900000180143717/comments/1324842"/>
<contenttype="application/xml" src="http://localhost:8080/dctm-rest/
repositories/
REPO/objects/0900000180143717/comments/1324842"/>
</entry>
</feed>

Example 2-57: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000180143717/comments/1324839/replies",
"title": "Comments on object: 0900000180143717 under parent comment id:
1324839",
"author":[
{
"name": "OpenText Documentum"
}
],
"updated": "2016-02-12T19:29:04.092+00:00",
"page": 1,
"items-per-page": 100,
"links":[

EDCPKRST220200-PRE-EN-01 Reference Guide 169

Chapter 2 Resources

{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000180143717/
comments/1324839/replies"
}
],
"entries":[
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000180143717/comments/1324840",
"title": "",
"author":[
{
"name": "John Doe",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/
users/John%2BDoe"
}
],
"summary": "&lt;font face= 'Arial' &gt;&lt;font size= '2' &gt;
&lt;font color= '#363636' &gt;
Thanks for reviewing it. I'll update the spec.&lt;br&gt;
&lt;/font&gt;&lt;/font&gt;&lt;/font&gt;",
"updated": "2016-01-26T15:19:21.000+00:00",
"published": "2016-01-26T15:19:21.000+00:00",
"links":[
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
objects/
0900000180143717/comments/1324840"
}
],
"content":{
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
objects/
0900000180143717/comments/1324840"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000180143717/comments/1324842",
"title": "",
"author":[
{
"name": "Jane Doe",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/
users/Jane%2BDoe"
}
],
"summary": "Do we need to expose this feature through REST api?
&lt;br&gt;",
"updated": "2016-01-26T15:27:50.000+00:00",
"published": "2016-01-26T15:27:50.000+00:00",
"links":[
{"rel": "edit", "href": "http://localhost:8080/dctm-rest/
repositories/
REPO/objects/0900000180143717/comments/1324842"…}
],
"content":{
"type": "application/vnd.emc.documentum+json",

170 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.16. Comment Replies

"src": "http://localhost:8080/dctm-rest/repositories/REPO/
objects/
0900000180143717/comments/1324842"
}
}
]
}

2.16.3.3 Create a reply to a comment

You can use this method to add a reply to a comment. You must have <RELATE>
permission on the comment object in order to add a reply. The content value of a
comment reply can be either plain text or rich text. All content is sanitized before it is
saved to the repository.

2.16.3.3.1 HTTP Request method and query parameters

POST

This method supports the following common query parameters:

• comment-id: The id of the comment

• parent-id: The id of the parent comment
• content-value: Contains the text content of the comment
• can-delete: Indicates whether the user can delete this comment
• can-reply: Indicates whether the user can reply to this comment

2.16.3.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.16.3.3.3 Request headers

• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 171

Chapter 2 Resources

2.16.3.3.4 Request body

The content-value tag contains the encoded text content of the reply. It's required for
comment creation.

Example 2-58: XML request

<comment xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<content-value>
Agree with John.&lt;br&gt;&lt;ol&gt;&lt;li&gt;Please add a diagram to show
the
flow.&lt;/li&gt;&lt;li&gt;Please clarify the filter
criteria.&lt;br&gt;&lt;/li&gt;
&lt;/ol&gt;
</content-value>
</comment>

Example 2-59: JSON request

{
"content-value": "Agree with John.&lt;br&gt;&lt;ol&gt;&lt;li&gt;
Please add a diagram to
show the flow.&lt;/li&gt;&lt;li&gt;Please clarify the filter
criteria.&lt;br&gt;&lt;/li&gt;&lt;/ol&gt;"
}

2.16.3.3.5 Response headers

• Location

2.16.3.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.16.3.3.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

172 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.16. Comment Replies

2.16.3.3.8 Response body

Example 2-60: XML response

<comment xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<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>Agree with John.&lt;br&gt;&lt;ol&gt;&lt;li&gt;Please add a
diagram
to show the flow.&lt;/li&gt;&lt;li&gt;Please clarify the filter
criteria.&lt;br&gt;
&lt;/li&gt;&lt;/ol&gt;
</content-value>
<parent-id>1324830</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>

Example 2-61: JSON response

{
"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": "Agree with John.&lt;br&gt;&lt;ol&gt;&lt;li&gt;Please add a
diagram to
show the flow.&lt;/li&gt;&lt;li&gt;Please clarify the filter criteria.
&lt;br&gt;&lt;/li&gt;&lt;/ol&gt;",
"parent-id": "1324830",
"title": "",
"can-delete": true,
"can-reply": true,
"links":[
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/

EDCPKRST220200-PRE-EN-01 Reference Guide 173

Chapter 2 Resources

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"
}
]
}

2.17 Content (s)

2.17.1 Content
The Content resource represents a content object in a repository. A content object
contains both content properties and a link to the content stream.

2.17.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Contents” on page 180 and About the Diagram on page 17.

174 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.17. Content (s)

2.17.1.2 Feed
No feed support.

2.17.1.3 Link relations

Link relation Description Resource reference

self Link to this content. “Content” on page 174
content-media Link to the content binary Content URL from REST server when
[1] * stream for download. neither of the ACS server or BOCS server
is available. (“Content Media”
on page 188)

Distributed content URL when either of

the ACS server or BOCS server is
available.
enclosure [1] * Link to content binary Content URL from REST server when
stream for download. neither of the ACS server or BOCS server
is available. (“Content Media”
on page 188)

Distributed content URL when either of

the ACS server or BOCS server is
available.
parent Link to the associated object “Document” on page 217
of this content.
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

* Repeatable link relation

2.17.1.4 Operations
2.17.1.4.1 Supported HTTP methods

Method Description
GET Retrieves the metadata of the primary
content or of the rendition content for an
existing document object, optionally with
content media links for content download.
DELETE Deletes primary content and/or rendition
content for a document object.

EDCPKRST220200-PRE-EN-01 Reference Guide 175

Chapter 2 Resources

2.17.1.4.2 Get content

Retrieve the metadata of the primary content or of the rendition content for an
existing document object, optionally with content media links for content download.

2.17.1.4.2.1 Content URL return policy

By using the media-url-policy parameter, you can customize content URL return
policy in this operation to control what URL to put in the content-media and
enclosure link relations. Valid values for this parameter are:

Value Description
DC-PREF* When you set media-url-policy to DC-PREF, this operation tries
to retrieve a distributed content URL first. If no distributed content
URL is available, a Content Media resource URL from the REST server
is still acceptable. Details are as follows:
• If the BOCS server is available, and the network location is
specified correctly, the BOCS content URL corresponding to the
network location is returned.
• If the BOCS server is available, but the specified network location
is not correct, or there is no BOCS configured for this network
location, or the BOCS server is unavailable, the ACS content URL
is returned if any ACS server is available.
• If there are multiple ACS URLs available, the REST server chooses
the one with most proximity.
• If no ACS or BOCS server is available, a Content Media resource
URL is returned from the REST server.
DC-ONLY When you set media-url-policy to DC-ONLY, the REST server
returns a distributed content URL (either from the ACS server or the
BOCS server with the same logic as the DC-PREF option does. If there
is no ACS server or BOCS server, the REST server returns the HTTP
400 Conflict error.
LOCAL When you set media-url-policy to LOCAL, the REST server
returns a Content Media resource URL from the REST server
regardless of the availability of the ACS server and the BOCS server.
ALL When you set media-url-policy to ALL, all available Content
Media links are returned, each one pointing to a different content
media server. It includes all available ACS URLs, all available BOCS
URLs, and the local Content Media resource URL.
* Default

176 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.17. Content (s)

2.17.1.4.2.2 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET page Specifies the integer Any non- 0
page number negative
for the number.
content
imported. Documentum
Server
defines the
other
constraints on
this value.
format Specifies the string Any format null
format for the registered in
content the Format
imported. table of the
repository.
modifier Specifies the string Any string null
page modifier value.
for the
content.
media-url- Specifies the enum • DC-PREF DC-PREF
policy Content
• DC-ONLY
Media URL
return policy. • LOCAL
For detailed • ALL
information,
see “Content
URL return
policy”
on page 176.
network- Specifies the string Any valid null
location network network
location location
identifier for identifier
BOCS content correspondin
download. g to the
netloc_
Used only ident
when property of
media-url- the dm_
policy is set network_
to DC-PREF location_
or DC-ONLY. map instance.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

EDCPKRST220200-PRE-EN-01 Reference Guide 177

Chapter 2 Resources

2.17.1.4.2.3 Request media types

N/A

2.17.1.4.2.4 Request headers

• Accept

• Authorization

2.17.1.4.2.5 Request body

N/A

2.17.1.4.2.6 Response headers

• Content-Type

2.17.1.4.2.7 Response media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

2.17.1.4.2.8 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.17.1.4.2.9 Response body

XML or JSON message that represents the content metadata and a URL for content
download.

2.17.1.4.3 Delete content

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 using other approaches can remain when the
primary content is deleted.

178 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.17. Content (s)

2.17.1.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
DELETE page Specifies the integer Any non- NA
page number negative
for the number. This is a
content required
imported. Documentum parameter.
Server
defines the
other
constraints on
this value.
format Specifies the string Any format NA
format for the registered in
content the Format This is a
imported. table of the required
repository. parameter.
modifier Specifies the string Any string null
page modifier value.
for the
content.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.17.1.4.3.2 Request media types

N/A

2.17.1.4.3.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 179

Chapter 2 Resources

2.17.1.4.3.4 Request body

N/A

2.17.1.4.3.5 Response headers

N/A

2.17.1.4.3.6 Response media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

2.17.1.4.3.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.17.1.4.3.8 Response body

HTTP 204 No Content status upon a successful delete operation. The response body
contains no content.

2.17.2 Contents
The Contents resource represents a collection of primary content objects and
renditions of an object. Each content entry contains content properties and a link to
the content binary stream.

2.17.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “SysObject” on page 690 and About the Diagram on page 17.

180 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.17. Content (s)

2.17.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the content without the file extension.

• Feed Title: Object name.
• Feed Updated: Last updated time of the object.
• Supports POST: Yes
• Entry: “Content” on page 174
• Entry ID: URI of the content
• Entry Title: Content name
• Entry Summary: Content description
• Entry Updated: r_modify_date of the content

2.17.2.3 Link relations

Link relation Description Resource reference

self Link to the contents. “Contents” on page 180
parent [1] Link to the associated object or “Document” on page 217
document of this content
first, last, next, Pagination links. “Folder Child Objects”
previous on page 285
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.17.2.4 Operations
2.17.2.4.1 Supported HTTP methods

Method Description
GET GET a collection of content resources.
POST Create a new primary content or rendition on
a document.

EDCPKRST220200-PRE-EN-01 Reference Guide 181

Chapter 2 Resources

2.17.2.4.2 Get content

GET a collection of all primary content, rendition content metadata, and URLs to the
content binary stream for a document object, depending on the query parameter
settings.

2.17.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET media-url- Specifies the enum • DC-PREF null
policy Content
• DC-ONLY
Media URL
return policy. • LOCAL
For detailed • ALL
information,
see “Content
URL return
policy”
on page 176.
network- Specifies the string Any valid null
location network network
location location
identifier for identifier
BOCS content correspondin
download. g to the
netloc_
Used only ident
when property of
media-url- the dm_
policy is set network_
to DC-PREF location_
or DC-ONLY. map instance.

This operation also supports the following parameters:

• inline
• page
• items-per-page
• include-total

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

182 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.17. Content (s)

2.17.2.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.17.2.4.2.3 Request headers

• Accept
• Authorization

2.17.2.4.2.4 Request body

N/A

2.17.2.4.2.5 Response headers

• Content-Type

2.17.2.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json (For compatible viewing

2.17.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.17.2.4.2.8 Response body

XML or JSON message that represents the content, and a link to the content binary
stream.

EDCPKRST220200-PRE-EN-01 Reference Guide 183

Chapter 2 Resources

2.17.2.4.3 Create content

Create new primary content or renditions on a document.

2.17.2.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
POST primary Specifies boolean true - true
whether the indicates the
imported imported
content is content is
primary primary
content or a content.
rendition.
false -
indicates the
imported
content is a
rendition.
page Specifies the integer Any non- 0
page number negative
for the number.
content
imported. Documentum
Server
defines the
other
constraints on
this value.
format Specifies the string Any format null
format for the registered in
content the Format
imported. table of the
repository.

184 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.17. Content (s)

HTTP Query Description Data type Value range Default value

method parameters
overwrite Specifies string true - false
whether or Overwrite the
not to existing
overwrite the primary
existing content.
content with
the same false -
content Throw an
properties. exception
when the
primary
content or
rendition
with the same
content
properties
already
exists.
modifier Specifies the string Any string null
page modifier value.
for the
content.
content- Specifies the string An accurate null
length byte count of byte count of
the contents the content to
to be be uploaded
uploaded

EDCPKRST220200-PRE-EN-01 Reference Guide 185

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
content- Used to string A valid null
charset sanitize charset
content.

This
parameter
tells the
server how to
parse the
content for
sanitizing.
When the
content-
charset is
not provided,
the server
tries to get
metadata
information
from the
content itself
when it's in
HTML
format.

When the
metadata has
a valid
charset, then
it is used to
sanitize the
content. The
configuration
default
charset is
used when
the
content-
charset
parameter
and the
metadata
information
are not
found.

Note:
When
the
charset
and the
content

186 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.17. Content (s)

HTTP Query Description Data type Value range Default value

method parameters
do not
match,
the
upload
ed
content
may
have an
incorre
ctly
encode
d value.

Notes

• When you import primary content, the format parameter is optional.

However, when you specify this parameter, its value must be the same as the
format of the primary content on page 0. When the page contains primary
content, the overwrite parameter must be set to true.
• When storing content to Centera storage, the content-length query
parameter must be provided. When providing the value for content-
length, you must provide an accurate byte count of the content that you
want to upload.
For other storage mediums, such as harddisk, the content-length
parameter is not required and is optional. However, even when not required,
when this parameter is provided, it must be accurate.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.17.2.4.3.2 Request media types

Any MIME type registered in the Format table of the repository.

2.17.2.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 187

Chapter 2 Resources

2.17.2.4.3.4 Request body

Binary of the content.

2.17.2.4.3.5 Response headers

• Location

• Content-Type

2.17.2.4.3.6 Response media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

2.17.2.4.3.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.17.2.4.3.8 Response body

JSON or XML representation of the Content resource.

2.18 Content Media

The Content Media resource represents the media of the primary content or
rendition downloaded from the REST server, other than those from an ACS server or
a BOCS server. This resource is typically used when no ACS server or BOCS server
is available.

2.18.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Content” on page 174 and About the Diagram on page 17.

188 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.18. Content Media

2.18.2 Feed
No feed support.

2.18.3 Link relations

N/A

2.18.4 Operations
2.18.4.1 Supported HTTP methods

Method Description
GET Retrieves a content media from the REST
server.

2.18.4.2 Get content media from the REST server

Retrieve a content media from the REST server when no ACS server or BOCS server
is available.

2.18.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET page Specifies the integer Any non- 0
page number negative
for the number.
content
imported. Documentum
Server
defines the
other
constraints on
this value.
format Specifies the string Any format null
format for the registered in
content the Format
imported. table of the
repository.
modifier Specifies the string Any string null
page modifier value.
for the
Content
Media.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

EDCPKRST220200-PRE-EN-01 Reference Guide 189

Chapter 2 Resources

2.18.4.2.2 Request media types

N/A

2.18.4.2.3 Request headers

• Authorization
• If-None-Match (If the REST client uses the ETag mechanism to enable client side
web cache, the value of this header must be identical to the ETag value from the
previous server response header.)

Note: When the client provides the If-None-Match header, the REST server
compares the value of the header with the ETag of the current version of the
resource. If these two values match, meaning that the resource has not been
changed, the REST server sends back a short response with the HTTP 304 Not
Modified status, which notifies the client to use the cached version.

2.18.4.2.4 Request body

N/A

2.18.4.2.5 Response headers

• Content-Type
• Content-Length
• ETag

2.18.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.18.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

190 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.19. Current User

2.18.4.2.8 Response body

The content media downloaded from the REST server.

2.19 Current User

The Current User resource represents the metadata of the user that is currently
logged in to the repository.

2.19.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.19.2 Feed
No feed support.

2.19.3 Link relations

Link relation Description Resource reference

self This user resource. “Current User” on page 191
default-folder [1] Default folder (home cabinet) of “User Default Folder” on page 779
the user.
parent Groups to which the user belongs. “Groups” on page 320
edit This user resource. Only a “Current User” on page 191
SysAdmin or SuperUser can find
this link.
delete This user resource. Only a “Current User” on page 191
SysAdmin or SuperUser can find
this link.
permission-set The permission set definition of the “User Permission Set” on page 783
user.

EDCPKRST220200-PRE-EN-01 Reference Guide 191

Chapter 2 Resources

Link relation Description Resource reference

[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.19.4 Operations
2.19.4.1 Supported HTTP methods

Method Description
GET Retrieves the metadata of the user that is
currently logged in to the repository.

2.19.4.2 Get a current user

Retrieve the metadata of a current user.

2.19.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameter:

• view

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.19.4.2.2 Request media types

N/A

2.19.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

192 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.20. Current User Preference (s)

2.19.4.2.4 Request body

N/A

2.19.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.19.4.2.6 Response media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

2.19.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.19.4.2.8 Response body

XML or JSON representation of the current login user.

2.20 Current User Preference (s)

2.20.1 Current User Preference
The Current User Preference resource represents the user preference settings of
the current user. This resource provides the user that is currently logged in to the
repository with the capability to manage the user preference setting. For example,
you can use this resource to store client-related metadata.

The syntax and semantics of the user preference is determined by the client
application that uses REST services to store preference data. Documentum REST
Services introduces a preference resource model to store user preference content as
plain text content. In addition to the user preference content, there are several
properties to describe the preference metadata. User preference content characters
must be escaped by the REST client.

EDCPKRST220200-PRE-EN-01 Reference Guide 193

Chapter 2 Resources

2.20.1.1 Resource relationships

The following diagram illustrates how this resource is related with other resources:

See Also: “Current User Preferences” on page 201 and About the Diagram
on page 17.

2.20.1.2 Feed
No feed support.

2.20.1.3 Link relations

The following table lists link relations for the Current User Preference resource:

Link Description Resource reference

relation
self This User Preference resource. “Current User Preference”
on page 193
edit Edit this User Preference resource. “Current User Preference”
on page 193
delete [1] Delete this User Preference resource. “Current User Preference”
on page 193
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.20.1.4 Operations

194 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.20. Current User Preference (s)

2.20.1.4.1 Supported HTTP methods

Method Description
GET GET metadata, content, and other
information from the preference instance
POST Updates the attributes of the preference
instance
DELETE Deletes the preference instance

2.20.1.4.2 Get the current user preference settings

Gets the attributes, content, and other information of the current user preference
instance.

2.20.1.4.2.1 HTTP Request method and query parameters

GET

2.20.1.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.20.1.4.2.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.20.1.4.2.4 Request body

N/A

2.20.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 195

Chapter 2 Resources

2.20.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.20.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.20.1.4.2.8 Response body

Example 2-62: XML response

<preference xmlns="http://identifiers.emc.com/vocab/documentum">
<client>kw</client>
<owner-name>dmadmin</owner-name>
<title>user preference for knowledge worker</title>
<subject>user preference</subject>
<keywords>
<item>knowledge worker</item>
<item>cn</item>
</keywords>
<creation-date>2015-11-10T05:40:40.000+00:00</creation-date>
<r_modify_date>2015-11-10T05:49:52.000+00:00</r_modify_date>
<preference-content>
&lt;user-locale&gt;
cn
&lt;/user-locale&gt;
&lt;timezone&gt;
gmt+8
&lt;/timezone&gt;
</preference-content>
<links>
<link rel="self" href="/repositories/REPO/currentuser-preferences/kw"/>
<link rel="edit" href="/repositories/REPO/currentuser-preferences/kw"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="/repositories/REPO/currentuser-preferences/kw"/>
</links>
</preference>

Example 2-63: JSON response

{
"name": "preference",
"client": "kw",
"owner-name": "dmadmin",
"title": "user preference for knowledge worker",
"subject": "user preference",

196 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.20. Current User Preference (s)

"keywords": ["knowledge worker", "cn"],

"creation-date": "2015-11-10T05:40:40.000+00:00",
"r_modify_date": "2015-11-10T05:49:52.000+00:00",
"preference-content": "{\"user-locale\":\"cn\", \"timezone\":\"gmt+8\"}"
"links": [
{
"rel": "self",
"href": "/repositories/REPO/currentuser-preferences/kw"
},
{
"rel": "edit",
"href": "/repositories/REPO/currentuser-preferences/kw"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "/repositories/REPO/currentuser-preferences/kw"
}
]
}

2.20.1.4.3 Update user preference settings

Update the attributes for the preference instance. When the client provides
undefined attributes in the request body, the server throws an exception.

2.20.1.4.3.1 HTTP Request method and query parameters

POST

2.20.1.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.20.1.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 197

Chapter 2 Resources

2.20.1.4.3.4 Request body

XML or JSON representation of preference settings of the current user. You can
update the following properties:

• title
• subject
• keywords
• preference-content

The title, subject, and keywords properties have the same property definitions as
those in the dm_SysObject type. There is no size limit on preference-content.
However, the actual size affects the REST request and response payload.

You can place a CDATA block or escaped string in the preference-content

property to store client-related metadata as shown in the following samples:

Example 2-64: XML representation

<preference>
<properties>
<title>Chrome Browser</title>
<subject>The browser of Chrome</subject>
<keywords>
<item>Firefox</item>
<item>Mozilla</item>
</keywords>
<preference-content><![CDATA[<user_name>Michael</user_name>]]></
preference-content>
</properties>
</preference>

Example 2-65: JSON representation

{
"properties":{
"title":"Chrome Browser",
"subject":"The browser of Chrome",
"keywords":["Firefox","Mozilla"],
"preference-content":"{\"user_name\":\"Michael\"}"
}
}

Note: The content in the preference-content element is treated as a plain

text, and it is not parsed, it is only stored and retrieved as a string.

198 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.20. Current User Preference (s)

2.20.1.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.20.1.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.20.1.4.3.7 Response status

• 200 - Updated successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.20.1.4.3.8 Response body

XML or JSON representation of the updated user preference settings.

Example 2-66: XML response

<?xml version='1.0' encoding='UTF-8' ?>

<preference>
<properties>
<client>client2</client>
<owner_name>Administrator</owner_name>
<title>the title of a preference</title>
<subject>summary of this preference</subject>
<keywords>
<item>key1</item>
<item>key2</item>
</keywords>
<creation-date>2015-09-07T05:47:00.000+00:00</creation-date>
<r_modify_date>2015-09-07T06:06:39.000+00:00</r_modify_date>
<preference-content>
&lt;user_name&gt;Michael&lt;/user_name&gt;
</preference-content>
</properties>
<links>
<link rel="self" href="localhost:8080/dctm-rest/repositories/REPO/
currentuser-preferences/client2.xml" />
<link rel="edit" href="localhost:8080/dctm-rest/repositories/REPO/
currentuser-preferences/client2.xml" />
<link rel="http://identifiers.emc.com/linkrel/delete"
href="localhost:8080/dctm-rest/repositories/REPO/
currentuser-preferences/client2.xml" />
</links>
</preference>

EDCPKRST220200-PRE-EN-01 Reference Guide 199

Chapter 2 Resources

Example 2-67: JSON response

{
properties: {
client: "client2",
owner_name: "Administrator",
title: "the title of a preference",
subject: "summary of this preference",
keywords: ["key1","key2"],
creation-date: "2015-09-07T05:47:00.000+00:00",
r_modify_date: "2015-09-07T06:06:39.000+00:00",
preference-content: "{\"user_name\":\"Michael\"}",
}
links:
{
rel: "self"
href: "localhost:8080/dctm-rest/repositories/REPO/
rentuser-preferences/client2"
},
{
rel: "edit"
href: "localhost:8080/dctm-rest/repositories/REPO/
rentuser-preferences/client2"
},
{
rel: "http://identifiers.emc.com/linkrel/delete"
href: "localhost:8080/dctm-rest/repositories/REPO/
rrentuser-preferences/client2"
};
}

2.20.1.4.4 Delete user preference settings

Delete user preference settings.

2.20.1.4.4.1 HTTP Request method and query parameters

DELETE

2.20.1.4.4.2 Request media types

N/A

200 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.20. Current User Preference (s)

2.20.1.4.4.3 Request headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.20.1.4.4.4 Request body

N/A

2.20.1.4.4.5 Response headers

N/A

2.20.1.4.4.6 Response media types

N/A

2.20.1.4.4.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.20.1.4.4.8 Response body

HTTP 204 No Content status upon a successful delete operation.

2.20.2 Current User Preferences

The Preferences resource represents the collection of preferences metadata.

2.20.2.1 Resource relationships

The following diagram illustrates how this resource is related with other resources:

See Also: “Current User” on page 191 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 201

Chapter 2 Resources

2.20.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: Preferences
• Feed Updated: Server's current time
• Entry: “Current User Preference” on page 193
• Supports POST? Yes

2.20.2.3 Link relations

The following table lists link relations for the Preferences resource.

Link relation Description Resource reference

self This object resource “Current User Preferences”
on page 201
first, last, next, previous Pagination link “Current User Preferences”
on page 201

2.20.2.4 Operations
2.20.2.4.1 Supported HTTP methods

Method Description
GET Gets the current user's preference collection.
POST Creates a user preference for the current
user.

2.20.2.4.2 Get current user preferences collection

GET the current user's preferences collection.

2.20.2.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• sort
• view
• inline
• page
• items-per-page

202 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.20. Current User Preference (s)

• include-total
• links
• filter

2.20.2.4.2.2 Request media types

N/A

2.20.2.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.20.2.4.2.4 Request body

N/A

2.20.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.20.2.4.2.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.20.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 203

Chapter 2 Resources

2.20.2.4.2.8 Response body

Example 2-68: XML response

<?xml version='1.0' encoding='UTF-8' ?>
<feed>
<id>http://localhost:8080/dctm-rest/repositories/REPO/currentuser/
preferences
</id>
<title>Preferences</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2015-08-17T04:36:37.195+00:00</updated>
<dm:page>1</dm:page>
<dm:items-per-page>100</dm:items-per-page>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/currentuser/
preferences.xml?inline=true" />
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/currentuser/
preferences/clinet1
</id>
<title>the title of a peference</title>
<summary>summary of this preference</summary>
<updated>2015-08-17T04:36:37.197+00:00</updated>
<published>2015-08-17T04:36:37.197+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/
currentuser/preferences/clinet1.xml" />
<content>
<dm:preference xmlns:dm="http://identifiers.emc.com/vocab/
documentum">
<dm:client>kw</dm:client>
<dm:owner-name>dmadmin</dm:owner-name>
<dm:title>user preference for knowledge worker</dm:title>
<dm:subject>user preference</dm:subject>
<dm:keywords>
<dm:item>knowledge worker</dm:item>
<dm:item>cn</dm:item>
</dm:keywords>
<dm:creation-date>2015-11-10T05:40:40.000+00:00
</dm:creation-date>
<dm:r_modify_date>2015-11-10T05:49:52.000+00:00</
dm:r_modify_date>
<dm:preference-content>
&lt;user-locale&gt;cn&lt;/user-locale&gt;
&lt;timezone&gt;gmt+8&lt;/timezone&gt;
</dm:preference-content>
<links>
<link rel="self" href="/repositories/REPO/
currentuser-preferences/kw"/>
<link rel="edit" href="/repositories/REPO/
currentuser-preferences/kw"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="/repositories/REPO/currentuser-preferences/kw"/>
</links>
</dm:preference>
</content>
</entry>
</feed>

204 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.20. Current User Preference (s)

Example 2-69: JSON response

{
id: "http://localhost:8080/dctm-rest/repositories/REPO/currentuser/
preferences",
title: "Preferences",
author: [{name: "OpenText Documentum"}],
updated: "2015-08-17T04:40:48.970+00:00",
page: 1,
items-per-page: 100,
links:[{rel: "self",href: "http://localhost:8080/dctm-rest/repositories/
REPO/
currentuser/preferences.json?inline=true"}],
entries:[{
id: "http://localhost:8080/dctm-rest/repositories/REPO/currentuser/
preferences/
client1",
title: "the title of a peference",
summary: "summary of this preference",
updated: "2015-08-17T04:40:48.972+00:00",
published: "2015-08-17T04:40:48.972+00:00",
content: {
{
"name": "preference",
"client": "kw",
"owner-name": "dmadmin",
"title": "user preference for knowledge worker",
"subject": "user preference",
"keywords": ["knowledge worker", "cn"],
"creation-date": "2015-11-10T05:40:40.000+00:00",
"r_modify_date": "2015-11-10T05:49:52.000+00:00",
"preference-content": "{\"user-locale\":\"cn\", \"timezone\":
\"gmt+8\"}",
"links": [
{
"rel": "self",
"href": "/repositories/REPO/currentuser-preferences/kw"
},
{
"rel": "edit",
"href": "/repositories/REPO/currentuser-preferences/kw"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "/repositories/REPO/currentuser-preferences/kw"
}
]
}
}
}
}

EDCPKRST220200-PRE-EN-01 Reference Guide 205

Chapter 2 Resources

2.20.2.4.3 Create a user preference

Create a user preference for the current user.

2.20.2.4.3.1 HTTP Request method and query parameters

POST

2.20.2.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.20.2.4.3.3 Request headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.20.2.4.3.4 Request body

Example 2-70: XML request

<preference xmlns="http://identifiers.emc.com/vocab/documentum">
<client>kw</client>
<title>user preference for knowledge worker</title>
<subject>user preference</subject>
<keywords>
<item>knowledge worker</item>
<item>cn</item>
</keywords>
<preference-content>
&lt;user-locale&gt;cn&lt;/user-locale&gt;
&lt;timezone&gt;gmt+8&lt;/timezone&gt;
</preference-content>
</preference>

Example 2-71: JSON request

{
"client": "kw",
"title": "user preference for knowledge worker",
"subject": "user preference",
"keywords": ["knowledge worker", "cn"],
"preference-content": "&lt;user-locale&gt;cn&lt;/user-locale
&gt;&lt;timezone&gt;gmt+8&lt;/timezone&gt;
"
}

206 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.20. Current User Preference (s)

2.20.2.4.3.5 Response headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.20.2.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.20.2.4.3.7 Response status

• 201 - Added successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.20.2.4.3.8 Response body

Example 2-72: XML response

<preference xmlns="http://identifiers.emc.com/vocab/documentum">
<client>kw</client>
<owner-name>dmadmin</owner-name>
<title>user preference for knowledge worker</title>
<subject>user preference</subject>
<keywords>
<item>knowledge worker</item>
<item>cn</item>
</keywords>
<creation-date>2015-11-10T05:40:40.000+00:00</creation-date>
<r_modify_date>2015-11-10T05:49:52.000+00:00</r_modify_date>
<preference-content>
&lt;user-locale&gt;cn&lt;/user-locale&gt;
&lt;timezone&gt;gmt+8&lt;/timezone&gt;
</preference-content>
<links>
<link rel="self" href="/repositories/REPO/currentuser-preferences/kw"/>
<link rel="edit" href="/repositories/REPO/currentuser-preferences/kw"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="/repositories/REPO/currentuser-preferences/kw"/>
</links>
</preference>

Example 2-73: JSON response

{
"client": "kw",
"owner-name": "dmadmin",
"title": "user preference for knowledge worker",

EDCPKRST220200-PRE-EN-01 Reference Guide 207

Chapter 2 Resources

"subject": "user preference",

"keywords": ["knowledge worker", "cn"],
"creation-date": "2015-11-10T05:40:40.000+00:00",
"r_modify_date": "2015-11-10T05:49:52.000+00:00",
"preference-content": "&lt;user-locale&gt;cn&lt;/user-locale&gt;
&lt;timezone&gt;gmt+8&lt;/timezone&gt;"
"links": [
{
"rel": "self",
"href": "/repositories/REPO/currentuser-preferences/kw"
},
{
"rel": "edit",
"href": "/repositories/REPO/currentuser-preferences/kw"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "/repositories/REPO/currentuser-preferences/kw"
}
]
}

2.21 Current Version

The Current Version resource represents the current version of the version tree of
an object. A version tree has only one CURRENT version.

2.21.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “SysObject” on page 690 and About the Diagram on page 17.

2.21.2 Feed
No feed support.

208 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.21. Current Version

2.21.3 Link relations

Link relation Description Resource reference
canonica [1] Canonical URI of the current “SysObject” on page 690
version of the object
“Document” on page 217
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.21.4 Operations
2.21.4.1 Supported HTTP methods

Method Description
GET Retrieves the current version of an object.

2.21.4.2 Get the current version

Retrieves the current version of a specified object from its version tree.

2.21.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameter:

• view

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.21.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

EDCPKRST220200-PRE-EN-01 Reference Guide 209

Chapter 2 Resources

2.21.4.2.3 Request headers

• Accept
• Authorization

2.21.4.2.4 Request body

N/A

2.21.4.2.5 Response headers

• Content-Type

2.21.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.21.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.21.4.2.8 Response body

XML or JSON representation of the current version of the specified object.

2.22 Custom Facets

The Custom Facets resource allows you to retrieve the facet information that has been
configured in xPlore. This facet information can then be used to filter search results.

2.22.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

210 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.22. Custom Facets

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.22.2 Feed
Is this resource a feed? Yes.

• Feed ID: Resource URI

• Feed Title: Supported Facets
• Feed Updated: Server's current time
• Supports POST: No
• Entry: A supported Facet object
• Entry ID: Request URI
• Entry Title: Facet name
• Entry Updated: Server's current time

2.22.3 Link relations

Link relation Description Resource reference
self Link to itself. “Custom Facets” on page 210
first, last, next, previous pagination links “Custom Facets” on page 210

2.22.4 Operations
2.22.4.1 Supported HTTP methods

Method Description
GET Retrieves the Facets information that has
been configured in xPlore.

2.22.4.2 Get supported Facets configured in xPlore

Retrieves the supported Facets that have been configured in xPlore.

EDCPKRST220200-PRE-EN-01 Reference Guide 211

Chapter 2 Resources

2.22.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET page, For more information, see Appendix B, REST Common
items-per- Definition - URI Request Query Parameters on page 979.
page,
include-
total

2.22.4.2.2 Request media types

N/A

2.22.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.22.4.2.4 Request body

N/A

2.22.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.22.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json
• application/hal+json

212 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.22. Custom Facets

2.22.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.22.4.2.8 Response body

Example 2-74: ATOM + XML Response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO1/supported-facets</id>
<title>Supported Facets</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2018-11-19T06:23:49.941+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" h
ref="http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO1/supported-facets</
id>
<title>a_content_type</title>
<type>string</type>
<summary>Attribute a_content_type of Type string supports Faceting</
summary>
<updated>2018-11-19T06:23:49.941+00:00</updated>
<published>2018-11-19T06:23:49.941+00:00</published>
<link rel="search"
hreftemplate="http://localhost:8080/dctm-rest/repositories/REPO1/
search?facet=a_content_type&amp;
object-type=string{&amp;collections,
include-total,inline,items-per-page,locations,page,q,
sort,timezone,view}"/>
</entry>
...
</feed>

Example 2-75: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO1/supported-facets",
"title": "Supported Facets",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-11-19T06:21:19.435+00:00",

EDCPKRST220200-PRE-EN-01 Reference Guide 213

Chapter 2 Resources

"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets",
"title": "a_content_type",
"type": "string",
"summary": "Attribute a_content_type of Type string supports
Faceting",
"updated": "2018-11-19T06:21:19.453+00:00",
"published": "2018-11-19T06:21:19.453+00:00",
"links": [
{
"rel": "search",
"hreftemplate": "http://localhost:8080/dctm-rest/repositories/
REPO1/search?facet=a_content_type&
object-type=string{&collections,include-total,
inline,items-per-page,locations,page,q,sort,
timezone,view}"
}
]
}

Example 2-76: HAL + JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO1/supported-facets",
"title": "Supported Facets",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-11-19T06:25:00.143+00:00",
"page": 1,
"items-per-page": 100,
"_embedded": {
"collection": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets",
"title": "a_content_type",
"type": "string",
"summary": "Attribute a_content_type of Type string supports
Faceting",
"updated": "2018-11-19T06:25:00.144+00:00",
"published": "2018-11-19T06:25:00.144+00:00",
"_links": {
"search": {
"hreftemplate": "http://localhost:8080/dctm-rest/
repositories/REPO1/search?

214 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.22. Custom Facets

facet=a_content_type&
object-type=string{&collections,
include-total,inline,items-per-page,
locations,page,q,sort,timezone,view}"
}
}
},
...
]
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets"
}
}
}

2.22.4.3 More Code Samples

Example 2-77: Request

GET /dctm-rest/repositories/REPO1/supported-facets?page=2&items-per-page=2
&include-total=true HTTP/1.1
Host: localhost:8080
Authorization: Basic QWRtaW5pc3RyYXRvcjpQYXNzd29yZEAxMjM=
Accept:application/vnd.emc.documentum+json

Example 2-78: Response

Status 200 OK

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO1/supported-facets",
"title": "Supported Facets",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-11-20T08:16:03.039+00:00",
"page": 2,
"items-per-page": 2,
"total": 10,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets?page=2&items-per-page=2&include-total=true"
},
{
"rel": "previous",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets?page=1&items-per-page=2&include-total=true"
},

EDCPKRST220200-PRE-EN-01 Reference Guide 215

Chapter 2 Resources

{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets?page=3&items-per-page=2&include-total=true"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets?page=1&items-per-page=2&include-total=true"
},
{
"rel": "last",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets?page=5&items-per-page=2&include-total=true"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets?page=2&items-per-page=2&include-total=true",
"title": "keywords",
"type": "string"
"summary": "Attribute keywords of Type string supports Faceting",
"updated": "2018-11-20T08:16:03.040+00:00",
"published": "2018-11-20T08:16:03.040+00:00",
"links": [
{
"rel": "search",
"hreftemplate": "http://localhost:8080/dctm-rest/repositories/
REPO1/search?facet=keywords&
object-type=string{&collections,include-total,
inline,items-per-page,locations,page,q,sort,
timezone,view}"
}
]
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO1/
supported-facets?page=2&items-per-page=2&include-total=true",
"title": "r_modify_date",
"type": "datetime",
"summary": "Attribute r_modify_date of Type datetime supports
Faceting",
"updated": "2018-11-20T08:16:03.041+00:00",
"published": "2018-11-20T08:16:03.041+00:00",
"links": [
{
"rel": "search",
"hreftemplate": "http://localhost:8080/dctm-rest/repositories/
REPO1/search?facet=r_modify_date&
object-type=datetime{&collections,
include-total,inline,items-per-page,locations,
page,q,sort,timezone,view}"
}
]
}
]
}

216 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.23. Document

2.23 Document
The Document resource represents a document in a repository.

2.23.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Folder Child Documents” on page 243 and About the Diagram
on page 17.

2.23.2 Feed
No feed support.

2.23.3 Link relations

Link relation Description Resource reference

self This document “Document” on page 217
parent The parent folder (or cabinet) “Cabinet” on page 137
of this document
“Folder” on page 236
cabinet [1] The cabinet of this document “Cabinet” on page 137
relations [1] A collection of relations “Relations” on page 536
related to this document
contents A collection of contents “Contents” on page 180
associated to this document
comments The comments associated to N/A
this document
related-documents The collection of documents N/A
related to this document by
way of a given relation

EDCPKRST220200-PRE-EN-01 Reference Guide 217

Chapter 2 Resources

Link relation Description Resource reference

version-history The collection of versions for N/A
this document
virtual-document-nodes Virtual document nodes “Virtual Document Nodes”
displayed when the on page 820
SysObject is a virtual
document in the following
cases:
• In 7.3.0, it is displayed
only when the document
is a virtual document
• Since 7.3.1, all documents
have this link relation
because users can convert
a simple document into a
virtual document by
adding a new virtual
document node
snapshots Link to the Virtual Document “Virtual Document
Snapshots resource. Snapshots” on page 838
related-docs [1] Allows you to find related or “Related Documents”
similar documents according on page 540
to common knowledge
among documents, such as
keyword, hashtag, or
category, etc.
related-sme [1] Allows you to find related “Related SME” on page 548
SMEs (Authors) who have
worked on any given
document.
significant-terms [1] Allows you to use key words “Significant Terms”
while searching for content on page 668
with Documentum CCE
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

218 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.23. Document

2.23.4 Operations
2.23.4.1 Supported HTTP methods

Method Description
GET Retrieves properties, and other information of the document
resource.
POST Updates the properties for the document resource.
DELETE Deletes the document resource from a repository.

2.23.4.2 Get a document

GET properties and other information of the document resource. Properties are
returned as embedded elements in the response message body. Other information,
such as relationships, is referenced from the link relations of the response message
body.

2.23.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET view For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
check- Determines string true, false false
subscripti whether or
on not to check if
the current
user is
subscribed to
the requested
instance.

2.23.4.2.2 Request media types

N/A

2.23.4.2.3 Request headers

• Accept
• Authorization

EDCPKRST220200-PRE-EN-01 Reference Guide 219

Chapter 2 Resources

2.23.4.2.4 Request body

N/A

2.23.4.2.5 Response headers

• Content-Type

2.23.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.23.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.23.4.2.8 Response body

Example 2-79: XML response

<?xml version="1.0" encoding="UTF-8"?>

<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>
<doc-type-label>SIMPLE_DOCUMENT</doc-type-label>
<properties>
<attr1>value1</attr1>
<repeating_attr2>
<item href="xxx2">value2</item>
<item href="xxx3">value3</item>
</repeating_attr2>
...
</properties>
<link rel="self" href="..."/>
...
</dm_document>

Example 2-80: JSON response

{
"name": "document",
"type": "dm_document",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/

220 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.23. Document

dm_document",
"doc-type-label": "SIMPLE_DOCUMENT",
"properties":
{
"attr1": "value1",
"repeating_attr2": [value2, value3],
...
},
"links":
[
{
"rel": "self",
"href": "..."
},
...
]
}

2.23.4.3 Update a document

Update the document with given properties. When the client provides undefined
properties in the Request body, the server throws an exception.

2.23.4.3.1 HTTP Request method and query parameters

PUT

2.23.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.23.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 221

Chapter 2 Resources

2.23.4.3.4 Request body

XML or JSON representation of the document resource. Only updatable properties

can be put in the message body.

Example 2-81: XML request body

<?xml version="1.0" encoding="UTF-8"?>
<document xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<doc-type-label>VIRTUAL_DOCUMENT</doc-type-label>
<properties>
<attr1>value1</attr1>
<repeating_attr2>
<item href="xxx2">value2</item>
<item href="xxx3">value3</item>
</repeating_attr2>
...
</properties>
</dm_document>

Example 2-82: JSON request body

{
"name": "document",
"type": "dm_document",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_document",
"doc-type-label": "VIRTUAL_DOCUMENT",
"properties":
{
"attr1": "value1",
"repeating_attr2": [value2, value3],
...
}
}

2.23.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

222 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.23. Document

2.23.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.23.4.3.7 Response status

• 200 - Updated successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.23.4.3.8 Response body

A successful response contains all of the properties of the updated document.

Example 2-83: XML response

<?xml version="1.0" encoding="UTF-8"?>

<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">
<doc-type-label>VIRTUAL_DOCUMENT</doc-type-label>
<properties>
<attr1>value1</attr1>
<repeating_attr2>
<item href="xxx2">value2</item>
<item href="xxx3">value3</item>
</repeating_attr2>
...
<properties>
<link rel="self" href="..."/>
...
</dm_document>

Example 2-84: JSON response

{
"name": "document",
"type": "dm_document",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_document",
"doc-type-label": "VIRTUAL_DOCUMENT",
"properties":
{
"attr1": "value1",
"repeating_attr2": [value2, value3],
...
},

EDCPKRST220200-PRE-EN-01 Reference Guide 223

Chapter 2 Resources

"links":
[
{
"rel": "self",
"href": "..."
},
...
]
}

2.23.4.4 Delete a document

Deletes the Document resource from the repository.

When the deletion fails, an exception is thrown and the Document resource is
reverted to the original state.

2.23.4.4.1 HTTP Request method and query parameters

224 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.23. Document

HTTP Query Description Data type Value range Default value

method parameters
DELETE del- Delete string N/A all
version options for
multi-version
document
objects.
• SELECTE
D_
VERSION:
The
version
associated
with the
given
object ID
is
removed.
• unused :
The
versions
that do
not have
symbolic
labels
associated
with them
are
removed.
• ALL_
VERSION
S: All
revisions
on the
same
version
tree are
removed.

EDCPKRST220200-PRE-EN-01 Reference Guide 225

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
del-vd-all Delete the string true, false false
virtual
document
and all of its
descendants
• false:
Deletes
only the
virtual
document
and the
containme
nts with
its direct
children
• true:
Deletes
the virtual
document
and all of
the
descendan
ts of this
virtual
document

2.23.4.4.2 Request media types

N/A

2.23.4.4.3 Request headers

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.23.4.4.4 Request body

N/A

226 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.24. DQL

2.23.4.4.5 Response headers

N/A

2.23.4.4.6 Response media types

N/A

2.23.4.4.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.23.4.4.8 Response body

HTTP 204 No Content Success status upon a successful delete operation. The
response body contains no content.

2.23.4.5 Example
Example 2-85: Delete a document

Request
DELETE http://localhost:8080/dctm-rest/repositories/REPO/documents/
0900000f80000cd8
Accept:application/vnd.emc.documentum+json
Authorization:Basic ZG1hZG1pbjpwYXNzd29yZA==

Response
Status Code: 204 No Content Success

2.24 DQL
The DQL resource represents a read-only DQL query.

EDCPKRST220200-PRE-EN-01 Reference Guide 227

Chapter 2 Resources

2.24.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.24.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: DQL Query Results
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: Query result corresponding to one of the rows in the result set
• Entry ID: Query resource URI with the item index in the current page
• Entry Title: 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.

• Entry Updated: r_modify_date of the query result if this property exists.

Otherwise, an empty string.

2.24.3 Link relations

Link relation Description Resource reference
self This DQL resource “DQL” on page 227
first, last, next, previous Pagination links. “DQL” on page 227

228 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.24. DQL

2.24.4 Operations
2.24.4.1 Supported HTTP methods

Method Description
GET Performs a read-only DQL query with the
dql query parameter.
POST Performs a read-only DQL query with the
dql query parameter or with the Request
body encoded in application/x-www-
form-urlencoded.

2.24.4.2 Perform a read-only DQL query

Perform a read-only DQL query with the dql query parameter.

Using the GET operation to perform a query can result in a response with better
cache performance. However, the web browser or client library may fail to handle
the Request properly when the DQL query is very long (for example, over 2,000
characters) since the DQL statement is provided using the HTTP query parameter
dql. To perform a query with a long DQL statement, use the POST operation.

For more information, see Perform a long read-only DQL query.

2.24.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Default value Yes

method parameters
GET dql The query string null Yes
parameter of
the DQL This
resource parameter is
required.

EDCPKRST220200-PRE-EN-01 Reference Guide 229

Chapter 2 Resources

HTTP Query Description Data type Default value Yes

method parameters
raw Indicates string false No
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.

Note: International characters that are used in query parameters must be sent
with URL encoded by the UTF-8 charset. Otherwise, the result may be
incorrect.

Also, this operation supports the following common query parameter:

• page
• items-per-page

Note: This operation does not support the include-total query parameter.
To obtain the total size of the result set, send another query by using the
aggregation function COUNT() with the same conditions.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.24.4.2.2 Request media types

N/A

230 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.24. DQL

2.24.4.2.3 Request headers

• Accept
• Authorization

For more information about HTTP headers, see Appendix D, REST Common
Definition - HTTP Headers on page 987.

2.24.4.2.4 Request body

N/A

2.24.4.2.5 Response headers

• Content-Type

For more information about HTTP headers, see Appendix D, REST Common
Definition - HTTP Headers on page 987.

2.24.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.24.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.24.4.2.8 Response body

XML or JSON representation of result set of the DQL query.

Example 2-86: XML response

...
<entry>
<id>http://localhost:8080/dctm-rest/repositories/acme01?dql=...</id>
<title>090004d2800001d0</title>
<updated>2013-06-18T20:17:39.331+08:00</updated>
<content>
<dm:query-result>
<dm:properties>
<dm:r_object_id>090004d2800001d0</dm:r_object_id>
<dm:object_name>Default Signature Page Template</dm:object_name>
</dm:properties>
</dm:query-result>

EDCPKRST220200-PRE-EN-01 Reference Guide 231

Chapter 2 Resources

</content>
</entry>
...

Example 2-87: JSON response

...
{
"id": "http://localhost:8080/dctm-rest/repositories/acme01?dql=...",
"title": "090004d2800001d0",
"updated": "2013-06-18T20:22:41.425+08:00",
"content": {
"name": "query-result",
"properties": {
"r_object_id": "090004d2800001d0",
"object_name": "Default Signature Page Template"
}
}
},
...

• 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.

Note: The query result may contain link relations or thumbnail links. For more
information, see Generating Link relations in DQL Results in the OpenText
Documentum REST Services Development Guide.

2.24.4.3 Perform a long read-only DQL query

Perform a read-only DQL query with the dql query parameter or with the request
body encoded in application/x-www-form-urlencoded.

To perform a query with long DQL statement, use the POST operation with a
request body in application/x-www-form-urlencoded.

232 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.24. DQL

2.24.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
POST dql Read-only string N/A null
DQL
statement to This
perform parameter is
required if
the HTTP
request does
not contain a
body.
raw Indicates string true, false false
whether or
not 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.

• page
• items-per-page

This operation also supports the following common query parameter:

Note: This operation does not support the include-total query parameter.
To obtain the total size of the result set, send another query using the
aggregation COUNT() function with the same conditions.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

EDCPKRST220200-PRE-EN-01 Reference Guide 233

Chapter 2 Resources

2.24.4.3.2 Request media types

• application/x-www-form-urlencoded

2.24.4.3.3 Request headers

• Accept

• Authorization

For more information about HTTP headers, see Appendix D, REST Common
Definition - HTTP Headers on page 987.

2.24.4.3.4 Request body

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.

Example 2-88: Example request

Accept: application/vnd.emc.documentum+json
Content-Type: application/www-form-urlencoded
POST http://localhost:8080/dctm-rest/repositories/acme01
dql=select%20r_object_id,object_name%20from%20dm_document&items-per-
page=100&page=1

2.24.4.3.5 Response headers

• Content-Type

For more information about HTTP headers, see Appendix D, REST Common
Definition - HTTP Headers on page 987.

2.24.4.3.6 Response media types

• application/atom+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

234 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.24. DQL

2.24.4.3.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.24.4.3.8 Response body

XML or JSON representation of result set of the DQL query.

Example 2-89: XML response

...
<entry>
<id>http://localhost:8080/dctm-rest/repositories/acme01?dql=...</id>
<title>090004d2800001d0</title>
<updated>2013-06-18T20:17:39.331+08:00</updated>
<content>
<dm:query-result>
<dm:properties>
<dm:r_object_id>090004d2800001d0</dm:r_object_id>
<dm:object_name>Default Signature Page Template</dm:object_name>
</dm:properties>
</dm:query-result>
</content>
</entry>
...

Example 2-90: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/acme01?dql=...",
"title": "090004d2800001d0",
"updated": "2013-06-18T20:22:41.425+08:00",
"content": {
"name": "query-result",
"properties": {
"r_object_id": "090004d2800001d0",
"object_name": "Default Signature Page Template"
}
}
},

• 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.

EDCPKRST220200-PRE-EN-01 Reference Guide 235

Chapter 2 Resources

• The returned query result set only contains the resources that you have access to.
• Pagination is supported.

Note: The query result may contain link relations or thumbnail links. For more
information, see Generating Link relations in DQL Results in the OpenText
Documentum REST Services Development Guide.

2.25 Folder
The Folder resource represents a folder in a repository.

2.25.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Folder Child Folders” on page 271 and About the Diagram on page 17.

2.25.2 Feed
No feed support.

236 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.25. Folder

2.25.3 Link relations

Link relation Description Resource reference
self Link to this folder. “Folder” on page 236
parent Link to the parent folder (or cabinet) “Cabinet” on page 137
of this folder.
“Folder” on page 236
relations [1] Collection of relations related to this “Relations” on page 536
folder.
cabinet [1] Link to the cabinet of this folder. “Cabinet” on page 137
folders [1] Collection of folders linked to this “Folder Child Folders” on page 271
folder.
documents [1] Collection of documents linked to “Folder Child Documents”
this folder. on page 243
objects [1] Collection of SysObjects linked to “Folder Child Objects” on page 285
this folder.
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.25.4 Operations
2.25.4.1 Supported HTTP methods

Method Description
GET Retrieves properties, and other information
of the Folder resource.
POST Updates the properties for the Folder
resource.
DELETE Deletes the Folder resource from a
repository.

2.25.4.2 Get a Folder

GET properties, and other information, such as relationships, of the Folder
resource. Properties are returned as embedded elements in the response message
body. Other information, such as relationships, is referenced from the link relations
of the response message body.

EDCPKRST220200-PRE-EN-01 Reference Guide 237

Chapter 2 Resources

2.25.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET view For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
links
check- Determines string true, false false
subscripti whether or
on not to check if
the current
user is
subscribed to
the requested
instance.

2.25.4.2.2 Request media types

N/A

2.25.4.2.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.25.4.2.4 Request body

N/A

2.25.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.25.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

• application/xml

• application/json

238 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.25. Folder

2.25.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.25.4.2.8 Response body

XML or JSON message that represents the folder.

2.25.4.3 Update a folder

Update the folder with given properties. If the client provides undefined properties
in the Request body, the server throws an exception.

2.25.4.3.1 HTTP Request method and query parameters

POST

2.25.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.25.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.25.4.3.4 Request body

XML or JSON representation of the Folder resource. Only updatable properties can
be put in the message body.

EDCPKRST220200-PRE-EN-01 Reference Guide 239

Chapter 2 Resources

2.25.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.25.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.25.4.3.7 Response status

• 200 - Updated successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.25.4.3.8 Response body

XML or JSON representation of the folder. The successful response contains all
properties of the updated folder.

2.25.4.4 Delete a Folder

Deletes the Folder resource from the repository.

Folder children deletion is controlled by query parameters.

If the deletion fails, an exception is thrown and the Folder resource (including the
folder tree and version history) is reverted to the original state.

2.25.4.4.1 HTTP Request method and query parameters

240 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.25. Folder

HTTP Query Description Data type Value range Default value

method parameters
DELETE del-non- Specifies string true, false false
empty whether this
operation
deletes a non-
empty folder
or not.
• true -
The folder
and all its
descendan
ts are
deleted.
• false -
Only this
folder is
deleted.
Deleting a
non-
empty
folder
results in
an error.

EDCPKRST220200-PRE-EN-01 Reference Guide 241

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
del-all- Specifies string true, false false
links whether a
multi-linked
descendant is
deleted or
unlinked
from this
specified
folder.
• true -
This
operation
deletes a
multi-
linked
descendan
t along
with all its
folder
links.
• false -
This
operation
only
deletes a
descendan
t's link to
this
folder.
The
descendan
t is still
linked to
other
folders.

Note:
Virtual
docum
ents are
not
support
ed.

242 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

2.25.4.4.2 Request media types

N/A

2.25.4.4.3 Request headers

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.25.4.4.4 Request body

N/A

2.25.4.4.5 Response headers

N/A

2.25.4.4.6 Response media types

N/A

2.25.4.4.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.25.4.4.8 Response body

HTTP 204 No Content status upon a successful delete operation. The Response body
contains no content.

2.26 Folder Child Documents

The Folder Child Documents resource represents the collection of all documents,
which can be any object of the dm_document type or its subtype, under a specified
folder.

EDCPKRST220200-PRE-EN-01 Reference Guide 243

Chapter 2 Resources

2.26.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Folder” on page 236 and About the Diagram on page 17.

2.26.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the documents without the file extension

• Feed Title: List of folder child documents
• Feed Updated: Server's current time
• Entry: A Document object filed under this folder
• Supports POST? Yes

2.26.3 Link relations

Link relation Description Resource reference
self The URI for folder child “Folder Child Documents”
documents collection feed on page 243
first, last, next, previous Pagination links “Folder Child Documents”
on page 243

2.26.4 Operations
2.26.4.1 Supported HTTP methods

Method Description
GET Retrieves a list of all documents under the
specified folder
POST Creates a new document under the specified
folder

244 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

2.26.4.2 Get all documents of a folder

This operation retrieves a collection of all the child documents of a specified folder
and according to the folder object type. You can specify any folder type to retrieve
from the parent folder, including a dm_folder type, a dm_cabinet type, or a custom
type. If the parent folder contains documents of the specified type and you have
permissions to access those documents, they will be retrieved.

Note: To maintain security, the REST server will only retrieve documents that
the logged in user has permissions to access.

2.26.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET hide- Specifies string true, false false
shared- whether to
parent show the
shared parent
object of the
lightweight
object.

Note:
Enablin
g
hide-
share
d-
paren
t may
decreas
e
perfor
mance.
object- Specifies the string Any sub type null
type name of a name of dm_
subtype of document
dm_
document
and returns
only
documents of
that subtype.

This method supports the following URI request query parameters:

• inline

• sort

EDCPKRST220200-PRE-EN-01 Reference Guide 245

Chapter 2 Resources

Note: The default sort order is by creation date, descending from most
recent to oldest.
• page
• items-per-page
• include-total
• view
• links
• q: Provides support for full text searching using a subset of the Simple Search
Language, however the parenthesis is not supported.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.26.4.2.2 Request media types

N/A

2.26.4.2.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.26.4.2.4 Request body

N/A

2.26.4.2.5 Response headers

• Content-Length
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

246 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

2.26.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.26.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.26.4.2.8 Response body

XML or JSON representation of the collection of child objects under the specified
folder.

• The body must contain 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 view query parameter.
• Each object may contain links that are specific to the Document type that is filed
in the specified folder.
See “Link relations” on page 691 in the SysObject resource, which provides
information on what links are available for various object types.
• The retrieved child documents collection only contains those objects that the user
has permissions to access.

The following code samples show you typical requests along with responses.

Example 2-91: XML request

GET http://localhost/rest/repositories/repo/folders/0c00000c80000105/documents
Accept: application/vnd.emc.documentum+xml

Example 2-92: XML response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/repo/folders/
0c00000580000107/
documents</id>
<title>Documents</title>
<author>

EDCPKRST220200-PRE-EN-01 Reference Guide 247

Chapter 2 Resources

<name>Open Text Documentum</name>

</author>
<updated>2018-01-11T02:32:49.139+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/folders/
0c00000580000107/documents?inline=true&amp;items-per-page=1"/>
<link rel="next"
href="http://localhost:8080/dctm-rest/repositories/repo/folders/
0c00000580000107/documents?inline=true&amp;items-per-
page=1&amp;page=2"/>
<link rel="first"
href="http://localhost:8080/dctm-rest/repositories/repo/folders/
0c00000580000107/documents?inline=true&amp;items-per-
page=1&amp;page=1"/>
<entry>
<id>
http://localhost:8080/dctm-rest/repositories/repo/documents/
0900000580006435
</id>
<title>obj_without_content</title>
<author>
<name>dmadmin</name>
<uri>http://localhost:8080/dctm-rest/repositories/repo/users/dmadmin</
uri>
</author>
<summary>dm_document 0900000580006435</summary>
<updated>2018-01-08T09:23:27.000+00:00</updated>
<published>2018-01-08T09:23:27.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/repo/documents/
0900000580006435"/>
<content>
<dm:document
definition="http://localhost:8080/dctm-rest/repositories/repo/
types/dm_document"
xmlns:dm="http://identifiers.emc.com/vocab/documentum"
xsi:type="dm_document">
<dm:properties>
<dm:r_object_id>0900000580006435</dm:r_object_id>
<dm:object_name>my doc</dm:object_name>
<dm:owner_name>dmadmin</dm:owner_name>
...
</dm:properties>
<dm:links>
<dm:link rel="self"
href="http://localhost:8080/dctm-rest/repositories/repo/
documents/
0900000580006435"/>
...
</dm:links>
</dm:document>
</content>
</entry>
</feed>

248 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

Example 2-93: JSON request

GET http://localhost/rest/repositories/repo/folders/0c00000c80000105/documents
Accept: application/vnd.emc.documentum+json

Example 2-94: JSON response

{
"id": "http://localhost:8080/rest/repositories/repo/folders/0c00000c80000105/
documents",
"title": "Documents",
"updated": "2018-01-11T02:32:49.139+00:00",
"offset": 0,
"limit": 50,
"links":
[
{
"rel": "self",
"href": "http://localhost:8080/rest/repositories/repo/folders/
0c00000c80000105/documents"
},
{
"rel": "first",
"href": "http://localhost:8080/rest/repositories/repo/folders/
0c00000c80000105/documents?offset=0&limit=50"
}
],
"entries":
[
{
"id": "http://localhost:8080/rest/repositories/repo/documents/
6700000c8000010a",
"title": "obj_without_content",
"updated": "2018-01-08T09:23:27.000+00:00",
"content":
{
"properties":
{
"r_object_id": "6700000c8000010a",
"object_name": "my doc",
"owner_name": "dmadmin",
...
},
"links":
[
{
"rel": "self",
"href": "http://localhost:8080/rest/repositories/repo/documents/
6700000c8000010a"
}
...
]
}
},
...
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 249

Chapter 2 Resources

2.26.4.3 Create a document in a folder

This operation creates a child document in the specified folder. You can set the
properties of the object while creating the object. The object must be a dm_document
object type or one of its subtypes. By default, the object type is dm_document.

2.26.4.3.1 HTTP Request method and query parameters

When storing content to Centera storage, the content-length query parameter

must be provided. When specifying the value for content-length, you must use an
accurate byte count of the content to be uploaded.

For other storage mediums, such as hard disk, the content-length parameter is not
required and is optional. However, even when not required, if this parameter is
specified, it must be accurate.

Note: When creating a document that contains no content, neither the

content-length or the content-charset query parameters are used. These
two query parameters are only used when the documents that are being
created or filed contain content.

HTTP Query Description Data type Value range Default value

method parameters
POST r_object_ Specifies the string For this dm_
type object type of resource, any document
the new valid dm_
object being document
created. type or one of
its subtypes

250 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

HTTP Query Description Data type Value range Default value

method parameters
content- Specifies the string N/A null
length byte count of
the content to
be uploaded

When storing
content to
Centera
storage, the
content-
length
parameter
must be
provided.
When
providing the
value for
content-
length, you
must provide
an accurate
byte count of
the content to
be uploaded.

For other
storage
mediums,
such as
harddisk, the
content-
length
parameter is
optional.
However,
even when
not required,
if this
parameter is
provided, it
must be
accurate.

EDCPKRST220200-PRE-EN-01 Reference Guide 251

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
content- Used to string N/A null
charset sanitize
content.

This
parameter
tells the
server how to
parse the
content for
sanitizing.
When the
content-
charset is
not provided,
the server
tries to get
metadata
information
from the
content itself,
as long as the
content is in
HTML
format.

When the
metadata has
a valid
charset, then
it is used to
sanitize the
content. The
configuration
default
charset is
used when
the
content-
charset
parameter
and the
metadata
information
are not found

Note:
When
the
charset
and the
content

252 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

HTTP Query Description Data type Value range Default value

method parameters
do not
match,
the
upload
ed
content
may
have an
incorre
ctly
encode
d value.

2.26.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.26.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.26.4.3.4 Request body

XML or JSON representation of the document that will be created.

• 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.
• Documentum Server validates the constraints and permissions on setting the
other properties, including any read-only properties.
• Any whitespace in the value for the r_object_type property is trimmed away
by the server.

EDCPKRST220200-PRE-EN-01 Reference Guide 253

Chapter 2 Resources

2.26.4.3.4.1 Create a document with aspects and a lifecycle

This section shows a code sample that demonstrates how to create a document,
attach Aspects to it, and then attach a Lifecycle. During this operation, the
document object is created first, then once the document object exists, the Aspects
are attached to it, and finally the Lifecycle is attached to it. If the operation to
create this document with aspects and a lifecycle fails, the newly created document
object must be destroyed. In this case, the REST server will attempt to drop the
document object, however, if this attempt fails, then the document object must be
dropped manually, otherwise it remains as an orphaned object in your system.

When you create a document object in this manner you can also set its properties in
addition to the object-aspects and object-lifecycle. You can set the properties
by using the aspect_name.property_name parameter. When specifying the aspect
in the properties attribute, the aspects to be attached in the object-aspects
attribute will be ignored.

Caution
You cannot set Aspect properties using the properties attribute when
you specify that a document will be created with a Lifecycleas part of the
procedure. This limitation occurs because this procedure does not support
the use of a transaction when adding a Lifecycle to the object and also
because when a Lifecycle is being attached, the REST server creates the
document with its Aspects first, then it attaches the Lifecycle to the
document. This means that the document object will have its Aspects
attached to it before the aspect properties can be set using the properties
attribute. When you intend to attach a Lifecycle to your document object,
use the aspect_name.property_name parameter to set your Aspect
properties.

Example 2-95: XML request

<document>
<properties>
<object_name>test doc</object_name>
<r_object_type>dm_document</r_object_type>
<xxx_aspect.xxx>...</xxx_aspect.xxx>
<xxx_aspect.yyy>
<item>123456</item>
</xxx_aspect.yyy>
</properties>

<object-lifecycle>
<lifecycle-id>xxx</lifecycle-id>
<current-state>xxx</current-state>
<aliasset-name>xxx</aliasset-name>
</object-lifecycle>

<object-aspects>
<aspect>xxx</aspect>
</object-aspects>
</document>

254 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

Example 2-96: JSON request

{
"properties" : {
"object_name" : "test doc",
"r_object_type" : "dm_document",
"xxx_aspect.xxx" : "...",
"xxx_aspect.yyy" : [
123456
]
},

"object-lifecycle" : {
"lifecycle-id" : "xxx",
"current-state" : "xxx",
"aliasset-name" : "xxx"
},

"object-aspects" : {
"aspects":[
"xxx_aspect"
]
}
}

2.26.4.3.5 Response headers

• Location
• Content-Length
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.26.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.26.4.3.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 255

Chapter 2 Resources

2.26.4.3.8 Response body

XML or JSON representation of the document created under the specified folder.

• Each object contains all properties of a document.

• Each object contains links specific to the document object type.
For more information on what kind of links are available for a certain type of
object, see “Link relations” on page 691 in the SysObject resource.

Example 2-97: XML request

POST http://localhost/rest-api-web/repositories/repo/folders/0c00000c80000105/
documents
Content-Type: application/vnd.emc.documentum+xml

<document>
<properties>
<object_name>obj_without_content</object_name>
<r_object_type>dm_document</r_object_type>
...
</properties>
</document>

Example 2-98: XML response

Status Code: 201 Created

Location: http://localhost/rest/repositories/repo/documents/0900000d10000983
Content-Type: application/vnd.emc.documentum+xml;charset=UTF-8

<document>
<properties>
<object_name>testDocument</object_name>
<r_object_type>dm_document</r_object_type>
<keywords>"rest", "documentum"</keywords>
...
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/documents/
0900000580006435"/>
...
</links>
</document>

Example 2-99: JSON request

POST http://localhost/rest-api-web/repositories/repo/folders/0c00000c80000105/
documents
Content-Type: application/vnd.emc.documentum+json

{
"attributes":{
"object_name":"testDocument",
"r_object_type":"dm_document",

256 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

"keywords":["rest", "documentum"]
...
}
}

Example 2-100: JSON response

Status Code: 201 Created
Location: http://localhost/rest/repositories/repo/documents/0900000d10000983
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"attributes":
{
"r_object_id": "0900000d10000983",
"object_name": "testDocument",
"r_creation_date": "2012-06-13T05:36:08.000+0800",
"r_modify_date": ck"2012-06-13T05:36:08.000+0800",
......
},
"links":
[
{
"rel": "self",
"href": "http://localhost:8080/rest/repositories/repo/documents/
0900000d10000983"
}
]
}

2.26.4.4 Import document metadata and content

This operation creates a document and its contents in a specified folder in a single
request.

2.26.4.4.1 HTTP Request method and query parameters

EDCPKRST220200-PRE-EN-01 Reference Guide 257

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
POST format Specifies the string Comma When this
dm_format separated parameter is
name for the string not specified,
contents. the REST
server will try
When more to determine
than one type the format
of content is using the
being Content-Type
imported, the specified in
format the primary
parameter content part
can be used of the
to define the multipart
format for Request. The
each piece of REST server
content by will assign
using a this format to
comma the primary
separated content.
string. However,
this format is
For example, not
format= guaranteed to
crtext, be accurate.
html,pub_
html

For more
information,
see format
below.
all- Specifies string true or true
primary whether to false
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,
which is page
0

258 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

HTTP Query Description Data type Value range Default value

method parameters
modifier Specifies the string Comma null
modifier of separated
the contents. string
For the
primary
content, the
modifier is
ignored.

For example,
when you
import with
the all-
primary
parameter set
to false, the
value of the
modifier can
be:
modifier=,
mod1,mod2,
mod3. That
means the
first (or
primary)
content has
no modifier,
and the
second
rendition's
modifier is
mod1, the
third is mod2
and so on.

Setting the
all-
primary
parameter to
true , or when
content-
count<=1
causes all
modifiers to
be ignored.

EDCPKRST220200-PRE-EN-01 Reference Guide 259

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
content- Specifies the string Comma null
length byte count of separated
the content to string
be uploaded.
This
parameter is
optional.

A comma
separated list
can be used
to define
multiple
values for
this
parameter.
For example:
content-
length=
1024,2048,
,4096. The
blank value
shown here is
0.

For more
information,
see content-
length below.

260 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

HTTP Query Description Data type Value range Default value

method parameters
content- This string Comma null
charset parameter is separated
used to string
sanitize
content and it
defines how
the server
parses the
content while
sanitizing.
Multiple
values for
this
parameter
can be set
using a
comma
separated list.
For example:
content-
charset=
UTF-8,GBK,
ISO-8859-1
.

For more
information,
see content-
charset
below.

Note: Here are some additional details about the query parameters listed
above:

• format

– The format list must match the content sequence. When you don't want to
specify the format for a piece of content you can leave it blank in the
comma separated list but you must still include the comma as a
placeholder. For example: format=crtext,,html
– When the format for contents is not defined, the server uses the content
media type to select the format.
– When the all-primary parameter is true, all primary content types must
have the same format. In this case, when you define more than one format,
they must be the same. For example: format=crtext,crtext,crtext.
You can also define one format for all of the primary content: format=
crtext

• content-charset

EDCPKRST220200-PRE-EN-01 Reference Guide 261

Chapter 2 Resources

– When the metadata has a valid charset, then it is used to sanitize the
content.
– When the content-charset is not provided and the content is in HTML
format, the server tries to get a value for the content-charset parameter
from the metadata information of the content itself.
– The configuration default charset is used when the content-charset
parameter and the metadata information are not found.
– When the charset and the content do not match, the uploaded content may
have an incorrectly encoded value.
• content-length

– When the all-primary parameter is set to false, the first value of in the
content-length parameter is used for the primary piece of content, the
other values in the comma separated string are ignored.
– When storing content to Centera storage, the content-length parameter
is mandatory and must be provided. For other storage mediums, such as
harddisk, the content-length parameter is optional.
– In all cases, including when the content-length parameter is not
required, if a value for it is set, the value must be an accurate byte count of
the contents to be uploaded.
• content-count

– When you import more than one piece of contents, the REST server must
know how many content pieces there are in total. The total number of
content pieces cannot be obtained until the end of the multipart stream.
Therefore, the REST client must specify this number in the value of the
content-count parameter.

– When the value set in the content-count parameter is greater than the
actual number of content pieces, an exception is thrown because the
system expects more content pieces than it has received.
– When the value set in the content-count parameter is less than the actual
number of content pieces, all content pieces that exist in addition to the
number of pieces declared in the content-count parameter are ignored.

Caution
Ensure that the value provided by the content-count parameter is
accurate.

262 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

2.26.4.4.2 Request media types

• multipart/form-data
• multipart/mixed

2.26.4.4.3 Request headers

• Accept
• Authorization
• Content-Type

Caution
The Content-Type header must be either multipart/form-data or
multipart/mixed, which notifies the REST server that this request is a
multipart request.

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.26.4.4.4 Request body

The request body is a multipart message that must conform to RFC 2046. A
multipart/form-data or multipart/mixed message that contains a series of parts.
This series must conform to the following rules:

• The series must contain two parts, one metadata part and one contents 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:

– application/vnd.emc.documentum+xml
– application/vnd.emc.documentum+json

If the client does not set the Content-Type value or if the client sets the Content-
Type to an invalid value, then the REST server uses application/vnd.emc.
documentum+json to overwrite the value.

• The second part, which is the content part, in the series must be the binary data
of the primary contents. Its Content-Type must be the MIME type for the
primary content.
• Each part in the series must contain a Content-Disposition header. The
disposition type of the header must be form-data. The disposition must contain
a parameter called name that specifies the name of this part. The name parameter
may be ignored by REST server. This behavior conforms to the W3 rules for
HTML multipart forms and is a decision that should be made from both the
server implementation and the client consumption perspective.

EDCPKRST220200-PRE-EN-01 Reference Guide 263

Chapter 2 Resources

Note: Most libraries for various programming languages can handle the
multipart processing of an HTML form. However, the generic multipart
processing library is not prevalent. Therefore, we selected the HTML
multipart/form-data Content-Type to include a broader audience of
compatibility.

• This operation also supports the usage of Aspects and Lifecycles. For more
information, see Create a Document With Aspects and a Lifecycle.

Example 2-101: XML request - multipart/form-data or multipart/mixed

--314159265358979
Content-Disposition: form-data; name=metadata
Content-Type: application/vnd.emc.documentum+xml

<object>
<properties>
<object_name>xyz</object_name>
</properties>
</object>

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the first content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the second content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the third content part

--314159265358979--

Example 2-102: JSON request - multipart/form-data or multipart/mixed

--314159265358979
Content-Disposition: form-data; name=metadata
Content-Type: application/vnd.emc.documentum+json
{
"properties":{
"object_name":"xyz"
}
}

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the first content part

264 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the second content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the third content part

--314159265358979--

Example 2-103: Use multipart in a custom controller

@RequestMapping(method = RequestMethod.POST, consumes = { "multipart/form-

data",
"multipart/mixed" })
@ResponseStatus(HttpStatus.OK)
public void processMultipart(@RequestBody final Iterator<Part> parts) throws
DfException,
MissingServletRequestParameterException, IOException {
if(parts != null) {
response.setContentType(MediaType.TEXT_PLAIN.toString());
OutputStream out = response.getOutputStream();
int p = 1;

while(parts.hasNext()) {
Part part = parts.next();
for(String header : part.getHeaderNames()) {
// Write the part header to the Response directly
out.write((header + "=" + part.getHeader(header) + "\r
\n" ).getBytes());
}
// Write the part content to the Response
IOUtils.copy(part.getInputStream(), out);
out.write("\r\n------------end------------\r\n".getBytes());
out.flush();
}
}
}

The sample reads the multipart input and writes it back to the response. Each
part of the multipart input has headers, and the content stream. Each part can
be individually read using one of the standard <hasNext> and <next> <Iterator>
methods.

All of the parts have to be read sequentially because they are all contained
within one multipart stream and the REST server does not cache it.

Note: When more than one content part exists, the REST server must know
how many content parts there are in total. However, the total number of

EDCPKRST220200-PRE-EN-01 Reference Guide 265

Chapter 2 Resources

content parts cannot be determined until the end of the multipart stream.
Therefore, the REST client must provide the total number of content parts to
the REST server by setting a value for the content-count parameter. For more
information about this parameter, see content-count.

2.26.4.4.5 Response headers

• Location
• Content-Length
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.26.4.4.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.26.4.4.7 Response status

• 201 - Imported successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.26.4.4.8 Response body

XML or JSON representation of the document created under the specified folder.

• The body may contain all of the attributes of an object, depending on the setting
of the attr_filter query parameter.
• The Document (or Document subtype) object may contain links that are specific
to the Document object type or Document subtype object type.
• The response body must contain a link with the enclosure relation, which is the
URI used to identify the primary content. A length attribute can be added to the
link to indicate the length, in bytes, of the primary content.

Example 2-104: XML request

POST http://localhost/rest-api-web/repositories/repo/folders/
0c00000c80000105/documents
Content-Type: multipart/form-data; boundary=314159265358979

--314159265358979
Content-Disposition: form-data; name=metadata
Content-Type: application/vnd.emc.documentum+xml
<document>
<properties>
<object_name>document</object_name>

266 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

<r_object_type>dm_document</r_object_type>
...
</properties>
</document>

--314159265358979
Content-Disposition: form-data; name=binary1
Content-Type: text/plain

This is primary content

--314159265358979--

Example 2-105: XML response

Status Code: 201 Created
Location: http://localhost/rest/repositories/repo/documents/0900000d10000983
Content-Type: application/vnd.emc.documentum+xml;charset=UTF-8

<document>
<properties>
<object_name>obj_without_content</object_name>
<r_object_type>dm_document</r_object_type>
...
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/
documents/
0900000580006435"/>
...
</links>
</document>

Example 2-106: JSON request

POST http://localhost/rest-api-web/repositories/repo/folders/0c00000c80000105/
documents
Content-Type: multipart/form-data; boundary=314159265358979

--314159265358979
Content-Disposition: form-data; name=metadata
Content-Type: application/vnd.emc.documentum+json

{
"attributes": {
"object_name": "rest-api-test"
}
}

--314159265358979
Content-Disposition: form-data; name=binary1
Content-Type: text/plain

This is primary content

--314159265358979--

EDCPKRST220200-PRE-EN-01 Reference Guide 267

Chapter 2 Resources

Example 2-107: JSON response

Status Code: 201 Created
Location: http://localhost/rest/repositories/repo/documents/0900000d10000983
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"attributes":
{
"r_object_id": "0900000d10000983",
"object_name": "testDocument",
"r_creation_date": "2012-06-13T05:36:08.000+0800",
"r_modify_date": "2012-06-13T05:36:08.000+0800",
...
},
"links":
[
{
"rel": "self",
"href": "http://localhost:8080/rest/repositories/repo/documents/
0900000d10000983"
},
{
"rel":"enclosure",
"type":"text/plain",
"href":"http://localhost:8080/rest/repositories/repo/documents/
0900000c80016641/content"
}
]
}

2.26.4.5 Create a document for distributed upload

This operation creates a document and adds the distributed content upload link so
that the document object’s primary content can be distributed to an Accelerated
Content Services (ACS) or Branch Office Caching Services (BOCS) server in a
separate request. Distributing content in this manner improves the overall
performance of data transfers on servers that are located at various geographic
locations.

268 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.26. Folder Child Documents

2.26.4.5.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default

metho parameter value
d s
POST r_ Specifies the object type of string For this dm_
object_ the new object being resource, document
type created. any valid
dm_
document
type or one
of its
subtypes
content- Specifies the byte count of string N/A null
length the content to be uploaded

When storing content to

Centera storage, the
content-length
parameter must be
provided. When providing
the value for content-
length, you must provide
an accurate byte count of
the content to be uploaded.

For other storage mediums,

such as harddisk, the
content-length
parameter is optional.
However, even when not
required, if this parameter
is provided, it must be
accurate.

EDCPKRST220200-PRE-EN-01 Reference Guide 269

Chapter 2 Resources

HTTP Query Description Data type Value range Default

metho parameter value
d s
content- Used to sanitize content. string N/A null
charset
This parameter tells the
server how to parse the
content for sanitizing. When
the content-charset is
not provided, the server
tries to get metadata
information from the
content itself, as long as the
content is in HTML format.

When the metadata has a

valid charset, then it is used
to sanitize the content. The
configuration default
charset is used when the
content-charset
parameter and the metadata
information are not found

Note: When the

charset and the
content do not match,
the uploaded content
may have an
incorrectly encoded
value.

2.26.4.5.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.26.4.5.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

270 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.27. Folder Child Folders

2.26.4.5.4 Response headers

• Location
• Content-Length
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.26.4.5.5 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.26.4.5.6 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.27 Folder Child Folders

The Folder Child Folders resource represents the collection of all folders (an
object of the dm_folder type or its subtype) under a specified folder.

2.27.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Folder” on page 236 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 271

Chapter 2 Resources

2.27.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the folders.

• Feed Title: List of folder child folders
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: “Folder” on page 236
• Entry ID: URI of the folder
• Entry Title: Folder name
• Entry Summary: Folder description
• Entry Updated: r_modify_date of the folder

2.27.3 Link relations

Link relation Description Resource reference
self The URI for folder child “Folder Child Folders”
objects collection feed. on page 271
first, last, next, previous Pagination links. “Folder Child Folders”
on page 271

2.27.4 Operations
2.27.4.1 Supported HTTP methods

Method Description
GET Retrieves a list all child folders under the
specified folder.
POST Creates a new child folder under the
specified folder.

272 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.27. Folder Child Folders

2.27.4.2 Get the child folders under a folder

GET the collection of child folders under the given folder. You can specify any folder
types, including dm_folder, dm_cabinet or a custom type.

2.27.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value Default

method parameters range value
GET hide- Specifies whether to show string true, false
shared- the shared parent object of false
parent the lightweight object

Note: Enabling
hide-shared-
parent may
decrease
performance
object- Specifies the exact sub type string N/A null
type name to get from the
collection of this type
thumbnail Specifies whether this string true, false
operation deletes a non- false
empty folder or not.
• true - Return the
thumbnail link for each
entry in the collection
resource.
• false - Do not return
the thumbnail link for
each entry in the
collection resource.

This method supports the following common query parameters:

• inline
• sort
The default sort order is by creation date, descending (most recent to oldest).
• page
• items-per-page
• include-total
• view
• links
• q
• filter

EDCPKRST220200-PRE-EN-01 Reference Guide 273

Chapter 2 Resources

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.27.4.2.2 Request media types

N/A

2.27.4.2.3 Request headers

• Accept
• Authorization

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.27.4.2.4 Request body

N/A

2.27.4.2.5 Response headers

• Content-Length

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.27.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json

• application/xml

• application/json

2.27.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

274 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.27. Folder Child Folders

2.27.4.2.8 Response body

XML or JSON representation of the collection of child objects under the specified
folder.

• 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 “Link relations”
on page 691 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.

2.27.4.3 Create a child folder in a folder

Create a child folder in the specified folder. You can set the properties when creating
the object. The object can be the type of dm_folder or its subtype other than dm_
cabinet or its subtype. This is because dm_cabinet must be a top-level folder which
cannot be filed under any other folder. By default, the object type is dm_folder.

2.27.4.3.1 HTTP Request method and query parameters

POST

2.27.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.27.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 275

Chapter 2 Resources

2.27.4.3.4 Request body

XML or JSON representation of the folder to create.

• The object_name property is required.

• 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.
• Documentum Server validates the constraints and permissions on setting the
other properties (including read-only properties).

2.27.4.3.5 Response headers

• Location
• Content-Length
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.27.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.27.4.3.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

276 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.28. Folder Child Link (s)

2.27.4.3.8 Response body

XML or JSON representation of the folder created under the specified folder. The
response contains all properties of the folder.

2.28 Folder Child Link (s)

2.28.1 Folder Child Link
The Folder Child Link resource represents the folder containment relationship
between a parent folder and one of its child objects.

2.28.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Folder Child Links” on page 280 and About the Diagram on page 17.

2.28.1.2 Feed
No feed support.

2.28.1.3 Link relations

Link relation Description Resource reference

self Link to this child link “Folder Child Link (s)”
on page 277

2.28.1.4 Operations

2.28.1.4.1 Supported HTTP methods

Method Description
GET Retrieves the folder link between the parent
folder and its child object.
DELETE Unlinks a given object from one of its parent
folder.

EDCPKRST220200-PRE-EN-01 Reference Guide 277

Chapter 2 Resources

2.28.1.4.2 Retrieve a folder link

Retrieve the folder link between the child object and its parent folder.

2.28.1.4.2.1 HTTP Request method and query parameters

GET

2.28.1.4.2.2 Request media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

2.28.1.4.2.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.28.1.4.2.4 Request body

N/A

2.28.1.4.2.5 Response headers

• Content-Type

2.28.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

• application/xml

• application/json

2.28.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

278 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.28. Folder Child Link (s)

2.28.1.4.2.8 Response body

XML or JSON representation of the folder link between the object and its parent
folder. 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.

2.28.1.4.3 Unlink an object from a parent folder

Unlink an object from one of its parent folders.

Notes

• 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.

2.28.1.4.3.1 HTTP Request method and query parameters

DELETE

2.28.1.4.3.2 Request media types

N/A

2.28.1.4.3.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.28.1.4.3.4 Request body

N/A

EDCPKRST220200-PRE-EN-01 Reference Guide 279

Chapter 2 Resources

2.28.1.4.3.5 Response headers

N/A

2.28.1.4.3.6 Response media types

N/A

2.28.1.4.3.7 Response status

• 204 - Unlinked successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.28.1.4.3.8 Response body

HTTP 204 No Content status upon a successful unlink operation. The response body
contains no content.

2.28.2 Folder Child Links

The Folder Child Links collection resource represents a collection of all folder
containment relationships for a folder. That is a set of links between a folder and its
child objects.

2.28.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Folder” on page 236 and About the Diagram on page 17.

2.28.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the feed

• Feed Title: List of parent folders
• Feed Updated: r_modify_date of the object
• Supports POST: Yes
• Entry: “Folder Child Links” on page 280

280 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.28. Folder Child Link (s)

• Entry ID: URI of the folder link

• Entry Title: Formatted string with both the child object ID and the parent object
ID
• Entry Updated: r_modify_date of the child object.

2.28.2.3 Link relations

Link relation Description Resource reference

self URI for Folder Child Links “Folder Child Links”
collection feed on page 280
first, last, next, previous Pagination links “Folder Child Links”
on page 280

2.28.2.4 Operations
2.28.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a collection of child links for a
given folder.
POST Links an object to a given folder.

2.28.2.4.2 Retrieve child links

Retrieve all child links for a given folder. That is a set of the links between the folder
and all child objects under this folder.

2.28.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET include- Specifies string true, false false
all- whether or
versions not to list all
versions of
the child
object.
• true -
Returns
all
versions.
• false -
Only
returns
the
current
version.

EDCPKRST220200-PRE-EN-01 Reference Guide 281

Chapter 2 Resources

This operation also supports the following common query parameters:

• inline

• page

• items-per-page

• include-total

• sort

• filter

• links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.28.2.4.2.2 Request media types

N/A

2.28.2.4.2.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.28.2.4.2.4 Request body

N/A

2.28.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.28.2.4.2.6 Response media types

• application/atom+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json (For compatible viewing

282 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.28. Folder Child Link (s)

2.28.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.28.2.4.2.8 Response body

XML or JSON representation of a collection child links for the given folder.

• 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
objects.
• 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.

2.28.2.4.3 Link an object to a folder

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, see “Folder Child Objects”
on page 285.

To create a secondary link, you must have browse permission and the change
location permission on the object. When the repository is running under folder
security, you must also have the write permission on the folder or cabinet to which
the object is linked.

Note: You cannot link a cabinet to a folder.

EDCPKRST220200-PRE-EN-01 Reference Guide 283

Chapter 2 Resources

2.28.2.4.3.1 HTTP Request method and query parameters

POST

2.28.2.4.3.2 Request media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

2.28.2.4.3.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.28.2.4.3.4 Request body

XML or JSON representation of the newly-created folder link between the given
folder and the child object. The body contains the reference to the child object.

Example 2-108: Example of the Request body

{
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
0900000c80000cc4"
}

2.28.2.4.3.5 Response headers

• Location

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.28.2.4.3.6 Response media types

• application/atom+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

284 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.29. Folder Child Objects

2.28.2.4.3.7 Response status

• 201 - Link created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.28.2.4.3.8 Response body

XML or JSON representation of newly-created link between the given folder and its
new child object.

2.29 Folder Child Objects

The Folder Child Objects resource represents the collection of all the SysObject
resources under a specified folder.

2.29.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Folder” on page 236 and About the Diagram on page 17.

2.29.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the objects.

• Feed Title: List of folder child objects
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: “SysObject” on page 690
• Entry ID: URI of the object
• Entry Title: Object name
• Entry Summary: Object description
• Entry Updated: r_modify_date of the object

EDCPKRST220200-PRE-EN-01 Reference Guide 285

Chapter 2 Resources

2.29.3 Link relations

Link relation Description Resource reference
self The URI for folder child Folder child objects collection
objects collection feed. resource
first, last, next, previous Pagination links. Folder child objects collection
resource

2.29.4 Operations
2.29.4.1 Supported HTTP methods

Method Description
GET Retrieves a list all objects under the specified
folder.
POST Creates a new object under the specified
folder.
POST Imports the object metadata and primary
content.
POST Copies an object to the specified folder.

2.29.4.2 Get child objects from a folder

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.

2.29.4.2.1 HTTP Request method and query parameters

286 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.29. Folder Child Objects

HTTP Query Description Data type Value range Default value

method parameters
GET hide- Specifies string true, false false
shared- whether to
parent show the
shared parent
object of the
lightweight
object.

Note:
Enablin
g
hide-
share
d-
paren
t may
decreas
e
perfor
mance.
include- Specifies string true, false false
all- whether or
versions not to list all
versions of
the child
object’s link.
• true -
Returns
all
versions.
• false -
Only
returns
the
current
version
object- Specifies the string N/A null
type exact sub
type name to
get from the
collection of
this type.

EDCPKRST220200-PRE-EN-01 Reference Guide 287

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
thumbnail Specifies string true, false false
whether this
operation
deletes a non-
empty folder
or not.
• true -
Return the
thumbnail
link for
each entry
in the
collection
resource.
• false -
Do not
return the
thumbnail
link for
each entry
in the
collection
resource.

288 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.29. Folder Child Objects

HTTP Query Description Data type Value range Default value

method parameters
q Specifies the string N/A No search
search criteria criteria is
with a full- used for the
text search.
expression in
Simple
Search
Language.

Parameter q
must be
encoded
because it
may contain
non-English
locale
characters.

Note:
Internat
ional
charact
ers that
are
used in
this
query
parame
ter
must be
sent
with
URL
encode
d by
the
UTF-8
charset.
Otherw
ise, the
result
may be
incorre
ct.

This method also supports the following common query parameters:

• inline
• sort
The default sort order is by creation date, descending (most recent to oldest).

EDCPKRST220200-PRE-EN-01 Reference Guide 289

Chapter 2 Resources

• page
• items-per-page
• include-total
• view
• links
• filter
• q

The q parameter is supported for full text searching with a subset of the Simple
Search Language, however parentheses are not supported.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.29.4.2.2 Request media types

N/A

2.29.4.2.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.29.4.2.4 Request body

N/A

2.29.4.2.5 Response headers

• Content-Length
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

290 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.29. Folder Child Objects

2.29.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.29.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.29.4.2.8 Response body

XML or JSON representation of the collection of child objects under the specified
folder.

• 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 “Link relations”
on page 691 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.

2.29.4.3 Create an object in a folder

Create a child object under the specified folder. You can set the properties when
creating the object. The object can be the type of dm_SysObject or its subtype. By
default, the object type is dm_SysObject.

2.29.4.3.1 HTTP Request method and query parameters

POST

When storing content to Centera storage, the content-length query parameter

must be provided. When providing the value for content-length, you must
provide an accurate byte count of the content to be uploaded. For other storage
mediums, such as harddisk, the content-length parameter is not required and is
optional. However, even when not required, if this parameter is provided, it must be
accurate.

EDCPKRST220200-PRE-EN-01 Reference Guide 291

Chapter 2 Resources

Note: When creating a document that contains no content, neither content-

length or content-charset is used. These two variables are only used when
your documents contain content.

2.29.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.29.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.29.4.3.4 Request body

XML or JSON representation of the object to create.

• 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.
• Documentum Server validates the object_name property in the request. This
property is mandatory for some types, for example, dm_folder.
• Documentum Server validates the constraints and permissions on setting the
other properties (including read-only properties).

2.29.4.3.5 Response headers

• Location
• Content-Length
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

292 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.29. Folder Child Objects

2.29.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.29.4.3.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.29.4.3.8 Response body

XML or JSON representation of the SysObject resource created under the specified
folder.

• Each object contains all properties of the object.

• Each object contains links specific to the type of the object. For information on
links that are available for a certain type of object, see “Link relations”
on page 691 in SysObject resource.

2.29.4.4 Import SysObject metadata and contents

Create a document and its contents under a specified folder in a single request.

2.29.4.4.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
POST content- Specifies how integer >=0 0
count many pieces
of content are
submitted.
The metadata
part is
excluded
from the
count.

For more
information,
see content-
count

EDCPKRST220200-PRE-EN-01 Reference Guide 293

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
all- Specifies string true or true
primary whether to false
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,
which is page
0
format Specifies the string Comma null
dm_format separated
name for string
contents.

When more
than one type
of contents
are being
imported, the
format
parameter
can be used
to define the
format for
each piece of
content by
using a
comma
separated
string.

For example,
format=
crtext,
html,pub_
html

For more
information,
see format

294 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.29. Folder Child Objects

HTTP Query Description Data type Value range Default value

method parameters
modifier Specifies the string Comma null
modifier of separated
the content. string
For the
primary
content, the
modifier is
ignored.

For example,
when you
import with
the all-
primary
parameter set
to false, the
value of
modifier
can be:
modifier=,
mod1,mod2,
mod3. That
means the
first (or
primary)
contents has
no modifier,
and the
second
rendition's
modifier is
mod1, the
third
rendition's
modifier is
mod2 and so
on.

For more
information,
see modifier

EDCPKRST220200-PRE-EN-01 Reference Guide 295

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
content- Specifies the string Comma null
length byte count of separated
the content to string
be uploaded.
This
parameter is
optional.

A comma
separated list
can be used
to define
multiple
values for
this
parameter.
For example:
content-
length=
1024,2048,
,4096. The
blank value
shown here is
0.

For more
information,
see content-
length

296 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.29. Folder Child Objects

HTTP Query Description Data type Value range Default value

method parameters
content- This string Comma null
charset parameter is separated
used to string
sanitize
content and it
defines how
the server
parses the
content while
sanitizing.
Multiple
values for
this
parameter
can be set
using a
comma
separated list.
For example:
content-
charset=
UTF-8,GBK,
ISO-8859-1
.

For more
information,
see content-
charset

Note: Here are some additional details about the variables listed above:

• format

– The format list must match the content sequence. When you don't want to
specify the format for a piece of content you can leave it blank in the
comma separated list but you must still include the comma as a
placeholder. For example: format=crtext,,html.
– When the format for contents is not defined, the server uses the content
media type to select the format.
– When the all-primary parameter is true, all primary content types must
have the same format. In this case, when you define more than one format,
they must be the same. For example: format=crtext,crtext,crtext.
You can also define one format for all of the primary content: format=
crtext.
• modifier
Setting the all-primary parameter to true , or when content-count<=1
causes all modifiers to be ignored.

EDCPKRST220200-PRE-EN-01 Reference Guide 297

Chapter 2 Resources

• content-charset

– When the metadata has a valid charset, then it is used to sanitize the
content.
– When the content-charset is not provided and the content is in HTML
format, the server tries to get a value for the content-charset parameter
from the metadata information of the content itself.
– The configuration default charset is used when the content-charset
parameter and the metadata information are not found
– When the charset and the content do not match, the uploaded content may
have an incorrectly encoded value.
– The configuration default charset is used when the content-charset
parameter and the metadata information are not found
• content-length

– When the all-primary parameter is set to false, the first value of in the
content-length parameter is used for the primary piece of content, the
other values in the comma separated string are ignored.
– When storing content to Centera storage, the content-length parameter
is mandatory and must be provided. For other storage mediums, such as
hard disk, the content-length parameter is optional.
– In all cases, including when the content-length parameter is not
required, if a value for it is set, the value must be an accurate byte count of
the contents to be uploaded.
– When the all-primary parameter is set to false, the first value in the
comma separated content-length string parameter is used for the
primary piece of content, but the other values in the comma separated
string are ignored.
• content-count

– When you import more than one piece of contents, the REST server must
know how many content pieces there are in total. The total number of
content pieces cannot be obtained until the end of the multipart stream.
Therefore, the client must specify this number in the value of the
content-count parameter.
– When the value set in the content-count parameter is greater than the
actual number of content pieces, an exception is thrown because the
system expects more content pieces.
– When the value set in the content-count parameter is less than the actual
number of content pieces, all content pieces that exist in addition to the
number of pieces set in the content-count parameter are ignored.

Caution
Ensure that the value provided by the content-count is accurate.

298 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.29. Folder Child Objects

2.29.4.4.2 Request media types

• multipart/form-data
• multipart/mixed

2.29.4.4.3 Request headers

• Accept
• Authorization
• Content-Type (The Content-Type header must be either multipart/form-data
or multipart/mixed, which notifies the server this request is a multipart
request.)

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.29.4.4.4 Request body

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 contain 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:

– application/vnd.emc.documentum+json (default)
– application/vnd.emc.documentum+xml

When the REST client sets Content-Type to a value that is invalid, the server
uses application/vnd.emc.documentum+json to overwrite the invalid value.
• The second part in the series must be the binary data of the primary content.
Content-Type for the second part must be the MIME type for the primary
content.
• 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 specifies the name of this part.

Example 2-109: XML request - multipart/form-data or multipart/mixed

--314159265358979
Content-Disposition: form-data; name=metadata
Content-Type: application/vnd.emc.documentum+xml

<object>
<properties>
<object_name>xyz</object_name>

EDCPKRST220200-PRE-EN-01 Reference Guide 299

Chapter 2 Resources

</properties>
</object>

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the first content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the second content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the third content part

--314159265358979--

Example 2-110: JSON request - multipart/form-data or multipart/mixed

--314159265358979
Content-Disposition: form-data; name=metadata
Content-Type: application/vnd.emc.documentum+json
{
"properties":{
"object_name":"xyz"
}
}

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the first content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the second content part

--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain

This is the third content part

--314159265358979--

300 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.29. Folder Child Objects

2.29.4.4.5 Response headers

• Location
• Content-Length
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.29.4.4.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.29.4.4.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.29.4.4.8 Response body

XML or JSON representation of the SysObject resource created under the specified
folder.

• Each object contains all properties of the object.

• Each object contains links specific to the type of the object. See “Link relations”
on page 691 in SysObject resource, which provides information on what links
are available for a certain type of object.

Example 2-111: XML response - application/vnd.emc.documentum+xml or

“application/xml”

<?xml version="1.0" encoding="UTF-8"?>

<document xmlns="http://identifiers.emc.com/vocab/documentum"
definition="{typeResourceUri}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_document">
<properties>
<object_name>xyz</object_name>
<r_object_id>090020808001398e</r_object_id>
...
</properties>
<links>
<link rel="self" href="{documentResourceUri}"/>
...

EDCPKRST220200-PRE-EN-01 Reference Guide 301

Chapter 2 Resources

</links>
</document>

Example 2-112: JSON response - application/vnd.emc.documentum+xml

or “application/xml”

{
"name":"document",
"type":"dm_document",
"definition":"<documentResourceUri>",
"properties":{
"object_name":"xyz",
"r_object_id":"090020808001398e",
...
}
"links":[
{ "rel":"self", "href":"<documentResourceUri>"},
...
]
}

2.29.4.5 Copy an object to a folder

Copy an object to a folder. The type of the object must be dm_SysObject or its
subtype. Properties of the object can be customized during the copy operation.

Note: When you copy a folder, whether and how to copy the objects under the
folder depends on the variables set in the message body.

For more information, see “Request body” on page 303.

2.29.4.5.1 HTTP Request method and query parameters

POST

2.29.4.5.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

302 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.29. Folder Child Objects

2.29.4.5.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.29.4.5.4 Request body

The request body contains the link to the object to copy, and the following variables.

Variable Description Data type Default value

deep-copy Specifies whether or not to copy the boolean true
objects under the folder:
• true - copy the objects under the
folder
• false - copy the folder only.
replicate- When the value of the deep-copy boolean true
vd-children parameter is true and you copy a
folder, copying a virtual document that
is within that folder will cause the
children of that virtual document to be
copied as well.

When the value of the deep-copy

parameter is false and you copy a
folder, the children of that virtual
document are only referenced.

EDCPKRST220200-PRE-EN-01 Reference Guide 303

Chapter 2 Resources

Variable Description Data type Default value

retain-acl This parameter determines whether to boolean false
apply a source object's ACL to the
target object while copying an object.

When this parameter is set to true:

• When the source is an object or the
source is a folder that has the
deep-copy parameter set to
false, this parameter causes the
source ACL to be applied only to
the newly copied object or folder.
• When the source is a folder with the
deep-copy parameter set to true,
the ACL of all the source objects
within that folder are applied to the
their related newly copied objects.

When the retain-acl parameter is

false, no ACL is applied to the target
of the copy procedure.
include- Specifies whether or not to include boolean false
broken binding broken components while
copying a virtual document.
binding- Specifies the late binding version while string CURRENT
label copying a virtual document.

Example 2-113: JSON request payload

{
"href":"http://localhost/dctm-rest/repositories/acme/objects/xxxxx",
"deep-copy":true,
"replicate-vd-children":true,
"retain-acl":true
"include-broken":false
"binding-label":CURRENT
}
}

Example 2-114: XML request payload

<dm:object href="http://localhost/dctm-rest/repositories/acme/objects/xxxxx"
deep-copy="true" replicate-vd-children="true" retain-acl="true"
include-broken="false" binding-label="CURRENT"/>

304 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.30. Format (s)

2.29.4.5.5 Response headers

• Location
• Content-Length
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.29.4.5.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.29.4.5.7 Response status

• 200 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.29.4.5.8 Response body

XML or JSON representation of the object copied to this folder.

2.30 Format (s)

2.30.1 Format
The Format resource represents a dm_format instance stored in a repository.

2.30.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Formats” on page 308 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 305

Chapter 2 Resources

2.30.1.2 Feed
No feed support.

2.30.1.3 Link relations

Link relation Description Resource reference

self This format “Format” on page 305

2.30.1.4 Operations
2.30.1.4.1 Supported HTTP methods

Method Description
GET Retrieves the information about a format.

2.30.1.4.2 Get a format

Retrieves the information about a format by a specified format name.

2.30.1.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• view
• links
• sort
• inline
• filter
• page
• items-per-page
• include-total

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

306 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.30. Format (s)

2.30.1.4.2.2 Request media types

N/A

2.30.1.4.2.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.30.1.4.2.4 Request body

N/A

2.30.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.30.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

2.30.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.30.1.4.2.8 Response body

XML or JSON representation of the format instance.

Note: The format name in the URL is encoded.

EDCPKRST220200-PRE-EN-01 Reference Guide 307

Chapter 2 Resources

2.30.2 Formats
The Formats resource represents a collection of dm_format instances stored in a
repository.

2.30.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.30.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: List of formats
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “Format” on page 305
• Entry ID: URI of the format
• Entry Title: Format name
• Entry Summary: Format description
• Entry Updated: r_modify_date of the format

2.30.2.3 Link relations

Link relation Description Resource reference

self This collection of formats. “Formats” on page 308
first, last, next, previous Pagination links. “Formats” on page 308

308 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.30. Format (s)

2.30.2.4 Operations

2.30.2.4.1 Supported HTTP methods

Method Description
GET Retrieves the information about a collection
of formats.

2.30.2.4.2 Get formats

Retrieve the information about a collection of formats.

2.30.2.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• inline

• view

• items-per-page

• page

• include-total

• sort

• links

• filter

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.30.2.4.2.2 Request media types

N/A

2.30.2.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 309

Chapter 2 Resources

2.30.2.4.2.4 Request body

N/A

2.30.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.30.2.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.30.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.30.2.4.2.8 Response body

XML or JSON representation of the collection of 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.

310 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.31. Group (s)

2.31 Group (s)

2.31.1 Group
The Group resource represents a group in a repository.

2.31.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Groups” on page 320 and About the Diagram on page 17.

2.31.1.2 Feed
No feed support.

2.31.1.3 Link relations

Link relation Description Resource reference

self This Group resource. “Group” on page 311
edit This Group resource. Only “Group” on page 311
sysAdmin, SuperUser or
group owner can view this
link
delete This Group resource. Only “Group” on page 311
sysAdmin, SuperUser or
group owner can view this
link
users [1] Users that directly belong to “Sub Groups” on page 675
this group.
groups [1] Sub groups that directly “Sub Groups” on page 675
belong to this group.
parent Groups that this group “Groups” on page 320
belongs to.

EDCPKRST220200-PRE-EN-01 Reference Guide 311

Chapter 2 Resources

Link relation Description Resource reference

[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.31.1.4 Operations
2.31.1.4.1 Supported HTTP methods

Method Description
GET Retrieve a group instance
POST Update a group
DELETE Delete a group

2.31.1.4.2 Get a group

Retrieve all attributes of a group.

2.31.1.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• view
• links
• inline
• filter
• sort
• page
• items-per-page
• include-total

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

312 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.31. Group (s)

2.31.1.4.2.2 Request media types

N/A

2.31.1.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.31.1.4.2.4 Request body

N/A

2.31.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.31.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.31.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.31.1.4.2.8 Response body

XML or JSON representation of the group. The information about the parent groups
and sub groups are presented in link relations instead of properties.

Note: The group name in the URL is encoded.

Example 2-115: XML response

<?xml version='1.0' encoding='UTF-8' ?>

<group xsi:type="dm_group" definition="http://localhost:8080/dctm-rest/
repositories/

EDCPKRST220200-PRE-EN-01 Reference Guide 313

Chapter 2 Resources

REPO/types/dm_group.xml">
<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 rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/
groups/
admingroup.xml" />
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/
groups/
admingroup.xml" />
<link rel="delete" href="http://localhost:8080/dctm-rest/repositories/REPO/
groups/
admingroup.xml" />
<link rel="parent" href="http://localhost:8080/dctm-rest/repositories/REPO/
groups.xml?group-name=admingroup" />
<link rel="http://identifiers.emc.com/linkrel/groups"
href="http://localhost:8080/dctm-rest/repositories/REPO/groups/
admingroup/
groups.xml" />
<link rel="http://identifiers.emc.com/linkrel/users"
href="http://localhost:8080/dctm-rest/repositories/REPO/groups/
admingroup/
users.xml" />
</links>
</group>

Example 2-116: JSON response

{
"name":"group",
"type":"dm_group",
"definition":"http://localhost:8080/dctm-rest/repositories/REPO/types/

314 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.31. Group (s)

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":"edit",
"href":"http://localhost:8080/dctm-rest/repositories/REPO/groups/
admingroup"},
{"rel":"delete",
"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"}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 315

Chapter 2 Resources

2.31.1.4.3 Update a group

Update the attributes of a group. Only the SysAdmin, SuperUser, or group owner
can update the group.

2.31.1.4.3.1 HTTP Request method and query parameters

POST

2.31.1.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.31.1.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.31.1.4.3.4 Request body

Example 2-117: XML request

<?xml version="1.0" encoding="UTF-8"?>

<dm:dm_group xsi:type="dm_group" definition="http://localhost:8080/dctm-rest/
repositories/REPO/types/dm_group.xml">
<dm:properties>
<dm:owner_name>Administrator</dm:owner_name>
..........
</dm:properties>
</dm:dm_group>

Example 2-118: JSON request

{
properties:{
"owner_name":"Administrator",
...
}
}

316 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.31. Group (s)

2.31.1.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.31.1.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.31.1.4.3.7 Response status

• 200 - Updated successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.31.1.4.3.8 Response body

Example 2-119: XML response

<?xml version='1.0' encoding='UTF-8' ?>

<group xsi:type="dm_group" definition="http://localhost:8080/dctm-rest/
repositories/
REPO/types/dm_group.xml">
<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>

EDCPKRST220200-PRE-EN-01 Reference Guide 317

Chapter 2 Resources

<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/
groups/
admingroup.xml" />
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/
groups/
admingroup.xml" />
<link rel="delete" href="http://localhost:8080/dctm-rest/repositories/REPO/
groups/
admingroup.xml" />
<link rel="parent" href="http://localhost:8080/dctm-rest/repositories/REPO/
groups.xml?group-name=admingroup" />
<link rel="http://identifiers.emc.com/linkrel/groups"
href="http://localhost:8080/dctm-rest/repositories/REPO/groups/
admingroup/
groups.xml" />
<link rel="http://identifiers.emc.com/linkrel/users"
href="http://localhost:8080/dctm-rest/repositories/REPO/groups/
admingroup/
users.xml" />
</links>
</group>

Example 2-120: JSON response

{
"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",

318 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.31. Group (s)

"href":"http://localhost:8080/dctm-rest/repositories/REPO/groups/
admingroup"},
{"rel":"edit",
"href":"http://localhost:8080/dctm-rest/repositories/REPO/groups/
admingroup"},
{"rel":"delete",
"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"}
]
}

2.31.1.4.4 Delete a group

Delete a group. Only the SysAdmin, SuperUser, or group owner can delete a group.

2.31.1.4.4.1 HTTP Request method and query parameters

DELETE

2.31.1.4.4.2 Request media types

N/A

2.31.1.4.4.3 Request headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.31.1.4.4.4 Request body

N/A

2.31.1.4.4.5 Response headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 319

Chapter 2 Resources

2.31.1.4.4.6 Response media types

N/A

2.31.1.4.4.7 Response status

• 204 - Deleted successfully

• 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.31.1.4.4.8 Response body

N/A

2.31.2 Groups
The Groups resource represents a collection of group instances in a repository.

2.31.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.31.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: List of groups
• Supports POST: No
• Entry: “Group” on page 311
• Entry ID: URI of the group
• Entry Title: Group name
• Entry Summary: Group description
• Entry Updated: r_modify_date of the group

320 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.31. Group (s)

2.31.2.3 Link relations

Link relation Description Resource reference

self This collection of groups. “Groups” on page 320
first, last, next, previous Pagination links. “Groups” on page 320

2.31.2.4 Operations
2.31.2.4.1 Supported HTTP methods

Method Description
GET Retrieves the information about a collection
of groups.

2.31.2.4.2 Get groups

Retrieve the information about a collection of groups in a repository.

2.31.2.4.2.1 HTTP Request method and query parameters

HTTP method Query Description Data type Default value

parameters
GET user-name Only groups that string null
contain a user (a
dm_user
instance) whose
user-name
property equals
to the specified
string are
returned in the
result.
group-name Only groups that string null
contain a sub
group (a dm_
group instance)
whose group_
name property
equals to the
specified string
are returned in
the result.

Caution
You cannot use the username and groupname parameters simultaneously.

This method also supports the following common query parameters:

EDCPKRST220200-PRE-EN-01 Reference Guide 321

Chapter 2 Resources

• inline
• view
• items-per-page
• page
• include-total
• sort
• recursive
• links
• filter

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

Note: International characters that are used in the preceding query parameters
must be sent with URL encoded by the UTF-8 charset. Otherwise, the result
may be incorrect.

2.31.2.4.2.2 Request media types

N/A

2.31.2.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.31.2.4.2.4 Request body

N/A

2.31.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

322 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.31. Group (s)

2.31.2.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.31.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.31.2.4.2.8 Response body

XML or JSON representation of the collection of 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.

2.31.2.4.3 Create a group

Create a group in the repository. The SysAdmin, SuperUser or any other user with
“Create group” permissions can create a group.

2.31.2.4.3.1 HTTP Request method and query parameters

POST

EDCPKRST220200-PRE-EN-01 Reference Guide 323

Chapter 2 Resources

2.31.2.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.31.2.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.31.2.4.3.4 Request body

The group_name property is mandatory.

Example 2-121: XML request

<?xml version="1.0" encoding="UTF-8"?>
<dm_group xsi:type="dm_group" definition="http://localhost:8080/dctm-rest/
repositories/
REPO/types/dm_group">
<properties>
<group_name>group1</group_name>
...
</properties>
</dm_group>

Example 2-122: JSON request

{
"properties" : {
"group_name" : "group1",
...
}
}

324 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.32. Group User (s)

2.31.2.4.3.5 Response headers

• Location
The URL of the created group.

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.31.2.4.3.6 Response media types

• application/atom+xml

• application/vnd.emc.documentum+json

2.31.2.4.3.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.31.2.4.3.8 Response body

N/A

2.32 Group User (s)

2.32.1 Group User
The Group User resource represents the relationship between a group and one of its
user members.

2.32.1.1 Resource relationships

The following diagram illustrates how this resource is related with other resources:

See Also: “Group Users” on page 327 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 325

Chapter 2 Resources

2.32.1.2 Feed
No feed support.

2.32.1.3 Link relations

N/A

2.32.1.4 Operations

2.32.1.4.1 Supported HTTP methods

Method Description
DELETE Remove the relation between a group and its
user member

2.32.1.4.2 Delete a user relationship

Remove the relation between a group and its user member.

2.32.1.4.2.1 HTTP Request method and query parameters

DELETE

2.32.1.4.2.2 Request media types

N/A

2.32.1.4.2.3 Request headers

• Accept

• Content-Type

• Authentication

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.32.1.4.2.4 Request body

Example 2-123: Request - Delete a user relationship

DELETE http://localhost:8080/dctm-rest/repositories/acme/groups/
mydocument/users/myuser

326 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.32. Group User (s)

2.32.1.4.2.5 Response headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.32.1.4.2.6 Response media types

N/A

2.32.1.4.2.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.32.1.4.2.8 Response body

HTTP 204 No Content status upon a successful delete operation.

2.32.2 Group Users

The Group Users resource represents a collection of users that belong to a specified
group.

2.32.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Group” on page 311 and About the Diagram on page 17.

2.32.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: List of users
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “User” on page 765
• Entry ID: URI of the user

EDCPKRST220200-PRE-EN-01 Reference Guide 327

Chapter 2 Resources

• Entry Title: User name

• Entry Summary: User description

• Entry Updated: r_modify_date of the user

2.32.2.3 Link relations

Link relation Description Resource reference

self This collection of users. “Group Users” on page 327
first, last, next, previous Pagination links. “Group Users” on page 327

2.32.2.4 Operations

2.32.2.4.1 Supported HTTP methods

Method Description
GET Retrieves the information about a collection
of users.

2.32.2.4.2 Get group users

Retrieve the information about a collection of users that belong to a given group.

2.32.2.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• inline

• view

• items-per-page

• page

• include-total

• sort

• recursive
• links

• filter

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

328 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.32. Group User (s)

2.32.2.4.2.2 Request media types

N/A

2.32.2.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.32.2.4.2.4 Request body

N/A

2.32.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.32.2.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.32.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.32.2.4.2.8 Response body

XML or JSON representation of the collection of 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.

EDCPKRST220200-PRE-EN-01 Reference Guide 329

Chapter 2 Resources

2.32.2.4.3 Add a user member

Add an existing group into a group as a user member.

2.32.2.4.3.1 HTTP Request method and query parameters

POST

• href

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.32.2.4.3.2 Request media types

• application/atom+xml
• application/vnd.emc.documentum+json

2.32.2.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.32.2.4.3.4 Request body

The href variable, which specifies the user resource, must be supplied. This variable
is a string and has a <null> default value.

Example 2-124: XML request

<dm:user href="http://localhost/dctm-rest/repositories/acme/users/xxxxx"/>

Example 2-125: JSON request

{
"href":"http://localhost/dctm-rest/repositories/acme/users/xxxxx"
}

330 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.33. Home Document

2.32.2.4.3.5 Response headers

• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.32.2.4.3.6 Response media types

N/A

2.32.2.4.3.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.32.2.4.3.8 Response body

N/A

2.33 Home Document

The Home Document collection resource provides an entry point for available
resources. The design of Home Document adheres to the following RFC documents:

Home Documents for HTTP Services: XML Syntax on IETF Tools website (XML
representation)

Home Documents for HTTP APIs on IETF Tools website (JSON representation)

2.33.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: About the Diagram on page 17

EDCPKRST220200-PRE-EN-01 Reference Guide 331

Chapter 2 Resources

2.33.2 Feed
No feed support.

2.33.3 Link relations

Link relation Description Resource reference
repositories [1] Link to access any available “Repositories” on page 571
repositories
about Link to production “Product Information”
information on page 515
search Link that can be used to “Multiple Repository Search”
perform a multiple on page 429
repositories search
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.33.4 Operations
2.33.4.1 Supported HTTP methods

Method Description
GET Retrieves the home document.

2.33.4.2 Get the home document

Retrieves the home document which provides an entry point for available resources.
The URI of the Home Document resource is constant, for example /services. Your
REST clients can use the /services URI to access the Documentum REST Services.

For example, when the context root of the REST server is deployed as http://
localhost:8080/dctm-rest, then the Home Document's URI would be http://
localhost:8080/dctm-rest/services.

2.33.4.2.1 HTTP Request method and query parameters

GET

332 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.33. Home Document

2.33.4.2.2 Request media types

N/A

2.33.4.2.3 Request headers

• Accept
This resource does not accept application/vnd.emc.documentum+json or
application/vnd.emc.documentum+xml. Instead, it accepts application/home
+json and application/home+xml.

Note: The authorization header is not needed when a client tries to get this
resource.

For more information about HTTP headers, see Appendix D, REST Common
Definition - HTTP Headers on page 987.

2.33.4.2.4 Request body

N/A

2.33.4.2.5 Response headers

• Content-Type
• Content-Length

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.33.4.2.6 Response media types

• application/home+xml
• application/home+json

2.33.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 333

Chapter 2 Resources

2.33.4.2.8 Response body

The following code sample illustrates the Response body for this resource.

Example 2-126: XML response

<resources>
<resource rel="http://identifiers.emc.com/linkrel/repositories">
<link href=
"http://core-rs-demo.lss.emc.com: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://core-rs-demo.lss.emc.com: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>

Example 2-127: JSON response

{
"resources": {
"http://identifiers.emc.com/linkrel/repositories": {
"href": "http://core-rs-demo.lss.emc.com:8080/dctm-rest/
repositories.json",
"hints": {
"allow": [
"GET"
],
"representations": [
"application/xml",
"application/json",
"application/atom+xml",
"application/vnd.emc.documentum+json"
]
}

334 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.34. Inbox

},
"about": {
"href": "http://core-rs-demo.lss.emc.com:8080/dctm-rest/product-
info.json",
"hints": {
"allow": [
"GET"
],
"representations": [
"application/xml",
"application/json",
"application/vnd.emc.documentum+xml",
"application/vnd.emc.documentum+json"
]
}
}
}
}

2.34 Inbox
The Inbox resource is used to get the notifications and workflow tasks of a user.

2.34.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.34.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the feed

• Feed Title: Inbox items
• Feed Updated: Server current time
• Supports POST: No
• Entry: “Inbox Item” on page 340 resource
• Entry ID: Entry URI
• Entry Title: Name of the inbox item
• Entry Updated: The date and time that the inbox item was sent to the user

EDCPKRST220200-PRE-EN-01 Reference Guide 335

Chapter 2 Resources

2.34.3 Link relations

Link relation Description Resource reference
self Link to this inbox “Inbox” on page 335

2.34.4 Operations
2.34.4.1 Supported HTTP methods

Method Description
GET Retrieves the inbox

2.34.4.2 Get Inbox

Retrieves the notifications and workflow tasks that are in the current user’s inbox.

2.34.4.2.1 HTTP Request method and query parameters

HTTP Query Descriptio Data Value range Default value

method parameters n type
GET links, For more information, see Appendix B, REST Common Definition -
inline, URI Request Query Parameters on page 979.
page,
items-
per-page
item-type Specifies Integer It can be any of the The default is
what kind following value bitwise to return all
of items the OR'ed together. notifications
Inbox and workflow
• 0xFFFF: (DF_ALL)
should tasks.
including all
return.
notifications and tasks A default
• 0x0001: value of 7,
(DF_NOTIFICATION) which is the
including only bitwise value
notifications but not of: 0x001|
queued notifications 0x0002|
• 0x0002: (DF_QUEUED) 0x0004
including only queued
notifications
• 0x0004:
(DF_WORKFLOWTASK)
including only
workflow tasks
• 0x0008:
(DF_ROUTERTASK)
including only router
task

336 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.34. Inbox

Note: The include-total, sort, view and filter parameters are not
supported.

2.34.4.2.2 Request media types

N/A

2.34.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.34.4.2.4 Request body

N/A

2.34.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.34.4.2.6 Response media types

• application/xml
• application/atom+xml
• application/json
• application/vnd.emc.documentum+json
• application/hal+json

2.34.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 337

Chapter 2 Resources

2.34.4.2.8 Response body

Example 2-128: XML response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/inbox</id>
<title>Inbox items</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2019-02-27T07:34:37.666+00:00</updated>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/inbox"
rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b000001800011fb</id>
<title>Activity-2</title>
<summary>ACQUIRED</summary>
<updated>2018-12-25T09:18:42.000+00:00</updated>
<published>2018-12-25T09:18:42.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b000001800011fb" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b000001800011fb" type="application/vnd.emc.documentum+xml"/>
</entry>
</feed>

Example 2-129: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/inbox",
"title": "Inbox items",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-27T07:34:39.138+00:00",
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/inbox"
}
],
"entries": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b000001800011fb",
"title": "Activity-2",
"summary": "ACQUIRED",
"updated": "2018-12-25T09:18:42.000+00:00",
"published": "2018-12-25T09:18:42.000+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
inbox/1b000001800011fb"
}

338 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.34. Inbox

],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b000001800011fb"
}
}
]
}

Example 2-130: HAL response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/inbox",
"title": "Inbox items",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-27T07:34:43.310+00:00",
"_embedded": {
"collection": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b000001800011fb",
"title": "Activity-2",
"summary": "ACQUIRED",
"updated": "2018-12-25T09:18:42.000+00:00",
"published": "2018-12-25T09:18:42.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
inbox/1b000001800011fb"
}
}
}
]
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/inbox"
}
}
}

EDCPKRST220200-PRE-EN-01 Reference Guide 339

Chapter 2 Resources

2.35 Inbox Item

The Inbox Item resource represents a notification or task in a user’s notifications and
workflow tasks.

2.35.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Inbox” on page 335 and About the Diagram on page 17.

2.35.2 Feed
No feed support.

2.35.3 Link relations

Link relation Description Resource reference
self Link to itself “Inbox Item” on page 340
workflow [1] workflow “Workflow” on page 906
workflow-activity workflow activity “Workflow Activity” on page 935
[1]
task-packages [1] task packages “Task Packages” on page 718
delete [1] delete notification item “Inbox Item” on page 340
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.35.4 Operations

340 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.35. Inbox Item

2.35.4.1 Supported HTTP methods

Method Description
GET Retrieves the properties of the inbox item
PUT Performs actions on the workflow task item
DELETE Removes a notification from the inbox

2.35.4.2 Get an Inbox Item

Retrieves information about a single inbox item.

2.35.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.35.4.2.2 Request media types

N/A

2.35.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.35.4.2.4 Request body

N/A

2.35.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 341

Chapter 2 Resources

2.35.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.35.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.35.4.2.8 Response body

Example 2-131: XML response

<?xml version="1.0" encoding="UTF-8"?>

<workflow-task xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<process-id>4b0000018000236e</process-id>
<is-signoff-required>false</is-signoff-required>
<is-repeatable>true</is-repeatable>
<is-delegable>true</is-delegable>
<is-end-activity>false</is-end-activity>
<next-forward-port-names>
<item>Output:2</item>
<item>Output:0</item>
</next-forward-port-names>
<next-reject-port-names>
<item>Output:1</item>
</next-reject-port-names>
<is-distribution-listtsak>false</is-distribution-listtsak>
<is-group-owned>false</is-group-owned>
<runtime-state>ACQUIRED</runtime-state>
<is-failed-autotask>false</is-failed-autotask>
<is-manual-transition>false</is-manual-transition>
<instruction/>
<is-sequentiala-activity>false</is-sequentiala-activity>
<has-self-reject-link>false</has-self-reject-link>
<is-first-performer>false</is-first-performer>
<is-last-performer>false</is-last-performer>
<has-forward-activities>true</has-forward-activities>
<has-reject-activities>true</has-reject-activities>
<queue-item-id>1b000001800011fb</queue-item-id>
<activity-id>4c000001800025c8</activity-id>
<activity-name>Activity-2</activity-name>
<is-performer-assignment-required>false</is-performer-assignment-required>
<complete-error-status>COMPLETE_UNKNOWN</complete-error-status>
<task-name>Activity-2</task-name>
<task-type>WORKFLOWTASK</task-type>
<task-state>ACQUIRED</task-state>
<priority>0</priority>

342 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.35. Inbox Item

<sent-by>dmadmin</sent-by>
<sent-date>2018-12-25T09:18:42.000+00:00</sent-date>
<item-id>4a00000180000102</item-id>
<workflow-id>4d00000180000100</workflow-id>
<workflow-task-type>NORMAL</workflow-task-type>
<performer>dmadmin</performer>
<stamp>1b000001800011fb</stamp>
<object-id>1b000001800011fb</object-id>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b000001800011fb"
rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100"
rel="http://identifiers.emc.com/linkrel/workflow"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c8"
rel="http://identifiers.emc.com/linkrel/workflow-activity"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/work-items/
4a00000180000102/packages"
rel="http://identifiers.emc.com/linkrel/task-packages"/>
</links>
</workflow-task>

Example 2-132: JSON response

{
"name": "workflow-task",
"process-id": "4b0000018000236e",
"is-signoff-required": false,
"is-repeatable": true,
"is-delegable": true,
"is-end-activity": false,
"next-forward-activities": [
"Activity-4",
"Activity-3"
],
"next-forward-port-names": [
"Output:2",
"Output:0"
],
"next-reject-port-names": [
"Output:1"
],
"is-distribution-listtsak": false,
"is-group-owned": false,
"runtime-state": "ACQUIRED",
"is-failed-autotask": false,
"is-manual-transition": false,
"instruction": "",
"is-sequentiala-activity": false,
"has-self-reject-link": false,
"is-first-performer": false,
"is-last-performer": false,

EDCPKRST220200-PRE-EN-01 Reference Guide 343

Chapter 2 Resources

"has-forward-activities": true,
"has-reject-activities": true,
"queue-item-id": "1b000001800011fb",
"activity-id": "4c000001800025c8",
"activity-name": "Activity-2",
"is-performer-assignment-required": false,
"complete-error-status": "COMPLETE_UNKNOWN",
"task-name": "Activity-2",
"task-type": "WORKFLOWTASK",
"task-state": "ACQUIRED",
"priority": 0,
"sent-by": "dmadmin",
"sent-date": "2018-12-25T09:18:42.000+00:00",
"item-id": "4a00000180000102",
"workflow-id": "4d00000180000100",
"workflow-task-type": "NORMAL",
"performer": "dmadmin",
"stamp": "1b000001800011fb",
"object-id": "1b000001800011fb",
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b000001800011fb"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c8"
}, {
"rel": "http://identifiers.emc.com/linkrel/task-packages",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/inbox/
4a00000180000102/packages"
}
]
}

Example 2-133: HAL response

{
"name": "workflow-task",
"process-id": "4b0000018000236e",
"is-signoff-required": false,
"is-repeatable": true,
"is-delegable": true,
"is-end-activity": false,
"next-forward-port-names": [
"Output:2",
"Output:0"
],
"next-reject-activities": [
"Activity-1"
],
"next-reject-port-names": [
"Output:1"
],
"is-distribution-listtsak": false,

344 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.35. Inbox Item

"is-group-owned": false,
"runtime-state": "ACQUIRED",
"is-failed-autotask": false,
"is-manual-transition": false,
"instruction": "",
"is-sequentiala-activity": false,
"has-self-reject-link": false,
"is-first-performer": false,
"is-last-performer": false,
"has-forward-activities": true,
"has-reject-activities": true,
"queue-item-id": "1b000001800011fb",
"activity-id": "4c000001800025c8",
"activity-name": "Activity-2",
"is-performer-assignment-required": false,
"complete-error-status": "COMPLETE_UNKNOWN",
"task-name": "Activity-2",
"task-type": "WORKFLOWTASK",
"task-state": "ACQUIRED",
"priority": 0,
"sent-by": "dmadmin",
"sent-date": "2018-12-25T09:18:42.000+00:00",
"item-id": "4a00000180000102",
"workflow-id": "4d00000180000100",
"workflow-task-type": "NORMAL",
"performer": "dmadmin",
"stamp": "1b000001800011fb",
"object-id": "1b000001800011fb",
"_links": {
"http://identifiers.emc.com/linkrel/workflow": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100"
},
"http://identifiers.emc.com/linkrel/workflow-activity": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c8"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b000001800011fb"
},
"http://identifiers.emc.com/linkrel/task-packages": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/work-items/
4a00000180000102/packages"
}
}
}

EDCPKRST220200-PRE-EN-01 Reference Guide 345

Chapter 2 Resources

2.35.4.3 Performing actions on a workflow task item

Some actions can be performed on a workflow task item.

HTTP Query Description Data Type Value Default

Metho Paramete Range Value
d rs
PUT action What action will be done on the string one null
workflow task inbox item. supported
Currently, the following actions action
are supported:
• ACQUIRE: Acquire this
workflow task
• FORWARD: Set next forward
activity for this task, and
complete current task, activity
name is required
• REJECT: Set next reject
activity for this task, and
complete current task, activity
name is required
• DELEGATE: Delegate this task
to another user, and complete
current task, delegate-user is
required
• REPEAT: Set the repeaters for
the task, and complete current
task, repeat-users is required
• SIGNOFF: Signoff and
complete the task, signoff-
password is required
• ASSIGN: Set performers for
activity, activity and assign-
performers is required
• COMPLETE: Complete the
workflow task

The parameter is required

delegate- URL encoded user name, with string null
user charset UTF-8, of the user to be
delegated

Mandatory when action=

DELEGATE. For other actions, the
value is ignored

346 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.35. Inbox Item

HTTP Query Description Data Type Value Default

Metho Paramete Range Value
d rs
repeat- URL encoded user names and/or string null
users group names to repeat the task

More values are separated by the

comma, e.g. Usera,userb,
userc

Mandatory when action=

REPEAT. For other actions, the
value is ignored
assign- URL encoded user names and/or string null
performer group names to be assigned to the
s target activity.

More values are separated by the

comma, e.g. Usera,userb,
userc

Mandatory when action=

ASSIGN. For other actions, the
value is ignored
signoff- The signoff password string null
password
Mandatory when action=
SIGNOFF. For other actions, the
value is ignored
activity The next forward or reject activity string null
name.

Optional when action=FORWARD

or REJECT. For other actions, the
value is ignored

2.35.4.3.1 Request media types

N/A

EDCPKRST220200-PRE-EN-01 Reference Guide 347

Chapter 2 Resources

2.35.4.3.2 Request headers

• Accept
• Authorization

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.35.4.3.3 Request body

N/A

2.35.4.3.4 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.35.4.3.5 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.35.4.3.6 Response status

• 200 - Action performed successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.35.4.3.7 Response body

Example 2-134: XML response

The same response as in the GET operation.

Example 2-135: JSON response

The same response as in the GET operation.

348 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.35. Inbox Item

Example 2-136: HAL response

The same response as in the GET operation.

2.35.4.4 Delete a notification item

Deletes a specified notification item from the inbox.

2.35.4.4.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
DELETE N/A For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.35.4.4.2 Request media types

N/A

2.35.4.4.3 Request headers

• Authorization
For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.35.4.4.4 Request body

N/A

2.35.4.4.5 Response headers

• N/A
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.35.4.4.6 Response media types

N/A

EDCPKRST220200-PRE-EN-01 Reference Guide 349

Chapter 2 Resources

2.35.4.4.7 Response status

• 204 - Successfully deleted

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.35.4.4.8 Response body

N/A

2.36 Job(s)
2.36.1 Job
The Job resource represents the metadata of a single job.

2.36.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Job” on page 350 and About the Diagram on page 17.

2.36.1.2 Feed
No feed support.

2.36.1.3 Link relations

Link relation Description Resource reference

self Link to itself “Job” on page 350
edit Link used to edit the metadata of a “Job” on page 350
job and enable scheduling of a job
delete [1] Link used to delete the Job instance “Job” on page 350
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

350 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.36. Job(s)

2.36.1.4 Operations
2.36.1.4.1 Supported HTTP methods

Method Description
GET Retrieve a job
POST Update a job
DELETE Delete a job

2.36.1.4.2 Get Job metadata

Retrieves the metadata of a single specified job.

2.36.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET view For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.36.1.4.2.2 Request media types

N/A

2.36.1.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.36.1.4.2.4 Request body

N/A

2.36.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 351

Chapter 2 Resources

2.36.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.36.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.36.1.4.2.8 Response body

Example 2-137: Request

GET http://localhost:8080/dctm-rest/repositories/documentum1/jobs/
080004d28000035b
Accept:application/xml
Authorization:Basic ZG1hZG1pbjpwYXNzd29yZA==

Example 2-138: Response

<dm:job xsi:type="dm_job"
definition="http://localhost:8080/dctm-rest/repositories/documentum1/
types/dm_job">
<dm:properties>
<dm:r_object_id>080004d28000035b</dm:r_object_id>
<dm:object_name>dm_DMClean</dm:object_name>
<dm:r_object_type>dm_job</dm:r_object_type>
<dm:subject>Executes dmclean on a schedule</dm:subject>
<dm:title>Content</dm:title>
<dm:owner_name>Administrator</dm:owner_name>
<dm:method_trace_level>0</dm:method_trace_level>
<dm:target_server>documentum1.documentum1@cs1671</dm:target_server>
<dm:is_inactive>true</dm:is_inactive>
<dm:start_date>2019-11-18T17:30:00.000+00:00</dm:start_date>
<dm:inactivate_after_failure>false</dm:inactivate_after_failure>
<dm:a_next_invocation>2019-11-18T17:30:00.000+00:00</
dm:a_next_invocation>
<dm:run_mode>4</dm:run_mode>
<dm:max_iterations>0</dm:max_iterations>
<dm:expiration_date>2027-11-18T17:30:00.000+00:00</dm:expiration_date>
<dm:method_name>dm_DMClean</dm:method_name>
<dm:method_arguments>
<dm:item>-window_interval 120</dm:item>
<dm:item>-queueperson</dm:item>
<dm:item>-clean_content TRUE</dm:item>
<dm:item>-clean_note TRUE</dm:item>
<dm:item>-clean_acl TRUE</dm:item>
<dm:item>-clean_wf_template TRUE</dm:item>
<dm:item>-clean_now TRUE</dm:item>
<dm:item>-clean_castore FALSE</dm:item>
<dm:item>-clean_aborted_wf FALSE</dm:item>
<dm:item>-clean_deleted_lwso TRUE</dm:item>

352 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.36. Job(s)

<dm:item>-clean_content_in_parallel FALSE</dm:item>
<dm:item>-parallel_degree 5</dm:item>
<dm:item>-clean_wf_method_exec_result FALSE</dm:item>
<dm:item>-batch_size 2000</dm:item>
<dm:item>-query_batch_size 0</dm:item>
</dm:method_arguments>
</dm:properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/documentum1/
jobs/
080004d28000035b"/>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/documentum1/
jobs/
080004d28000035b"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/
documentum1/
jobs/080004d28000035b"/>
</links>
</dm:job>

2.36.1.4.3 Update a Job

Updates the metadata of a Job by providing attributes.

HTTP Query Description Data type Value range Default value

method parameters
POST N/A For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.36.1.4.3.1 Request media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

2.36.1.4.3.2 Request headers

• Accept

• Authorization

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 353

Chapter 2 Resources

2.36.1.4.3.3 Request body

Example 2-139: XML Request

<?xml version="1.0" encoding="UTF-8"?>

<dm:dm_job xmlns:dm="http://ns.emc.com/documentum"
xmlns="http://www.w3.org/2005/Atom">
<dm:properties>
<dm:object_name>dm_DMClean</dm:object_name>
<dm:start_date>2019-11-20T05:46:08.000+00:00</dm:start_date>
<dm:max_iterations>1</dm:max_iterations>
<dm:method_name>my_method</dm:method_name>
...
</dm:properties>
</dm:dm_job>

2.36.1.4.3.4 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.36.1.4.3.5 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.36.1.4.3.6 Response status

• 200 - Updated successfully

• 400, 401, 403, 404, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.36.1.4.3.7 Response body

Example 2-140: XML Response

<dm:job xsi:type="dm_job"
definition="http://localhost:8080/dctm-rest/repositories/documentum1/
types/dm_job">
<dm:properties>
<dm:r_object_id>080004d28000035b</dm:r_object_id>
<dm:object_name>dm_DMClean</dm:object_name>
<dm:r_object_type>dm_job</dm:r_object_type>
<dm:subject>Executes dmclean on a schedule</dm:subject>
<dm:title>Content</dm:title>
<dm:owner_name>Administrator</dm:owner_name>
<dm:method_trace_level>0</dm:method_trace_level>
<dm:target_server>documentum1.documentum1@cs1671</dm:target_server>
<dm:is_inactive>true</dm:is_inactive>
<dm:start_date>2019-11-20T05:46:08.000+00:00</dm:start_date>

354 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.36. Job(s)

<dm:inactivate_after_failure>false</dm:inactivate_after_failure>
<dm:a_next_invocation>2019-11-18T17:30:00.000+00:00</
dm:a_next_invocation>
<dm:run_mode>4</dm:run_mode>
<dm:max_iterations>0</dm:max_iterations>
<dm:expiration_date>2027-11-18T17:30:00.000+00:00</dm:expiration_date>
<dm:method_name>my_method</dm:method_name>
<dm:method_arguments>
<dm:item>-window_interval 120</dm:item>
<dm:item>-queueperson</dm:item>
<dm:item>-clean_content TRUE</dm:item>
<dm:item>-clean_note TRUE</dm:item>
<dm:item>-clean_acl TRUE</dm:item>
<dm:item>-clean_wf_template TRUE</dm:item>
<dm:item>-clean_now TRUE</dm:item>
<dm:item>-clean_castore FALSE</dm:item>
<dm:item>-clean_aborted_wf FALSE</dm:item>
<dm:item>-clean_deleted_lwso TRUE</dm:item>
<dm:item>-clean_content_in_parallel FALSE</dm:item>
<dm:item>-parallel_degree 5</dm:item>
<dm:item>-clean_wf_method_exec_result FALSE</dm:item>
<dm:item>-batch_size 2000</dm:item>
<dm:item>-query_batch_size 0</dm:item>
</dm:method_arguments>
</dm:properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/documentum1/
jobs/
080004d28000035b"/>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/documentum1/
jobs/
080004d28000035b"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/documentum1/
jobs/
080004d28000035b"/>
</links>
</dm:job>

2.36.1.4.4 Delete a Job

Deletes a specified Job.

EDCPKRST220200-PRE-EN-01 Reference Guide 355

Chapter 2 Resources

2.36.1.4.4.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
DELETE N/A For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.36.1.4.4.2 Request media types

N/A

2.36.1.4.4.3 Request headers

• N/A
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.36.1.4.4.4 Request body

N/A

2.36.1.4.4.5 Response headers

• N/A
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.36.1.4.4.6 Response media types

N/A

2.36.1.4.4.7 Response status

• 204 - Successfully deleted

• 400, 401, 403, 404, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

356 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.36. Job(s)

2.36.1.4.4.8 Response body

N/A

2.36.2 Jobs
The Jobs resource represents a collection of Job instances in a repository.

2.36.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.36.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: List of jobs
• Feed Updated: The current time
• Entry: “Job” on page 350
• Supports POST: Yes

2.36.2.3 Link relations

Link relation Description Resource reference

self The URI of the collection of “Jobs” on page 357
Jobs.
first, last, next, previous Pagination links. “Jobs” on page 357

EDCPKRST220200-PRE-EN-01 Reference Guide 357

Chapter 2 Resources

2.36.2.4 Operations
2.36.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a collection of Job instances.
POST Used to create new Jobs instances.

2.36.2.4.2 Get a Jobs collection

Retrieve a collection of Jobs along with their filters and pagination.

2.36.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value Range Default value

method parameters
GET inline Determines boolean true - returns false
whether to an object
show content instance and
(the object embeds the
instance) in object
the atom instance into
entry for a the entry's
collection. content.

false - does
not return an
object
instance.
sort Only groups string string null
that contain a
sub group (a
dm_group
instance)
whose
group_name
property
equals to the
specified
string are
returned in
the result.

358 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.36. Job(s)

HTTP Query Description Data type Value Range Default value

method parameters
page Determines integer >=1 1 for
the number example,
of the page to items_per_
be served; page=200&
when the page=2
result feed is returns items
paged, an 201 to 400
element
<dm:page>x
x</
dm:page> is
displayed
under the
feed root.
items-per- Determines integer >=1 100
page the number
of entries per
page; when
the result
feed is paged,
an element
<dm:items-
per-
page>xx</
dm:items-
per-page>
is displayed
under the
feed root.
include- Indicates boolean true - the false
total whether to total count of
calculate the feed items is
total count of calculated by
feed items server and
that are returned.
returned on
one page. false - not
calculate &
When true, a return the
<dm:total> total count.
xx</
dm:total>
element
displays
under the
feed root.

EDCPKRST220200-PRE-EN-01 Reference Guide 359

Chapter 2 Resources

HTTP Query Description Data type Value Range Default value

method parameters
view Defines the string The pattern :default
properties to is: ?
return and view=(:vie
that are w-name)?(,
displayed. column)* -
(:view-
name) and
(,columns)*
must be
mutually
displayed.

exclusive -
names of
predefined
views start
with ":", the
following
view-name
values are
defined: – :all
– :default - if
no view-
name is
specified,
names of
properties or
predefined
views should
be returned,
separated by
comma (',').

360 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.36. Job(s)

HTTP Query Description Data type Value Range Default value

method parameters
links Determines boolean true or false. true
whether link
• links =
relations are true is
returned for default
this object
instance. • links =
false
means "do
not send
me any
links that
are
expensive
to
calculate,
but it is
fine if you
send me
ones that
are cheap
to
calculate."

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.36.2.4.2.2 Using filters

• The following filter queries can be used to get Jobs by name:

/repositories/<repositoryName>/jobs?filter=object_name='dm_AsynchronousWrite'
/repositories/<repositoryName>/jobs?filter=starts-with(object_name,"dm_Asy")

• The following filter query can be used to get Jobs by title:

/repositories/<repositoryName>/jobs?filter=title='CA Store'

List of the available Job types:

• CA Store (EMC Centera and NetApp SnapLock stores)

• Content
• Data Dictionary
• Distributed Content
• Docbase
• Federation
• Fulltext
• Other
• Replication

EDCPKRST220200-PRE-EN-01 Reference Guide 361

Chapter 2 Resources

• Workflow

2.36.2.4.2.3 Request media types

N/A

2.36.2.4.2.4 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.36.2.4.2.5 Request body

N/A

2.36.2.4.2.6 Response headers

• Content-Type
• Content-Length

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.36.2.4.2.7 Response media types

N/A

2.36.2.4.2.8 Response status

• 200 - Request successful

• 400, 401, 403, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.36.2.4.2.9 Response body

• The body contains a list of Jobs that are in the repository.

• Each Job metadata contains the following attributes:
1. Id: The Id of the Job.
2. Title: The name of the Job.
3. Summary: A brief description of the Job.

362 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.36. Job(s)

Example 2-141: Request

GET http://localhost:9089/dctm-rest/repositories/documentum1/jobs?inline=true
Accept:application/atom+xml
Authorization:Basic ZG1hZG1pbjpwYXNzd29yZA==

Example 2-142: XML Response

<?xml version='1.0' encoding='UTF-8'?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:9089/dctm-rest/repositories/documentum1/jobs</id>
<title>jobs</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2020-01-03T05:50:06.140+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:9089/dctm-rest/repositories/documentum1/jobs"/>
<link rel="first"
href="http://localhost:9089/dctm-rest/repositories/documentum1/
jobs?items-per-page=100&page=1"/>
<entry>
<id>http://localhost:9089/dctm-rest/repositories/documentum1/jobs/
080004d28000035f</id>
<title>dm_AuditMgt</title>
<summary>Removes old audit trail entries</summary>
<updated>2019-11-20T05:46:08.000+00:00</updated>
<published>2019-11-20T05:46:08.000+00:00</published>
<content xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:job xsi:type="dm_job"
definition="http://localhost:9089/dctm-rest/repositories/
documentum1/types/dm_job">
<dm:properties>
<dm:r_object_id>080004d28000035f</dm:r_object_id>
<dm:r_object_type>dm_job</dm:r_object_type>
<dm:object_name>dm_AuditMgt</dm:object_name>
<dm:subject>Removes old audit trail entries</dm:subject>
<dm:title>Docbase</dm:title>
</dm:properties>
<dm:links>
<dm:link rel="self"
href="http://localhost:9089/dctm-rest/repositories/
documentum1/jobs/080004d28000035f"/>
<dm:link rel="edit"
href="http://localhost:9089/dctm-rest/repositories/
documentum1/jobs/080004d28000035f"/>
</dm:links>
</dm:job>
</content>
</entry>
<entry>
<id>http://localhost:9089/dctm-rest/repositories/documentum1/jobs/
080004d28000036f</id>
<title>dm_ContentReplication</title>
<summary>
Replicates content from specified source (or all) to target site

EDCPKRST220200-PRE-EN-01 Reference Guide 363

Chapter 2 Resources

</summary>
<updated>2020-01-03T09:29:17.060+00:00</updated>
<published>2020-01-03T09:29:17.060+00:00</published>
<content xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:job xsi:type="dm_job"
definition="http://localhost:8080/dctm-rest/repositories/
documentum1/types/dm_job">
<dm:properties>
<dm:r_object_id>080004d28000036f</dm:r_object_id>
<dm:r_object_type>dm_job</dm:r_object_type>
<dm:object_name>dm_ContentReplication</dm:object_name>
<dm:subject>Replicates content from specified source (or all) to
target site</dm:subject>
<dm:title>Replication</dm:title>
</dm:properties>
<dm:links>
<dm:link rel="self"
href="http://localhost:9089/dctm-rest/repositories/
documentum1/jobs/080004d28000036f"/>
<dm:link rel="edit"
href="http://localhost:9089/dctm-rest/repositories/
documentum1/jobs/080004d28000036f"/>
</dm:links>
</dm:job>
</content>
</entry>
</feed>

Example 2-143: Response for starts-with filter

GET http://localhost:9089/dctm-rest/repositories/documentum1/
jobs?filter=starts-with(object_name,"dm_Au")
Accept:application/atom+xml
Authorization:Basic ZG1hZG1pbjpwYXNzd29yZA==

Example 2-144: XML Response for starts-with filter

<?xml version='1.0' encoding='UTF-8'?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:9089/dctm-rest/repositories/documentum1/jobs</id>
<title>jobs</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2020-01-03T05:50:06.140+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:9089/dctm-rest/repositories/documentum1/jobs"/>
<entry>
<id>http://localhost:9089/dctm-rest/repositories/documentum1/jobs/
080004d28000035f</id>
<title>dm_AuditMgt</title>
<summary>Removes old audit trail entries</summary>
<updated>2019-11-20T05:46:08.000+00:00</updated>

364 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.36. Job(s)

<published>2019-11-20T05:46:08.000+00:00</published>
<content xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:job xsi:type="dm_job"
definition="http://localhost:9089/dctm-rest/repositories/
documentum1/types/dm_job">
<dm:properties>
<dm:r_object_id>080004d28000035f</dm:r_object_id>
<dm:r_object_type>dm_job</dm:r_object_type>
<dm:object_name>dm_AuditMgt</dm:object_name>
<dm:subject>Removes old audit trail entries</dm:subject>
<dm:title>Docbase</dm:title>
</dm:properties>
<dm:links>
<dm:link rel="self"
href="http://localhost:9089/dctm-rest/repositories/
documentum1/jobs/080004d28000035f"/>
<dm:link rel="edit"
href="http://localhost:9089/dctm-rest/repositories/
documentum1/jobs/080004d28000035f"/>
</dm:links>
</dm:job>
</content>
</entry>
</feed>

2.36.2.4.3 Create a Job

Creates a Job in the repository.

2.36.2.4.3.1 HTTP Request method and query parameters

POST

2.36.2.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.36.2.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 365

Chapter 2 Resources

2.36.2.4.3.4 Request body

The following parameters are mandatory to create a Job:

• method_name: Values are any valid string.

• start_date: Values are any valid date year-month-day
• run_mode: Values are integers that range from 1 - 9
The following illustrates how to use run_mode values:

– 1: Every x minutes
– 2: Every x hours
– 3: Every x days
– 4: Every x weeks
– 5: Every x months
– 7: Every x day of week
– 8: Every x day of month
– 9: Every x day of year

Where x represents the value set for the run_interval property.

• run_interval: Values must be greater than 1
• max_iterations or expiration_date

Example 2-145: XML request

<?xml version="1.0" encoding="UTF-8"?>
<dm:dm_job xmlns:dm="http://ns.emc.com/documentum"
xmlns="http://www.w3.org/2005/Atom">
<dm:properties>
<dm:object_name>acme</dm:object_name>
<dm:start_date>acme</dm:start_date>
<dm:max_iterations>1</dm:max_iterations>
<dm:method_name>my_method</dm:method_name>
......
</dm:properties>
</dm:dm_job>

366 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

2.36.2.4.3.5 Response headers

• Location
The URL of the Job created.

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.36.2.4.3.6 Response media types

• application/atom+xml

• application/vnd.emc.documentum+json

2.36.2.4.3.7 Response status

• 201 - Created successfully

• 400, 401, 403, 500

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.36.2.4.3.8 Response body

N/A

2.37 Lifecycle (s)

2.37.1 Lifecycle
This resource represents a single Lifecycle object.

2.37.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Lifecycles” on page 382 and About the Diagrams on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 367

Chapter 2 Resources

2.37.1.2 Feed
No feed support.

2.37.1.3 Link relations

Link relation Description Resource reference

self This Lifecycle resource “Lifecycle” on page 367
permission-set The permission set of the lifecycle “Permission Set” on page 505
permissions The lifecycle permissions “Permissions” on page 501
type The type of the type inclusion “Type” on page 726
owner The owner user resource “User” on page 765

2.37.1.4 Operations

2.37.1.4.1 Supported HTTP methods

Method Description
GET Retrieves a single Lifecycle object.

2.37.1.4.2 Get a Lifecycle

Retrieve a single lifecycle object.

2.37.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.37.1.4.2.2 Request media types

N/A

2.37.1.4.2.3 Request headers

• Authorization

• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

368 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

2.37.1.4.2.4 Request body

N/A

2.37.1.4.2.5 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.37.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.37.1.4.2.7 Response status

• 200 – Retrieved successfully.

• 400, 401, 404, 406, 409, 415, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.37.1.4.2.8 Response body

Example 2-146: XML response

<?xml version='1.0' encoding='UTF-8'?>

<lifecycle xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>4600000580004abc</id>
<name>my_lifecycle</name>
<title>xxx</title>
<subject>xxx</subject>
<keywords>
<keyword>xxx</keyword>
</keywords>
<implementation-type>JAVA</implementation-type>
<owner>dmadmin</owner>
<created>2017-03-30T07:18:36.000+00:00</created>
<modifed>2017-03-30T07:18:36.000+00:00</modifed>
<version-labels>
<version-label>1.0</version-label>
<version-label>CURRENT</version-label>
</version-labels>
<alias-sets>
<alias-set>660000058000010a</alias-set>
</alias-sets>
<type-inclusions>
<type-inclusion>
<type>dm_sysobject</type>
<include-subtypes>false</include-subtypes>

EDCPKRST220200-PRE-EN-01 Reference Guide 369

Chapter 2 Resources

</type-inclusion>
<type-inclusion>
<type>dm_document</type>
<include-subtypes>true</include-subtypes>
</type-inclusion>
</type-inclusions>
<user-validation-service>
<id>0b00000580004df1</id>
<name>lifecyclemodule</name>
<primary-class>
com.emc.documentum.emc.dfc.lifecycle.RestLifecycleUserProcessor
</primary-class>
</user-validation-service>
<app-validation>
<id>0b00000580004df1</id>
<name>lifecyclemodule</name>
<version></version>
</app-validation>
<states>
<state>
<name>draft</name>
<type></type>
<description>draft version</description>
<exceptional>false</exceptional>
<exception-state></exception-state>
<allow-attach>true</allow-attach>
<allow-schedule>true</allow-schedule>
<allow-return-to-base>false</allow-return-to-base>
<allow-demote>false</allow-demote>
<index>0</index>
<no>0</no>
<return-conditions>
<return-condition>ALL</return-condition>
</return-conditions>
<type-override-id></type-override-id>
<entry-criteria>
<id>550000058000093b</id>
<expression>((subject = "ok"))</expression>
</entry-criteria>
<action>
<id>0800000580004e05</id>
<name>
review_fmuzh1p0kpq8ilz5ifvexz actionset procedure for policy
a_docbasic_lifecycle
</name>
</action>
<user-criteria>
<id></id>
<name></name>
<version></version>
</user-criteria>
<user-action>
<id></id>
<name></name>
<version></version>
</user-action>
<user-post-action>
<id></id>
<name></name>
<version></version>
</user-post-action>
<user-criteria-service>

370 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

<id>0b00000580004df1</id>
<name>lifecyclemodule</name>
<primary-class>
com.emc.documentum.emc.dfc.lifecycle.RestLifecycleUserProcessor
</primary-class>
</user-criteria-service>
<user-action-service>
<id>0b00000580004df1</id>
<name>lifecyclemodule</name>
<primary-class>
com.emc.documentum.emc.dfc.lifecycle.RestLifecycleUserProcessor
</primary-class>
</user-action-service>
<user-post-service>
<id>0b00000580004df1</id>
<name>lifecyclemodule</name>
<primary-class>
com.emc.documentum.emc.dfc.lifecycle.RestLifecycleUserProcessor
</primary-class>
</user-post-service>
<system-action>
<id></id>
<name></name>
<primary-class></primary-class>
</system-action>
</state>
</states>
<status>INSTALLED</state>
<links>...</links>
</lifecycle>

Example 2-147: JSON response

{
"id" : "4600000580004abc",
"name" : "my_lifecycle",
"title" : "xxx",
"subject" : "xxx",
"keywords" : "xxx",
"implementation-type" : "JAVA",
"owner" : "dmadmin",
"created" : "2017-03-30T07:18:36.000+00:00",
"modifed" : "2017-03-30T07:18:36.000+00:00",
"version-labels" : [ "1.0", "CURRENT" ],
"alias-set" : [ "660000058000010a" ],
"type-inclusions" : [ {
"type" : "dm_sysobject",
"include-subtypes" : false
}, {
"type" : "dm_document",
"include-subtypes" : true
} ],
"user-validation-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-class" :
"com.emc.documentum.emc.dfc.lifecycle.RestLifecycleUserProcessor"
},
"app-validation" : {

EDCPKRST220200-PRE-EN-01 Reference Guide 371

Chapter 2 Resources

"id" : "0800000580004e05",
"name" : ""
},
"states" : [{
"name" : "draft",
"type" : "",
"description" : "draft version",
"exceptional" : false,
"exception-state" : "",
"allow-attach" : true,
"allow-schedule" : true,
"allow-return-to-base" : false,
"allow-demote" : false,
"index" : 0,
"return-conditions" : [ "ALL" ],
"entry-criteria" : {
"id" : "550000058000093b",
"expression" : "(((subject = \"ok\") Or (subject = \"action fail\"))
Or (subject = \"post fail\"))"
},
"action" : {
"id" : "0800000580004e05",
"name" : "review_fmuzh1p0kpq8ilz5ifvexz actionset procedure for policy
a_docbasic_lifecycle",
"versin" : ""
},
"user-criteria" : {
"id" : "",
"name" : "",
"versin" : ""
},
"user-action" : {
"id" : "",
"name" : "",
"versin" : ""
},
"user-post-action" : {
"id" : "",
"name" : "",
"versin" : ""
},
"user-criteria-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-class" :
"com.emc.documentum.emc.dfc.lifecycle.RestLifecycleUserProcessor"
},
"user-action-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-class" :
"com.emc.documentum.emc.dfc.lifecycle.RestLifecycleUserProcessor"
},
"user-post-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-class" :
"com.emc.documentum.emc.dfc.lifecycle.RestLifecycleUserProcessor"
},
"system-action" : {
"id" : "",
"name" : "",

372 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

"primary-class" : ""
}
}],
"type-override-id" : "",
"status" : "INSTALLED",
"links" : [xxx]
}

2.37.1.4.2.9 Lifecycle Property Mappings

The following table shows the mapping between Documentum properties and
Lifecycle properties.

Table 2-1: Property mappings: Documentum to Lifecycle

Lifecycle property name Lifecycle DCTM DCTM

property property property
type name type
id string r_object_id dm_policy
name string object_nam dm_policy
e
title string title dm_policy
subject string subject dm_policy
keywords keyword string keywords dm_policy
implement string java_metho dm_policy
ation-type ds
owner string owner_na dm_policy
me
created string r_creation_ dm_policy
date
modified string r_modify_d dm_policy
ate
version- version- string r_version_l dm_policy
labels label abel
alias-sets alias-set string alias_set_id dm_policy
s
type- type- type string included_t dm_policy
inclusions inclusion ype
include- string include_su dm_policy
subtype btypes
user- id string r_object_id dm_policy
validation-
service

EDCPKRST220200-PRE-EN-01 Reference Guide 373

Chapter 2 Resources

Lifecycle property name Lifecycle DCTM DCTM

property property property
type name type
name string user_valida dmc_modu
tion_servic le
e
primary- string primary_cl dm_policy
class ass
app- id string app_valida dm_proced
validation tion_id ure
name string object_nam dm_policy
e
version string app_valida dm_policy
tion_ver
states state name string state_name dm_policy
type string state_type dm_policy
description string state_descri dm_policy
ption
exceptional string state_class dm_policy
exception- string exception_s dm_policy
state tate
allow- string allow_attac dm_policy
attach h
allow- string allow_sche dm_policy
schedule dule
allow- string allow_dem dm_policy
demote ote
allow- string return_to_b dm_policy
return-to- ase
base
index integer
no integer i_state_no dm_policy
return- return- string return_con dm_policy
conditions condition dition
type- string type_overri dm_policy
override-id de_id
entry- id string entry_criter dm_policy
criteria ia_id
entry- string expression dm_func_e
criteria _text xpr

374 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

Lifecycle property name Lifecycle DCTM DCTM

property property property
type name type
action id string action_obje dm_policy
ct_id
name string object_nam dm_proced
e ure
user- id string user_criteri dm_policy
criteria a_id
name string object_nam dm_proced
e ure
version string user_criteri dm_policy
a_ver
user-action id string user_action dm_policy
_id
name string object_nam dm_proced
e ure
version string user_action dm_policy
_ver
user-post- id string user_postp dm_policy
action roc_id
name string object_nam dm_proced
e ure
version string user_postp dm_policy
roc_ver
name string user_criteri dm_policy
a_service
primary- string primary_cl dmc_modu
class ass le
user- id string r_object_id dmc_modu
action- le
service
name string user_action dm_policy
_service
primary- string primary_cl dmc_modu
class ass le
user-post- id string r_object_id dmc_modu
service le
name string user_postp dm_policy
rocessing_s
ervice
primary- string primary_cl dmc_modu
class ass le

EDCPKRST220200-PRE-EN-01 Reference Guide 375

Chapter 2 Resources

Lifecycle property name Lifecycle DCTM DCTM

property property property
type name type
system- id string r_object_id dmc_modu
action le
name string system_acti dm_policy
ons
primary- string primary_cl dmc_modu
class ass le
status string r_definition dm_policy
_state

2.37.1.5 Additional examples for the response

A Lifecycle sample implemented in DocBasic.

Example 2-148: JSON response

{
"id" : "4600000580004dfb",
"name" : "a_docbasic_lifecycle",
"owner" : "dmadmin",
"created" : "2017-05-03T02:15:21.000+00:00",
"modified" : "2017-05-03T02:15:25.000+00:00",
"implementation-type" : "DOCBASIC",
"version-labels" : [
"1.0",
"CURRENT"
],
"status" : "INSTALLED",
"type-inclusions" : [
{
"type" : "dm_document",
"include-subtypes" : true
}
],
"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",

376 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

"allow-attach" : false,
"allow-schedule" : true,
"allow-return-to-base" : true,
"allow-demote" : true,
"return-conditions" : [
"CHECKIN",
"SAVE_AS_NEW",
"BRANCH"
],
"entry-criteria" : {
"id" : "550000058000093b",
"expression" : "(((subject = \"ok\") Or (subject = \"action fail\"))
Or (subject = \"post fail\"))"
},
"action" : {
"id" : "0800000580004e05",
"name" : "review_fmuzh1p0kpq8ilz5ifvexz actionset procedure for policy
a_docbasic_lifecycle"
}
},
{
"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"
],
"entry-criteria" : {
"id" : "550000058000093c",
"expression" : "(((subject = \"ok\") Or (subject = \"action fail\"))
Or (subject = \"post fail\"))"
},
"action" : {
"id" : "0800000580004e06",
"name" : "publish_2cp0x50b4s+anynusyzqm5 actionset procedure for
policy
a_docbasic_lifecycle"
}
},
{
"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/

EDCPKRST220200-PRE-EN-01 Reference Guide 377

Chapter 2 Resources

4600000580004dfb"
},
{
"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"
}
]
}

Example 2-149: XML response

<?xml version="1.0" encoding="UTF-8"?>
<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>

378 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

<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>

EDCPKRST220200-PRE-EN-01 Reference Guide 379

Chapter 2 Resources

<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>

Example 2-150: JSON response

A Lifecycle sample implemented in Java.

{
"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.emc.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,

380 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

"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.emc.dfc.lifecycle.RestLifecycleUserProcessor"
},
"user-action-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-
class":"com.emc.documentum.emc.dfc.lifecycle.RestLifecycleUserProcessor"
},
"user-post-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-
class":"com.emc.documentum.emc.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.emc.dfc.lifecycle.RestLifecycleUserProcessor"
},
"user-action-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-
class":"com.emc.documentum.emc.dfc.lifecycle.RestLifecycleUserProcessor"
},
"user-post-service" : {
"id" : "0b00000580004df1",
"name" : "lifecyclemodule",
"primary-
class":"com.emc.documentum.emc.dfc.lifecycle.RestLifecycleUserProcessor"
}
},
{

EDCPKRST220200-PRE-EN-01 Reference Guide 381

Chapter 2 Resources

"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"
}
]
}

2.37.2 Lifecycles
The Lifecycles resource is used to retrieve the Lifecycles (policies) defined in the
repository.

2.37.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagrams on page 17.

382 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

2.37.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: Lifecycles
• Feed Updated: Server's current time
• Supports POST: No
• Entry: A single Lifecycle
• Entry ID: The Lifecycle URI
• Entry Title: The Lifecycle name
• Entry Updated: The last modify date

2.37.2.3 Link relations

Link relation Description Resource reference

self This Lifecycles resource “Lifecycles” on page 382
first, last, next, previous Pagination links “Lifecycles” on page 382

2.37.2.4 Operations
2.37.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a list of Lifecycles from a
repository.

2.37.2.4.2 Get all Lifecycles

Retrieves a list of lifecycles from a repository.

2.37.2.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• inline
• sort
• page
• items-per-page
• include-total
• links

EDCPKRST220200-PRE-EN-01 Reference Guide 383

Chapter 2 Resources

• filter
• object-id: This query parameter is a string containing the object id and its
default value is null.
• object-type: This query parameter is a string containing the object type name
and its default value is null.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

The view parameter is not supported. When the filter parameter is specified, the
client must provide the property name of the DCTM Lifecycle (policy) object, such
as object_name, or r_object_id.

Caution
Providing the object-id and the object-type at the same time causes an
exception to be thrown. When the object-id or the object-type are
specified, only those lifecycles that are allowed to be attached by the
specified object or object type, are returned. The filter parameter, in this
case, is ignored.

2.37.2.4.2.2 Request media types

N/A

2.37.2.4.2.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.37.2.4.2.4 Request body

N/A

2.37.2.4.2.5 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

384 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

2.37.2.4.2.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.37.2.4.2.7 Response status

• 200 - List of Lifecycles retrieved successfully.

• 400, 401, 403, 404, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.37.2.4.2.8 Response body

Example 2-151: XML response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/lifecycles</id>
<title>Lifecycles</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2017-05-05T09:01:47.253+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/xml"/>
</entry>
<entry>
<id>
http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/
4600000580004dfc

EDCPKRST220200-PRE-EN-01 Reference Guide 385

Chapter 2 Resources

</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/xml"/>
</entry>
</feed>

Example 2-152: JSON response

{
"id" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles",
"title" : "Lifecycles",
"author" : [
{
"name" : "OpenText Documentum"
}
],
"updated" : "2017-05-05T09:01:28.405+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" : {

386 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

"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"
}
}
]
}

Caution
When getting an inline lifecycle, the following information is not returned:

• The id and primary-class of the user-validation-service

• The name of the app-validation
• The expression of entry-criteria in each state when present
• The name of the action, user-criteria, user-action, and the user-
post-action in each state when present

• The id and primary-class of the user-criteria-service, the user-

action-service, the user-post-service, and the system-action in
each state when present

The above information is available when using the single “Lifecycle”

on page 367 resource.

EDCPKRST220200-PRE-EN-01 Reference Guide 387

Chapter 2 Resources

2.37.2.4.3 Additional examples for response

Example 2-153: XML inline response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/lifecycles</id>
<title>Lifecycles</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2017-05-05T09:08:44.905+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?
inline=true"
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>
<dm:lifecycle xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:id>4600000580004dfb</dm:id>
<dm:name>a_docbasic_lifecycle</dm:name>
<dm:owner>dmadmin</dm:owner>
<dm:created>2017-05-03T02:15:21.000+00:00</dm:created>
<dm:modified>2017-05-03T02:15:25.000+00:00</dm:modified>
<dm:implementation-type>DOCBASIC</dm:implementation-type>
<dm:version-labels>
<dm:version-label>1.0</dm:version-label>
<dm:version-label>CURRENT</dm:version-label>
</dm:version-labels>
<dm:status>INSTALLED</dm:status>
<dm:type-inclusions>
<dm:type-inclusion>
<dm:type>dm_document</dm:type>
<dm:include-subtypes>true</dm:include-subtypes>
</dm:type-inclusion>
</dm:type-inclusions>
<dm:states>
<dm:state>
<dm:name>draft</dm:name>
<dm:index>0</dm:index>
<dm:no>0</dm:no>
<dm:exceptional>false</dm:exceptional>

388 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

<dm:allow-attach>true</dm:allow-attach>
<dm:allow-schedule>true</dm:allow-schedule>
<dm:allow-return-to-base>false</dm:allow-return-to-base>
<dm:allow-demote>false</dm:allow-demote>
<dm:return-conditions>
<dm:return-condition>ALL</dm:return-condition>
</dm:return-conditions>
</dm:state>
<dm:state>
<dm:name>review</dm:name>
<dm:index>1</dm:index>
<dm:no>1</dm:no>
<dm:exceptional>false</dm:exceptional>
<dm:exception-state>fail</dm:exception-state>
<dm:allow-attach>false</dm:allow-attach>
<dm:allow-schedule>true</dm:allow-schedule>
<dm:allow-return-to-base>true</dm:allow-return-to-base>
<dm:allow-demote>true</dm:allow-demote>
<dm:return-conditions>
<dm:return-condition>CHECKIN</dm:return-condition>
<dm:return-condition>SAVE_AS_NEW</dm:return-condition>
<dm:return-condition>BRANCH</dm:return-condition>
</dm:return-conditions>
<dm:entry-criteria>
<dm:id>550000058000093b</dm:id>
</dm:entry-criteria>
<dm:action>
<dm:id>0800000580004e05</dm:id>
</dm:action>
</dm:state>
<dm:state>
<dm:name>publish</dm:name>
<dm:index>2</dm:index>
<dm:no>2</dm:no>
<dm:exceptional>false</dm:exceptional>
<dm:allow-attach>false</dm:allow-attach>
<dm:allow-schedule>true</dm:allow-schedule>
<dm:allow-return-to-base>true</dm:allow-return-to-base>
<dm:allow-demote>true</dm:allow-demote>
<dm:return-conditions>
<dm:return-condition>BRANCH</dm:return-condition>
</dm:return-conditions>
<dm:entry-criteria>
<dm:id>550000058000093c</dm:id>
</dm:entry-criteria>
<dm:action>
<dm:id>0800000580004e06</dm:id>
</dm:action>
</dm:state>
<dm:state>
<dm:name>fail</dm:name>
<dm:index>3</dm:index>
<dm:no>3</dm:no>
<dm:exceptional>true</dm:exceptional>
<dm:allow-attach>false</dm:allow-attach>
<dm:allow-schedule>true</dm:allow-schedule>
<dm:allow-return-to-base>false</dm:allow-return-to-base>
<dm:allow-demote>false</dm:allow-demote>
<dm:return-conditions>
<dm:return-condition>ALL</dm:return-condition>
</dm:return-conditions>
</dm:state>

EDCPKRST220200-PRE-EN-01 Reference Guide 389

Chapter 2 Resources

</dm:states>
<dm:links>
<dm:link
href="http://localhost:8080/dctm-rest/repositories/REPO/
lifecycles/
4600000580004dfb"
rel="self"/>
<dm:link
href="http://localhost:8080/dctm-rest/repositories/REPO/
users/dmadmin"
rel="http://identifiers.emc.com/linkrel/owner"/>
<dm:link
href="http://localhost:8080/dctm-rest/repositories/REPO/
types/
dm_document"
rel="http://identifiers.emc.com/linkrel/type"
title="dm_document"/>
</dm:links>
</dm:lifecycle>
</content>
</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>
<dm:lifecycle xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:id>4600000580004dfc</dm:id>
<dm:name>a_java_lifecycle</dm:name>
<dm:owner>dmadmin</dm:owner>
<dm:created>2017-05-03T02:15:22.000+00:00</dm:created>
<dm:modified>2017-05-03T02:15:24.000+00:00</dm:modified>
<dm:implementation-type>JAVA</dm:implementation-type>
<dm:version-labels>
<dm:version-label>1.0</dm:version-label>
<dm:version-label>CURRENT</dm:version-label>
</dm:version-labels>
<dm:status>INSTALLED</dm:status>
<dm:type-inclusions>
<dm:type-inclusion>
<dm:type>dm_document</dm:type>
<dm:include-subtypes>true</dm:include-subtypes>
</dm:type-inclusion>
</dm:type-inclusions>
<dm:user-validation-service>
<dm:name>lifecyclemodule</dm:name>
</dm:user-validation-service>
<dm:states>
<dm:state>
<dm:name>draft</dm:name>
<dm:index>0</dm:index>

390 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

<dm:no>0</dm:no>
<dm:exceptional>false</dm:exceptional>
<dm:allow-attach>true</dm:allow-attach>
<dm:allow-schedule>true</dm:allow-schedule>
<dm:allow-return-to-base>false</dm:allow-return-to-base>
<dm:allow-demote>false</dm:allow-demote>
<dm:return-conditions>
<dm:return-condition>ALL</dm:return-condition>
</dm:return-conditions>
</dm:state>
<dm:state>
<dm:name>review</dm:name>
<dm:index>1</dm:index>
<dm:no>1</dm:no>
<dm:exceptional>false</dm:exceptional>
<dm:exception-state>fail</dm:exception-state>
<dm:allow-attach>false</dm:allow-attach>
<dm:allow-schedule>true</dm:allow-schedule>
<dm:allow-return-to-base>true</dm:allow-return-to-base>
<dm:allow-demote>true</dm:allow-demote>
<dm:return-conditions>
<dm:return-condition>CHECKIN</dm:return-condition>
<dm:return-condition>SAVE_AS_NEW</dm:return-condition>
<dm:return-condition>BRANCH</dm:return-condition>
</dm:return-conditions>
<dm:user-criteria-service>
<dm:name>lifecyclemodule</dm:name>
</dm:user-criteria-service>
<dm:user-action-service>
<dm:name>lifecyclemodule</dm:name>
</dm:user-action-service>
<dm:user-post-service>
<dm:name>lifecyclemodule</dm:name>
</dm:user-post-service>
</dm:state>
<dm:state>
<dm:name>publish</dm:name>
<dm:index>2</dm:index>
<dm:no>2</dm:no>
<dm:exceptional>false</dm:exceptional>
<dm:allow-attach>false</dm:allow-attach>
<dm:allow-schedule>true</dm:allow-schedule>
<dm:allow-return-to-base>true</dm:allow-return-to-base>
<dm:allow-demote>true</dm:allow-demote>
<dm:return-conditions>
<dm:return-condition>BRANCH</dm:return-condition>
</dm:return-conditions>
<dm:user-criteria-service>
<dm:name>lifecyclemodule</dm:name>
</dm:user-criteria-service>
<dm:user-action-service>
<dm:name>lifecyclemodule</dm:name>
</dm:user-action-service>
<dm:user-post-service>
<dm:name>lifecyclemodule</dm:name>
</dm:user-post-service>
</dm:state>
<dm:state>
<dm:name>fail</dm:name>
<dm:index>3</dm:index>
<dm:no>3</dm:no>
<dm:exceptional>true</dm:exceptional>

EDCPKRST220200-PRE-EN-01 Reference Guide 391

Chapter 2 Resources

<dm:allow-attach>false</dm:allow-attach>
<dm:allow-schedule>true</dm:allow-schedule>
<dm:allow-return-to-base>false</dm:allow-return-to-base>
<dm:allow-demote>false</dm:allow-demote>
<dm:return-conditions>
<dm:return-condition>ALL</dm:return-condition>
</dm:return-conditions>
</dm:state>
</dm:states>
<dm:links>
<dm:link
href="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/
4600000580004dfc"
rel="self"/>
<dm:link
href="http://localhost:8080/dctm-rest/repositories/REPO/users/
dmadmin"
rel="http://identifiers.emc.com/linkrel/owner"/>
<dm:link
href="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_document"
rel="http://identifiers.emc.com/linkrel/type"
title="dm_document"/>
</dm:links>
</dm:lifecycle>
</content>
</entry>
</feed>

Example 2-154: JSON inline response

{
"id" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles",
"title" : "Lifecycles",
"author" : [
{
"name" : "OpenText Documentum"
}
],
"updated" : "2017-05-05T09:09:10.214+00:00",
"page" : 1,
"items-per-page" : 100,
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles?
inline=true"
}
],
"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"

392 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

}
],
"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" : {
"id" : "4600000580004dfb",
"name" : "a_docbasic_lifecycle",
"owner" : "dmadmin",
"created" : "2017-05-03T02:15:21.000+00:00",
"modified" : "2017-05-03T02:15:25.000+00:00",
"implementation-type" : "DOCBASIC",
"version-labels" : [
"1.0",
"CURRENT"
],
"status" : "INSTALLED",
"type-inclusions" : [
{
"type" : "dm_document",
"include-subtypes" : true
}
],
"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"
],
"entry-criteria" : {
"id" : "550000058000093b"
},

EDCPKRST220200-PRE-EN-01 Reference Guide 393

Chapter 2 Resources

"action" : {
"id" : "0800000580004e05"
}
},
{
"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"
],
"entry-criteria" : {
"id" : "550000058000093c"
},
"action" : {
"id" : "0800000580004e06"
}
},
{
"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/
4600000580004dfb"
},
{
"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"
}
]
}
},
{
"id" : "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/
4600000580004dfc",
"title" : "a_java_lifecycle",

394 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.37. Lifecycle (s)

"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" : {
"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" : {
"name" : "lifecyclemodule"
},
"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,

EDCPKRST220200-PRE-EN-01 Reference Guide 395

Chapter 2 Resources

"return-conditions" : [
"CHECKIN",
"SAVE_AS_NEW",
"BRANCH"
],
"user-criteria-service" : {
"name" : "lifecyclemodule"
},
"user-action-service" : {
"name" : "lifecyclemodule"
},
"user-post-service" : {
"name" : "lifecyclemodule"
}
},
{
"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" : {
"name" : "lifecyclemodule"
},
"user-action-service" : {
"name" : "lifecyclemodule"
},
"user-post-service" : {
"name" : "lifecyclemodule"
}
},
{
"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"

396 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.38. Lightweight Objects

},
{
"rel" : "http://identifiers.emc.com/linkrel/type",
"title" : "dm_document",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_document"
}
]
}
}
]
}

2.38 Lightweight Objects

The Lightweight Objects resource represents lightweight objects that share a
shareable object.

2.38.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “SysObject” on page 690 and About the Diagram on page 17.

2.38.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of lightweight objects.

• Feed Title: Objects
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: “SysObject” on page 690

EDCPKRST220200-PRE-EN-01 Reference Guide 397

Chapter 2 Resources

2.38.3 Link relations

Link relation Description Resource reference
self This Lightweight Objects “Lightweight Objects”
resource on page 397
first, last, next, previous Pagination links. “SysObject” on page 690

2.38.4 Operations
2.38.4.1 Supported HTTP methods

Method Description
POST Creates a new lightweight object that shares
this shareable object
GET Retrieves all lightweight objects that share
this shareable object

2.38.4.2 Create a lightweight object

Create a lightweight object and share this shareable object.

Note: While creating the lightweight object, if a lightweight object modifies the
shared properties, then the lightweight object is materialized. This mechanism
of lightweight type is called as auto materialized.

One shared object can only be shared by one kind of lightweight type object at
the same time.

2.38.4.2.1 HTTP Request method and query parameters

POST

2.38.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

398 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.38. Lightweight Objects

2.38.4.2.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.38.4.2.4 Request body

Example 2-155: XML request

<?xml version="1.0" encoding="UTF-8"?>
<object>
<properties>
<object_name>xyz</object_name>
<r_object_type>lightweight type</r_object_type>
...
</properties>
</object>

Example 2-156: JSON request

{
"name":"object",
"properties":{
"object_name":"xyz",
"r_object_type":"lightweight type",
...
}
}

2.38.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 399

Chapter 2 Resources

2.38.4.2.6 Response media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

2.38.4.2.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.38.4.2.8 Response body

Example 2-157: XML response

<?xml version="1.0" encoding="UTF-8"?>

<object>
<properties>
<object_name>xyz</object_name>
<r_object_id>090020808001398e</r_object_id>
...
</properties>
<links>
<link rel="self" href="{objectResourceUri}"/>
...
</links>
</object>

Example 2-158: JSON response

{
"name":"object",
"type":"dm_sysobject",
"definition":"",
"properties":{
"object_name":"xyz",
"r_object_id":"090020808001398e",
...
}
"links":[
{ "rel":"self", "href":"objectResourceUri"},
...
]
}

400 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.38. Lightweight Objects

2.38.4.3 Get the Lightweight Objects of a shared Object

GET all the lightweight objects of the specified shared parent object.

2.38.4.3.1 HTTP Request method and query parameters

GET

• inline
• items-per-page

• view

• include-total

• page

• sort

• filter

• links

• q

Note: The view, sort, and filter query parameters do not support the
properties of the shared parent.

For example, an exception may be thrown when view=i_folder_id&inline=

true.

The q parameter is supported for full text searching with a subset of the Simple
Search Language, however parenthesis are not supported.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.38.4.3.2 Request media types

N/A

2.38.4.3.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 401

Chapter 2 Resources

2.38.4.3.4 Request body

N/A

2.38.4.3.5 Response headers

• Content-Type
• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.38.4.3.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.38.4.3.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.38.4.3.8 Response body

Example 2-159: XML response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/
0800000580005381/lw-objects</id>
<title>Objects</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2015-12-28T07:31:31.795+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/objects/
0800000580005381/lw-objects?inline=true" rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/objects/
0800000580005d9a</id>
<title>new lightweight 29</title>
<author>
<name>dave</name>

402 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.38. Lightweight Objects

<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/
dave</uri>
</author>
<summary>my_lightweight_object 0800000580005d9a</summary>
<updated>2015-12-28T07:00:24.000+00:00</updated>
<published>2015-12-28T07:00:24.000+00:00</published>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0800000580005d9a" rel="edit"/>
<content>
<dm:object definition="http://localhost:8080/dctm-rest/
repositories/REPO/
types/my_lightweight_object"
xmlns:dm="http://identifiers.emc.com/vocab/documentum"
xsi:type="my_lightweight_object">
<dm:properties>
<dm:object_name>new lightweight 29</dm:object_name>
<dm:i_sharing_parent>0800000580005381</dm:i_sharing_parent>
<dm:r_object_type>my_lightweight_object</dm:r_object_type>
<dm:r_page_cnt>0</dm:r_page_cnt>
<dm:r_object_id>0800000580005d9a</dm:r_object_id>
<dm:r_modify_date>2015-12-28T07:00:24.000+00:00
</dm:r_modify_date>
<dm:owner_name>dave</dm:owner_name>
<dm:creation-date>2015-12-28T07:00:24.000+00:00
</dm:creation-date>
</dm:properties>
<dm:links>
<link href="http://localhost:8080/dctm-rest/repositories/
REPO/
objects/0800000580005d9a" rel="self"/>
...
</dm:links>
</dm:object>
</content>
</entry>
</feed>

Example 2-160: JSON response

{
"id" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0800000580005381/
lw-objects",
"title" : "Objects",
"author" : [
{
"name" : "OpenText Documentum"
}
],
"updated" : "2015-12-28T07:57:27.299+00:00",
"page" : 1,
"items-per-page" : 100,
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0800000580005381/lw-objects?inline=true"
}
],

EDCPKRST220200-PRE-EN-01 Reference Guide 403

Chapter 2 Resources

"entries" : [
{
"id" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0800000580005d9a",
"title" : "new lightweight 29",
"author" : [
{
"name" : "dave",
"uri" : "http://localhost:8080/dctm-rest/repositories/REPO/users/
dave"
}
],
"summary" : "my_lightweight_object 0800000580005d9a",
"updated" : "2015-12-28T07:00:24.000+00:00",
"published" : "2015-12-28T07:00:24.000+00:00",
"links" : [
{
"rel" : "edit",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0800000580005d9a"
}
],
"content" : {
"name" : "object",
"type" : "my_lightweight_object",
"definition" : "http://localhost:8080/dctm-rest/repositories/REPO/
types/
my_lightweight_object",
"properties" : {
"object_name" : "new lightweight 29",
"i_sharing_parent" : "0800000580005381",
"r_object_type" : "my_lightweight_object",
"r_page_cnt" : 0,
"r_object_id" : "0800000580005d9a",
"r_modify_date" : "2015-12-28T07:00:24.000+00:00",
"owner_name" : "dave",
"creation-date" : "2015-12-28T07:00:24.000+00:00"
},
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/
objects/
0800000580005d9a"
},
...
]
}
}
]
}

404 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.39. Lightweight Object Parent

2.39 Lightweight Object Parent

The Lightweight Object Parent resource represents the parent sharable object of a
lightweight object.

2.39.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “SysObject” on page 690 and About the Diagram on page 17.

2.39.2 Feed
No feed support.

2.39.3 Link relations

Link relation Description Resource reference
self This Lightweight Object “Lightweight Object Parent”
Parent resource on page 405
This resource also has all of the same link relations as the “SysObject” on page 690 resource.

2.39.4 Operations
2.39.4.1 Supported HTTP methods

Method Description
GET Retrieves the lightweight parent shareable
object
POST Reassign the parent to another shareable
object

EDCPKRST220200-PRE-EN-01 Reference Guide 405

Chapter 2 Resources

2.39.4.2 Get the Parent Shareable Object

Get the parent shareable object of a lightweight object.

2.39.4.2.1 HTTP Request method and query parameters

GET

• view
• links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.39.4.2.2 Request media types

N/A

2.39.4.2.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.39.4.2.4 Request body

N/A

2.39.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.39.4.2.6 Response media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

406 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.39. Lightweight Object Parent

2.39.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.39.4.2.8 Response body

Example 2-161: XML response

<?xml version="1.0" encoding="UTF-8"?>
<object>
<properties>
<object_name>xyz</object_name>
<r_object_id>090020808001398e</r_object_id>
...
</properties>
<links>
<link rel="self" href="{objectResourceUri}"/>
...
</links>
</object>

Example 2-162: JSON response

{
"name":"object",
"type":"shareable_type",
"definition":"",
"properties":{
"object_name":"xyz",
"r_object_id":"090020808001398e",
...
}
"links":[
{ "rel":"self", "href":"objectResourceUri"},
...
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 407

Chapter 2 Resources

2.39.4.3 Reassign the parent a lightweight object

Reassign the parent of the lightweight object to another shareable object.

2.39.4.3.1 HTTP Request method and query parameters

POST

2.39.4.3.2 Request media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

2.39.4.3.3 Request headers

• Accept

• Authorization

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.39.4.3.4 Request body

Example 2-163: XML request

<?xml version="1.0" encoding="UTF-8"?>

<dm:object href="http://localhost/dctm-rest/repositories/acme/objects/xxxxx"/>

Example 2-164: JSON request

{
"href":"http://localhost/dctm-rest/repositories/acme/objects/xxxxx"
}

2.39.4.3.5 Response headers

• Content-Type

• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

408 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.39. Lightweight Object Parent

2.39.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.39.4.3.7 Response status

• 200 - New parent successfully assigned

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.39.4.3.8 Response body

The same as the “SysObject” on page 690 resource.

Example 2-165: XML response

<?xml version="1.0" encoding="UTF-8"?>

<object xmlns="http://identifiers.emc.com/vocab/documentum"
definition="{typeResourceUri}"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="shareable_type">
<properties>
<object_name>xyz</object_name>
<r_object_id>090020808001398e</r_object_id>
...
</properties>
<links>
<link rel="self" href="{documentResourceUri}"/>
...
</links>
</document>

Example 2-166: JSON response

{
"name":"document",
"type":"shareable_type",
"definition":"<documentResourceUri>",
"properties":{
"object_name":"xyz",
"r_object_id":"090020808001398e",
...
}
"links":[
{ "rel":"self", "href":"<documentResourceUri>"},
...
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 409

Chapter 2 Resources

2.40 Lightweight Object Materialization

The Lightweight Object Materialization resource represents the materialization
of a lightweight object.

2.40.1 Feed
No feed support.

2.40.2 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “SysObject” on page 690 and About the Diagram on page 17.

2.40.3 Link relations

Link relation Description Resource reference
self This Lightweight Object “Lightweight Object
Parent resource Materialization” on page 410
The same relations as “SysObject” on page 690.

2.40.4 Operations
2.40.4.1 Supported HTTP methods

Method Description
PUT Materialize the lightweight object
DELETE Dematerialize the lightweight object

410 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.40. Lightweight Object Materialization

2.40.4.2 Materialize the lightweight object

Materializes an unmaterialized lightweight object.

2.40.4.2.1 HTTP Request method and query parameters

PUT

2.40.4.2.2 Request media types

N/A

2.40.4.2.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.40.4.2.4 Request body

N/A

2.40.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.40.4.2.6 Response media types

• application/vnd.emc.documentum+xml

• application/xml

• application/vnd.emc.documentum+json

• application/json

2.40.4.2.7 Response status

• 200 - Materialized successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 411

Chapter 2 Resources

2.40.4.2.8 Response body

Example 2-167: XML response

<?xml version="1.0" encoding="UTF-8"?>
<object>
<properties>
<object_name>xyz</object_name>
<r_object_id>090020808001398e</r_object_id>
...
</properties>
<links>
<link rel="self" href="{objectResourceUri}"/>
<link rel="http://identifiers.emc.com/linkrel/dematerialize" href=""/>
<link rel="http://identifiers.emc.com/linkrel/parent" href=""/>
...
</links>
</object>

Example 2-168: JSON response

{
"name":"object",
"type":"dm_sysobject",
"definition":"",
"properties":{
"object_name":"xyz",
"r_object_id":"090020808001398e",
...
}
"links":[
{ "rel":"self", "href":"objectResourceUri"},
{ "rel":"http://identifiers.emc.com/linkrel/dematerialize", "href":""},
{ "rel":"http://identifiers.emc.com/linkrel/parent", "href":""},
...
]
}

2.40.4.3 Dematerialize a lightweight object

Dematerialize a materialized lightweight object.

2.40.4.3.1 HTTP Request method and query parameters

DELETE

412 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.41. Lock

2.40.4.3.2 Request media types

N/A

2.40.4.3.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.40.4.3.4 Request body

N/A

2.40.4.3.5 Response headers

N/A

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.40.4.3.6 Response media types

N/A

2.40.4.3.7 Response status

• 204 - Dematerialized successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.40.4.3.8 Response body

N/A

2.41 Lock
The Lock resource represents a lock of the SysObject.

EDCPKRST220200-PRE-EN-01 Reference Guide 413

Chapter 2 Resources

2.41.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “SysObject” on page 690 and About the Diagram on page 17.

2.41.2 Feed
No feed support.

2.41.3 Link relations

The Lock resource is used as a link relation in the SysObject resource. See
“SysObject” on page 690.

2.41.4 Operations
2.41.4.1 Supported HTTP methods

Method Description
PUT Checks out a SysObject.
DELETE Cancels a check-out operation on a SysObject.

2.41.4.2 Check out (lock) an object

Check out a SysObject.

2.41.4.2.1 HTTP Request method and query parameters

PUT

414 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.41. Lock

2.41.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.41.4.2.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.41.4.2.4 Request body

N/A

2.41.4.2.5 Response headers

• Content-Type

2.41.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.41.4.2.7 Response status

• 200 - Checked out successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.41.4.2.8 Response body

XML or JSON representation of the object. A successful response contains all

properties of the checked out object.

EDCPKRST220200-PRE-EN-01 Reference Guide 415

Chapter 2 Resources

2.41.4.3 Cancel the check-out (unlock) operation on an object.

Cancel the check-out operation on a SysObject.

2.41.4.3.1 HTTP Request method and query parameters

DELETE

2.41.4.3.2 Request media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

2.41.4.3.3 Request headers

• Authorization

• Accept

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.41.4.3.4 Request body

N/A

2.41.4.3.5 Response headers

N/A

2.41.4.3.6 Response media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

2.41.4.3.7 Response status

• 204 - Unlocked successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

416 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.42. Module(s)

2.41.4.3.8 Response body

HTTP 204 No Content status upon a successful unlock operation. The Response body
contains no content.

2.42 Module(s)
2.42.1 Module
The Module resource represents an object instance of a module.

2.42.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “SysObject” on page 690 and About the Diagram on page 17.

2.42.1.2 Feed
No feed support.

2.42.1.3 Link relations

Link relation Description Resource reference

self This Module resource “Module” on page 417
edit Edit this Module resource “Module” on page 417

2.42.1.4 Operations
2.42.1.4.1 Supported HTTP methods

Method Description
GET Retrieves an instance of a givenModule.
POST Updates an instance of a given Module.

EDCPKRST220200-PRE-EN-01 Reference Guide 417

Chapter 2 Resources

2.42.1.4.2 Get Module details

Using the specified module id, this method retrieves the specified Module instance
details.

Each Module instance has five attributes:

• name: The name of the resource object.

• id: The id of the module.
• moduleName: The name of the module.
• description: A brief description of the module.
• Status: The current state of whether the module is enabled or disabled.

2.42.1.4.2.1 HTTP Request method and query parameters

GET

2.42.1.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.42.1.4.2.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.42.1.4.2.4 Request body

N/A

2.42.1.4.2.5 Response headers

• Content-Type

418 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.42. Module(s)

2.42.1.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json

2.42.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.42.1.4.2.8 Response body

XML or JSON representation of the Module object instance. A successful Response

contains all of the properties of the retrieved Module instance.

Example 2-169: JSON Response

...
{
"name": "module",
"id": "PRM",
"description": "Physical Records Management provides functions to model
physical objects in Documentum and also provides library
services.",
"status": "enabled",
"moduleName": "Physical Records Manager",
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/documentum2/modules/pRM"
}
]
}

Example 2-170: Request

Accept: application/vnd.emc.documentum+json

GET http://localhost/dctm-rest/repositories/documentum2/modules/RPS

Example 2-171: JSON Response

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+json;charset=UTF-8
Date: Tue, 16 Oct 2012 01:27:01 GMT
Server: Apache-Coyote/1.1
Transfer-Encoding: chunked

EDCPKRST220200-PRE-EN-01 Reference Guide 419

Chapter 2 Resources

{
"name": "module",
"id": "RPS",
"description": "Automates policy-based storage and archival of content.",
"status": "disabled",
"moduleName": "Retension Policy Services",
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/documentum2/
modules/rps"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/documentum2/
modules/RPS"
}
]
}

2.42.1.4.3 Update the Module status to enabled

Update the module status to the enabled state by providing the valid license key.
When the client provides a valid license key in the Request body, the status of the
module is updated to the enabled state. When the client provides an invalid license
key in the Request body, the server throws an exception. In this case, the user is not
authorized to disable the module.

2.42.1.4.3.1 HTTP Request method and query parameters

POST

2.42.1.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.42.1.4.3.3 Request headers

• Authorization
• Accept
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

420 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.42. Module(s)

2.42.1.4.3.4 Request body

Module instance in XML or JSON representation. Only the use of the licensekey
attribute is allowed the message body.

Example 2-172: JSON Request

{
"licensekey":"value1"
}

2.42.1.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.42.1.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.42.1.4.3.7 Response status

• 200 - Updated successfully

• 400, 401, 403, 404, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.42.1.4.3.8 Response body

The details, in XML or JSON, of a single Module instance. A successful Response

contains the attributes of the specified module, and updates the status to enabled.

Example 2-173: JSON Response

...

{
"name": "module",
"id": "PRM",
"description": "Physical Records Management provides functions to model
physical objects in Documentum and also provides library
services.",
"status": "enabled",
"moduleName": "Physical Records Manager",
"links": [
{
"rel": "self",

EDCPKRST220200-PRE-EN-01 Reference Guide 421

Chapter 2 Resources

"href": "http://localhost:8080/dctm-rest/repositories/documentum2/
modules/pRM"
}
]
}

Example 2-174: Request

POST http://10.37.10.116:8080/dctm-rest/repositories/acme01/modules/FRS
Accept:application/vnd.emc.documentum+json
Content-Type:application/vnd.emc.documentum+xml
Authorization:Basic ZG1hZG1pbjpwYXNzd29yZA==

{
"license_key":"HKLMPOST"
}

Example 2-175: JSON Response

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"name": "module",
"id": "PRM",
"description": "Physical Records Management provides functions to model
physical objects in Documentum and also provides library
services.",
"status": "enabled",
"moduleName": "Physical Records Manager",
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/documentum2/
modules/pRM"
}
]
}

2.42.2 Modules
The Modules collection resource represents a collection of licensed modules in a
repository.

422 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.42. Module(s)

2.42.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.42.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: Modules
• Feed Updated: The current time
• Entry: “Module” on page 417
• Supports POST: No

2.42.2.3 Link relations

Link relation Description Resource reference

self The current collection of licensed Modules
modules

2.42.2.4 Operations
2.42.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a collection of licensed modules in
a repository.

EDCPKRST220200-PRE-EN-01 Reference Guide 423

Chapter 2 Resources

2.42.2.4.2 Get licensed Modules

Retrieves a list of all licensed modules in a repository.

2.42.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET inline Determines boolean true or false
whether to false
show content
(the object true -
instance) in Returns an
an atom entry object
for a instance,
collection. which is put
into the
entry's
content
element.

false - Does
not return
anything.
links Determines boolean true or true
whether a false
link relation
is returned true - The
for this object default value.
representatio
n. false -
means "do
not send me
any links that
are expensive
to calculate,
but it is fine if
you send me
ones that are
cheap"

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

424 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.42. Module(s)

2.42.2.4.2.2 Request media types

N/A

2.42.2.4.2.3 Request headers

• Accept
• Content-Type
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.42.2.4.2.4 Request body

N/A

2.42.2.4.2.5 Response headers

• Content-Type
• Content-Length

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.42.2.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json

2.42.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.42.2.4.2.8 Response body

An XML or JSON representation of the licensed modules collection.

• The body contains a list of licensed modules for a repository.

Example 2-176: JSON

1
2
3 {
4 "id": "http://localhost:8080/dctm-rest/repositories/documentum1/modules",
5 "title": "Modules",
6 "author": [{

EDCPKRST220200-PRE-EN-01 Reference Guide 425

Chapter 2 Resources

7 "name": "Open Text Documentum"

8 }
9 ],
10 "updated": "2020-02-04T10:31:38.208+00:00",
11 "page": 1,
12 "items-per-page": 1000,
13 "total": 5,
14 "links": [{
15 "rel": "self",
16 "href": "http://localhost:8080/dctm-rest/repositories/documentum1/
17 modules"
18 }
19 ],
20 "entries": [{
21 "id": "http://localhost:8080/dctm-rest/repositories/documentum1/
22 modules/RM",
23 "title": "Records Manager",
24 "summary": "Enable the capability for clients to declare formal records
25 and create relationships among these records. Allows
26 administrators to configure and apply policies to create
27 their own file plans.
28 Requires RPS to also be licensed. - Enabled",
29 "updated": "2020-02-04T10:31:38.209+00:00",
30 "published": "2020-02-04T10:31:38.209+00:00",
31 "links": [{
32 "rel": "edit",
33 "href": "http://localhost:8080/dctm-rest/repositories/
34 documentum1/modules/RM"
35 }
36 ],
37 "content": {
38 "type": "application/vnd.emc.documentum+json",
39 "src": "http://localhost:8080/dctm-rest/repositories/documentum1/
40 modules/RM"
41 }
42 },
43 ...
44 ]
45 }

Example 2-177: Request

1
2
3 Accept: application/vnd.emc.documentum+json
4
5 GET http://localhost/dctm-rest/repositories/documentum1/modules?inline=true

Example 2-178: Response

1
2
3 Status Code: 200 OK
4 Content - Type: application / vnd.emc.documentum + json;
5 charset = UTF - 8
6 Date: Tue, 16 Oct 2012 01: 27: 01 GMT
7 Server: Apache - Coyote / 1.1
8 Transfer - Encoding: chunked
9
10 {
11 "id": "http://localhost:8080/dctm-rest/repositories/documentum1/modules",
12 "title": "Modules",

426 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.42. Module(s)

13 "author": [
14 {
15 "name": "Open Text Documentum"
16 }
17 ],
18 "updated": "2020-02-04T09:35:39.361+00:00",
19 "page": 1,
20 "items-per-page": 1000,
21 "total": 5,
22 "links": [
23 {
24 "rel": "self",
25 "href": "http://localhost:8080/dctm-rest/repositories/documentum1/
26 modules?inline=true"
27 }
28 ],
29 "entries": [
30 {
31 "id": "http://localhost:8080/dctm-rest/repositories/documentum1/modules/
32 RM",
33 "title": "Records Manager",
34 "summary": "Enable the capability for clients to declare formal records
35 and create relationships among these records.Allows
36 administrators to configure and apply policies to create
37 their own file plans.
38 Requires RPS to also be licensed. - Enabled",
39 "updated": "2020-02-04T09:35:39.363+00:00",
40 "published": "2020-02-04T09:35:39.363+00:00",
41 "links": [
42 {
43 "rel": "edit",
44 "href": "http://localhost:8080/dctm-rest/repositories/documentum1/
45 modules/RM"
46 }
47 ],
48 "content": {
49 "name": "module",
50 "id": "RM",
51 "description": "Enable the capability for clients to declare formal
52 records and create relationships among these records.
53 Allows administrators to configure and apply policies
54 to create their own file plans.Requires RPS to also
55 be licensed.",
56 "status": "enabled",
57 "moduleName": "Records Manager",
58 "links": [
59 {
60 "rel": "self",
61 "href": "http://localhost:8080/dctm-rest/repositories/
62 documentum1/modules/RM"
63 }
64 ]
65 }
66 },
67 {
68 "id": "http://localhost:8080/dctm-rest/repositories/documentum1/modules/
69 RPS",
70 "title": "Retension Policy Services",
71 "summary": "Automates policy-based storage and archival of
72 content. - Enabled",
73 "updated": "2020-02-04T09:35:39.363+00:00",
74 "published": "2020-02-04T09:35:39.363+00:00",
75 "links": [
76 {
77 "rel": "edit",
78 "href": "http://localhost:8080/dctm-rest/repositories/documentum1/
79 modules/RPS"
80 }
81 ],
82 "content": {

EDCPKRST220200-PRE-EN-01 Reference Guide 427

Chapter 2 Resources

83 "name": "module",
84 "id": "RPS",
85 "description": "Automates policy-based storage and archival of
86 content.",
87 "status": "enabled",
88 "moduleName": "Retension Policy Services",
89 "links": [
90 {
91 "rel": "self",
92 "href": "http://localhost:8080/dctm-rest/repositories/
93 documentum1/modules/RPS"
94 }
95 ]
96 }
97 },
98 {
99 "id": "http://localhost:8080/dctm-rest/repositories/documentum1/modules/
100 PRM",
101 "title": "Physical Records Manager",
102 "summary": "Physical Records Management provides functions to model
103 physical objects in Documentum and also provides library
104 services. - Enabled",
105 "updated": "2020-02-04T09:35:39.363+00:00",
106 "published": "2020-02-04T09:35:39.363+00:00",
107 "links": [
108 {
109 "rel": "edit",
110 "href": "http://localhost:8080/dctm-rest/repositories/documentum1/
111 modules/PRM"
112 }
113 ],
114 "content": {
115 "name": "module",
116 "id": "PRM",
117 "description": "Physical Records Management provides functions to
118 model physical objects in Documentum and also
119 provides library services.",
120 "status": "enabled",
121 "moduleName": "Physical Records Manager",
122 "links": [
123 {
124 "rel": "self",
125 "href": "http://localhost:8080/dctm-rest/repositories/
126 documentum1/modules/PRM"
127 }
128 ]
129 }
130 },
131 {
132 "id": "http://localhost:8080/dctm-rest/repositories/documentum1/modules/
133 FRS",
134 "title": "Federated Record Services",
135 "summary": "Manages records, valuable and discoverable corporate assets,
136 across the enterprise or multiple repositories. - Enabled",
137 "updated": "2020-02-04T09:35:39.364+00:00",
138 "published": "2020-02-04T09:35:39.364+00:00",
139 "links": [
140 {
141 "rel": "edit",
142 "href": "http://localhost:8080/dctm-rest/repositories/documentum1/
143 modules/FRS"
144 }
145 ],
146 "content": {
147 "name": "module",
148 "id": "FRS",
149 "description": "Manages records, valuable and discoverable corporate
150 assets, across the enterprise or multiple
151 repositories.",
152 "status": "enabled",

428 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.43. Multiple Repository Search

153 "moduleName": "Federated Record Services",

154 "links": [
155 {
156 "rel": "self",
157 "href": "http://localhost:8080/dctm-rest/repositories/
158 documentum1/modules/FRS"
159 }
160 ]
161 }
162 },
163 {
164 "id": "http://localhost:8080/dctm-rest/repositories/documentum1/
165 modules/Collaboration",
166 "title": "Collaborative Edition",
167 "summary": "Provides Web-based collaborative workplace. - Enabled",
168 "updated": "2020-02-04T09:35:39.364+00:00",
169 "published": "2020-02-04T09:35:39.364+00:00",
170 "links": [
171 {
172 "rel": "edit",
173 "href": "http://localhost:8080/dctm-rest/repositories/documentum1/
174 modules/Collaboration"
175 }
176 ],
177 "content": {
178 "name": "module",
179 "id": "Collaboration",
180 "description": "Provides Web-based collaborative workplace.",
181 "status": "enabled",
182 "moduleName": "Collaborative Edition",
183 "links": [
184 {
185 "rel": "self",
186 "href": "http://localhost:8080/dctm-rest/repositories/
187 documentum1/modules/Collaboration"
188 }
189 ]
190 }
191 }
192 ]
193 }

2.43 Multiple Repository Search

The Multiple Repository Search resource allows you to define multiple repositories as
the scope of a search and obtain search results from all of those repositories with one
HTTP request.

Note: Currently, only repositories from Documentum Content Server are

supported.

EDCPKRST220200-PRE-EN-01 Reference Guide 429

Chapter 2 Resources

2.43.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Home Document” on page 331 and About the Diagram on page 17.

2.43.2 Feed
This resource is a feed that wraps the search results returned from all repositories
that were specified by the client in the search criteria. Each entry represents an object
within one of the repositories.

• Feed ID: Resource URI

• Feed Title: Search results of the repositories
• Feed Updated: Current server time
• Supports POST: Yes
• Entry: Search results
• Entry ID: The object id of an object returned in the search results
• Entry Title: The object name of an object returned in the search results
• Entry Updated: Current server time

2.43.3 Link relations

Link relation Description Resource reference
self The URI of the current search “Multiple Repository Search”
on page 429
search [1] The URI template for any “Multiple Repository Search”
subsequent searches on page 429
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

Note: Since pagination is not effective in this resource, pagination link

relations, such as previous, last, first, and next, are not supported.

430 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.43. Multiple Repository Search

2.43.4 Operations
2.43.4.1 Result range
This resource does not use any pagination parameters, such as page and items-per-
page, to determine the range of the search in the way that the Single Search
Repository resource does. Instead, the start and limit URI parameters are used to
define the range of the search for each repository separately. For example, if you
have REPO1 and REPO2 (assuming that they produce a sufficient number of search
results), and you use the start=1&limit=10 URI parameters for each of those
repositories. Using these URI parameters returns a total of 20 search results in the
Response. In this case, there are 10 results from REPO1 and 10 results from REPO2 that
are returned in the Response.

2.43.4.2 Supported HTTP methods

Method Description
GET Use URI parameters to search across many
repositories
POST Use AQL and URI parameters to search
across many repositories

2.43.4.3 Search by Get HTTP method

Search all repositories with global login information using the GET HTTP method.
Searching using the GET method does not allow you to choose the repositories to be
searched because all repository names that are available are cached after REST has
retrieved them for the first time.

If some of the repositories change, the cached repository names will become obsolete
after a certain amount of time. Detailed cache properties can be found and
customized (by overriding the default ones) in the rest-api-common-ehcache.xml
file, which is located at <dctm-rest.war>/WEB-INF/classes/.

2.43.4.3.1 HTTP Request method and query parameters

This resource uses the GET HTTP method and the following URI parameters. Most
URI parameters have the same usage as those of the Search resource. However,
some URI parameters are not supported.

The following table shows the details of the URI parameters:

EDCPKRST220200-PRE-EN-01 Reference Guide 431

Chapter 2 Resources

Parameter Parameter Support Description

Type
Common include-total Yes When only one repository is being searched, the
URI total field is returned.
parameters
When more than one repository is being
searched, a Map named total-for-each is
returned rather than the total field.
inline Yes
page No An exception is thrown when this parameter is
specified.
items-per- No An exception is thrown when this parameter is
page specified.
start Yes Defines the start index of the search range for
each repository.

The default value is 1.

limit Yes Defines the maximum size of the search range for
each repository.

The default value is 100.

sort Yes Sorts the search results of each repository.
view Yes • When no value for this view parameter is
specified, the :default attributes are:
– r_object_id
– object_namel
– r_object_type
– r_modify_date
– r_modifier
– summary
• :all not supported as it is the same
as :default
• Custom view is supported and it overwrites
the attributes of :default.
view=r_object_id,r_object_type&inline=true

This returns two attributes

Search URI q Yes A full-text expression as defined in Simple Search
parameters Language.
locations No A list of folder paths. The query is restricted to
these folders.
collections Yes A list of collection names. These names must
match the collections defined in xPlore.
object-type Yes Target object type to search against.

432 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.43. Multiple Repository Search

Parameter Parameter Support Description

Type
facet Yes Facet is applied across all repositories. A general
count of the search results for all of the
repositories is returned.
facet-value- Yes Constraints attributes for the facet parameter.
constraints
The format is facet-value-constraints=
attr_constraint_expression
query-locale Yes A locale used to evaluate the query and parse
words into a language dependent token.

Only supported with xPlore.

The default value is en.

2.43.4.3.2 Request media types

N/A

2.43.4.3.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.43.4.3.4 Request body

N/A

2.43.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.43.4.3.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

EDCPKRST220200-PRE-EN-01 Reference Guide 433

Chapter 2 Resources

2.43.4.3.7 Response status

• 200 - Retrieved successfully

• 201,204,400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.43.4.3.8 Response body

Example 2-179: XML response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/search</id>
<title>Search results</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2018-12-07T06:26:06.665+00:00</updated>
<dm:total-for-each xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:REPO>0</dm:REPO>
<dm:REPO1>2</dm:REPO1>
</dm:total-for-each>
<link rel="self"
href="http://localhost:8080/dctm-rest/search.xml?start=1&amp;limit=1">
</link>
<link rel="search"
hreftemplate="http://localhost:8080/dctm-rest/search.xml{?
collections,facet,include-total,inline,limit,locations,
object-type,q,start,timezone,view}"></link>
<entry>
<id>0c00000280002104</id>
<title>auditadmin1</title>
<author>
<name>dmadmin1</name>
</author>
<updated>2018-06-13T03:20:15.000+00:00</updated>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO1/objects/
0c00000280002104.xml"></link>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO1/objects/
0c00000280002104.xml"></content>
<relevance:score xmlns:relevance="http://a9.com/-/opensearch/extensions/
relevance/1.0/">1.0</relevance:score>
<dm:source xmlns:dm="http://identifiers.emc.com/vocab/documentum">
REPO1
</dm:source>
</entry>
</feed>

Example 2-180: JSON response

{
"id": "http://localhost:8080/dctm-rest/search",

434 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.43. Multiple Repository Search

"title": "Search results",

"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2018-12-07T06:27:02.819+00:00",
"total-for-each": {
"REPO": 0,
"REPO1": 2
},
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/search?start=1&limit=1"
}, {
"rel": "search",
"hreftemplate": "http://localhost:8080/dctm-rest/search{?collections,
facet,include-total,inline,limit,locations,
object-type,q,start,timezone,view}"
}
],
"entries": [{
"id": "0c00000280002104",
"title": "auditadmin1",
"author": [{
"name": "dmadmin1"
}
],
"updated": "2018-06-13T03:20:15.000+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
objects/0c00000280002104"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO1/objects/
0c00000280002104"
},
"score": "1.0",
"source": "REPO1"
}
]
}

Example 2-181: JSON + HAL response

{
"id": "http://localhost:8080/dctm-rest/search",
"title": "Search results",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2018-12-10T07:37:09.054+00:00",
"_embedded": {
"collection": [{
"id": "0900000280001629",
"title": "Doc-3.pdf",

EDCPKRST220200-PRE-EN-01 Reference Guide 435

Chapter 2 Resources

"author": [{
"name": "Administrator"
}
],
"summary": "Manage Document Versions in REST Services This doc
shows a series of JSON message samples to do
versioning in Documentum REST Services. Get a document
resource Assumed that you get a document resource.
GET http://localhost:8080/dctm-rest/repositories/rep",
"updated": "2018-11-09T12:52:14.000+00:00",
"score": "0.5375551581382751",
"terms": [
"java"
],
"source": "REPO1",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
objects/0900000280001629.hal"
}
}
}
]
},
"_links": {
"search": {
"href": "http://localhost:8080/dctm-rest/search.hal{?collections,
facet,include-total,inline,limit,locations,object-type,q,
start,timezone,view}",
"templated": true
},
"self": {
"href": "http://localhost:8080/dctm-rest/search.hal?q=java"
}
}
}

2.43.4.4 Search by POST HTTP method

The POST HTTP method allows you to search across multiple repositories using
AQL and URI parameters. You can define the target repository (or repositories)
using AQL. By default, all available repositories are searched when no target
repository is specified in AQL. Just like searching with the GET HTTP method, these
default repository names are cached.

436 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.43. Multiple Repository Search

2.43.4.4.1 HTTP Request method and query parameters

Many URI parameters are not supported because their functions are covered in
AQL. The following table shows more details:

Parameter Parameter Support Description

Type
Common include-total Yes When only one repository is being searched the
URI field, total is returned.
parameters
When more than one repository is being searched, a
Map named total-for-each is returned rather
than total.
inline Yes
page No An exception is thrown when this parameter is
specified.
items-per- No An exception is thrown when this parameter is
page specified.
start Yes Defines the starting index of the search range for
each repository.

The default value is 1.

limit Yes Defines the maximum size of the search range for
each repository.

The default value is 100.

sort No
view No
Search URI q No
parameters
locations No
collections No
object-type No
facet No
facet-value- No
constraints
facet-id- Yes It contains pairs of facet id and its constraints.
constraints
For example, the expression below has two facet
constraints:
• id1 is the facet for the r_object_type property
• id2 is the facet for the owner_name property
facet-id-
constraints=id1%3Ddm_document,id2%3dAdministrator

EDCPKRST220200-PRE-EN-01 Reference Guide 437

Chapter 2 Resources

Parameter Parameter Support Description

Type
query-locale Yes A locale used to evaluate the query and parse
words into a language dependent token.

Only supported with xPlore.

The default value is en.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.43.4.4.2 Request media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.43.4.4.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.43.4.4.4 Request body

For more information, see Appendix E, AQL on page 991 for a complete definition.

When working with this resource, please note the following items:

• The repositories element specified in the AQL defines the scope of the
searching procedure.
• Repository names are validated before the search begins. An error message is
shown when an invalid repository name is specified.
• When the repositories element is not provided, then by default all repositories
are searched.

Example 2-182: An XML request

<search xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<types>
<type>dm_document</type>
</types>
<repositories>
<repository>REPO8</repository>

438 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.43. Multiple Repository Search

<repository>REPO1</repository>
</repositories>
<expression-set operator="AND">
<expressions>
<fulltext>REST</fulltext>
<property name="object_name" operator="BEGINS_WITH">Doc</property>
<property-list name="owner_name" operator="IN">
<values>
<value>Administrator</value>
</values>
</property-list>
<property-range name="r_full_content_size" operator="BETWEEN">
<from>130000</from>
<to>900000</to>
</property-range>
</expressions>
</expression-set>
</search>

Example 2-183: A JSON request

{
"types": ["dm_document"],
"repositories": ["REPO1"],
"expression-set": {
"expression-type": "expression-set",
"operator" : "AND",
"expressions": [
{
"expression-type": "property",
"name": "object_name",
"operator": "CONTAINS",
"value": "Doc"
},
{
"expression-type": "fulltext",
"value": "rest"
},
{
"expression-type": "property-range",
"name": "r_content_size",
"operator": "BETWEEN",
"from": "0",
"to": "100000"
}
]
}
}

EDCPKRST220200-PRE-EN-01 Reference Guide 439

Chapter 2 Resources

2.43.4.4.5 Response headers

• Content-Type
• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.43.4.4.6 Response media types

N/A

2.43.4.4.7 Response status

• 200 - Retrieved successfully

• 201, 204, 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.43.4.4.8 Response body

The Response body is the same as the one shown for the GET method above.

Example 2-184: XML response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/search</id>
<title>Search results</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2018-12-07T06:26:06.665+00:00</updated>
<dm:total-for-each xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:REPO>0</dm:REPO>
<dm:REPO1>2</dm:REPO1>
</dm:total-for-each>
<link rel="self" href="http://localhost:8080/dctm-rest/search.xml?start=1
&amp;limit=1"/>
<link rel="search" hreftemplate="http://localhost:8080/dctm-rest/
search.xml{?collections,facet,include-total,inline,limit,locations,
object-type,q,start,timezone,view}"/>
<entry>
<id>0c00000280002104</id>
<title>auditadmin1</title>
<author>
<name>dmadmin1</name>
</author>
<updated>2018-06-13T03:20:15.000+00:00</updated>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO1/objects/
0c00000280002104.xml"/>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO1/objects/

440 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.43. Multiple Repository Search

0c00000280002104.xml"/>
<relevance:score xmlns:relevance="http://a9.com/-/opensearch/extensions/
relevance/1.0/">1.0</relevance:score>
<dm:source xmlns:dm="http://identifiers.emc.com/vocab/documentum">REPO1
</dm:source>
</entry>
</feed>

Example 2-185: JSON response

{
"id": "http://localhost:8080/dctm-rest/search",
"title": "Search results",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-12-07T06:27:02.819+00:00",
"total-for-each": {
"REPO": 0,
"REPO1": 2
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/search?start=1&limit=1"
},
{
"rel": "search",
"hreftemplate": "http://localhost:8080/dctm-rest/search{?collections,
facet,include-total,inline,limit,locations,
object-type,q,start,timezone,view}"
}
],
"entries": [
{
"id": "0c00000280002104",
"title": "auditadmin1",
"author": [
{
"name": "dmadmin1"
}
],
"updated": "2018-06-13T03:20:15.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
objects/0c00000280002104"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO1/objects
/0c00000280002104"
},
"score": "1.0",
"source": "REPO1"

EDCPKRST220200-PRE-EN-01 Reference Guide 441

Chapter 2 Resources

}
]
}

2.43.5 Authentication
This section describes the authentication modes used for this resource and some
important details.

2.43.5.1 Credentials usages

Every Request for this resource, which uses a URL pattern like /search*, must
contain login credentials for authentication.

The login credentials provided by users have two purposes:

• Retrieve a global DFC session from the Global Registry Repository of Content
Server to use for all subsequent search operations.
• Provide authentication information for every target repository.

2.43.5.1.1 Search authentication

• Every repository including the global registry repository must have a user that
has the same username. Further, when the underlying authentication scheme
requests a password, then this user must also have the same password.
• When the credentials provided are only valid for just one repository (or for just
part of all of the specified repositories), then the REST server will throw an
authentication error and no results will be returned.

2.43.5.2 Authentication modes

The following modes can be used to authenticate for this resource:

• Http Basic('basic')
• Client Token('ct-basic')
• OTDS

– otds_password
– otds_token
– ct-otds_password
– ct-otds_token
– otds_token-basic
– ct-otds_token-basic

442 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.44. Network Location (s)

2.43.5.2.1 Configuration for client token

Any authentication mode that has a ct- prefix uses REST CT (Client Token) and a
Content Server login ticket for authentication. When one of these authentication
modes are used to search repositories, every repository being searched must be
configured to trust other repositories, at minimum they must be configured to trust
the global registry repository. Also, all repositories being searched must allow the
use of a global login ticket, which must have the same Login Ticket Key (LTK), from
another repository in order to insure that the global login ticket works.

For more information, see the OpenText Documentum Server Fundamentals Guide.

2.43.5.2.2 Configuration for OTDS

A repository is referred to as a Resource in OTDS.

A global user must exist, or be created, in every repository before that global user
can be used with an OTDS related authentication mode to login. The global user
must be able to access every repository in OTDS. Therefore, an SSO (Single Sign On)
access token, which can be used for a Multiple Repository Search and other single
repository resources, is issued to the global user.

2.44 Network Location (s)

2.44.1 Network Location
The Network Location resource represents a network location, which is an instance
of dm_network_location_map, that is stored in a repository.

2.44.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Network Locations” on page 446 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 443

Chapter 2 Resources

2.44.1.2 Feed
No feed support.

2.44.1.3 Link relations

Link relation Description Resource reference

self This network location “Network Location”
resource. on page 443

2.44.1.4 Operations
2.44.1.4.1 Supported HTTP methods

Method Description
GET Retrieves the metadata of a network location
(an instance of dm_network_location_
map) in the repository.

2.44.1.4.2 Get a Network Location

Retrieves the metadata of a network location (an instance of dm_network_location_

map) specified by the identifier.

2.44.1.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• view
• links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.44.1.4.2.2 Request media types

N/A

444 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.44. Network Location (s)

2.44.1.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.44.1.4.2.4 Request body

N/A

2.44.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.44.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.44.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.44.1.4.2.8 Response body

XML or JSON representation of the 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.

EDCPKRST220200-PRE-EN-01 Reference Guide 445

Chapter 2 Resources

2.44.2 Network Locations

The Network Locations collection resource represents the collection of network
locations (instances of dm_network_location_map) in a repository.

2.44.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.44.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: List of network locations
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “Network Location” on page 443
• Entry ID: Network location URI
• Entry Title: Display name of the network location.
• Entry Updated: r_modify_date of the network location (the dm_network_
location_map instance).

2.44.2.3 Link relations

Link relation Description Resource reference

self This collection of network “Network Locations”
locations on page 446
first, last, next, previous Pagination links. “Network Locations”
on page 446

446 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.44. Network Location (s)

2.44.2.4 Operations
2.44.2.4.1 Supported HTTP methods

Method Description
GET Retrieves the metadata of a collection of
network locations (instances of dm_
network_location_map) in the
repository.

2.44.2.4.2 Get Network Locations

Retrieves the metadata of a collection of network locations (instances of dm_

network_location_map) in the repository.

2.44.2.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• sort
• view
• inline
• page
• items-per-page
• include-total
• filter
• links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.44.2.4.2.2 Request media types

N/A

EDCPKRST220200-PRE-EN-01 Reference Guide 447

Chapter 2 Resources

2.44.2.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.44.2.4.2.4 Request body

N/A

2.44.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.44.2.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.44.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.44.2.4.2.8 Response body

XML or JSON representation of the collection of 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.

448 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.45. Object Aspect (s)

2.45 Object Aspect (s)

2.45.1 Object Aspect
The Object Aspect resource is only used for detaching an aspect from a specified
object.

2.45.1.1 Resource relationships

The following diagram illustrates how this resource is related with other resources:

See Also: “Object Aspects” on page 451 and About the Diagram on page 17.

2.45.1.2 Link relations

None.

2.45.1.3 Operations
2.45.1.3.1 Supported HTTP methods

Method Description
DELETE Detach an aspect from an object

2.45.1.3.2 Detach an object aspect

Detach an aspect from an object.

2.45.1.3.2.1 HTTP Request method and query parameters

DELETE

EDCPKRST220200-PRE-EN-01 Reference Guide 449

Chapter 2 Resources

2.45.1.3.2.2 Server Accepted Request media types

None.

2.45.1.3.2.3 Request headers

• Authorization

For more details about HTTP headers, see Appendix D, REST Common Definition -
HTTP Headers on page 987.

2.45.1.3.2.4 Request body

None.

Example 2-186: Detaching an Aspect

DELETE http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002523/aspects/my_aspect_1

2.45.1.3.2.5 Response headers

None.

2.45.1.3.2.6 Supported Response media types

None.

2.45.1.3.2.7 Response status

• 204 - Detached successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.45.1.3.2.8 Response body

HTTP 204 No Content status upon a successful detach operation. The response body
contains no content.

450 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.45. Object Aspect (s)

2.45.2 Object Aspects

The Object Aspects resource represents the aspects attached to a specified object in
a repository. Using this resource, you can attach extra properties to certain objects.

2.45.2.1 Resource relationships

The following diagram illustrates how this resource is related with other resources:

See Also: “SysObject” on page 690, “Document” on page 217, “Folder” on page 236,
“Cabinet” on page 137, and About the Diagram on page 17.

2.45.2.2 Feed
No feed support.

2.45.2.3 Link relations

The following table lists general link relations in the Object Aspects resource.

Link relation Description Resource reference

self This Object Aspects resource “Object Aspects” on page 451
aspect-type [1] Type definition of an aspect “Aspect Type” on page 78
delete [1] Detach an aspect from the “Object Aspect” on page 449
SysObject
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

EDCPKRST220200-PRE-EN-01 Reference Guide 451

Chapter 2 Resources

2.45.2.4 Operations
2.45.2.4.1 Supported HTTP methods

Method Description
GET GET all aspects attached to a SysObject
POST Attach one or more aspects to a SysObject

2.45.2.4.2 Get Attached Aspects

GET all aspects attached to a specified SysObject.

2.45.2.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameter:

• links

For more details about the query parameters, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.45.2.4.2.2 Server accepted request media types

None.

2.45.2.4.2.3 Request headers

• Accept
• Authorization

For more details about HTTP headers, see Appendix D, REST Common Definition -
HTTP Headers on page 987.

2.45.2.4.2.4 Request body

None.

452 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.45. Object Aspect (s)

2.45.2.4.2.5 Response headers

• Content-Type

For more details about HTTP headers, see Appendix D, REST Common Definition -
HTTP Headers on page 987.

2.45.2.4.2.6 Supported response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json (For compatible viewing

2.45.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.45.2.4.2.8 Response body

XML or JSON representation of the aspects attached to the SysObject. The response
body mainly contains two parts:

• The first part is a set of aspect elements, each of which represents an aspect
attached to the SysObject.
• The second part is the links block. Each attached aspect has two related links:

– An aspect-type link pointing to the corresponding aspect type definition.

For more information, see Aspect Type
– A delete link enabling you to detach the aspect. For more information, see
Object Aspect.

XML representation
<?xml version="1.0" encoding="UTF-8"?>
<object-aspects xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<aspect>my_aspect_1</aspect>
<aspect>dm_checkin_control</aspect>
<aspect>dm_version_behavior</aspect>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002523/aspects" rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002523/aspects/my_aspect_1"
rel="http://identifiers.emc.com/linkrel/delete"

EDCPKRST220200-PRE-EN-01 Reference Guide 453

Chapter 2 Resources

title="my_aspect_1"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/aspect-
types/my_aspect_1"
rel="http://identifiers.emc.com/linkrel/aspect-type"
title="my_aspect_1"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002523/
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/
0900000580002523/
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>

JSON representation
{
"aspects" : [
"my_aspect_1",
"dm_checkin_control",
"dm_version_behavior"
],
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002523/aspects"
},
{
"rel" : "http://identifiers.emc.com/linkrel/delete",
"title" : "my_aspect_1",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002523/
aspects/my_aspect_1"
},
{
"rel" : "http://identifiers.emc.com/linkrel/aspect-type",
"title" : "my_aspect_1",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/aspect-types/
my_aspect_1"
},
{
"rel" : "http://identifiers.emc.com/linkrel/delete",
"title" : "dm_checkin_control",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/objects/

454 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.45. Object Aspect (s)

0900000580002523/
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/
0900000580002523/
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"
}
]
}

2.45.2.4.3 Attach aspects to a SysObject

Attach one or more aspects to a specified SysObject.

2.45.2.4.3.1 HTTP Request method and query parameters

POST

2.45.2.4.3.2 Server accepted request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.45.2.4.3.3 Request headers

• Authorization
• Content-Type
• Accept

For more details about HTTP headers, see Appendix D, REST Common Definition -
HTTP Headers on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 455

Chapter 2 Resources

2.45.2.4.3.4 Request body

To attach aspects to a SysObject, specify the aspect type names in the request body.

XML representation
POST http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002523/aspects
Accept: application/vnd.emc.documentum+xml
Content-Type: application/vnd.emc.documentum+xml
<object-aspects xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<aspect>my_aspect_1</aspect>
<aspect>dm_checkin_control</aspect>
<aspect>dm_version_behavior</aspect>
</object-aspects>

JSON representation
POST http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002523/aspects
Accept: application/vnd.emc.documentum+json
Content-Type: application/vnd.emc.documentum+json{
"aspects":[
"my_aspect_1", "dm_checkin_control", "dm_version_behavior"
]
}

2.45.2.4.3.5 Response headers

• Content-Type

For more details about HTTP headers, see Appendix D, REST Common Definition -
HTTP Headers on page 987.

2.45.2.4.3.6 Supported response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xmlPalermo
• application/json

2.45.2.4.3.7 Response status

• 201 - Attached successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

456 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.46. Object Lifecycle

2.45.2.4.3.8 Response body

XML or JSON representation of all aspects attached to the SysObject.

2.45.2.5 Add aspect properties to object properties

You can add aspect properties to an object’s properties. After The updated object
will contain the aspect’s properties in its representation. The property names
attached by using aspects are displayed according to the following pattern:

<aspect_name>.<property_name>

You can update the aspect properties in the same way as other common object
properties.

Example 2-187: Updated object properties with aspect properties

{
"properties" : {
"r_object_id" : "0900000580003c83"
"object_name" : "my doc",
"r_object_type" : "dm_document",
"my_aspect_1.annotation_name" : "anno",
"my_aspect_1.module_name" : "mod",
"my_aspect_1.annotation_metadata" : "meta",
"my_aspect_1.i_partition" : 0,
}, "links" : [...]
}

2.46 Object Lifecycle

The current information of the attached Lifecycle object.

2.46.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

EDCPKRST220200-PRE-EN-01 Reference Guide 457

Chapter 2 Resources

See Also: “SysObject” on page 690 and About the Diagrams on page 17.

2.46.2 Feed
No feed support.

2.46.3 Link relations

Link relation Description Resource reference
self This resource “Object Lifecycle” on page 457
promotion [1] Promote the object Lifecycle to the “Object Lifecycle Promotion”
next state on page 473
cancel-promotion Cancel a scheduled promotion “Object Lifecycle Promotion”
[1] on page 473
demotion [1] Demote the object Lifecycle to the “Object Lifecycle Demotion”
previous state on page 466
cancel-demotion Cancel a scheduled demotion “Object Lifecycle Demotion”
[1] on page 466
suspension [1] Suspend the object Lifecycle to the “Object Lifecycle Suspension”
exceptional state on page 484
cancel-suspension Cancel a scheduled suspension “Object Lifecycle Suspension”
[1] on page 484
resumption [1] Resume the object Lifecycle to the “Object Lifecycle Resumption”
normal state on page 479
cancel-resumption Cancel a scheduled resumption “Object Lifecycle Resumption”
[1] on page 479
Lifecycle [1] The attached Lifecycle “Lifecycle” on page 367
parent The object resource “SysObject” on page 690
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.46.4 Operations

458 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.46. Object Lifecycle

2.46.4.1 Supported HTTP methods

Method Description
GET Retrieves the Lifecycle status of the object that is currently attached.
PUT Attach a Lifecycle to the object.
DELETE Detach a Lifecycle from the object that is currently attached.

2.46.4.2 Get an Object Lifecycle

Retrieves the status of an object's currently attached lifecycle.

2.46.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.46.4.2.2 Request media types

N/A

2.46.4.2.3 Request headers

• Authorization

• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.46.4.2.4 Request body

N/A

2.46.4.2.5 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 459

Chapter 2 Resources

2.46.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.46.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.46.4.2.8 Response body

Example 2-188: XML response

<?xml version='1.0' encoding='UTF-8'?>

<object-lifecycle
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<lifecycle-id>4600000180001165</lifecycle-id>
<lifecycle-name>lifecycle-for-doc</lifecycle-name>
<current-state>review</current-state>
<previous-state>draft</previous-state>
<next-state>publish</next-state>
<able-to-promote>true</able-to-promote>
<able-to-demote>true</able-to-demote>
<able-to-suspend>true</able-to-suspend>
<able-to-resume>false</able-to-resume>
<schedules>
<schedule action="promote" from="review"
to="publish">2020-01-01T12:00:00.000+00:00</schedule>
</schedules>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle.xml"/>
<link rel="http://identifiers.emc.com/linkrel/lifecycle"
href="http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/
4600000180001165.xml"/>
<link rel="parent"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c.xml"/>
<link rel="http://identifiers.emc.com/linkrel/promotion"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/promotion.xml"/>
<link rel="http://identifiers.emc.com/linkrel/demotion"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/demotion.xml"/>
<link rel="http://identifiers.emc.com/linkrel/suspension"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/

460 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.46. Object Lifecycle

090000018000117c/
lifecycle/suspension.xml"/>
<link rel="http://identifiers.emc.com/linkrel/cancel-promotion"
title="2020-01-01T12:00:00.000+00:00"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/promotion.xml?
schedule=2020-01-01T12:00:00.000%2B00:00"/>
</links>
</object-lifecycle>

Example 2-189: JSON response

{
"lifecycle-id": "4600000180001165",
"lifecycle-name": "lifecycle-for-doc",
"current-state": "review",
"previous-state": "draft",
"next-state": "publish",
"able-to-promote": true,
"able-to-demote": true,
"able-to-suspend": true,
"able-to-resume": false,
"schedules": [
{
"action": "promote",
"schedule": "2020-01-01T12:00:00.000+00:00",
"from": "review",
"to": "publish"
}
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle"
},
{
"rel": "http://identifiers.emc.com/linkrel/lifecycle",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/
4600000180001165"
},
{
"rel": "parent",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c"
},
{
"rel": "http://identifiers.emc.com/linkrel/promotion",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/promotion"
},
{
"rel": "http://identifiers.emc.com/linkrel/demotion",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/demotion"

EDCPKRST220200-PRE-EN-01 Reference Guide 461

Chapter 2 Resources

},
{
"rel": "http://identifiers.emc.com/linkrel/suspension",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/suspension"
},
{
"rel": "http://identifiers.emc.com/linkrel/cancel-promotion",
"title": "2020-01-01T12:00:00.000+00:00",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/promotion?schedule=2020-01-01T12:00:00.000%2B00:00"
}
]
}

2.46.4.3 Attach a lifecycle

Attaches a Lifecycle to the current object.

2.46.4.3.1 HTTP Request method and query parameters

PUT

2.46.4.3.2 Request media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

2.46.4.3.3 Request headers

• Authorization

• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.46.4.3.4 Request body

Example 2-190: XML request

<object-lifecycle>
<lifecycle-id>XXX</lifecycle-id>
<current-state>XXX</current-state>
<aliasset-name>XXX</aliasset-name>
</object-lifecycle>

462 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.46. Object Lifecycle

Example 2-191: JSON request

{
"lifecycle-id" : "XXX",
"current-state" : "XXX",
"aliasset-name" : "XXX"
}

Query parameters

• The lifecycle-id property specifies the id of the Lifecycle to be attached the

object. When the type has a default Lifecycle defined, this property is optional.
• The current-state specifies the name of a normal state in which the object is
attached to a Lifecycle. When you want to attach an object to a specified state, the
current-state parameter must have its allow-attach property set to true,
then you can define the state name using the current-state parameter.
• The current-state parameter is optional. However, when a value for the
current-state parameter is not provided, the base state is attached by default.

• The aliasset-name parameter specifies the name of an alias set. The aliasset-
name parameter must contain a valid alias name, which must be defined in the
Lifecycle.

Note: The request body is optional and empty when none of the above three
parameters are defined.

2.46.4.3.5 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.46.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

EDCPKRST220200-PRE-EN-01 Reference Guide 463

Chapter 2 Resources

2.46.4.3.7 Response status

• 201 - Object Lifecycle successfully attached.

• 400, 401, 403, 404, 406, 409, 415, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.46.4.3.8 Response body

The response body is the same as the one shown in the GET an Object Lifecycle
samples.

Example 2-192: XML response

<?xml version='1.0' encoding='UTF-8'?>

<object-lifecycle
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<lifecycle-id>4600000180001165</lifecycle-id>
<lifecycle-name>lifecycle-for-doc</lifecycle-name>
<current-state>review</current-state>
<previous-state>draft</previous-state>
<next-state>publish</next-state>
<able-to-promote>true</able-to-promote>
<able-to-demote>true</able-to-demote>
<able-to-suspend>true</able-to-suspend>
<able-to-resume>false</able-to-resume>
<links>xxx</links>
</object-lifecycle>

Example 2-193: JSON response

{
"lifecycle-id": "4600000180001165",
"lifecycle-name": "lifecycle-for-doc",
"current-state": "review",
"previous-state": "draft",
"next-state": "publish",
"able-to-promote": true,
"able-to-demote": true,
"able-to-suspend": true,
"able-to-resume": false,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle"
},
{
"rel": "http://identifiers.emc.com/linkrel/lifecycle",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/
4600000180001165"
},
{
"rel": "parent",

464 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.46. Object Lifecycle

"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c"
},
{
"rel": "http://identifiers.emc.com/linkrel/promotion",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/promotion"
},
{
"rel": "http://identifiers.emc.com/linkrel/demotion",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/demotion"
},
{
"rel": "http://identifiers.emc.com/linkrel/suspension",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/suspension"
}
]
}

2.46.4.4 Detach a Lifecycle

Detach the Lifecycle from a specified object. When a Lifecycle has been detached
from an object, any existing or scheduled Lifecycle operations for that object are
automatically cancelled.

2.46.4.4.1 HTTP Request method and query parameters

DELETE

2.46.4.4.2 Request media types

N/A

2.46.4.4.3 Request headers

Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 465

Chapter 2 Resources

2.46.4.4.4 Request body

N/A

2.46.4.4.5 Response headers

Content-Type, etc.

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.46.4.4.6 Response media types

N/A

2.46.4.4.7 Response status

• 204 - Object Lifecycle successfully detached.

• 400, 401, 403, 404, 406, 409, 415, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.46.4.4.8 Response body

N/A

2.47 Object Lifecycle Demotion

This resource allows the demotion of an Object Lifecycle.

2.47.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Object Lifecycle” on page 457 and About the Diagrams on page 17.

466 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.47. Object Lifecycle Demotion

2.47.2 Feed
No feed support.

2.47.3 Link relations

Link relation Description Resource reference
self This resource “Object Lifecycle Demotion”
on page 466
object-lifecycle The object Lifecycle resource “Object Lifecycle” on page 457
[1]
parent The object resource “SysObject” on page 690
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.47.4 Operations
2.47.4.1 Supported HTTP methods

Method Description
PUT Move the object from a normal state back to the previous normal state
or back to its base state.
DELETE Cancel the scheduled demotion.

2.47.4.2 Demote a lifecycle

Demotes a Lifecycle to its previous state, or to its base state.

2.47.4.2.1 HTTP Request method and query parameters

EDCPKRST220200-PRE-EN-01 Reference Guide 467

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
PUT to-base Whether to string true, false false
demote the
object to the
base state.

This
parameter is
ignored when
a value for
the
schedule
parameter
has been
provided. [1]
schedule When this datetime Any valid null
parameter is datetime
provided, the
demotion is
scheduled for
the time that
is set. [2]
[1] A scheduled demotion can only be made to the previous normal state. In this case, when
the schedule parameter has been set, the to-base parameter is ignored.

[2] To schedule a demotion, your user account must allow this action in its user privilege
and object permission constraints.

Caution
Any manual demote operation, where schedule=null, causes the
cancellation of all existing scheduled operations, regardless of whether the
operation succeeds or fails.

2.47.4.2.2 Request media types

N/A

2.47.4.2.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

468 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.47. Object Lifecycle Demotion

2.47.4.2.4 Request body

N/A

2.47.4.2.5 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.47.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.47.4.2.7 Response status

• 200 - Demote or scheduled demotion was successful

• 400, 401, 403, 404, 406, 409, 415, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.47.4.2.8 Response body

Example 2-194: XML response

<?xml version='1.0' encoding='UTF-8'?>

<object-lifecycle xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<lifecycle-id>4600000180001165</lifecycle-id>
<lifecycle-name>lifecycle-for-doc</lifecycle-name>
<current-state>review</current-state>
<previous-state>draft</previous-state>
<next-state>publish</next-state>
<able-to-promote>true</able-to-promote>
<able-to-demote>true</able-to-demote>
<able-to-suspend>true</able-to-suspend>
<able-to-resume>false</able-to-resume>
<schedules>
<schedule action="demote" from="review" to="draft">
2020-01-01T12:00:00.000+00:00
</schedule>
</schedules>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/
REPO/objects/
090000018000117c/lifecycle.xml"/>
<link rel="http://identifiers.emc.com/linkrel/lifecycle"
href="http://localhost:8080/dctm-rest/repositories/REPO/
lifecycles/
4600000180001165.xml"/>

EDCPKRST220200-PRE-EN-01 Reference Guide 469

Chapter 2 Resources

<link rel="parent" href="http://localhost:8080/dctm-rest/repositories/

REPO/
objects/090000018000117c.xml"/>
<link rel="http://identifiers.emc.com/linkrel/demotion"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/demotion.xml"/>
<link rel="http://identifiers.emc.com/linkrel/demotion"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/demotion.xml"/>
<link rel="http://identifiers.emc.com/linkrel/suspension"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/suspension.xml"/>
<link rel="http://identifiers.emc.com/linkrel/cancel-demotion"
title="2020-01-01T12:00:00.000+00:00"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/demotion.xml?
schedule=2020-01-01T12:00:00.000%2B00:00"/>
</links>
</object-lifecycle>

Example 2-195: JSON response

{
"lifecycle-id": "4600000180001165",
"lifecycle-name": "lifecycle-for-doc",
"current-state": "review",
"previous-state": "draft",
"next-state": "publish",
"able-to-promote": true,
"able-to-demote": true,
"able-to-suspend": true,
"able-to-resume": false,
"schedules": [
{
"action": "demote",
"schedule": "2020-01-01T12:00:00.000+00:00",
"from": "review",
"to": "draft"
}
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle"
},
{
"rel": "http://identifiers.emc.com/linkrel/lifecycle",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/
4600000180001165"
},
{
"rel": "parent",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c"
},
{
"rel": "http://identifiers.emc.com/linkrel/demotion",

470 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.47. Object Lifecycle Demotion

"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/demotion"
},
{
"rel": "http://identifiers.emc.com/linkrel/demotion",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/demotion"
},
{
"rel": "http://identifiers.emc.com/linkrel/suspension",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/suspension"
},
{
"rel": "http://identifiers.emc.com/linkrel/cancel-demotion",
"title": "2020-01-01T12:00:00.000+00:00",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/demotion?schedule=2020-01-01T12:00:00.000%2B00:00"
}
]
}

2.47.4.3 Cancel a scheduled demotion

Cancel a scheduled demotion for the object.

2.47.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
DELETE schedule This is a datetime Any valid null
required datetime
parameter.
The execution
time of the
scheduled
demotion. [1]
[1] To cancel a scheduled demotion, your user account must allow this action in its user
privilege constraints.

EDCPKRST220200-PRE-EN-01 Reference Guide 471

Chapter 2 Resources

2.47.4.3.2 Request media types

N/A

2.47.4.3.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.47.4.3.4 Request body

N/A

2.47.4.3.5 Response headers

N/A

2.47.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.47.4.3.7 Response status

• 204 - Scheduled demotion successfully canceled.

• 400, 401, 403, 404, 406, 409, 415, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.47.4.3.8 Response body

N/A

472 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.48. Object Lifecycle Promotion

2.48 Object Lifecycle Promotion

This resource allows for the promotion of an Object Lifecycle.

2.48.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Object Lifecycle” on page 457 and About the Diagrams on page 17.

2.48.2 Feed
No feed support.

2.48.3 Link relations

Link relation Description Resource reference
self This resource “Object Lifecycle Promotion”
on page 473
object-lifecycle The object Lifecycle resource “Object Lifecycle” on page 457
[1]
parent The object resource “SysObject” on page 690
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.48.4 Operations
2.48.4.1 Supported HTTP methods

Method Description
PUT Move the object from one normal state to the next normal state.
DELETE Cancel the scheduled promotion.

EDCPKRST220200-PRE-EN-01 Reference Guide 473

Chapter 2 Resources

2.48.4.2 Promote a lifecycle

Promotes a Lifecycle to its next normal state.

2.48.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
PUT force Force the string true, false false
object to be
promoted,
regardless of
any entry
criteria for
the target
state.
trial Test whether string true, false false
the
promotion
can be done.
This does not
promote the
object. [1]
schedule When datetime Any valid null
provided, this datetime
parameter
schedules the
promotion
for the date
and time set
as its value.
[2]
[1] Providing a value for both the schedule and trial parameters causes a 400 error.

[2] To schedule a promotion, your user account must allow this action in its user privilege
and object permission constraints.

Caution
Any manual promote operation, where schedule=null and trial=false,
causes the cancellation of all existing scheduled operations, regardless of
whether the operation succeeds or fails.

474 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.48. Object Lifecycle Promotion

2.48.4.2.2 Request media types

N/A

2.48.4.2.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.48.4.2.4 Request body

N/A

2.48.4.2.5 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.48.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.48.4.2.7 Response status

• 200 - Promote or scheduled promotion was successful

• 400, 401, 403, 404, 406, 409, 415, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.48.4.2.8 Response body

Example 2-196: XML response

<?xml version='1.0' encoding='UTF-8'?>

<object-lifecycle xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<lifecycle-id>4600000180001165</lifecycle-id>
<lifecycle-name>lifecycle-for-doc</lifecycle-name>
<current-state>review</current-state>
<previous-state>draft</previous-state>
<next-state>publish</next-state>
<able-to-promote>true</able-to-promote>
<able-to-demote>true</able-to-demote>

EDCPKRST220200-PRE-EN-01 Reference Guide 475

Chapter 2 Resources

<able-to-suspend>true</able-to-suspend>
<able-to-resume>false</able-to-resume>
<schedules>
<schedule action="promote" from="review" to="publish">
2020-01-01T12:00:00.000+00:00
</schedule>
</schedules>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/
REPO/objects/
090000018000117c/lifecycle.xml"/>
<link rel="http://identifiers.emc.com/linkrel/lifecycle"
href="http://localhost:8080/dctm-rest/repositories/REPO/
lifecycles/
4600000180001165.xml"/>
<link rel="parent" href="http://localhost:8080/dctm-rest/repositories/
REPO/
objects/090000018000117c.xml"/>
<link rel="http://identifiers.emc.com/linkrel/promotion"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/promotion.xml"/>
<link rel="http://identifiers.emc.com/linkrel/demotion"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/demotion.xml"/>
<link rel="http://identifiers.emc.com/linkrel/suspension"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/suspension.xml"/>
<link rel="http://identifiers.emc.com/linkrel/cancel-promotion"
title="2020-01-01T12:00:00.000+00:00"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/promotion.xml?
schedule=2020-01-01T12:00:00.000%2B00:00"/>
</links>
</object-lifecycle>

Example 2-197: JSON response

{
"lifecycle-id": "4600000180001165",
"lifecycle-name": "lifecycle-for-doc",
"current-state": "review",
"previous-state": "draft",
"next-state": "publish",
"able-to-promote": true,
"able-to-demote": true,
"able-to-suspend": true,
"able-to-resume": false,
"schedules": [
{
"action": "promote",
"schedule": "2020-01-01T12:00:00.000+00:00",
"from": "review",
"to": "publish"
}
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/

476 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.48. Object Lifecycle Promotion

090000018000117c/
lifecycle"
},
{
"rel": "http://identifiers.emc.com/linkrel/lifecycle",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/
4600000180001165"
},
{
"rel": "parent",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c"
},
{
"rel": "http://identifiers.emc.com/linkrel/promotion",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/promotion"
},
{
"rel": "http://identifiers.emc.com/linkrel/demotion",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/demotion"
},
{
"rel": "http://identifiers.emc.com/linkrel/suspension",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/suspension"
},
{
"rel": "http://identifiers.emc.com/linkrel/cancel-promotion",
"title": "2020-01-01T12:00:00.000+00:00",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/promotion?schedule=2020-01-01T12:00:00.000%2B00:00"
}
]
}

2.48.4.3 Cancel a scheduled promotion

Cancel a scheduled promotion for the object.

EDCPKRST220200-PRE-EN-01 Reference Guide 477

Chapter 2 Resources

2.48.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value Default

method parameters range value
DELETE schedule This is a required datetime Any null
parameter. The execution valid
time of the scheduled datetim
promotion [1] e
[1] To cancel a scheduled promotion, your user account must allow this action in its user
privilege constraints.

2.48.4.3.2 Request media types

N/A

2.48.4.3.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.48.4.3.4 Request body

N/A

2.48.4.3.5 Response headers

N/A

2.48.4.3.6 Response media types

N/A

2.48.4.3.7 Response status

• 204 - Scheduled promotion successfully canceled.

• 400, 401, 403, 404, 406, 409, 415, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

478 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.49. Object Lifecycle Resumption

2.48.4.3.8 Response body

N/A

2.49 Object Lifecycle Resumption

This resource allows the resumption of an Object Lifecycle.

2.49.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Object Lifecycle” on page 457 and About the Diagrams on page 17.

2.49.2 Feed
No feed support.

2.49.3 Link relations

Link relation Description Resource reference
self This resumption resource “Object Lifecycle Resumption”
on page 479
object-lifecycle The object Lifecycle resource “Object Lifecycle” on page 457
[1]
parent The object resource “SysObject” on page 690
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.49.4 Operations

EDCPKRST220200-PRE-EN-01 Reference Guide 479

Chapter 2 Resources

2.49.4.1 Supported HTTP methods

Method Description
PUT Move the object from an exception state back
to the normal state from which it was
suspended, or move it back to the base state.
DELETE Cancel the scheduled resumption.

2.49.4.2 Resume a lifecycle

Resumes the lifecycle to its normal state.

2.49.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameter
PUT to-base Determines string true, false false
whether to
resume the
object to its
base state.
force Forces the string true, false false
object to be
resumed.
trial Allows you string true, false false
to test
whether the
resumption
can be done.
This will not
actually
resume the
object. [1]
schedule When datetime Any valid null
provided, this datetime
parameter
schedules the
resumption
for the date
and time set
as its value.
[2]
[1] Providing a value for both the schedule and trial parameters causes a 400 error.

[2] To schedule a resumption, your user account must allow this action in its user privilege
and object permission constraints.

480 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.49. Object Lifecycle Resumption

Caution
Any manual resumption operation, where schedule=null and trial=
false, causes the cancellation of all existing scheduled operations,
regardless of whether the operation succeeds or fails.

2.49.4.2.2 Request media types

N/A

2.49.4.2.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.49.4.2.4 Request body

N/A

2.49.4.2.5 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.49.4.2.6 Response media types

N/A

2.49.4.2.7 Response status

• 200 - Resumption successful or resumption successfully scheduled

• 400, 401, 403, 404, 406, 409, 415, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 481

Chapter 2 Resources

2.49.4.2.8 Response body

Example 2-198: XML response

<?xml version='1.0' encoding='UTF-8'?>

<object-lifecycle xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<lifecycle-id>4600000180001165</lifecycle-id>
<lifecycle-name>lifecycle-for-doc</lifecycle-name>
<current-state>failed</current-state>
<resume-state>review</resume-state>
<able-to-promote>false</able-to-promote>
<able-to-demote>false</able-to-demote>
<able-to-suspend>false</able-to-suspend>
<able-to-resume>true</able-to-resume>
<schedules>
<schedule action="resume" from="review">2020-01-01T12:00:00.000+00:00</
schedule>
</schedules>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle.xml"/>
<link rel="http://identifiers.emc.com/linkrel/lifecycle"
href="http://localhost:8080/dctm-rest/repositories/REPO/
lifecycles/
4600000180001165.xml"/>
<link rel="parent"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c.xml"/>
<link rel="http://identifiers.emc.com/linkrel/resumption"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/resumption.xml"/>
<link rel="http://identifiers.emc.com/linkrel/cancel-resumption"
title="2020-01-01T12:00:00.000+00:00"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/resumption.xml?
schedule=2020-01-01T12:00:00.000%2B00:00"/>
</links>
</object-lifecycle>

Example 2-199: JSON response

{
"lifecycle-id": "4600000180001165",
"lifecycle-name": "lifecycle-for-doc",
"current-state": "failed",
"resume-state": "draft",
"able-to-promote": false,
"able-to-demote": false,
"able-to-suspend": false,
"able-to-resume": true,
"schedules": [
{
"action": "resume",
"schedule": "2020-01-01T12:00:00.000+00:00",
"from": "failed"
}
],

482 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.49. Object Lifecycle Resumption

"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle"
},
{
"rel": "http://identifiers.emc.com/linkrel/lifecycle",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/
4600000180001165"
},
{
"rel": "parent",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c"
},
{
"rel": "http://identifiers.emc.com/linkrel/resumption",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/resumption"
},
{
"rel": "http://identifiers.emc.com/linkrel/cancel-resumption",
"title": "2020-01-01T12:00:00.000+00:00",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/resumption?
schedule=2020-01-01T12:00:00.000%2B00:00"
}
]
}

2.49.4.3 Cancel a scheduled resumption

Cancel a scheduled resumption for the lifecycle.

2.49.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value Default

method parameter range value
s
DELETE schedule This is a required parameter datetime Any valid null
that defines the execution datetime
time of the scheduled
resumption [1]
[1] Your user account must have sufficient privileges that allow you to cancel a scheduled
resumption.

EDCPKRST220200-PRE-EN-01 Reference Guide 483

Chapter 2 Resources

2.49.4.3.2 Request media types

N/A

2.49.4.3.3 Request headers

Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.49.4.3.4 Request body

N/A

2.49.4.3.5 Response headers

Content-Type, etc.

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.49.4.3.6 Response media types

N/A

2.49.4.3.7 Response status

• 204 - Scheduled Resumption successfully canceled.

• 400, 401, 403, 404, 406, 409, 415, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.49.4.3.8 Response body

N/A

2.50 Object Lifecycle Suspension

This resource allows the Suspension of the object Lifecycle.

484 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.50. Object Lifecycle Suspension

2.50.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Object Lifecycle” on page 457 and About the Diagrams on page 17.

2.50.2 Feed
No feed support.

2.50.3 Link relations

Link relation Description Resource reference
self This resumption resource “Object Lifecycle
Suspension” on page 484
object-lifecycle [1] The object Lifecycle resource “Object Lifecycle”
on page 457
parent The object resource “SysObject” on page 690
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.50.4 Operations
2.50.4.1 Supported HTTP methods

Method Description
PUT Move the object from the current normal
state to the exception state.
DELETE Cancel the scheduled suspension.

EDCPKRST220200-PRE-EN-01 Reference Guide 485

Chapter 2 Resources

2.50.4.2 Suspend a Lifecycle

Suspend a lifecycle to the exception state.

2.50.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default

method paramet value
ers
PUT force Forces the object to be string true, false
suspended. false
trial Allows you to test string true, false
whether the suspension false
can be done. This will not
actually suspend the
object. [1]
schedul When provided, this datetime Any valid null
e parameter schedules the datetime
suspension for the date
and time set as its value.
[2]
[1] Providing a value for both the schedule and trial parameters causes a 400 error.

[2] To schedule a suspension, your user account must allow this action in its user privilege
and object permission constraints.

Caution
Any manual suspension operation, where schedule=null and trial=
false, causes the cancellation of all existing scheduled operations,
regardless of whether the operation succeeds or fails.

2.50.4.2.2 Request media types

N/A

2.50.4.2.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

486 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.50. Object Lifecycle Suspension

2.50.4.2.4 Request body

N/A

2.50.4.2.5 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.50.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.50.4.2.7 Response status

• 200 - Lifecycle was successfully suspended or scheduled for suspension.

• 400, 401, 403, 404, 406, 409, 415, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.50.4.2.8 Response body

Example 2-200: XML response

<?xml version='1.0' encoding='UTF-8'?>

<object-lifecycle xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<lifecycle-id>4600000180001165</lifecycle-id>
<lifecycle-name>lifecycle-for-doc</lifecycle-name>
<current-state>review</current-state>
<previous-state>draft</previous-state>
<next-state>publish</next-state>
<able-to-promote>true</able-to-promote>
<able-to-demote>true</able-to-demote>
<able-to-suspend>true</able-to-suspend>
<able-to-resume>false</able-to-resume>
<schedules>
<schedule action="suspend"
from="review">2020-01-01T12:00:00.000+00:00</schedule>
</schedules>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle.xml"/>
<link rel="http://identifiers.emc.com/linkrel/lifecycle"
href="http://localhost:8080/dctm-rest/repositories/REPO/
lifecycles/
4600000180001165.xml"/>
<link rel="parent"

EDCPKRST220200-PRE-EN-01 Reference Guide 487

Chapter 2 Resources

href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c.xml"/>
<link rel="http://identifiers.emc.com/linkrel/promotion"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/promotion.xml"/>
<link rel="http://identifiers.emc.com/linkrel/demotion"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/demotion.xml"/>
<link rel="http://identifiers.emc.com/linkrel/suspension"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/suspension.xml"/>
<link rel="http://identifiers.emc.com/linkrel/cancel-suspension"
title="2020-01-01T12:00:00.000+00:00"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/lifecycle/suspension.xml?
schedule=2020-01-01T12:00:00.000%2B00:00"/>
</links>
</object-lifecycle>

Example 2-201: JSON response

{
"lifecycle-id": "4600000180001165",
"lifecycle-name": "lifecycle-for-doc",
"current-state": "review",
"previous-state": "draft",
"next-state": "publish",
"able-to-promote": true,
"able-to-demote": true,
"able-to-suspend": true,
"able-to-resume": false,
"schedules": [
{
"action": "suspend",
"schedule": "2020-01-01T12:00:00.000+00:00",
"from": "review"
}
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle"
},
{
"rel": "http://identifiers.emc.com/linkrel/lifecycle",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles/
4600000180001165"
},
{
"rel": "parent",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c"
},
{
"rel": "http://identifiers.emc.com/linkrel/promotion",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/

488 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.50. Object Lifecycle Suspension

lifecycle/promotion"
},
{
"rel": "http://identifiers.emc.com/linkrel/demotion",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/demotion"
},
{
"rel": "http://identifiers.emc.com/linkrel/suspension",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/suspension"
},
{
"rel": "http://identifiers.emc.com/linkrel/cancel-suspension",
"title": "2020-01-01T12:00:00.000+00:00",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000018000117c/
lifecycle/suspension?schedule=2020-01-01T12:00:00.000%2B00:00"
}
]
}

2.50.4.3 Cancel a Scheduled Suspension

Cancels a scheduled Lifecycle suspension.

2.50.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value Default

method parame range value
ters
DELETE schedu When provided, this datetime Any valid null
le parameter defines the datetime
execution time of the
scheduled suspension that
will be canceled [1]
[1] To cancel a scheduled suspension, your user account must allow this action in its user
privilege and object permission constraints.

EDCPKRST220200-PRE-EN-01 Reference Guide 489

Chapter 2 Resources

2.50.4.3.2 Request media types

N/A

2.50.4.3.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.50.4.3.4 Request body

N/A

2.50.4.3.5 Response headers

N/A

2.50.4.3.6 Response media types

N/A

2.50.4.3.7 Response status

• 204 - Successfully canceled the scheduled Suspension.

• 400, 401, 403, 404, 406, 409, 415, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.50.4.3.8 Response body

N/A

2.51 Parent Link (s)

2.51.1 Parent Link
The Parent Link resource represents the folder containment relationships between
an object and its parent folder.

490 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.51. Parent Link (s)

2.51.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Parent Links” on page 496 and About the Diagram on page 17.

2.51.1.2 Feed
No feed support.

2.51.1.3 Link relations

Link relation Description Resource reference

self This parent link. “Parent Link” on page 490

2.51.1.4 Operations
2.51.1.4.1 Supported HTTP methods

Method Description
GET Retrieves the folder link between the child
object and its parent folder.
PUT Moves an object from a source folder into a
destination folder.
DELETE Unlinks an object from one of its parent
folders.

2.51.1.4.2 Retrieve a folder link

Retrieve the folder link between the child object and its parent folder.

EDCPKRST220200-PRE-EN-01 Reference Guide 491

Chapter 2 Resources

2.51.1.4.2.1 HTTP Request method and query parameters

GET

2.51.1.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.51.1.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.51.1.4.2.4 Request body

N/A

2.51.1.4.2.5 Response headers

• Content-Type

2.51.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.51.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

492 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.51. Parent Link (s)

2.51.1.4.2.8 Response body

XML or JSON representation of the folder link between the object and its parent
folder. The body contains the URI for the object and the URI for its parent folder.
The body also contains the parent ID and child ID.

2.51.1.4.3 Move an object from one folder to another

Move an object from a source folder to a destination folder.

Notes

• If the object is a folder, this operation also moves the objects under that
folder to the destination folder.
• A cabinet object is not allowed to be moved.

2.51.1.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameter
PUT include- Specifies string true, false false
all- whether or
versions not to move
all versions of
the object.
• true -
Return all
versions.
• false -
Only
return the
current
version.

2.51.1.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

EDCPKRST220200-PRE-EN-01 Reference Guide 493

Chapter 2 Resources

2.51.1.4.3.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.51.1.4.3.4 Request body

N/A

2.51.1.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.51.1.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.51.1.4.3.7 Response status

• 200 - Operation completed successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.51.1.4.3.8 Response body

XML or JSON representation of the folder link between the object and the
destination folder. The response contains the URI of the new destination folder.

Example 2-202: Moving a folder

JSON request
Accept: application/vnd.emc.documentum+json

PUT http://localhost:8080/dctm-rest/repositories/repo/objects/0900000c80000cc4/
parent-links/0b0004d280002732
{
"href": "http://localhost:8080/dctm-rest/repositories/repo/folders/
0b0004d28000ad36"
}

JSON response

494 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.51. Parent Link (s)

{
"child": "http://localhost:8080/dctm-rest/repositories/repo/objects/
0900000c80000cc4",
"parent": "http://localhost:8080/dctm-rest/repositories/repo/folders/
0b0004d28000ad36",
"links":
[
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
0900000c80000cc4/
parent-links/0b0004d28000ad36"
}
]
}

2.51.1.4.4 Unlink an object from a parent folder

Unlink an object from one of its parent folders.

Notes

• 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.

2.51.1.4.4.1 HTTP Request method and query parameters

DELETE

2.51.1.4.4.2 Request media types

N/A

EDCPKRST220200-PRE-EN-01 Reference Guide 495

Chapter 2 Resources

2.51.1.4.4.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.51.1.4.4.4 Request body

N/A

2.51.1.4.4.5 Response headers

N/A

2.51.1.4.4.6 Response media types

N/A

2.51.1.4.4.7 Response status

• 204 - Unlinked successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.51.1.4.4.8 Response body

HTTP 204 No Content status upon a successful unlink operation. The response body
contains no content.

2.51.2 Parent Links

The Parent Links collection resource represents a collection of all folder
containment relationships for an object. That is a set of links between an object and
its parent folders.

2.51.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “SysObject” on page 690 and About the Diagram on page 17.

496 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.51. Parent Link (s)

2.51.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the feed

• Feed Title: Parent links
• Feed Updated: r_modify_date of the object
• Supports POST: Yes
• Entry: “Parent Link” on page 490
• Entry ID: URI of the folder link
• Entry Title: Formatted string with both the child object ID and the parent object
ID
• Entry Updated: r_modify_date of the child object

2.51.2.3 Link relations

Link relation Description Resource reference

self URI for Parent Links “Parent Links” on page 496
collection feed
first, last, next, previous Pagination links “Parent Links” on page 496

2.51.2.4 Operations
2.51.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a collection of parent links for an
object.
POST Links an object to a new parent folder.

2.51.2.4.2 Get Parent Links

Retrieve all parent links for a given object in a repository.

Note: For a cabinet, the parent links collection is empty because a cabinet does
not have a parent folder.

EDCPKRST220200-PRE-EN-01 Reference Guide 497

Chapter 2 Resources

2.51.2.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• inline

• page

• items-per-page
• include-total

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.51.2.4.2.2 Request media types

N/A

2.51.2.4.2.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.51.2.4.2.4 Request body

N/A

2.51.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.51.2.4.2.6 Response media types

• application/atom+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json (For compatible viewing

498 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.51. Parent Link (s)

2.51.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.51.2.4.2.8 Response body

XML or JSON representation of a collection parent links for the given object.

• 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 object 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.

2.51.2.4.3 Link an object to a new folder

Link an object 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, see “Folder Child Objects”
on page 285.

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.

2.51.2.4.3.1 HTTP Request method and query parameters

POST

EDCPKRST220200-PRE-EN-01 Reference Guide 499

Chapter 2 Resources

2.51.2.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.51.2.4.3.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.51.2.4.3.4 Request body

XML or JSON representation of a reference to the object's new parent folder.

Example 2-203: Example of the request body

{
"href":
"http://localhost:8080/dctm-rest/repositories/repo/folders/0b0004d280002732"
}

2.51.2.4.3.5 Response headers

• Location
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.51.2.4.3.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

500 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.52. Permissions

2.51.2.4.3.7 Response status

• 201 - Link created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.51.2.4.3.8 Response body

XML or JSON representation of newly-created link between the given object and its
new parent folder.

2.52 Permissions
The Permissions resource allows a specified user to get basic and extended
permissions for a specific accessor on a SysObject. When no accessor is specified,
the default accessor is the user that is currently logged into the system.

2.52.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

2.52.2 Feed
No feed support.

2.52.3 Link relations

Link relation Description Resource reference
self This permissions resource “Permissions” on page 501

EDCPKRST220200-PRE-EN-01 Reference Guide 501

Chapter 2 Resources

2.52.4 Operations
2.52.4.1 Supported HTTP methods

Method Description
GET GET a specified accessor’s basic and
extended permissions on a certain object

2.52.4.2 Get the permission view instance

GET the computed effective basic and extended permissions on a specified
SysObject for a specified accessor. Permission attributes are returned as embedded
elements in the response message body.

2.52.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979

502 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.52. Permissions

HTTP Query Description Data type Value range Default value

method parameters
accessor A user name string N/A The user that
or group is currently
name to get logged in to
permissions the system
against for
the
SysObject.

This
parameter is
not
mandatory.

The server
returns the
current login
user's
permissions
by default.

The server
returns the
system
default
permissions
on this object
when an
unknown
accessor
(user) is
provided by
the client.

2.52.4.2.2 Request media types

N/A

2.52.4.2.3 Request headers

• Authorization
• Accept
• For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987

EDCPKRST220200-PRE-EN-01 Reference Guide 503

Chapter 2 Resources

2.52.4.2.4 Request body

N/A

2.52.4.2.5 Response headers

• Content-Type
• For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987

2.52.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.52.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985

2.52.4.2.8 Response body

Example 2-204: XML request and response

GET http://localhost:8080/dctm-rest/repositories/
REPO/objects/0900000580002507/permissions?accessor=dave
Authorization: Basic ZG1hZG1pbjpwYXNzd29yZA==
Accept: application/vnd.emc.documentum+xml

Status Code 200 OK

Content-Type: application/vnd.emc.documentum+xml
<?xml version='1.0' encoding='UTF-8'?>
<permission
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 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>

504 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.53. Permission Set

Example 2-205: JSON request and response

GET http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580002507/
permissions?accessor=dave
Authorization: Basic ZG1hZG1pbjpwYXNzd29yZA==
Accept: application/vnd.emc.documentum+json

Status Code 200 OK

Content-Type: application/vnd.emc.documentum+json
{
"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"
}
]
}

2.53 Permission Set

The Permission Set resource represents the permission set instance of a specified
SysObject. Object level permission management, such as granting permissions or
revoking permissions, is done using this resource's operations.

A permission set contains the following four sections that manage the access control
of an object by using various aspects:

• permitted: This access level defines a set of users who are permitted to access the
object.
• restricted: This access level defines a set of users who have restricted access to the
object.
• required group: This access level requires that the user requesting access to the
object must be a member of the group identified in the entry. If more than one
group is defined in this section, the user requesting access to the object must be a
member of all the groups defined.
• required group set: This access level requires that the user requesting access to the
object be a member of at least one group in the set of groups defined.

EDCPKRST220200-PRE-EN-01 Reference Guide 505

Chapter 2 Resources

2.53.1 Resource relationships

The following diagram illustrates how this resource is related with other resources:

See Also: “SysObject” on page 690 and About the Diagram on page 17.

2.53.2 Feed
No feed support.

2.53.3 Link relations

The following table lists link relations for the Permission Set resource.

Link relation Description Resource reference

self This Permission Set resource. “Permission Set” on page 505
edit Edit this Permission Set resource. “Permission Set” on page 505
acl [1] Retrieve the ACL object associated to “ACL” on page 42
this permission set object.
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.53.4 Operations
2.53.4.1 Supported HTTP methods

Method Description
GET GET a permission set
PUT Update a permission set

506 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.53. Permission Set

2.53.4.2 Get the Permission Set instance

GET the definition of the permission set of a specific object. The permission set
returned may contain one or more sections of the complete permission set, which
includes the <permitted>, <restricted>, <required-group>, and <required-group-set>
sections. Sections that do not appear in the permission set returned are not set by
that permission set.

2.53.4.2.1 HTTP Request method and query parameters

GET

This method supports the following Request query parameter:

• links
For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.53.4.2.2 Request media types

N/A

2.53.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.53.4.2.4 Request body

N/A

2.53.4.2.5 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 507

Chapter 2 Resources

2.53.4.2.6 Supported Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.53.4.2.7 Response status

• 200 - Permission set retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.53.4.2.8 Response body

Example 2-206: XML representation

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+xml
<?xml version='1.0' encoding='UTF-8'?>
<permission-set
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<permitted>
<permission accessor="dm_world" basic-permission="Read"
extend-permissions="EXECUTE_PROC,CHANGE_LOCATION"/>
<permission accessor="dm_owner" basic-permission="Delete"
extend-permissions="EXECUTE_PROC,CHANGE_LOCATION"/>
......
</permitted>
<restricted>
<permission accessor="docu" basic-permission="Version"/>
......
</restricted>
<required-group>
<group>{group1}</group>
<group>{group2}</group>
......
</required-group>
<required-group-set>
<group>{group3}</group>
<group>{group4}</group>
......
</required-group-set>
<links>
<link rel="self" href="{permissionSetResourceUri}"/>
<link rel="edit" href="{permissionSetResourceUri}"/>
<link rel="http://identifiers.emc.com/linkrel/acl"
href="{aclResourceUri}"/>
</links>
</permission-set>

508 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.53. Permission Set

Example 2-207: JSON representation

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+json
{
"permitted": [
{
"accessor": "dm_world",
"basic-permission": "Read",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
},
{
"accessor": "dm_owner",
"basic-permission": "Delete",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
},
......
],
"restricted": [
{
"accessor": "docu",
"basic-permission": "Version"
}
......
],
"required-group": [
"{group1}",
"{group2}"
......
],
"required-group-set": [
"{group3}",
"{group4}"
......
],
"links": [
{
"rel": "self",
"href": "{permissionSetResourceUri}"
},
{
"rel": "edit",
"href": "{permissionSetResourceUri}"
},
{
"rel": "http://identifiers.emc.com/linkrel/acl",
"href": "{aclResourceUri}"
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 509

Chapter 2 Resources

2.53.4.3 Update the Permission Set instance

The update operation on a permission set object enables you to do the following:

• grant or revoke a specific access level, or edit the existing access level for a user
requesting access to the object (corresponding to add/delete/edit a user
permission in the <permitted> attribute)
• add or remove a specific restricted level or edit the existing restricted level for a
certain user that is requesting access to the object (corresponding to add/delete/
edit a user permission in restricted attribute)
• add or remove a membership constraint to or from the user requesting access to
the object (corresponding to add/delete a group in required-group or
required-group-set attribute)

When the object permission set is updated, a newly created ACL is assigned to the
specified object.

Anyone who has <BROWSE> basic permissions and <CHANGE_PERMIT> extended

permissions can update the basic permission. However, only the owner of the
SysObject and the superuser can change basic and extended permissions. This
means that because the PUT method must be used to update a permission set, only
the owner of the SysObject and the superuser have sufficient permissions to update
a permission set.

There are two built-in accessors: dm_world and dm_owner. Regardless of whether or
not the REST client has specified any access level for dm_world or dm_owner.
Documentum Server automatically grants users default permissions for the
permission set.

The default basic and extended permission levels for these two users are defined in
the <default_acl> property of the server configuration object.

When updating a permission set, you must provide a complete permission set object
in the Request body, rather than specifying only the part you want to update. When
any property is null or empty, the property's value will be reset to null.

A permission set object may contain a list of user permissions. A user permission is
made up of an accessor, a basic-permission, extend-permissions, and application-
permission. The following table shows permission set and user permission object
attributes:

Attribute Description Valid value Default value Mandatory?

accessor A user or group Any valid user Yes
name or group name
This is
mandatory for a
user permission

510 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.53. Permission Set

Attribute Description Valid value Default value Mandatory?

basic-permission The basic One of the None No
permissions for following:
an accessor
• None
• Browse
• Read
• Relate
• Version
• Write
• Delete

extend- The extended One or more of EXECUTE_PRO No

permissions permissions for the following: C
an accessor
• EXECUTE_P CHANGE_LOC
ROC ATION
• CHANGE_L
OCATION
• CHANGE_P
ERMIT
• CHANGE_S
TATE
• DELETE_OBJ
ECT
• CHANGE_F
OLDER_LIN
KS
application- Specifies a string NULL No
permission permission that
is recognized by
an application.
An application
permit is not
recognized or
enforced by
Documentum
Server. The
application is
responsible for
enforcing the
permission
permitted A list of granted User dm_world and No
user permissions permissions dm_owner user
permissions
restricted A list of User NULL No
restricted user permissions
permissions

EDCPKRST220200-PRE-EN-01 Reference Guide 511

Chapter 2 Resources

Attribute Description Valid value Default value Mandatory?

required-group A list of group Any valid group NULL No
names name
required-group- A list of group Any valid group NULL No
set names name

2.53.4.3.1 HTTP Request method and query parameters

PUT

2.53.4.3.2 Request media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

2.53.4.3.3 Request headers

• Accept

• Authorization

• Content-Type

• For more information, see Appendix D, REST Common Definition - HTTP

Headers on page 987.

2.53.4.3.4 Request body

Example 2-208: XML request

<permission-set
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<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"/>
......
</permitted>
<restricted>
...
</restricted>
<required-group>
...
</required-group>
<required-group-set>
...
</required-group-set>
</permission-set>

512 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.53. Permission Set

Example 2-209: JSON request

{
"permitted": [
{
"accessor": "dm_world",
"basic-permission": "Read",
"extend-permissions":
"EXECUTE_PROC,CHANGE_LOCATION"
},
{
"accessor": "dm_owner",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION",
"basic-permission": "Write"
},
......
],
"restricted": [
......
],
"required-group": [
......
],
"required-group-set": [
......
]
}

2.53.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.53.4.3.6 Response media types

• application/vnd.emc.documentum+xml
application/xml

• application/vnd.emc.documentum+json
application/json

EDCPKRST220200-PRE-EN-01 Reference Guide 513

Chapter 2 Resources

2.53.4.3.7 Response status

• 200 - Permission set updated successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.53.4.3.8 Response body

Example 2-210: XML response

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+xml
<permission-set
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<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"/>
......
</permitted>
<restricted>
...
</restricted>
<required-group>
...
</required-group>
<required-group-set>
...
</required-group-set>
<links>
<link rel="self" href="{permissionSetResourceUri}"/>
<link rel="edit" href="{permissionSetResourceUri}"/>
<link rel="http://identifiers.emc.com/linkrel/acl"
href="{aclResourceUri}"/>
</links>
</permission-set>

Example 2-211: JSON representation

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+json
{
"permitted": [
{
"accessor": "dm_world",
"basic-permission": "Read",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
},
{

514 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.54. Product Information

"accessor": "dm_owner",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION",
"basic-permission": "Write"
},
......
],
"restricted": [
......
],
"required-group": [
......
],
"required-group-set": [
......
],
"links": [
{
"rel": "self",
"href": "{permissionSetResourceUri}"
},
{
"rel": "edit",
"href": "{permissionSetResourceUri}"
},
{
"rel": "http://identifiers.emc.com/linkrel/acl",
"href": "{aclResourceUri}"
}
]
}

2.54 Product Information

The Product Information resource provides general information about the
product, including the product name, major version, minor version, and so on.

2.54.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Home Document” on page 331 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 515

Chapter 2 Resources

2.54.2 Feed
No feed support.

2.54.3 Link relations

Link relation Description Resource reference
self Production information “Product Information”
on page 515

2.54.4 Operations
2.54.4.1 Supported HTTP methods

Method Description
GET Retrieves product information.

2.54.4.2 Get Product Information

Retrieve product information about Documentum REST Services, including product
name, product version information. No authentication is required to perform this
operation.

2.54.4.2.1 HTTP Request method and query parameters

GET

2.54.4.2.2 Request media types

N/A

2.54.4.2.3 Request headers

• Accept

Note: The authorization header is not required when a client tries to get the
Product Information resource.

516 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.54. Product Information

2.54.4.2.4 Request body

N/A

2.54.4.2.5 Response headers

• Content-Type
• Content-Length

2.54.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.54.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.54.4.2.8 Response body

XML or JSON representation of product information.

Example 2-212: XML response

<product-info name="documentum-rest-services-product-info">
<properties>
<product>Documentum REST Services</product>
<product_version>7.3.xxx.yyy</product_version>
<major>7.3</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.emc.com:8080/dctm-rest/product-info" />
</links>
</product-info>

Example 2-213: JSON response

{
"name": "documentum-rest-services-product-info",
"properties": {
"product": "Documentum REST Services",

EDCPKRST220200-PRE-EN-01 Reference Guide 517

Chapter 2 Resources

"product_version": "7.3.xxx.yyy",
"major": "7.3",
"minor": "xxx",
"build_number": "yyy",
"revision_number": "zzz"
},
"links": [
{
"rel": "self",
"href": "http://core-rs-demo.lss.emc.com:8080/dctm-rest/product-
info.json"
}
]
}

2.55 Registered Audit Event (s)

2.55.1 Registered Audit Event
The Registered Audit Event resource represents a single registered audit event for
a specified object, folder, format, or repository. Logged in users must have CONFIG
privileges added to their extended user permissions to get access to this resource.

2.55.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Registered Audit Events” on page 522 and About the Diagram
on page 17.

2.55.1.2 Feed
No feed support.

518 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.55. Registered Audit Event (s)

2.55.1.3 Link relations

Link relations Description Resource reference

self This resource. “Registered Audit Event”
on page 518
delete Used to unregister the “Registered Audit Event”
specified event from the on page 518
specified object.

2.55.1.4 Operations
2.55.1.4.1 Supported HTTP methods

HTTP method Description

GET GET a single registered audit event.
DELETE Unregister a single audit event.

2.55.1.4.2 Get a Registered Event

This operation retrieves a registered audit event from a specified object.

2.55.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.55.1.4.2.2 Request media types

N/A

2.55.1.4.2.3 Request headers

• Authorization
• Accept
For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

EDCPKRST220200-PRE-EN-01 Reference Guide 519

Chapter 2 Resources

2.55.1.4.2.4 Request body

N/A

2.55.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.55.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.55.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.55.1.4.2.8 Response body

Example 2-214: XML

<?xml version='1.0' encoding='UTF-8'?>

<audit-event xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<properties>
<r_object_id>2600000580000505</r_object_id>
<registered_id>0300000580000105</registered_id>
<event>dm_save</event>
<audit_subtypes>true</audit_subtypes>
<controlling_app></controlling_app>
<policy_id>0000000000000000</policy_id>
<policy_state></policy_state>
<a_authentication>0</a_authentication>
<audit_attr_names xsi:nil="true"/>
<sign_audit>false</sign_audit>
<a_esignature_required>0</a_esignature_required>
<user_name>dm_fulltext_index_user_01</user_name>
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events/2600000580000505"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events/2600000580000505"/>

520 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.55. Registered Audit Event (s)

</links>
</audit-event>

2.55.1.4.3 Delete a registered event

This operation unregisters a registered audit event.

2.55.1.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
DELETE N/A For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.55.1.4.3.2 Request media types

N/A

2.55.1.4.3.3 Request headers

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.55.1.4.3.4 Request body

N/A

2.55.1.4.3.5 Response headers

N/A

2.55.1.4.3.6 Response media types

N/A

2.55.1.4.3.7 Response status

• 204 - Unregistered successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 521

Chapter 2 Resources

2.55.1.4.3.8 Response body

N/A

2.55.2 Registered Audit Events

The Registered Audit Events represents the registered audit events for a specified
object, folder, format, or repository. Logged in users must have CONFIG privileges
added to their extended user permissions to get access to this resource.

2.55.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.55.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: Audit Events
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: RegisteredAuditEvent
• Entry ID: URI of the Registered Audit Event
• Entry Title: The id of the specified registered event.
• Entry Updated: Current server time.

522 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.55. Registered Audit Event (s)

2.55.2.3 Link relations

Link relations Description Resource reference

self This resource. “Registered Audit Events”
on page 522
unregister-all-audit-events Unregisters all registered “Registered Audit Events”
[1] audit events for the specified on page 522
object.
first, last, next and previous Pagination links “Registered Audit Events”
on page 522
available-audit-events [1] Retrieves the available audit “Available Audit Events”
event in a specified on page 112
condition.
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.55.2.4 Operations

2.55.2.4.1 Supported HTTP methods

HTTP methods Descriptions

GET Retrieves all of the registered events for the specified path requested.
POST Registers an audit event for a specified object.
DELETE Unregisters all audit events according to the query parameters set.

2.55.2.4.2 Get All Registered Audit Events

2.55.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

methods parameters
GET • inline For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
• page
• items-
per-
page
• include
-total
• filter
• links
• sort
• view

EDCPKRST220200-PRE-EN-01 Reference Guide 523

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

methods parameters
audit- Defines the String One of the null
scope scope of following
impact for the values:
audit events
• reposit
ory
• type
• object
object-id <r_object_id> String Any valid null
of any object <r_object_id>
in value.
Documentum
Server. This
parameter. is
meant to be
used alone or
as part of a
statement.
object- The name of String Any valid null
type the <dm_type> <dm_type>
in name.
Documentum
Server. This
parameter is
meant to be
used alone or
as part of a
statement.

2.55.2.4.2.2 Request media types

N/A

2.55.2.4.2.3 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

524 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.55. Registered Audit Event (s)

2.55.2.4.2.4 Request body

N/A

2.55.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.55.2.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.55.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.55.2.4.2.8 Response body

Example 2-215: XML

<?xml version='1.0' encoding='UTF-8'?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/registered-audit-
events</id>
<title>Audit Events</title>
<author>
<name>EMC Documentum</name>
</author>
<updated>2017-05-24T03:05:05.381+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/
registered-audit-events"/>
<link rel="http://identifiers.emc.com/linkrel/unregister-all-audit-events"
href="http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events"/>
<link rel="http://identifiers.emc.com/linkrel/available-audit-events"
href="http://localhost:8080/dctm-rest/repositories/REPO/
available-audit-events"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/

EDCPKRST220200-PRE-EN-01 Reference Guide 525

Chapter 2 Resources

registered-audit-events/2600000580000905</id>
<title>2600000580000905</title>
<author>
<name>auditadmin</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/
auditadmin</uri>
</author>
<summary>Detail of Registered Audit Event</summary>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events/2600000580000905"/>
<content>
<dm:audit-event xmlns:dm="http://identifiers.emc.com/vocab/
documentum"/>
</content>
</entry>
</feed>

Example 2-216: JSON

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/registered-audit-
events",
"title": "Audit Events",
"author": [
{
"name": "EMC Documentum"
}
],
"updated": "2017-05-24T03:03:48.854+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events"
},
{
"rel": "http://identifiers.emc.com/linkrel/unregister-all-audit-events",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events"
},
{
"rel": "http://identifiers.emc.com/linkrel/available-audit-events",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
available-audit-events"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events/2600000580000905",
"title": "2600000580000905",
"author": [
{
"name": "auditadmin",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/
auditadmin"

526 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.55. Registered Audit Event (s)

}
],
"summary": "Detail of Registered Audit Event",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events/2600000580000905"
}
],
"content": {
}
}
]
}

2.55.2.4.3 Register an audit event

2.55.2.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

methods parameters
POST audit- Defines the String One of the null
scope scope of following
impact for the values:
Mandatory audit events
query • reposit
parameter ory
• type
• object
object-id <r_object_id> String Any valid null
of any object <r_object_id>
in value.
Documentum
Server. This
parameter is
meant to be
used as part
of a
statement.
object- The name of String Any valid null
type the <dm_type> <dm_type>
in name.
Documentum
Server. This
parameter is
meant to be
used as part
of a
statement.

EDCPKRST220200-PRE-EN-01 Reference Guide 527

Chapter 2 Resources

Caution
The object-id query parameter is mandatory when used as part of this
statement.<audit-scope=object>

This object-type query parameter is mandatory when used as part of this

statement.<audit-scope=type>

2.55.2.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.55.2.4.3.3 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.55.2.4.3.4 Request body

Example 2-217: XML

<?xml version="1.0" encoding="UTF-8"?>
<register-audit-event xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_register-audit-event">
<properties>
<event>dm_getlogin</event>
</properties>
</register-audit-event>

Example 2-218: JSON

{
"properties": {
"event": "dm_getlogin",
}
}

528 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.55. Registered Audit Event (s)

2.55.2.4.3.5 Response headers

• Content-Type
• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.55.2.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.55.2.4.3.7 Response status

• 201 - Registered successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.55.2.4.3.8 Response body

Example 2-219: XML

<?xml version='1.0' encoding='UTF-8'?>

<audit-event xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dmi_registry">
<properties>
<user_name>auditadmin</user_name>
<registered_id>0000000000000000</registered_id>
<event>dm_save</event>
<oneshot>false</oneshot>
<sendmail>false</sendmail>
<priority>0</priority>
<message>Save Object</message>
<is_audittrail>true</is_audittrail>
<policy_id>0000000000000000</policy_id>
<audit_subtypes>false</audit_subtypes>
<a_authentication>0</a_authentication>
<sign_audit>false</sign_audit>
<a_esignature_required>0</a_esignature_required>
<i_is_replica>false</i_is_replica>
<i_vstamp>0</i_vstamp>
<r_object_id>2600000580000906</r_object_id>
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events?audit-scope=repository"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/

EDCPKRST220200-PRE-EN-01 Reference Guide 529

Chapter 2 Resources

registered-audit-events/2600000580000906"/>
</links>
</audit-event>

Example 2-220: JSON

{
"json-root": "audit-event",
"type": "dmi_registry",
"properties": {
"user_name": "auditadmin",
"registered_id": "0000000000000000",
"event": "dm_save",
"oneshot": false,
"sendmail": false,
"priority": 0,
"message": "Save Object",
"is_audittrail": true,
"policy_id": "0000000000000000",
"audit_subtypes": false,
"a_authentication": 0,
"sign_audit": false,
"a_esignature_required": 0,
"i_is_replica": false,
"i_vstamp": 0,
"r_object_id": "2600000580000906"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events?audit-scope=repository"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
registered-audit-events/2600000580000906"
}
]
}

Notes

• The value of <controlling_app> is stored in Documentum Server in lowercase.

• The <policy_id>, <policy_state>, and <audit_subtypes> parameters are not
permitted when performing an audit on an object instance.

530 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.55. Registered Audit Event (s)

2.55.2.4.4 Unregister all registered audit events

2.55.2.4.4.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

methods parameters
DELETE audit- Defines the String One of the null
scope scope of following
impact for the values:
Mandatory audit events
query • reposit
parameter ory
• type
• object
object-id <r_object_id> String Any valid null
of any object <r_object_id>
in value.
Documentum
Server. This
parameter is
meant to be
used as part
of a
statement.
object- The name of String Any valid null
type the <dm_type> <dm_type>
in name.
Documentum
Server. This
parameter is
meant to be
used as part
of a
statement.

Caution
The object-id query parameter is mandatory when used as part of this
statement. <audit-scope=object>

The object-type query parameter is mandatory when used as part of this

statement. <audit-scope=type>

EDCPKRST220200-PRE-EN-01 Reference Guide 531

Chapter 2 Resources

2.55.2.4.4.2 Request media types

N/A

2.55.2.4.4.3 Request headers

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.55.2.4.4.4 Request body

N/A

2.55.2.4.4.5 Response headers

N/A

2.55.2.4.4.6 Response media types

N/A

2.55.2.4.4.7 Response status

• 204 - Unregister procedure succeeded

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.55.2.4.4.8 Response body

N/A

2.55.2.4.4.9 Additional information on events

Documentum Server audits some events by default. For more information, see
Appendix F, Events Audited by Default on page 1009.

2.56 Relation (s)

532 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.56. Relation (s)

2.56.1 Relation
The Relation resource represents a single relation instance in a repository.

2.56.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Relations” on page 536 and About the Diagram on page 17.

2.56.1.2 Feed
No feed support.

2.56.1.3 Link relations

Link relation Description Resource reference

self This Relation resource “Relation” on page 533
relation-type [1] Relation type definition “Relation Type” on page 554
parent Reference to the parent object of “SysObject” on page 690
this instance
“Document” on page 217

“Folder” on page 236

“Cabinet” on page 137

child Reference to the child object of this “SysObject” on page 690
instance
“Document” on page 217

“Folder” on page 236

“Cabinet” on page 137

EDCPKRST220200-PRE-EN-01 Reference Guide 533

Chapter 2 Resources

Link relation Description Resource reference

[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.56.1.4 Operations
2.56.1.4.1 Supported HTTP methods

Method Description
GET Retrieves a specified relation.
DELETE Deletes a specified relation.

2.56.1.4.2 Get a Relation

Retrieve a specified relation instance.

2.56.1.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameter:

HTTP Query Description Data type Value range Default value

method parameter
GET view For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.56.1.4.2.2 Request media types

N/A

2.56.1.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

534 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.56. Relation (s)

2.56.1.4.2.4 Request body

N/A

2.56.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.56.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.56.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.56.1.4.2.8 Response body

An XML or JSON representation of the relation.

2.56.1.4.3 Delete a Relation

Delete a specified relation in the repository.

2.56.1.4.3.1 HTTP Request method and query parameters

DELETE

2.56.1.4.3.2 Request media types

N/A

EDCPKRST220200-PRE-EN-01 Reference Guide 535

Chapter 2 Resources

2.56.1.4.3.3 Request headers

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.56.1.4.3.4 Request body

N/A

2.56.1.4.3.5 Response headers

N/A

2.56.1.4.3.6 Response media types

N/A

2.56.1.4.3.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.56.1.4.3.8 Response body

HTTP 204 No Content status upon a successful delete operation. The response body
contains no content.

2.56.2 Relations
The Relations resource represents a collection of relations in a repository.

2.56.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

536 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.56. Relation (s)

2.56.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: List of relations
• Supports POST: Yes
• Entry: “Relation” on page 533
• Entry ID: URI of the relation
• Entry Title: Relation name
• Entry Summary: Relation description
• Entry Updated: r_modify_date of the relation

2.56.2.3 Link relations

Link relation Description Resource reference

self This collection of relations. “Relations” on page 536
first, last, next, previous Pagination links. “Relations” on page 536

2.56.2.4 Operations
2.56.2.4.1 Supported HTTP methods

Method Description
GET Retrieves the information about a collection
of relations.
POST Create a new relation instance between two
objects.

2.56.2.4.2 Get Relations

Retrieve the information about a collection of relations.

2.56.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value Default

method param range value
eters
GET relat Only relations whose name string N/A null
ion- equals to the specified string are
name returned in the result.

Relation names are case sensitive.

EDCPKRST220200-PRE-EN-01 Reference Guide 537

Chapter 2 Resources

HTTP Query Description Data type Value Default

method param range value
eters
relat Only relations that contain an string N/A null
ed- object whose object ID equals to
objec the specified string are returned
t-id in the result.
relat Indicates the role of the object string N/A <any>
ed- specified by the object ID. (Only
objec works when the related-
t- object-id parameter is
role specified.)

Valid values are:

• child
• parent
• any

This method supports the following common query parameters:

• inline
• view
• items-per-page
• page
• include-total
• sort
• links
• filter

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.56.2.4.2.2 Request media types

N/A

538 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.56. Relation (s)

2.56.2.4.2.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.56.2.4.2.4 Request body

N/A

2.56.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.56.2.4.2.6 Response media types

• application/atom+xml

• application/vnd.emc.documentum+json

• application/xml

• application/json

2.56.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.56.2.4.2.8 Response body

XML or JSON representation of the collection of relations.

• The body contains a list of the dm_relation instances (or subtypes of dm_
relation).

• Each object may contain all or a set of 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.

EDCPKRST220200-PRE-EN-01 Reference Guide 539

Chapter 2 Resources

2.57 Related Documents

The Related Documents resource forms part of the related document service of the
Documentum Contextual Content Engine (CCE). This resource can find related or
similar documents using common values among documents, such as keywords.

2.57.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Document” on page 217 and About the Diagram on page 17.

2.57.2 Feed
Is this resource a feed? Yes.

• Feed ID: Resource URI

• Feed Title: Related Documents of <document name> from CCE
• Supports POST: No
• Feed Updated: Current server time
• Entry: “Document” on page 217
• Entry ID: URI of the Document resource
• Entry Title: The name of the document
• Entry Updated: Current server time

2.57.3 Link relations

Link relation Description Resource reference
self This collection of related “Related Documents”
documents. on page 540

540 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.57. Related Documents

2.57.4 Operations
2.57.4.1 Supported HTTP methods

Method Description
GET Retrieves the related documents of the
requested document.

2.57.4.2 Get Related Documents

Retrieves the related documents of the requested document.

2.57.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET page, For more information, see Appendix B, REST Common
items-per- Definition - URI Request Query Parameters on page 979.
page,
links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.57.4.2.2 Request media types

N/A

2.57.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.57.4.2.4 Request body

N/A

EDCPKRST220200-PRE-EN-01 Reference Guide 541

Chapter 2 Resources

2.57.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.57.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json
• application/hal+json

2.57.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.57.4.2.8 Response body

Example 2-221: XML Response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115c/related-docs</id>
<title>Related Documents of document 090000018000115c from CCE</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2018-08-20T02:34:35.756+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/documents/
090000018000115c/related-docs"></link>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115a</id>
<title>Laboratory-Manager</title>
<author>
<name>Administrator</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/
Administrator</uri>

542 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.57. Related Documents

</author>
<summary>dm_document 090000018000115a</summary>
<updated>2018-08-01T02:48:54.000+00:00</updated>
<published>2018-07-31T09:16:35.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115a"></link>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115a"></content>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115d</id>
<title>Project-Manager</title>
<author>
<name>Administrator</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/
Administrator</uri>
</author>
<author>
<name>mary</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/
mary</uri>
</author>
<author>
<name>dave</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/
dave</uri>
</author>
<summary>dm_document 090000018000115d</summary>
<updated>2018-08-01T02:59:30.000+00:00</updated>
<published>2018-07-31T09:19:08.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115d"></link>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115d"></content>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115b</id>
<title>Product-Manager</title>
<author>
<name>mary</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/
mary</uri>
</author>
<author>
<name>dave</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/
dave</uri>
</author>
<author>
<name>Administrator</name>
<uri>http://localhost:8080/dctm-rest/repositories/REPO/users/
Administrator</uri>
</author>
<summary>dm_document 090000018000115b</summary>
<updated>2018-08-01T02:53:37.000+00:00</updated>
<published>2018-07-31T09:17:01.000+00:00</published>

EDCPKRST220200-PRE-EN-01 Reference Guide 543

Chapter 2 Resources

<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115b"></link>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115b"></content>
</entry>
</feed>

Example 2-222: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115c/related-docs",
"title": "Related Documents of document 090000018000115c from CCE",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-08-20T02:30:30.334+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115c/related-docs"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115a",
"title": "Laboratory-Manager",
"author": [
{
"name": "Administrator",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/
users/Administrator"
}
],
"summary": "dm_document 090000018000115a",
"updated": "2018-08-01T02:48:54.000+00:00",
"published": "2018-07-31T09:16:35.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/documents/090000018000115a"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115a"
}
},
{

544 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.57. Related Documents

"id": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115d",
"title": "Project-Manager",
"author": [
{
"name": "Administrator",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/
users/Administrator"
},
{
"name": "mary",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/
users/mary"
},
{
"name": "dave",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/
users/dave"
}
],
"summary": "dm_document 090000018000115d",
"updated": "2018-08-01T02:59:30.000+00:00",
"published": "2018-07-31T09:19:08.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/documents/090000018000115d"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115d"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115b",
"title": "Product-Manager",
"author": [
{
"name": "mary",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/
users/mary"
},
{
"name": "dave",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/
users/dave"
},
{
"name": "Administrator",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/
users/Administrator"
}
],
"summary": "dm_document 090000018000115b",
"updated": "2018-08-01T02:53:37.000+00:00",
"published": "2018-07-31T09:17:01.000+00:00",
"links": [
{

EDCPKRST220200-PRE-EN-01 Reference Guide 545

Chapter 2 Resources

"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/documents/090000018000115b"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115b"
}
}
]
}

Example 2-223: HAL: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115c/related-docs",
"title": "Related Documents of document 090000018000115c from CCE",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-08-20T02:30:30.334+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115c/related-docs"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115a",
"title": "Laboratory-Manager",
"author": [
{
"name": "Administrator",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/
users/Administrator"
}
],
"summary": "dm_document 090000018000115a",
"updated": "2018-08-01T02:48:54.000+00:00",
"published": "2018-07-31T09:16:35.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/documents/090000018000115a"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",

546 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.57. Related Documents

"src": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115a"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115d",
"title": "Project-Manager",
"author": [
{
"name": "Administrator",
"uri": "http://localhost:8080/dctm-rest/repositories/
REPO/users/Administrator"
},
{
"name": "mary",
"uri": "http://localhost:8080/dctm-rest/repositories/
REPO/users/mary"
},
{
"name": "dave",
"uri": "http://localhost:8080/dctm-rest/repositories/
REPO/users/dave"
}
],
"summary": "dm_document 090000018000115d",
"updated": "2018-08-01T02:59:30.000+00:00",
"published": "2018-07-31T09:19:08.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/documents/090000018000115d"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115d"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115b",
"title": "Product-Manager",
"author": [
{
"name": "mary",
"uri": "http://localhost:8080/dctm-rest/repositories/
REPO/users/mary"
},
{
"name": "dave",
"uri": "http://localhost:8080/dctm-rest/repositories/
REPO/users/dave"
},
{
"name": "Administrator",
"uri": "http://localhost:8080/dctm-rest/repositories/
REPO/users/Administrator"
}
],

EDCPKRST220200-PRE-EN-01 Reference Guide 547

Chapter 2 Resources

"summary": "dm_document 090000018000115b",

"updated": "2018-08-01T02:53:37.000+00:00",
"published": "2018-07-31T09:17:01.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/documents/090000018000115b"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115b"
}
}
]
}

2.58 Related SME

The Related Subject Matter Experts (SME) resource forms part of the services of the
Documentum Contextual Content Engine (CCE). This resource can find related SME
(Authors) who have done work on a given document.

2.58.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Document” on page 217 and About the Diagram on page 17.

2.58.2 Feed
Is this resource a feed? Yes.

• Feed ID: Resource URI

• Feed Title: Related SME (authors) of <document name> from CCE
• Supports POST: No
• Feed Updated: Current server time
• Entry: “User” on page 765
• Entry ID: The User resource URI
• Entry Title: The name of the user

548 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.58. Related SME

• Entry Updated: Current server time

2.58.3 Link relations

Link relation Description Resource reference

self This collection of related “Related SME” on page 548
SMEs.

2.58.4 Operations
2.58.4.1 Supported HTTP methods

Method Description
GET Retrieves the related SME of the requested
document.

2.58.4.2 Get Related SMEs

Retrieves the related SME of the requested document.

2.58.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET page, For more information, see Appendix B, REST Common
items-per- Definition - URI Request Query Parameters on page 979.
page,
links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.58.4.2.2 Request media types

N/A

2.58.4.2.3 Request headers

• Accept

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 549

Chapter 2 Resources

2.58.4.2.4 Request body

N/A

2.58.4.2.5 Response headers

• Content-Type
• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.58.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json
• application/hal+json

2.58.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.58.4.2.8 Response body

Example 2-224: XML Response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:xsi="http://www.w3.org/2001/
XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115c/related-sme</id>
<title>Related SMEs(authors) of document 090000018000115c from CCE</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2018-08-20T02:52:47.378+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/documents/
090000018000115c/related-sme"></link>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/users/dave</id>
<title>dave</title>
<summary></summary>

550 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.58. Related SME

<updated>2018-08-01T02:28:30.000+00:00</updated>
<published>2018-08-01T02:28:30.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/users/
dave"></link>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/users/
dave"></content>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/users/
Administrator</id>
<title>Administrator</title>
<summary></summary>
<updated>2018-07-31T03:56:09.000+00:00</updated>
<published>2018-07-31T03:56:09.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/users/
Administrator"></link>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/users/
Administrator"></content>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/users/mary</id>
<title>mary</title>
<summary></summary>
<updated>2018-08-01T02:30:03.000+00:00</updated>
<published>2018-08-01T02:30:03.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/users/
mary"></link>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/users/
mary"></content>
</entry>
</feed>

Example 2-225: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115c/related-sme",
"title": "Related SMEs(authors) of document 090000018000115c from CCE",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-08-20T02:47:02.551+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115c/related-sme"
}
],

EDCPKRST220200-PRE-EN-01 Reference Guide 551

Chapter 2 Resources

"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/users/
dave",
"title": "dave",
"summary": "",
"updated": "2018-08-01T02:28:30.000+00:00",
"published": "2018-08-01T02:28:30.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/users/dave"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
users/dave"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/users/
Administrator",
"title": "Administrator",
"summary": "",
"updated": "2018-07-31T03:56:09.000+00:00",
"published": "2018-07-31T03:56:09.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"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/users/
mary",
"title": "mary",
"summary": "",
"updated": "2018-08-01T02:30:03.000+00:00",
"published": "2018-08-01T02:30:03.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/users/mary"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
users/mary"
}
}

552 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.58. Related SME

]
}

Example 2-226: HAL: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115c/related-sme",
"title": "Related SMEs(authors) of document 090000018000115c from CCE",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-09-14T02:07:01.300+00:00",
"page": 1,
"items-per-page": 100,
"_embedded": {
"collection": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
users/dave",
"title": "dave",
"updated": "2018-08-01T02:28:30.000+00:00",
"published": "2018-08-01T02:28:30.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/users/dave"
}
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
users/Administrator",
"title": "Administrator",
"updated": "2018-07-31T03:56:09.000+00:00",
"published": "2018-07-31T03:56:09.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/users/Administrator"
}
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
users/mary",
"title": "mary",
"updated": "2018-08-01T02:30:03.000+00:00",
"published": "2018-08-01T02:30:03.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/users/mary"
}
}
}
]

EDCPKRST220200-PRE-EN-01 Reference Guide 553

Chapter 2 Resources

},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115c/related-sme"
}
}
}

2.59 Relation Type (s)

2.59.1 Relation Type
The Relation Type resource represents a single instance of a relation type (dm_
relation_type and its subtypes) in a repository.

2.59.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Relation Types” on page 556 and About the Diagram on page 17.

2.59.1.2 Feed
No feed support.

2.59.1.3 Link relations

Link relation Description Resource reference

self This Relation resource. “Relation Type” on page 554
relations [1] Relations that use this relation “Relations” on page 536
type
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

554 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.59. Relation Type (s)

2.59.1.4 Operations
2.59.1.4.1 Supported HTTP methods

Method Description
GET Retrieves a specified Relation Type resource.

2.59.1.4.2 Get a Relation Type

Retrieve a specified Relation Type resource.

2.59.1.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameter:

• view

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.59.1.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.59.1.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.59.1.4.2.4 Request body

N/A

EDCPKRST220200-PRE-EN-01 Reference Guide 555

Chapter 2 Resources

2.59.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.59.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

• application/xml

• application/json

2.59.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.59.1.4.2.8 Response body

XML or JSON representation of the relation type.

Note: The relation type name in the URL is encoded.

2.59.2 Relation Types

The Relation Types resource represents a collection of relation type (dm_relation_
type and its subtypes) instances in a repository.

2.59.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

556 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.59. Relation Type (s)

2.59.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the relation types

• Feed Title: Relation Types
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: “Relation Type” on page 554
• Entry ID: URI of the relation type
• Entry Title: Relation type name
• Entry Summary: Relation type description
• Entry Updated: r_modify_date of the relation type

2.59.2.3 Link relations

Link relation Description Resource reference

self This Relation Types resource. “Relation Types” on page 556
first, last, next, previous Pagination links “Relation Types” on page 556

2.59.2.4 Operations
2.59.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a collection of Relation Type
instances.

2.59.2.4.2 Get Relation Types

Retrieve a collection of Relation Type instances.

2.59.2.4.2.1 HTTP Request method and query parameters

EDCPKRST220200-PRE-EN-01 Reference Guide 557

Chapter 2 Resources

HTTP Query Descriptio Data type Value range Default

method paramete n value
rs
GET view Defines the string The pattern is: <? <:default>
properties view=(:view-name)?(,column)*
to return. - (:view-name) and
(,columns)*> and must be
mutually exclusive names
of predefined views start
with ":".

The following view-names

are
defined:<– :all><– :default>- if
no view-name is specified,
then a comma-separated list
of the names of properties
or predefined views are
returned.
links Defines string true or false <true>
whether
• <links=true> is default
link
relations to • <links=false> means “Do
be not send me any links
returned that are too expensive to
for this calculate. Only send me
object links that are cheap to
representat calculate”.
ion
inline Ensures string • <true> - Returns the <false>
whether to object instance and
show embeds an object
content instance into the entry's
(the object content element
instance) in • <false> - Does not return
the atom an object instance.
entry for a
collection;

558 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.59. Relation Type (s)

HTTP Query Descriptio Data type Value range Default

method paramete n value
rs
sort Defines string <sort> is an optional The default
sorting for parameter that is created value of this
entries in using a comma separated parameter
the list of sort specifications may differ
collection that, when combined, create by resource
result a sort order. Each sort
specification consists of an
attribute to be sorted and its
sort order, separated by a
space character.

The sort order can be either

“DESC” or “ASC”, and the
sort can also be case
insensitive.

Optionally, sort order can

be specified with non-
repeating attributes;

For example: sort=r_

modify_date desc,
object_id asc,title

When an attribute with

invalid name is specified, an
error is thrown.
filter A filter filter N/A No filter is
expression expression applied
in a subset
of XPath.
page Defines the integer >= 1 <1>
number of
the page to For example:
be served. items_
per_page=
When the 200&page=
result feed 2 returns
is paged, items 201 to
an 400
<dm:page
>xxx</
dm:page>
element is
displayed
under the
feed root.

EDCPKRST220200-PRE-EN-01 Reference Guide 559

Chapter 2 Resources

HTTP Query Descriptio Data type Value range Default

method paramete n value
rs
items- number of integer >=1 <100>
per- entries per
page page; when
the result
feed is
paged, an
element
<dm:item
s-per-
page>xxx
</
dm:items
-per-
page> will
be
displayed
under the
feed root
include indicate to string • <true> - The server <false>
-total calculate calculates the total count
the total of feed items and returns
count of that value.
the feed • <false>- Does not
items as calculate and return a
though not total count.
returning
them all in
one page;
when it is
true, an
element
<dm:tota
l>xxx</
dm:total
> will be
displayed
under the
feed root

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

560 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.59. Relation Type (s)

2.59.2.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.59.2.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.59.2.4.2.4 Request body

N/A

2.59.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.59.2.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.59.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 561

Chapter 2 Resources

2.59.2.4.2.8 Response body

XML or JSON representation of the relation types.

Note: The type name in the URL is encoded.

2.60 Repository
The Repository resource provides information about a single repository. This
resource requires authentication.

2.60.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repositories” on page 571 and About the Diagram on page 17.

2.60.2 Feed
No feed support.

2.60.3 Link relations

Link relation Description Resource reference
acls [1] Link to ACLs in this repository. “ACLs Collection” on page 55
archived-contents Link to archived contents resource “Archived Contents” on page 70
[1]
aspect-types [1] Link to aspect types resource. “Aspect Types” on page 83
batches [1] Link to batches resource. “Batches” on page 115
batch-capabilities Link to batch capabilities resource. “Batch Capabilities” on page 133
[1]
cabinets [1] Link to the cabinets collection. “Cabinets” on page 143
checked-out- Link to the Checked Out Objects “Checked Out Objects”
objects [1] resource. on page 148

562 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.60. Repository

Link relation Description Resource reference

current-user [1] Link to the current login user of “Current User” on page 191
the repository.
current-user- Link to the Current User “Current User Preferences”
preferences [1] Preferences resource. on page 201
dql [1] Link to the dql resource in this “DQL” on page 227
repository.
formats [1] Link to the formats in this “Formats” on page 308
repository.
groups [1] Link to the groups in this “Groups” on page 320
repository.
lifecycles [1] Link to the Lifecycles resource. “Lifecycles” on page 382
network-locations Link to the network locations of “Network Locations” on page 446
[1] this repository.
relations [1] Link to the Relations resource. “Relations” on page 536
relation-types [1] Link to the relation types in this “Relation Types” on page 556
repository.
saved-searches [1] Link to the saved-searches “Saved Searches” on page 584
resource.
search [1] Link to the search resource. “Search” on page 643
search-templates Link to search templates resource. “Saved Search Templates”
[1] on page 619
self Link to this repository. “Repository” on page 562
snapshots Link to the Virtual Document “Virtual Document Snapshots”
Snapshots resource. on page 838
repository Link to the repository instance “Repositories” on page 571
itself.
types [1] Link to the Types resource. “Types” on page 754
users [1] Link to the users in this repository. “Users” on page 774
subscriptions [1] You, as the current user, can view “User Subscriptions”
all subscriptions in the repository. on page 797
word-suggestions Allows you to use word “Word Suggestions”
[1] suggestions while searching for on page 863
content with Documentum CCE
synonyms [1] Allows you to use synonyms “Synonyms” on page 680
while searching for content with
Documentum CCE
synonym- Allows you to use synonym- “Synonym Categories”
categories [1] categories while searching for on page 684
content with Documentum CCE

EDCPKRST220200-PRE-EN-01 Reference Guide 563

Chapter 2 Resources

Link relation Description Resource reference

[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.60.4 Operations
2.60.4.1 Supported HTTP methods

Method Description
GET Retrieves properties of the Repository resource.

2.60.4.2 Get a repository

Retrieves information about a single repository.

2.60.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
include- Specifies string true, false false
domains whether to
return
domain
names. When
this
parameter is
set to true, it
returns
domain
names.

2.60.4.2.2 Request media types

N/A

564 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.60. Repository

2.60.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.60.4.2.4 Request body

N/A

2.60.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.60.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.60.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.60.4.2.8 Response body

XML or JSON representation of the repository. Documentum REST Services version

16.4 and later, provide the following two attributes:

• auth-protocol: When this attribute is set to domain-required on Windows

platforms, the repository runs in domain-required mode.
When this attribute is not set to domain-required, the repository does not run in
domain-required mode and this property is blank.
When you are authenticating users on the UNIX platform against a Windows
domain, you must set this attribute to unix_domain_used. Otherwise, it remains
blank for repositories that run on the UNIX platform.
• domains: Retrieves a list of domain names that are in the repository. The domain
name is the object_name of the dm_ldap_config object. The domains attribute
does not appear in the response when no domain has been configured in the
repository.

EDCPKRST220200-PRE-EN-01 Reference Guide 565

Chapter 2 Resources

Example 2-227: XML response

<?xml version='1.0' encoding='utf-8'?>
<repository xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>12</id>
<name>REPO1</name>
<description></description>
<auth-protocol></auth-protocol>
<server>
<name>REPO1</name>
<host>CS73</host>
<version xml:space="preserve">
7.3.0000.0214 Win64.SQLServer
</version>
<docbroker>CS73</docbroker>
</server>
<domains>
<domain>Ldap-joli-146</domain>
<domain>Copy of Ldap-joli-146</domain>
</domains>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO1?
include-domains=true" />
<link rel="http://identifiers.emc.com/linkrel/cabinets"
href="http://localhost:8080/dctm-rest/repositories/REPO1/cabinets" />
<link rel="http://identifiers.emc.com/linkrel/checked-out-objects"
href="http://localhost:8080/dctm-rest/repositories/REPO1/checked-out-
objects" />
<link rel="http://identifiers.emc.com/linkrel/current-user"
href="http://localhost:8080/dctm-rest/repositories/REPO1/
currentuser" />
<link rel="http://identifiers.emc.com/linkrel/current-user-preferences"
href="http://localhost:8080/dctm-rest/repositories/REPO1/
currentuser-preferences" />
<link rel="http://identifiers.emc.com/linkrel/users"
href="http://localhost:8080/dctm-rest/repositories/REPO1/users" />
<link rel="http://identifiers.emc.com/linkrel/groups"
href="http://localhost:8080/dctm-rest/repositories/REPO1/groups" />
<link rel="http://identifiers.emc.com/linkrel/formats"
href="http://localhost:8080/dctm-rest/repositories/REPO1/formats" />
<link rel="http://identifiers.emc.com/linkrel/network-locations"
href="http://localhost:8080/dctm-rest/repositories/REPO1/network-
locations" />
<link rel="http://identifiers.emc.com/linkrel/relations"
href="http://localhost:8080/dctm-rest/repositories/REPO1/relations" /
>
<link rel="http://identifiers.emc.com/linkrel/relation-types"
href="http://localhost:8080/dctm-rest/repositories/REPO1/relation-
types" />
<link rel="http://identifiers.emc.com/linkrel/types"
href="http://localhost:8080/dctm-rest/repositories/REPO1/types" />
<link rel="http://identifiers.emc.com/linkrel/aspect-types"
href="http://localhost:8080/dctm-rest/repositories/REPO1/aspect-
types" />
<link rel="http://identifiers.emc.com/linkrel/dql"
hreftemplate="http://localhost:8080/dctm-rest/repositories/REPO1{?
dql}" />
<link rel="http://identifiers.emc.com/linkrel/search"
hreftemplate="http://localhost:8080/dctm-rest/repositories/REPO1/

566 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.60. Repository

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/REPO1/saved-
searches" />
<link rel="http://identifiers.emc.com/linkrel/search-templates"
href="http://localhost:8080/dctm-rest/repositories/REPO1/search-
templates" />
<link rel="http://identifiers.emc.com/linkrel/acls"
href="http://localhost:8080/dctm-rest/repositories/REPO1/acls" />
<link rel="http://identifiers.emc.com/linkrel/batches"
href="http://localhost:8080/dctm-rest/repositories/REPO1/batches" />
<link rel="http://identifiers.emc.com/linkrel/batch-capabilities"
href="http://localhost:8080/dctm-rest/repositories/REPO1/batch-
capabilities" />
<link rel="http://identifiers.emc.com/linkrel/lifecycles"
href="http://localhost:8080/dctm-rest/repositories/REPO1/
lifecycles" />
<link rel="http://identifiers.emc.com/linkrel/snapshots"
href="http://localhost:8080/dctm-rest/repositories/REPO1/snapshots" /
>
<link rel="http://identifiers.emc.com/linkrel/audit-policies"
href="http://localhost:8080/dctm-rest/repositories/REPO1/audit-
policies" />
</links>
</repository>

Example 2-228: JSON response

{
"id": 12,
"name": "REPO1",
"description": "",
"auth-protocol": "",
"servers": [
{
"name": "REPO1",
"host": "CS73",
"version": "7.3.0000.0214 Win64.SQLServer",
"docbroker": "CS73"
}
],
"domains": [
"Ldap-joli-146",
"Copy of Ldap-joli-146"
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1?include-
domains=true"
},
{
"rel": "http://identifiers.emc.com/linkrel/cabinets",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/cabinets"
},
{

EDCPKRST220200-PRE-EN-01 Reference Guide 567

Chapter 2 Resources

"rel": "http://identifiers.emc.com/linkrel/checked-out-objects",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/checked-
out-objects"
},
{
"rel": "http://identifiers.emc.com/linkrel/current-user",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
currentuser"
},
{
"rel": "http://identifiers.emc.com/linkrel/current-user-preferences",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/
currentuser-preferences"
},
{
"rel": "http://identifiers.emc.com/linkrel/users",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/users"
},
{
"rel": "http://identifiers.emc.com/linkrel/groups",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/groups"
},
{
"rel": "http://identifiers.emc.com/linkrel/formats",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/formats"
},
{
"rel": "http://identifiers.emc.com/linkrel/network-locations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/network-
locations"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/relations"
},
{
"rel": "http://identifiers.emc.com/linkrel/relation-types",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/relation-
types"
},
{
"rel": "http://identifiers.emc.com/linkrel/types",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/types"
},
{
"rel": "http://identifiers.emc.com/linkrel/aspect-types",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/aspect-
types"
},
{
"rel": "http://identifiers.emc.com/linkrel/dql",
"hreftemplate": "http://localhost:8080/dctm-rest/repositories/REPO1{?
dql}"
},
{
"rel": "http://identifiers.emc.com/linkrel/search",
"hreftemplate": "http://localhost:8080/dctm-rest/repositories/REPO1/
search{?
collections,facet,include-total,inline,items-per-
page,locations,
object-type,page,q,sort,timezone,view}"
},

568 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.60. Repository

{
"rel": "http://identifiers.emc.com/linkrel/saved-searches",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/saved-
searches"
},
{
"rel": "http://identifiers.emc.com/linkrel/search-templates",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/search-
templates"
},
{
"rel": "http://identifiers.emc.com/linkrel/acls",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/acls"
},
{
"rel": "http://identifiers.emc.com/linkrel/batches",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/batches"
},
{
"rel": "http://identifiers.emc.com/linkrel/batch-capabilities",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/batch-
capabilities"
},
{
"rel": "http://identifiers.emc.com/linkrel/lifecycles",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/lifecycles"
},
{
"rel": "http://identifiers.emc.com/linkrel/snapshots",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/snapshots"
},
{
"rel": "http://identifiers.emc.com/linkrel/audit-policies",
"href": "http://localhost:8080/dctm-rest/repositories/REPO1/audit-
policies"
}
]
}

Example 2-229: Request and response

Request
GET http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/acme01
Accept:application/vnd.emc.documentum+json

Response
Status Code: 200 OK
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"id":1234,
"name":"acme01",
"servers":[
{
"name":"acme01",
"host":"CS70RC2_Main",

EDCPKRST220200-PRE-EN-01 Reference Guide 569

Chapter 2 Resources

"version":"7.0.0000.0501 Win64.SQLServer",
"docbroker":"CS70RC2_Main"
}
],
"links":[
{
"rel":"self",
"href":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/
acme01"
},
{
"rel":"http://identifiers.emc.com/linkrel/users",
"href":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/
acme01/users"
},
{
"rel":"http://identifiers.emc.com/linkrel/current-user",
"href":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/
acme01/
currentuser"
},
{
"rel":"http://identifiers.emc.com/linkrel/groups",
"href":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/
acme01/groups"
},
{
"rel":"http://identifiers.emc.com/linkrel/cabinets",
"href":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/
acme01/cabinets"
},
{
"rel":"http://identifiers.emc.com/linkrel/formats",
"href":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/
acme01/formats"
},
{
"rel":"http://identifiers.emc.com/linkrel/network-locations",
"href":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/
acme01/
network-locations"
},
{
"rel":"http://identifiers.emc.com/linkrel/relations",
"href":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/
acme01/relations"
},
{
"rel":"http://identifiers.emc.com/linkrel/relation-types",
"href":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/
acme01/
relation-types"
},
{
"rel":"http://identifiers.emc.com/linkrel/checked-out-objects",
"href":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/
acme01/
checked-out-objects"
},
{
"rel":"http://identifiers.emc.com/linkrel/types",
"href":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/repositories/

570 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.61. Repositories

acme01/types"
},
{
"rel":"http://identifiers.emc.com/linkrel/dql",
"hreftemplate":"http://core-rs-demo.lss.emc.com:8080/dctm-rest/
repositories/
acme01{?dql,page,items-per-page}"
}
]
}

2.61 Repositories
The Repositories resource represents a collection of available repositories
(including those that are not running).

2.61.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Home Document” on page 331 and About the Diagram on page 17.

2.61.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the repositories without the file extension

• Feed Title: List of repositories

• Feed Updated: Server's current time

• Supports POST: No

• Entry: “Repository” on page 562

• Entry ID: URI of the repository without the file extension

• Entry Title: Repository name

• Entry Summary: Repository description

EDCPKRST220200-PRE-EN-01 Reference Guide 571

Chapter 2 Resources

2.61.3 Link relations

Link relation Description Resource reference

self Link to this repositories “Repositories” on page 571
resource.

2.61.4 Operations
2.61.4.1 Supported HTTP methods

Method Description
GET Retrieves a collection of the repository
resources.

2.61.4.2 Get repositories

Retrieve a list of repositories with each repository's properties embedded in the
corresponding entry.

2.61.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• inline

• links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.61.4.2.2 Request media types

N/A

2.61.4.2.3 Request headers

• Accept

Note: The Authorization header is not needed when a client tries to get this
resource.

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987 .

572 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

2.61.4.2.4 Request body

N/A

2.61.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.61.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json (For compatible viewing

2.61.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.61.4.2.8 Response body

XML or JSON representation of the repository.

2.62 Saved Search (es)

2.62.1 Saved Search
You can define search criteria and save the search. After your search has been saved,
you can load, edit the search criteria, or execute the saved search and view the saved
results of the search.

EDCPKRST220200-PRE-EN-01 Reference Guide 573

Chapter 2 Resources

2.62.1.1 Feed
No feed support.

2.62.1.2 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: About the Diagram on page 17.

For more information, see “Saved Searches” on page 584.

2.62.1.3 Link relations

Link relation Description Resource reference

self Save the search “Saved Search” on page 573
edit Edit the saved search “Saved Search” on page 573
delete [1] Delete the saved search “Saved Search” on page 573
search-execution [1] Execute the saved search “Saved Search Execution”
on page 594
saved-search-results [1] View or work with the saved “Saved Search Results”
search results on page 601
as-search-template [1] Save the saved search as a “Saved Search” on page 573
template
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

574 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

2.62.1.4 Operations

2.62.1.4.1 Supported HTTP methods

Method Description
GET Retrieves saved search
POST Updates the saved search
DELETE Removes the saved search

2.62.1.4.2 Get a saved search

Gets a saved search from a repository.

2.62.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.62.1.4.2.2 Request media types

N/A

2.62.1.4.2.3 Request headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.62.1.4.2.4 Request body

N/A

2.62.1.4.2.5 Response headers

N/A

2.62.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

• application/xml

• application/json

EDCPKRST220200-PRE-EN-01 Reference Guide 575

Chapter 2 Resources

2.62.1.4.2.7 Response status

200 - Retrieved successfully

400, 401, 403, 406, 409, 415, 500

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985

2.62.1.4.2.8 Response body

Example 2-230: XML response

<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>
<creation-date>2016-03-10T01:38:44.000+00:00</creation-date>
<r_modify_date>2016-03-10T01:38:44.000+00:00</r_modify_date>
<r_modifier>Administrator</r_modifier>
<owner_name>Administrator</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>080000018000157f</r_object_id>
</properties>
<query-document>&lt;?xml version='1.0' encoding='UTF-8'?&gt;&lt;search
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" all-
versions="false"
include-hidden-objects="false"&gt;&lt;repositories&gt;&lt;repository
&gt;REPO&lt;/repository&gt;&lt;/repositories&gt;&lt;types&gt;&lt;type
&gt;dm_document&lt;/type&gt;&lt;/types&gt;
&lt;expression-set operator="AND"&gt;&lt;expressions&gt;
&lt;fulltext fuzzy="true"&gt;iig&lt;/fulltext&gt;&lt;/expressions&gt;
&lt;/expression-set&gt;&lt;columns&gt;&lt;column&gt;r_object_type
&lt;/column&gt;&lt;column&gt;object_name&lt;/column&gt;
&lt;column&gt;summary&lt;/column&gt;&lt;/columns&gt;&lt;/search&gt;
</query-document>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/
REPO/
saved-searches/080000018000157f.xml"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/
REPO/
saved-searches/080000018000157f.xml"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
080000018000157f.xml"/>
<link rel="http://identifiers.emc.com/linkrel/saved-search-results"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-

576 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

searches/
080000018000157f/results.xml"/>
<link rel="http://identifiers.emc.com/linkrel/search-execution"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
080000018000157f/execution.xml"/>
<link rel="http://identifiers.emc.com/linkrel/as-search-template"
href="http://localhost:8080/dctm-rest/repositories/REPO/
search-templates.xml"/>
</links>
</saved-search>

Example 2-231: JSON response

{
"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",
"creation-date": "2016-03-10T01:38:44.000+00:00",
"r_modify_date": "2016-03-10T01:38:44.000+00:00",
"r_modifier": "Administrator",
"owner_name": "Administrator",
"r_is_public": true,
"selected_sources": [
"REPO"
],
"has_results": false,
"results_count": -1,
"query_type": "query_builder",
"r_object_id": "080000018000157f"
},
"query-document": "{\"all-versions\":false,\"include-hidden-objects
\":false,
\"repositories\":[\"REPO\"],\"types\":[\"dm_document\"],\"expression-set\":
{\"expression-type\":\"expression-set\",\"operator\":\"AND\",
\"expressions\":
[{\"expression-type\":\"fulltext\",\"value\":\"iig\",\"fuzzy
\":true}]},
\"columns\":"[\"r_object_type\", \"object_name\", \"summary\"]",
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
080000018000157f"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
080000018000157f"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-

EDCPKRST220200-PRE-EN-01 Reference Guide 577

Chapter 2 Resources

searches/
080000018000157f"
},
{
"rel": "http://identifiers.emc.com/linkrel/saved-search-results",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
080000018000157f/results"
},
{
"rel": "http://identifiers.emc.com/linkrel/search-execution",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
080000018000157f/execution"
},
{
"rel": "http://identifiers.emc.com/linkrel/as-search-template",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search-
templates"
}
]
}

2.62.1.4.3 Update a saved search

You can use this resource to update a saved search. You can update the object_
name, title, and r_is_public attributes. You can also update a query-document
that contains an AQL. However, the AQL must be escaped.

For more information about the Abstract Query Language, see AQL.

2.62.1.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
POST query-locale A locale used string N/A Only
to evaluate supported
the query and with xPlore.
parse words
into a The default
language value is en.
dependent
token

578 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

2.62.1.4.3.2 Request media types

• application/vnd.emc.documentum+xml

• application/vnd.emc.documentum+json

2.62.1.4.3.3 Request headers

•Authorization, Accept, Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987..

2.62.1.4.3.4 Request body

Here is a code sample that shows you a saved search, which has properties and an
embedded query document in AQL. As you can see, the AQL statements in the
<query-document> element must all be escaped as shown below.

Example 2-232: XML request

<saved-search
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<properties>
<object_name>dave public</object_name>
<title>this is saved search</title>
<r_is_public>true</r_is_public>
</properties>
<query-document>
&lt;search xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"&gt;
&lt;types&gt;
&lt;type&gt;dm_sysobject&lt;/type&gt;
&lt;/types&gt;
&lt;expression-set&gt;
&lt;expressions&gt;
&lt;property-list name="owner_name" operator="IN"&gt;
&lt;values&gt;
&lt;value&gt;dmadmin&lt;/value&gt;
&lt;/values&gt;
&lt;/property-list&gt;
&lt;/expressions&gt;
&lt;/expression-set&gt;
&lt;facet-definitions&gt;
&lt;facet-definition id="id-1"&gt;
&lt;attributes&gt;
&lt;attribute&gt;r_object_type&lt;/attribute&gt;
&lt;/attributes&gt;
&lt;/facet-definition&gt;
&lt;/facet-definitions&gt;
&lt;/search&gt;
</query-document>
</saved-search>

EDCPKRST220200-PRE-EN-01 Reference Guide 579

Chapter 2 Resources

Example 2-233: JSON request

{
"properties": {
"object_name": "dave public",
"title": "this is saved search",
"r_is_public": true,
},
"query-document":"
{
\"types\": [\"dm_document\"],
\"expression-set\": {
\"expression-type": "expression-set",
\"expressions\": [
{
\"expression-type\": \"property\",
\"name\": \"myprop\",
\"operator\": \"CONTAINS\",
\"value\": \"myvalue\"
}
]
}
}
"
}

2.62.1.4.3.5 Response status

• 200 - OK
• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.62.1.4.3.6 Response headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.62.1.4.3.7 Response body

For more information, see “Response headers” on page 575

Example 2-234: XML request

<saved-search
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<properties>
<object_name>public search</object_name>
<title>this is saved search</title>
<r_is_public>true</r_is_public>
</properties>
<query-document>
&lt;?xml version='1.0' encoding='UTF-8'?&gt;&lt;search

580 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" all-
versions="false"
include-hidden-
objects="false"&gt;&lt;repositories&gt;&lt;repository&gt;REPO
&lt;/repository&gt;&lt;/
repositories&gt;&lt;types&gt;&lt;type&gt;dm_document&lt;/type&gt;
&lt;/types&gt;&lt;expression-set
operator="AND"&gt;&lt;expressions&gt;&lt;
fulltext fuzzy="true"&gt;iig&lt;/fulltext&gt;&lt;/
expressions&gt;&lt;/expression-set&gt;
&lt;columns&gt;&lt;column&gt;r_object_type&lt;/
column&gt;&lt;column&gt;object_name
&lt;/column&gt;&lt;column&gt;summary&lt;/column&gt;&lt;/
columns&gt;&lt;/search&gt;
</query-document>
</saved-search>

Example 2-235: XML response

<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">
<properties>
<object_name>public search</object_name>
<title>this is saved search</title>
<creation-date>2016-02-03T01:47:42.000+00:00</creation-date>
<r_modify_date>2016-02-03T01:50:01.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>0800000180010d42</r_object_id>
</properties>
<query-document>
&lt;?xml version='1.0' encoding='UTF-8'?&gt;&lt;search
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" all-
versions="false"
include-hidden-
objects="false"&gt;&lt;repositories&gt;&lt;repository&gt;
REPO&lt;/repository&gt;&lt;/
repositories&gt;&lt;types&gt;&lt;type&gt;dm_document
&lt;/type&gt;&lt;/types&gt;&lt;expression-set
operator="AND"&gt;&lt;expressions&gt;
&lt;fulltext fuzzy="true"&gt;iig&lt;/fulltext&gt;&lt;/
expressions&gt;
&lt;/expression-
set&gt;&lt;columns&gt;&lt;column&gt;r_object_type&lt;/column&gt;
&lt;column&gt;object_name&lt;/column&gt;&lt;column&gt;summary&lt;/
column&gt;

EDCPKRST220200-PRE-EN-01 Reference Guide 581

Chapter 2 Resources

&lt;/columns&gt;&lt;/search&gt;
</query-document>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/
REPO/
saved-searches/0800000180010d42"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/
REPO/
saved-searches/0800000180010d42"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/
saved-searches/0800000180010d42"/>
<link rel="http://identifiers.emc.com/linkrel/saved-search-results"
href="http://localhost:8080/dctm-rest/repositories/REPO/
saved-searches/0800000180010d42/results"/>
<link rel="http://identifiers.emc.com/linkrel/search-execution"
href="http://localhost:8080/dctm-rest/repositories/REPO/
saved-searches/0800000180010d42/execution"/>
<link rel="http://identifiers.emc.com/linkrel/as-search-template"
href="http://localhost:8080/dctm-rest/repositories/REPO/search-
templates"/>
</links>
</saved-search>

Example 2-236: JSON request

POST http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
0800000180010d42
Content-Type: application/vnd.emc.documentum+json

{
"properties": {
"object_name": "public search",
"title": "this is saved search",
"r_is_public": true
},
"query-document": "{\"all-versions\":false,\"include-hidden-objects
\":false,\"
repositories\":[\"REPO\"],\"types\":[\"dm_document\"],
\"expression-set\":{\"expression-type\":\"expression-set\",\"operator\":\"AND
\",
\"expressions\":[{\"expression-type\":\"fulltext\",\"value\":\"iig\",
\"fuzzy\":true}]},\"columns\":[\"r_object_type\", \"object_name\", \"summary
\"]"
}

Example 2-237: JSON response

{
"name": "saved-search",
"type": "dm_smart_list",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_smart_list",
"properties": {
"object_name": "public search",
"title": "this is saved search",

582 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

"creation-date": "2016-02-03T01:47:42.000+00:00",
"r_modify_date": "2016-02-03T01:48:53.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": "0800000180010d42"
},
"query-document": "{\"all-versions\":false,\"include-hidden-objects
\":false,
\"repositories\":[\"REPO\"],\"types\":[\"dm_document\"],
\"expression-set\":{\"expression-type\":\"expression-set\",\"operator\":
\"AND\",
\"expressions\":[{\"expression-type\":\"fulltext\",\"value\":\"iig\",
\"fuzzy\":true}]},\"columns\":[\"r_object_type\", \"object_name\",
\"summary\"],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
0800000180010d42"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
0800000180010d42"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
0800000180010d42"
},
{
"rel": "http://identifiers.emc.com/linkrel/saved-search-results",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
0800000180010d42/results"
},
{
"rel": "http://identifiers.emc.com/linkrel/search-execution",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
0800000180010d42/execution"
},
{
"rel": "http://identifiers.emc.com/linkrel/as-search-template",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search-
templates"
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 583

Chapter 2 Resources

2.62.1.4.4 Delete a saved search

You can use this resource to delete a saved search.

2.62.1.4.4.1 HTTP Request method and query parameters

DELETE

2.62.1.4.4.2 Request headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987..

2.62.1.4.4.3 Request body

N/A

2.62.1.4.4.4 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.62.2 Saved Searches

This resource retrieves saved searches that are visible to the logged in user. The
visible searches include all of the user's saved searches and all shared searches that
are available to the user.

2.62.2.1 Feed
Is this resource a feed? Yes.

• Feed ID: <Feed URI of the Saved Searches resource without file extension>

• Feed Title: Saved Searches

• Feed Updated: Server's current time

• Supports POST: Yes

• Entry ID: <Entry URI of the Saved Search>

• Entry Title: Saved Search name

• Entry Updated: Modified date

584 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

2.62.2.2 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.62.2.3 Link relations

Link relation Description Resource reference

self Saved Searches resource “Saved Searches”
on page 584
first, last, next, previous Pagination links Used for navigation when
more than one page of search
results are available

2.62.2.4 Operations
2.62.2.4.1 Supported HTTP methods

Method Description
GET Retrieves the visible saved searches
POST Creates a saved search

2.62.2.4.2 Get a saved searches collection

Gets the saved searches collection from the repository.

2.62.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET • inline For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
• page
• items-
per-
page
• total
• sort
• filter
• links

EDCPKRST220200-PRE-EN-01 Reference Guide 585

Chapter 2 Resources

Notes

• The Saved Searches resource ignores the view parameter.

• In the feed, the query-document is not shown even when inline=true has
been set.

2.62.2.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.62.2.4.2.3 Request body

N/A

2.62.2.4.2.4 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.62.2.4.2.5 Response headers

• Content-Type
• For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.62.2.4.2.6 Response media type

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

586 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

2.62.2.4.2.7 Example

Example 2-238: XML request

GET http://localhost/dctm-rest/repositories/REPO/saved-searches?items-per-
page=1
Accept: application/atom+xml

Example 2-239: XML response

Status Code: 200 OK
Content-Type: application/atom+xml;charset=UTF-8

<?xml version="1.0" encoding="utf-8"?>

<feed
xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/saved-searches</id>
<title>Saved Searches</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2015-07-30T02:56:38.870+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/
saved-searches.xml?include-total=true&inline=false&view=has_results
&sort=object_name%20asc&filter=starts-with(object_name,%27dave%27)"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c518000472c</id>
<title>dave public</title>
<author>
<name>dave</name>
</author>
<summary>this is saved search</summary>
<updated>2015-07-30T02:41:25.000+00:00</updated>
<published>2015-07-30T02:41:25.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/
REPO/saved-searches/
08024c518000472c.xml"/>
<content type="application/xml" src="http://localhost:8080/dctm-
rest/repositories/REPO/
saved-searches/08024c518000472c.xml"/>
</entry>
</feed>

EDCPKRST220200-PRE-EN-01 Reference Guide 587

Chapter 2 Resources

Example 2-240: JSON request

GET http://localhost/dctm-rest/repositories/REPO/saved-searches?items-per-
page=1
Accept: application/vnd.emc.documentum+json

Example 2-241: JSON response

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches",
"title": "Saved Searches",
"author": [
{
"name": "OpenText Documentum"
}
],
"updated": "2015-07-30T02:57:34.222+00:00",
"page": 1,
"items-per-page": 100,
"total": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches?
include-total=true&inline=false&view=has_results&
sort=object_name%20asc&filter=starts-with(object_name,%27dave%27)"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c518000472c",
"title": "dave public",
"author": [
{
"name": "dave"
}
],
"summary": "this is saved search",
"updated": "2015-07-30T02:41:25.000+00:00",
"published": "2015-07-30T02:41:25.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
saved-searches/
08024c518000472c"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
saved-searches/

588 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

08024c518000472c"
}
}
]
}

2.62.2.4.3 Create a saved search

For a saved search, there are four basic attributes: name, r_object_name, title, r_
is_public, and query-document. All the other attributes are populated by the
system. The name and query-document parameters are mandatory to create a saved
search.

2.62.2.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
POST query-locale A locale used string N/A Only
to evaluate supported
the query and with xPlore.
parse words
into a The default
language value is en.
dependent
token

2.62.2.4.3.2 Request media type

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.62.2.4.3.3 Request headers

• Authorization
• Accept
• For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 589

Chapter 2 Resources

2.62.2.4.3.4 Request body

Here is a code sample that shows you a saved search, which has properties and an
embedded query document in AQL. The AQL statements in the <query-document>
element must be escaped as shown below.

For more information about the Abstract Query Language, see AQL.

Example 2-242: XML request

<saved-search
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<properties>
<object_name>dave public</object_name>
<title>this is saved search</title>
<r_is_public>true</r_is_public>
</properties>
<query-document>

&lt;search xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"&gt;
&lt;types&gt;
&lt;type&gt;dm_sysobject&lt;/type&gt;
&lt;/types&gt;
&lt;expression-set&gt;
&lt;expressions&gt;
&lt;property-list name="owner_name" operator="IN"&gt;
&lt;values&gt;
&lt;value&gt;dmadmin&lt;/value&gt;
&lt;/values&gt;
&lt;/property-list&gt;
&lt;/expressions&gt;
&lt;/expression-set&gt;
&lt;facet-definitions&gt;
&lt;facet-definition id="id-1"&gt;
&lt;attributes&gt;
&lt;attribute&gt;r_object_type&lt;/attribute&gt;
&lt;/attributes&gt;
&lt;/facet-definition&gt;
&lt;/facet-definitions&gt;
&lt;/search&gt;

</query-document>
</saved-search>

Example 2-243: JSON request

{
"properties":{
"object_name": "dmadmin private",
"title": "this is a facet search",
"r_is_public": false
},
"query-document": "
{
\"types\": [\"dm_document\"],
\"expression-set\": {

590 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

\"expression-type": "expression-set",
\"expressions\": [
{
\"expression-type\":\"property\",
\"name\": \"myprop\",
\"operator\": \"CONTAINS\",
\"value\": \"myvalue\"
}
]
}
}
"
}

2.62.2.4.3.5 Response headers

• Location (The URI of the newly created search)

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.62.2.4.3.6 Response media type

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.62.2.4.3.7 Response status

• 201 Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.62.2.4.3.8 Response body

Caution
• In AQL, there is an element named location that element must contain
a valid path location. A search with an invalid location can be
successfully created. Attempting to load a search that contains an
invalid location will cause DFC to throw an exception. When this is the
case, the REST layer will use the value UNREACHABLE LOCATION PATH for
the invalid path and no search results can be returned.
• Location must include source information. If you save to a location
without using any source information, the system will add a default

EDCPKRST220200-PRE-EN-01 Reference Guide 591

Chapter 2 Resources

source (current repository) as the source information. This behavior is

consistent with executing a query document.

Example 2-244: JSON response

{
"properties": {
"object_name": "dmadmin private",
"title": "this is a facet search",
"creation-date": "2015-07-30T03:06:59.000+00:00",
"r_modify_date": "2015-07-30T03:06:59.000+00:00",
"r_modifier": "dave",
"owner_name": "dave",
"r_is_public": false,
"selected_sources": [
"REPO"
],
"has_results": false,
"results_count": -1,
"query_type": "query_builder",
"r_object_id": "08024c518000501f"
},
"query-document": "{\"all-versions\":false,\"facet-definitions\":[{\"id\":
\"id-1\",
\"attributes\":[\"r_object_type\"],\"group-by\":\"string\",\"sort\":
\"FREQUENCY\",
\"properties\":{\"skipEmptyValues\":\"true\"},\"max-values\":8}],
\"repositories\":[\"REPO\"],\"types\":[\"dm_sysobject\"],
\"expression-set\":{
\"expression-type\":\"expression-set\",\"operator\":\"AND\",
\"expressions\":[{
\"expression-type\":\"property-list\",\"name\":\"owner_name\",
\"operator\":\"IN\",\"values\":[\"dmadmin\"],\"repeating
\":false}]
}
}",
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c518000501f"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c518000501f"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c518000501f"
},
{
"rel": "http://identifiers.emc.com/linkrel/saved-search-results",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c518000501f/results"
},

592 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

{
"rel": "http://identifiers.emc.com/linkrel/search-execution",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c518000501f/execution"
},
{
"rel": "http://identifiers.emc.com/linkrel/as-search-template",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search-
templates"
}
]
}

Example 2-245: XML response

<?xml version='1.0' encoding='UTF-8'?>
<saved-search
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<properties>
<object_name>dave public</object_name>
<title>this is saved search</title>
<creation-date>2015-07-30T03:09:01.000+00:00</creation-date>
<r_modify_date>2015-07-30T03:09:01.000+00:00</r_modify_date>
<r_modifier>dave</r_modifier>
<owner_name>dave</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>08024c5180005021</r_object_id>
</properties>
<query-document>
&lt;?xml version='1.0' encoding='UTF-8'?&gt;
&lt;search xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
all-versions="false"&gt;
&lt;repositories&gt;&lt;repository&gt;REPO
&lt;/repository&gt;&lt;/repositories&gt;&lt;types&
;gt;&lt;type&gt;dm_document&lt;/type&gt;
&lt;/types&gt;&lt;expression-set operator="AND"&gt;&
lt;expressions&gt;
&lt;fulltext fuzzy="true"&gt;rest&lt;/fulltext&gt;&
lt;fulltext fuzzy="false"&gt;test
&lt;/fulltext&gt;&lt;/expressions&gt;&
lt;/expression-set&gt;&lt;columns&gt;
&lt;column&gt;r_object_type&lt;/column&gt;&
lt;column&gt;object_name&lt;/column&gt;
&lt;column&gt;summary&lt;/column&gt;&lt;/columns&
gt;&lt;/search&gt;
</query-document>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c518000501f.xml"

EDCPKRST220200-PRE-EN-01 Reference Guide 593

Chapter 2 Resources

></link>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c518000501f.xml"
></link>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c518000501f.xml"
></link>
<link rel="http://identifiers.emc.com/linkrel/saved-search-results"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c518000501f/results.xml"
></link>
<link rel="http://identifiers.emc.com/linkrel/search-execution"
href="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c518000501f/execution.xml"
></link>
<link rel="http://identifiers.emc.com/linkrel/as-search-template"
href="http://localhost:8080/dctm-rest/repositories/REPO/search-
templates.xml"
></link>
</links>
</saved-search>

2.62.3 Saved Search Execution

The Saved Search Execution resource enables you to run a specified saved search
and retrieve real-time results.

2.62.3.1 Resource relationships

The following diagram illustrates how this resource is related with other resources:

See Also: “Saved Search” on page 573 and About the Diagram on page 17.

594 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

2.62.3.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the Saved Search Execution resource

• Feed Title: Saved Search Execution
• Feed Updated: Server's current time
• Supports POST: No
• Entry: Search result
• Entry ID: URI of a result
• Entry Name: Result name
• Entry Updated: r_modify_date of a result

2.62.3.3 Link relations

Link relation Description Resource reference

self This Saved Search Execution “Saved Search Execution”
resource. on page 594
first, last, next, previous Pagination links. Used for navigation when
more than one page of search
results are available

2.62.3.4 Operations

2.62.3.4.1 Supported HTTP methods

Method Description
GET Retrieve real-time results of a saved search.

2.62.3.4.2 Execute a saved search

Execute a saved search and retrieve real-time results.

2.62.3.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data Value Default

method parameters type range value
GET links, inline, For more information, see Appendix B, REST Common Definition -
include-total URI Request Query Parameters on page 979.
page,
iterms-per-
page

EDCPKRST220200-PRE-EN-01 Reference Guide 595

Chapter 2 Resources

HTTP Query Description Data Value Default

method parameters type range value
facet-id- Specifies one or more pairs of
constraints facet id and its constraints
1. id1 is the facet for the
r_object_type property
2. id2 is the facet for the
owner_name property

facet-id-constraints=
id1%3Ddm_document,
id2%3dAdministrator
query-locale A locale used to evaluate the string N/A Only
query and parse words into a supported
language dependent token with xPlore.

The default
value is en.

Note: International characters and symbols that are used with this query
parameter must be URL encoded with the UTF-8 charset. Otherwise, the result
may be incorrect.

Example 2-246: Facet ID constraints

In this example, the facet query is used against the r_full_content_size

attribute and the grouping strategy used is range. There are two ranges
specified in the AQL: [0, 100000) and [10000, 20000):
<search xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

<expression-set>
<expressions>
<property-list name="owner_name" operator="IN">
<values>
<value>dmadmin</value>
</values>
</property-list>
</expressions>
</expression-set>
<facet-definitions>
<facet-definition group-by="range">
<attributes>
<attribute>r_full_content_size</attribute>
</attributes>
<properties>
<property name="range">0:10000,10000:20000</property>
</properties>
</facet-definition>
</facet-definitions>
</search>

The search returns the search results along with the facet results. Here you can
see that there are two groups returned for [0, 100000) and [10000, 20000)

596 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

respectively. Submitting the original AQL to the URL of each group navigates
to the results of that group.
<dm:facet
xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:facet-id>facet_r_full_content_size</dm:facet-id>
<dm:facet-label>Full Content Size</dm:facet-label>
<dm:facet-value>
<dm:facet-id>facet_r_full_content_size</dm:facet-id>
<dm:facet-value-id>0:10000</dm:facet-value-id>
<dm:facet-value-count>36</dm:facet-value-count>
<dm:facet-value-constraint>0/10000</dm:facet-value-constraint>
<link rel="search" href="http://localhost:8080/dctm-rest/repositories/
REPO/
search.xml?facet-id-constraints=facet_r_full_content_size%3D0/10000"/>
</dm:facet-value>
<dm:facet-value>
<dm:facet-id>facet_r_full_content_size</dm:facet-id>
<dm:facet-value-id>10000:20000</dm:facet-value-id>
<dm:facet-value-count>10</dm:facet-value-count>
<dm:facet-value-constraint>10000/20000</dm:facet-value-constraint>
<link rel="search" href="http://localhost:8080/dctm-rest/repositories/
REPO/
search.xml?facet-id-constraints=facet_r_full_content_size
%3D10000/20000"/>
</dm:facet-value>
</dm:facet>

2.62.3.4.2.2 Request media types

N/A

2.62.3.4.2.3 Request headers

• Accept
• Authorization

2.62.3.4.2.4 Request body

N/A.

2.62.3.4.2.5 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 597

Chapter 2 Resources

2.62.3.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.62.3.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.62.3.4.2.8 Response body

XML or JSON representation of the real-time results of the saved search.

• The body contains a list of search results.

• The returned result collection only contains those results to which the REST
client has access.
• Pagination is supported.

Example 2-247: XML response

<feed
xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/saved-searches
/08024c5180005288/execution</id>
<title>Search results</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2015-08-04T07:19:05.885+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/08024c5180005288/execution.xml?items-per-page=1"/>
<link rel="next" href="http://localhost:8080/dctm-rest/repositories/
REPO/saved-searches/08024c5180005288/execution.xml?items-per-
page=1&page=2"/>
<link rel="first" href="http://localhost:8080/dctm-rest/repositories/REPO/
saved-searches/08024c5180005288/execution.xml?items-per-page=1&page=1"/>
<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>09024c518000488c</id>

598 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

<title>ADFS and Shib 0.81.docx</title>

<author>
<name>UnitTestUser</name>
</author>
<summary>Federated Access 18 Step 3: ...</summary>
<updated>2015-08-04T06:50:23.000+00:00</updated>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
09024c518000488c.xml"/>
<content type="application/xml" src="http://localhost:8080/dctm-
rest/repositories/REPO
/objects/09024c518000488c.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>Test</dm:term>
<dm:term>test</dm:term>
<dm:term>testing</dm:term>
<dm:term>rest</dm:term>
<dm:term>Testing</dm:term>
<dm:term>tested</dm:term>
</dm:terms>
</entry>
...
<entry>...</entry>
</feed>

Example 2-248: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c5180005288/execution",
"title": "Search results",
"author": [
{
"name": "OpenText Documentum"
}
],
"updated": "2015-08-04T07:17:59.804+00:00",
"page": 1,
"items-per-page": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c5180005288/execution?items-per-page=1"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c5180005288/execution?items-per-page=1&page=2"
},
{
"rel": "first",

EDCPKRST220200-PRE-EN-01 Reference Guide 599

Chapter 2 Resources

"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c5180005288/execution?items-per-page=1&page=1"
},
{
"rel": "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}"
}
],
"entries": [
{
"id": "09024c518000488c",
"title": "ADFS and Shib 0.81.docx",
"author": [
{
"name": "UnitTestUser"
}
],
"summary": "Federated Access\t18 Step 3: ...",
"updated": "2015-08-04T06:50:23.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
objects/
09024c518000488c"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
objects/
09024c518000488c"
},
"score": "1.0",
"terms": [
"Test",
"test",
"testing",
"rest",
"Testing",
"tested"
]
}
...
{...}
]
}

600 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

2.62.4 Saved Search Results

The Saved Search Results resource allows you to take the results of a search and
save it in Documentum Server. Saving search results enables you to retrieve search
results without having to re-execute the search.

This resource returns saved results, instead of real-time results.

Note: Facet results cannot be saved

2.62.4.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Saved Search” on page 573 and About the Diagram
on page 17.

2.62.4.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the Saved Search Results resource

• Feed Title: Saved Search Results
• Feed Updated: Time when the results are saved.
• Supports POST: No
• Entry: Search result
• Entry ID: URI of a result
• Entry Name: Result name
• Entry Updated: r_modify_date of a result

EDCPKRST220200-PRE-EN-01 Reference Guide 601

Chapter 2 Resources

2.62.4.3 Link relations

Link relation Description Resource reference

self This Saved Search Results “Saved Search Results”
resource. on page 601
first, last, next, previous Pagination links. Used for navigation when
more than one page of search
results are available

2.62.4.4 Operations
2.62.4.4.1 Supported HTTP methods

Method Description
PUT Enable or refresh results of a saved search.
GET Retrieve results of a saved search.
DELETE Disable saved results.

2.62.4.4.2 Enable and refresh saved results

By default, a newly created Saved Search resource does not save results. This
operation enables any previously disabled saved results. This operation causes the
value of the <has_results> attribute of a saved search to change from false to true.

When <has_results> is already true, which means that results saving is already
enabled, this operation can be used to refresh the saved results and prevent users
from seeing any out-of-date search results.

2.62.4.4.2.1 HTTP Request method and query parameters

602 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

HTTP Query Description Data Value range Defaul

method parameters type t
value
PUT max- The maximum number integer –1 and any non- 1000
results- of results to for a saved negative integer.
count search
• –1: Apply the DFC
configuration
Note: When -1 is
used as the value • Any non-negative
integer: the smaller
for the max-
of max-results-
results-count
count and DFC
parameter, the
configuration takes
Request may
effect.
require more time
to retrieve as
many matching
objects as
possible. The
number of
matching objects
returned is only
limited by the
DFC
configuration.
Using a default
value of 1000 ,
which returns 10
pages at once by
default, greatly
improves
performance.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.62.4.4.2.2 Request media types

N/A

2.62.4.4.2.3 Request headers

• Accept
• Authorization (optional)

EDCPKRST220200-PRE-EN-01 Reference Guide 603

Chapter 2 Resources

2.62.4.4.2.4 Request body

A PUT request is used to turn on saved results.

Example 2-249: XML request - application/vnd.emc.documentum+xml or

application/xml media types
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c5180004332/saved-results</id>
<title>Search results</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2015-08-04T02:54:54.399+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/08024c5180004332/saved-results.xml?items-per-page=1"/>
<link rel="next" href="http://localhost:8080/dctm-rest/repositories/REPO/
saved-searches/08024c5180004332/saved-results.xml?items-per-
page=1&page=2"/>
<link rel="first" href="http://localhost:8080/dctm-rest/repositories/REPO/
saved-searches/08024c5180004332/saved-results.xml?items-per-
page=1&page=1"/>
<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>09024c5180004344</id>
<title>ADFS and Shib 0.81.docx</title>
<summary>Federated Access 18 Step 3: Test AD FS 2.0 as the Identity...
Step 5:
Test Shibboleth as the Identity Provider and AD FS 2.0 as...
following sections. AD FS 2.0 The test deployment that is
created in the...
domain controller and the federation server in test
deployments</summary>
<updated>2015-08-04T03:00:22.950+00:00</updated>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/
objects/09024c5180004344.xml"/>
<content type="application/xml" src="http://localhost:8080/dctm-rest/
repositories/
REPO/objects/09024c5180004344.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>Test</dm:term>
<dm:term>test</dm:term>
<dm:term>testing</dm:term>
<dm:term>rest</dm:term>
<dm:term>Testing</dm:term>

604 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

<dm:term>tested</dm:term>
</dm:terms>
</entry>
</feed>

Example 2-250: JSON request - application/vnd.emc.documentum+json or

application/json media types

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c5180004332/saved-results",
"title": "Search results",
"author": [
{
"name": "OpenText Documentum"
}
],
"updated": "2015-08-04T02:54:54.399+00:00",
"page": 1,
"items-per-page": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c5180004332/saved-results?items-per-page=1"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c5180004332/saved-results?items-per-page=1&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c5180004332/saved-results?items-per-page=1
&page=1"
},
{
"rel": "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}"
}
],
"entries": [
{
"id": "09024c5180004344",
"title": "ADFS and Shib 0.81.docx",
"author": [
null
],
"summary": "Federated Access\t18 Step 3: Test AD FS 2.0 as the Identity...
Step 5: Test Shibboleth as the Identity Provider and AD FS 2.0 as... following
sections. AD FS 2.0 The test deployment that is created in the... domain
controller and the federation server in test deployments",
"updated": "2015-08-04T02:55:22.883+00:00",

EDCPKRST220200-PRE-EN-01 Reference Guide 605

Chapter 2 Resources

"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
09024c5180004344"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
09024c5180004344"
},
"score": "1.0",
"terms": [
"Test",
"test",
"testing",
"rest",
"Testing"]
]
}

2.62.4.4.2.5 Response headers

• Content-Type

2.62.4.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.62.4.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

606 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.62. Saved Search (es)

2.62.4.4.2.8 Response body

XML or JSON representation of saved results of the search. See the response body of
the Saved Search Execution resource for representation samples.

• This method sets the has_results property of a saved search to true.

• The results_count represents the count of saved results whether or not max-
results-count has been reached.

2.62.4.4.3 Get saved results

GET saved results of a search.

2.62.4.4.3.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• links
• inline
• include-total
• page
• items-per-page

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.62.4.4.3.2 Request media types

N/A

2.62.4.4.3.3 Request headers

• Accept
• Authorization (optional)

2.62.4.4.3.4 Request body

N/A

EDCPKRST220200-PRE-EN-01 Reference Guide 607

Chapter 2 Resources

2.62.4.4.3.5 Response headers

• Content-Type

2.62.4.4.3.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.62.4.4.3.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.62.4.4.3.8 Response body

XML or JSON representation of saved results of the search. See the Response body of
the Saved Search Execution for representation samples.

• The body contains a list of search results.

• The returned result collection only contains those that the REST client has access
to.
• Pagination is supported.

2.62.4.4.4 Disable saved results

Disable saved results. The following properties are updated after this operation:

• The has_results property of the saved search resource is set to false.

• The results_count property of the saved search resource is set to -1.

2.62.4.4.4.1 HTTP Request method and query parameters

DELETE

608 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

2.62.4.4.4.2 Request media types

N/A

2.62.4.4.4.3 Request headers

• Accept
• Authorization (optional)

2.62.4.4.4.4 Request body

N/A

2.62.4.4.4.5 Response headers

N/A

2.62.4.4.4.6 Response media types

N/A

2.62.4.4.4.7 Response status

• 204 - Saved results disabled successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.62.4.4.4.8 Response body

After you disable saved results, the system returns 204 no content with no content
in the response body.

2.63 Saved Search Template (s)

2.63.1 Saved Search Template
There are two ways to create a search template. You can create a search template
using a generalized set of search criteria or you can use the existing criteria of a
saved search to create a search template.

A search template allows you to share a search with others users. Users who receive
the search template can customize it for their own specific use, and can also give it to
other users who can customize it further.

In the search template resource, AQL expressions that contain variables have the
boolean attribute template set to true. Variables are set to a predicate value that
can be updated at a later time.

An expression containing variables generally follows this pattern. For example:

EDCPKRST220200-PRE-EN-01 Reference Guide 609

Chapter 2 Resources

<sample_expression attr_1=v_1 attr_2=v2 ... template="true">predicate_value</

sample_expression>

<property-list name="r_object_type" operator="IN" repeating="false" template="true"">

<values>
<value>dm_document</value>
</values>
</property-list>

The following table lists all AQL expressions that support variables:

Expression type Variable Sample (variable

predicates highlighted in
bold)
fulltext Fulltext search criterion <fulltext
fuzzy="false"
template="true">key
word</fulltext>
property Property value <property
name="object_name"
Note: The search operator="CONTAINS"
operator cannot be IS_ exact-match="false"
NULL or IS_NOT_ repeating="false"
NULL. case-sensitive="false"
fuzzy="false"
template="true">myobj
</property>
property list Value list <property-list
name="r_object_type"
operator="IN"
repeating="false"
template="true">

<values>

<value>dm_document</
value>

<value>dm_folder</
value>

</values>

</property-list>
relative date Relative value and time unit <relative-date
name="r_modify_date"
time-unit="MONTH"
operator="GREATER_
THAN"
repeating="false"
template="true">-3</
relative-date>

610 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

Expression type Variable Sample (variable

predicates highlighted in
bold)
property range From and To values <property-range
name="r_modify_date"
operator="BETWEEN"
repeating="false"
template="true">

<from>2010-10-13T07:3
3:13.009+00:00</from>

<to>2014-11-11T01:35:
17.089+00:00</to>

</property-range>

A search template differs from a saved search in that a search template may contain
variables in its search criteria while a saved search cannot.

2.63.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: About the Diagram on page 17.

For more information, see “Saved Search Templates” on page 619.

2.63.1.2 Feed
No feed support.

EDCPKRST220200-PRE-EN-01 Reference Guide 611

Chapter 2 Resources

2.63.1.3 Link relations

Link relation Description Resource reference

self This Search Template “Saved Search Template”
resource. on page 609
delete [1] This Search Template “Saved Search Template”
resource. on page 609
search-execution [1] Execute the search template “Search Template Execution”
on page 635
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.63.1.4 Operations

2.63.1.4.1 Supported HTTP methods

Method Description
GET Get a search template.
DELETE Delete a search template.

2.63.1.4.2 Get a Search Template

GET a search template.

2.63.1.4.2.1 HTTP Request method and query parameters

GET

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.63.1.4.2.2 Request media types

N/A

2.63.1.4.2.3 Request headers

• Accept
• Authorization (optional)

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

612 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

2.63.1.4.2.4 Request body

N/A

2.63.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.63.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.63.1.4.2.7 Response status

• 200 Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985

2.63.1.4.2.8 Response body

XML or JSON representation of the search template. Search criteria containing

variables are presented in the query-document-template block where all variables
have their template attribute set to true. Moreover, the external-variables block
is appended to query-document-template, which contains a number of
<expression_type>-var sections describing all variables in the template.
<external-variables>
...
<fulltext-variable>
<id>/expression[0]</id>
<expression-type>fulltext</expression-type>
<data-type>string</data-type>
<variable-value>key word</variable-value>
</fulltext-variable>
<property-variable>
<id>/expression[1]/expression[0]</id>
<expression-type>property</expression-type>
<property-name>object_name</property-name>
<data-type>string</data-type>
<operator>CONTAINS</operator>
<variable-value>attr1</variable-value>
</property-variable>
...
</external-variables>

An expression_type variable section contains the following elements:

EDCPKRST220200-PRE-EN-01 Reference Guide 613

Chapter 2 Resources

Element Description
id xPath-like identifier of the expression where
the variable is located. For example, /
expression[1]/expression[0]
indicates the first child expression of the
second expression under the root.
expression-type Type of the expression where the variable is
located.
property-name Name of the property that is used as a
variable. Not valid in fulltext expressions.
data-type Data type of the property that is used as a
variable. Not valid in fulltext expressions.
operator Operator of the expression where the
variable is located. Not valid in fulltext and
relative date expressions. The GREATER_
THAN operator can be used for relative date
expressions.
variable-value Predicate variable value.

Example 2-251: XML response

<?xml version="1.0" encoding="UTF-8"?>

<saved-search-template
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dmc_search_template"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/
dmc_search_template.xml">
<properties>
<object_name>test</object_name>
<subject>Search template Description for unit tests.</subject>
<creation-date>2015-09-23T01:45:31.000+00:00</creation-date>
<r_modify_date>2015-09-23T01:45:31.000+00:00</r_modify_date>
<owner_name>dmadmin</owner_name>
<r_is_public>true</r_is_public>
<selected_sources>
<item>REPO</item>
</selected_sources>
<r_object_id>0900000180010d1f</r_object_id>
</properties>
<query-document-template>&lt;?xml version='1.0' encoding='UTF-8'?>
&lt;search
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" all-
versions="false">
&lt;repositories>&lt;repository>REPO&lt;/repository>
&lt;/repositories>&lt;types>
&lt;type>dm_sysobject&lt;/type>&lt;/types>
&lt;expression-set operator="AND">
&lt;expressions>&lt;fulltext fuzzy="false" template="true">key word
&lt;/fulltext>
&lt;expression-set operator="AND">&lt;expressions>
&lt;property name="object_name" operator="CONTAINS" exact-
match="false"
repeating="false"

614 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

case-sensitive="false" fuzzy="false" template="true">attr1&lt;/

property>
&lt;/expressions>
&lt;/expression-set>&lt;property-range name="r_modify_date"
operator="BETWEEN"
repeating="false" template="true">&lt;from>1973-01-26T01:45:31
000+00:00
&lt;/from>
&lt;to>2006-01-30T01:12:31 000+00:00&lt;/to>
&lt;/property-range>&lt;relative-date
name="r_modify_date" time-unit="MONTH" operator="GREATER_THAN"
repeating="false"
template="true">-3&lt;/relative-date>&lt;/expressions>
&lt;/expression-set>&lt;/search>
</query-document-template>
<external-variables>
<fulltext-variable>
<id>/expression[0]</id>
<expression-type>fulltext</expression-type>
<data-type>string</data-type>
<variable-value>key word</variable-value>
</fulltext-var>
<property-variable>
<id>/expression[1]/expression[0]</id>
<expression-type>property</expression-type>
<property-name>object_name</property-name>
<data-type>string</data-type>
<operator>CONTAINS</operator>
<variable-value>attr1</variable-value>
</property-variable>
<property-variable>
<id>/expression[2]/from</id>
<expression-type>property-range</expression-type>
<property-name>r_modify_date</property-name>
<data-type>datetime</data-type>
<operator>GREATER_EQUAL</operator>
<variable-value>1973-01-26T01:45:31 000+00:00</variable-value>
</property-variable>
<property-variable>
<id>/expression[2]/to</id>
<expression-type>property-range</expression-type>
<property-name>r_modify_date</property-name>
<data-type>datetime</data-type>
<operator>LESS_EQUAL</operator>
<variable-value>2006-01-30T01:12:31 000+00:00</variable-value>
</property-variable>
<relative-date-variable>
<id>/expression[3]</id>
<expression-type>relative-date</expression-type>
<property-name>r_modify_date</property-name>
<data-type>datetime</data-type>
<variable-value>-3:MONTH</variable-value>
</relative-date-variable>
</external-variables>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/
search-templates/08024c5180004333/execution.xml"/>
<link rel="http://identifiers.emc.com/linkrel/search-execution"
href="http://localhost:8080/dctm-rest/repositories/REPO/
search-templates/08024c5180004333.xml"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/

EDCPKRST220200-PRE-EN-01 Reference Guide 615

Chapter 2 Resources

repositories/REPO/search-templates/08024c5180004333.xml"/>
</links>
</saved-search-template>

Example 2-252: JSON response

{
"name": "saved-search-template",
"type": "dmc_search_template",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dmc_search_template",
"properties": {
"object_name": "test",
"subject": "Search template Description for unit tests.",
"creation-date": "2015-09-23T01:45:31.000+00:00",
"r_modify_date": "2015-09-23T01:45:31.000+00:00",
"owner_name": "dmadmin",
"r_is_public": true,
"selected_sources": [
"REPO"
],
"r_object_id": "0900000180010d1f"
},
"query-document-template": "{\"all-versions\":false,\"repositories\":
[\"REPO\"],
\"types\":[\"dm_sysobject\"],\"expression-set\":{\"expression-type\":
\"expression-set\",
\"operator\":\"AND\",\"expressions\":[{\"expression-type\":\"fulltext\",
\"value
\":\"key word\",\"fuzzy\":false,\"template\":\"true\"},{\"expression-type
\":\"expression-set\",
\"operator\":\"AND\",\"expressions\":[{\"expression-type\":\"property\",
\"name\":
\"object_name\",\"operator\":\"CONTAINS\",\"value\":\"attr1\",\"exact-match
\":false,
\"repeating\":false,\"case-sensitive\":false,\"fuzzy\":false,\"template\":
\"true\"}]},
{\"expression-type\":\"property-range\",\"name\":\"r_modify_date\",
\"operator\":
\"BETWEEN\",\"from\":\"1973-01-26T01:45:31 000+00:00\",
\"to\":\"2006-01-30T01:12:31 000+00:00\",
\"repeating\":false,\"template\":\"true\"},{\"expression-type\":\"relative-
date\",
\"name\":\"r_modify_date\",\"value\":-3,\"time-unit\":\"MONTH\",\"operator
\":
\"GREATER_THAN\",\"repeating\":false,\"template\":\"true\"}]}}",
"external-variables": [
{
"id": "/expression[0]",
"expression-type": "fulltext",
"data-type": "string",
"variable-value": "key word"
},
{
"id": "/expression[1]/expression[0]",
"expression-type": "property",
"property-name": "object_name",
"data-type": "string",
"operator": "CONTAINS",

616 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

"variable-value": "attr1"
},
{
"id": "/expression[2]/from",
"expression-type": "property-range",
"property-name": "r_modify_date",
"data-type": "datetime",
"operator": "GREATER_EQUAL",
"variable-value": "1973-01-26T01:45:31 000+00:00"
},
{
"id": "/expression[2]/to",
"expression-type": "property-range",
"property-name": "r_modify_date",
"data-type": "datetime",
"operator": "LESS_EQUAL",
"variable-value": "2006-01-30T01:12:31 000+00:00"
},
{
"id": "/expression[3]",
"expression-type": "relative-date",
"property-name": "r_modify_date",
"data-type": "datetime",
"variable-value": "-3:MONTH"
}
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search-
templates/
08024c5180004333"
},
{
"rel": "http://identifiers.emc.com/linkrel/search-execution",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search-
template/
08024c5180004333/execution"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search-
templates/
08024c5180004333"
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 617

Chapter 2 Resources

2.63.1.4.3 Delete a search template

Delete a search template.

2.63.1.4.3.1 HTTP Request method and query parameters

DELETE

2.63.1.4.3.2 Request media types

N/A

2.63.1.4.3.3 Request headers

• Authorization (optional)

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.63.1.4.3.4 Request body

N/A

2.63.1.4.3.5 Response headers

N/A

2.63.1.4.3.6 Response media types

N/A

2.63.1.4.3.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.63.1.4.3.8 Response body

HTTP 204 No Content status upon a successful delete operation. The Response body
contains no content.

618 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

2.63.2 Saved Search Templates

This resource is a collection of search templates. Users can get list of search
templates or create a new search template with this resource.

2.63.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: About the Diagram on page 17.

For more information, see “Repository” on page 562.

2.63.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: The URI of the Search Templates resource

• Feed Title: Search templates

• Feed Updated: Server's current time

• Supports POST: Yes

• Entry: “Saved Search Template” on page 609

• Entry ID: Search template URI

• Entry Title: Display name of the search template.

• Entry Updated: r_modify_date of the object

2.63.2.3 Link relations

Link relation Description Resource reference

self this object “Saved Search Templates”
on page 619
first, last, next, previous Pagination links Used for navigation when
more than one page of search
results are available

EDCPKRST220200-PRE-EN-01 Reference Guide 619

Chapter 2 Resources

2.63.2.4 Operations
2.63.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a visible search template collection
POST Creates a new search template

2.63.2.4.2 Create a search template

2.63.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
POST query-locale A locale used string N/A Only
to evaluate supported
the query and with xPlore.
parse words
into a The default
language value is en.
dependent
token

2.63.2.4.2.2 Request headers

• Authorization (optional)
• Accept
• For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.63.2.4.2.3 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.63.2.4.2.4 Request body

Example 2-253: XML request body

Here is a code sample that shows you a search template that has properties and
an embedded query document in AQL. The AQL statements in the <query-
document> element must be escaped as shown below.

For more information about Abstract Query Language, see AQL.

<search-template
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dmc_search_template"
definition="http://localhost:8080/dctm-rest/repositories/REPO/

620 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

types/dmc_search_template.xml">
<properties>
<object_name>wangchen</object_name>
<subject>Search template Description for unit tests.</subject>
<r_is_public>true</r_is_public>
</properties>
<query-document-template>
&lt;search xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" all-
versions="false"&gt;
&lt;repositories&gt;
&lt;repository&gt;REPO&lt;/repository&gt;
&lt;/repositories&gt;
&lt;types&gt;
&lt;type&gt;dm_sysobject&lt;/type&gt;
&lt;/types&gt;
&lt;expression-set operator="AND"&gt;
&lt;expressions&gt;
&lt;fulltext fuzzy="false" template="true"&gt;key word&lt;/fulltext&gt;
&lt;expression-set operator="AND"&gt;
&lt;expressions&gt;
&lt;property name="object_name" operator="CONTAINS"
exact-match="false" repeating="false" case-sensitive="false"
fuzzy="false" template="true"&gt;attr1&lt;/property&gt;
&lt;/expressions&gt;
&lt;/expression-set&gt;
&lt;property-range name="r_modify_date" operator="BETWEEN"
repeating="false"
template="true"&gt;
&lt;from&gt;1973-01-26T03:09:01:000+00:00&lt;/from&gt;
&lt;to&gt;2015-07-30T035:10:04.000+00:00&lt;/to&gt;
&lt;/property-range&gt;
&lt;relative-date name="r_modify_date" time-unit="MONTH"
operator="GREATER_THAN" repeating="false" template="true"&gt;-3&lt;/
relative-date&gt;
&lt;/expressions&gt;
&lt;/expression-set&gt;
&lt;/search&gt;
</query-document-template>
</search-template>

Example 2-254: JSON request body

{
"properties":
{
"object_name": "wangchen",
"subject": "Search template Description for unit tests.",
"r_is_public": true
},
"query-document-template": "{
\"all-versions\": false,
\"repositories\": [
\"REPO\"
],
\"types\": [
\"dm_sysobject\"
],
\"expression-set\":

EDCPKRST220200-PRE-EN-01 Reference Guide 621

Chapter 2 Resources

{
\"expression-type\": \"expression-set\",
\"operator\": \"AND\",
\"expressions\": [
{
\"expression-type\": \"fulltext\",
\"value\": \"key word\",
\"fuzzy\": false,
\"template\": \"true\"
},
{
\"expression-type\": \"expression-set\",
\"operator\": \"AND\",
\"expressions\": [
{
\"expression-type\": \"property\",
\"name\": \"object_name\",
\"operator\": \"CONTAINS\",
\"value\": \"attr1\",
\"exact-match\": false,
\"repeating\": false,
\"case-sensitive\": false,
\"fuzzy\": false,
\"template\": \"true\"
}
]
},
{
\"expression-type\": \"property-range\",
\"name\": \"r_modify_date\",
\"operator\": \"BETWEEN\",
\"from\": \"1973-07-30T03:09:01.000+00:00\",
\"to\": \"2015-07-30T035:10:04.000+00:00\",
\"repeating\": false,
\"template\": \"true\"
},
{
\"expression-type\": \"relative-date\",
\"name\": \"r_modify_date\",
\"value\": -3,
\"time-unit\": \"MONTH\",
\"operator\": \"GREATER_THAN\",
\"repeating\": false,
\"template\": \"true\"
}
]
}
}"
}

622 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

2.63.2.4.2.5 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985

2.63.2.4.2.6 Response headers

• Content-Type
• Location: The URI for the newly added search template
• For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987

2.63.2.4.2.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

Example 2-255: XML response

The value of the <relative-date> variable has the pattern number:time-unit to

specify the relative date against the current time.
<?xml version="1.0" encoding="UTF-8"?>
<search-template
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dmc_search_template"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/
dmc_search_template.xml">
<properties>
<object_name>wangchen</object_name>
<subject>Search template Description for unit tests.</subject>
<creation-date>2015-09-23T01:45:31.000+00:00</creation-date>
<r_modify_date>2015-09-23T01:45:31.000+00:00</r_modify_date>
<owner_name>dmadmin</owner_name>
<r_is_public>true</r_is_public>
<selected_sources>
<item>REPO</item>
</selected_sources>
<r_object_id>0900000180010d1f</r_object_id>
</properties>
<query-document-template>&lt;?xml version='1.0' encoding='UTF-8'?
&gt;&lt;search
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" all-
versions="false"&gt;&lt;repositories&gt;
&lt;repository&gt;REPO&lt;/repository&gt;&lt;/
repositories&gt;&lt;types&gt;&lt;type&gt;dm_sysobject&lt;/type&gt;
&lt;/types&gt;&lt;expression-set

EDCPKRST220200-PRE-EN-01 Reference Guide 623

Chapter 2 Resources

operator="AND"&gt;&lt;expressions&gt;&lt;fulltext fuzzy="false"
template="true"&gt;key word&lt;/fulltext&gt;
&lt;expression-set operator="AND"&gt;&lt;expressions&gt;&lt;property
name="object_name" operator="CONTAINS"
exact-match="false" repeating="false" case-sensitive="false" fuzzy="false"
template="true"&gt;attr1&lt;/property&gt;&lt;/expressions&gt;&lt;/expression-
set&gt;&lt;property-range name="r_modify_date" operator="BETWEEN"
repeating="false" template="true"&gt;&lt;from&gt;01/26/1973 00:00:00&lt;/
from&gt;&lt;to&gt;11/30/2006 00:00:00&lt;/to&gt;&lt;/property-
range&gt;&lt;relative-date name="r_modify_date" time-unit="MONTH"
operator="GREATER_THAN" repeating="false" template="true"&gt;-3&lt;/relative-
date&gt;&lt;/expressions&gt;&lt;/expression-set&gt;&lt;/search&gt;
</query-document-template>
<external-variables>
<fulltext-variable>
<id>/expression[0]</id>
<expression-type>fulltext</expression-type>
<data-type>string</data-type>
<variable-value>key word</variable-value>
</fulltext-variable>
<property-variable>
<id>/expression[1]/expression[0]</id>
<expression-type>property</expression-type>
<property-name>object_name</property-name>
<data-type>string</data-type>
<operator>CONTAINS</operator>
<variable-value>attr1</variable-value>
</property-variable>
<property-variable>
<id>/expression[2]/from</id>
<expression-type>property-range</expression-type>
<property-name>r_modify_date</property-name>
<data-type>datetime</data-type>
<operator>GREATER_EQUAL</operator>
<variable-value>2015-09-23T01:45:31.000+00:00</variable-value>
</property-variable>
<property-variable>
<id>/expression[2]/to</id>
<expression-type>property-range</expression-type>
<property-name>r_modify_date</property-name>
<data-type>datetime</data-type>
<operator>LESS_EQUAL</operator>
<variable-value>2015-09-23T01:45:31.000+00:00</variable-value>
</property-variable>
<relative-date-variable>
<id>/expression[3]</id>
<expression-type>relative-date</expression-type>
<property-name>r_modify_date</property-name>
<data-type>datetime</data-type>
<variable-value>-3:MONTH</variable-value>
</relative-date-variable>
</external-variables>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/
search-templates/08024c5180004333.xml"/>
<link rel="delete" href="http://localhost:8080/dctm-rest/repositories/REPO/
search-templates/08024c5180004333/execution.xml"/>
<link rel="execution"
href="http://localhost:8080/dctm-rest/repositories/REPO/
search-templates/08024c5180004333.xml"/>

624 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

</links>
</search-template>

Example 2-256: JSON response

{
"name": "search-template",
"type": "dmc_search_template",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dmc_search_template",
"properties": {
"object_name": "wangchen",
"subject": "Search template Description for unit tests.",
"creation-date": "2015-09-23T01:45:31.000+00:00",
"r_modify_date": "2015-09-23T01:45:31.000+00:00",
"owner_name": "dmadmin",
"r_is_public": true,
"selected_sources": [
"REPO"
],
"r_object_id": "0900000180010d1f"
},
"query-document-template": "{\"all-versions\":false,\"repositories\":
[\"REPO\"],
\"types\":[\"dm_sysobject\"],\"expression-set\":{\"expression-type\":
\"expression-set\",
\"operator\":\"AND\",\"expressions\":[
{\"expression-type\":\"fulltext\",
\"value\":\"key word\",\"fuzzy\":false,\"template\":\"true\"},
{\"expression-type\":\"expression-set\",\"operator\":\"AND\",
\"expressions\":[{\"expression-type\":\"property\",\"name\":
\"object_name\",\"operator\":\"CONTAINS\",\"value\":\"attr1\",
\"exact-match\":false,\"repeating\":false,\"case-sensitive\":false,
\"fuzzy\":false,\"template\":\"true\"}]},
{\"expression-type\":\"property-range\",\"name\":\"r_modify_date\",
\"operator\":\"BETWEEN\",\"from\":\"1973-09-23T01:45:31.000+00:00\",
\"to\":\"2015-09-23T08:45:31.000+00:00\",\"repeating\":false,\"template
\":\"true\"},
{\"expression-type\":\"relative-date\",\"name\":\"r_modify_date\",\"value
\":-3,
\"time-unit\":\"MONTH\",\"operator\":\"GREATER_THAN\",\"repeating
\":false,
\"template\":\"true\"}
]}}",
"external-variables": [
{
"id": "/expression[0]",
"expression-type": "fulltext",
"data-type": "string",
"variable-value": "key word"
},
{
"id": "/expression[1]/expression[0]",
"expression-type": "property",
"property-name": "object_name",
"data-type": "string",
"operator": "CONTAINS",
"variable-value": "attr1"
},

EDCPKRST220200-PRE-EN-01 Reference Guide 625

Chapter 2 Resources

{
"id": "/expression[2]/from",
"expression-type": "property-range",
"property-name": "r_modify_date",
"data-type": "datetime",
"operator": "GREATER_EQUAL",
"variable-value": "2015-09-23T01:45:31.000+00:00"
},
{
"id": "/expression[2]/to",
"expression-type": "property-range",
"property-name": "r_modify_date",
"data-type": "datetime",
"operator": "LESS_EQUAL",
"variable-value": "2015-09-23T01:45:31.000+00:00"
},
{
"id": "/expression[3]",
"expression-type": "relative-date",
"property-name": "r_modify_date",
"data-type": "datetime",
"variable-value": "-3:MONTH"
}
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search-templates/08024c5180004333"
},
{
"rel": "delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search-template/08024c5180004333/execution"
},
{
"rel": "execution",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search-templates/08024c5180004333"
}
]
}

2.63.2.4.3 Use a saved search as search template

This operation creates a new search template from an existing saved search. Each
call to this method creates a new search template. Any expressions that are in the
saved search that can be templates will become templates. When a property
expression has the IS_NULL or IS_NOT_NULL operator it does not become a template.
This is because there is no value in the property expression that can be used as a
variable.

626 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

2.63.2.4.3.1 HTTP Request method and query parameters

POST

2.63.2.4.3.2 Request media types

application/vnd.emc.documentum+xml

application/vnd.emc.documentum+json

2.63.2.4.3.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.63.2.4.3.4 Request body

The three attributes of the search template that can be specified by users include the
following:

• object_name
• subject
• r_is_public

You can set the object_name attribute, however, when a value for the object_name
attribute is not specified in the request body, its value is set from the saved search
used to create the new template. The values for all of the other attributes are set
using the values from the source saved search used to create the new template. The
search-reference attribute specifies the URL of the source saved search.

Example 2-257: XML request

<search-template
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" search-
reference="http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
0800000580008fd3">
<properties>
<object_name>new template</object_name>
<subject>Search template created from saved search.</subject>
<r_is_public>true</r_is_public>
</properties>
</search-template>

Example 2-258: JSON request

{
"properties": {

EDCPKRST220200-PRE-EN-01 Reference Guide 627

Chapter 2 Resources

"object_name": "new template",

"subject": "Search template created from saved search.",
"r_is_public": true
},
"search-reference":"http://localhost:8080/dctm-rest/repositories/REPO/
saved-searches/0800000580008fd3"
}

2.63.2.4.3.5 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.
• Location - The URI of the newly created search template.

2.63.2.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.63.2.4.3.7 Response status

• 201 Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985

2.63.2.4.3.8 Response body

Example 2-259: XML response

<?xml version="1.0" encoding="UTF-8"?>

<search-template
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dmc_search_template"
definition="http://localhost:8080/dctm-rest/repositories/REPO/types
/dmc_search_template.xml">
<properties>
<object_name>wangchen</object_name>
<subject>Search template Description for unit tests.</subject>
<r_creation_date>2015-09-23T01:45:31.000+00:00</r_creation_date>
<r_modify_date>2015-09-23T01:45:31.000+00:00</r_modify_date>
<owner_name>dmadmin</owner_name>
<r_is_public>true</r_is_public>
<selected_sources>
<item>REPO</item>
</selected_sources>

628 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

<r_object_id>0900000180010d1f</r_object_id>
</properties>
<query-document-template><?xml version='1.0' encoding='UTF-8'?><search
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" all-
versions="false">
<repositories><repository>REPO</repository>
</repositories><types><type>dm_sysobject</type>
</types><expression-set operator="AND"><expressions>
<fulltext fuzzy="false" template="true">key word</fulltext>
<expression-set operator="AND"><expressions><property
name="object_name" operator="CONTAINS" exact-match="false"
repeating="false"
case-sensitive="false" fuzzy="false" template="true">attr1</property>
</expressions></expression-set><property-range name="r_modify_date"
operator="BETWEEN" repeating="false" template="true">
<from>01/26/1973 00:00:00</from><to>11/30/2006 00:00:00
</to></property-range><relative-date name="r_modify_date"
time-unit="MONTH" operator="GREATER_THAN" repeating="false"
template="true">
-3</relative-date></expressions></expression-set>
</search>
</query-document-template>
<external-variables>
<fulltext-variable>
<id>/expression[0]</id>
<expression-type>fulltext</expression-type>
<data-type>string</data-type>
<variable-value>key word</variable-value>
</fulltext-variable>
<property-variable>
<id>/expression[1]/expression[0]</id>
<expression-type>property</expression-type>
<property-name>object_name</property-name>
<data-type>string</data-type>
<operator>CONTAINS</operator>
<variable-value>attr1</variable-value>
</property-variable>
<property-variable>
<id>/expression[2]/from</id>
<expression-type>property-range</expression-type>
<property-name>r_modify_date</property-name>
<data-type>datetime</data-type>
<operator>GREATER_EQUAL</operator>
<variable-value>01/26/1973 00:00:00</variable-value>
</property-variable>
<property-variable>
<id>/expression[2]/to</id>
<expression-type>property-range</expression-type>
<property-name>r_modify_date</property-name>
<data-type>datetime</data-type>
<operator>LESS_EQUAL</operator>
<variable-value>11/30/2006 00:00:00</variable-value>
</property-variable>
<relative-date-variable>
<id>/expression[3]</id>
<expression-type>relative-date</expression-type>
<property-name>r_modify_date</property-name>
<data-type>datetime</data-type>
<variable-value>-3:MONTH</variable-value>
</relative-date-variable>
</external-variables>

EDCPKRST220200-PRE-EN-01 Reference Guide 629

Chapter 2 Resources

<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO
/search-templates/08024c5180004333.xml"/>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/
search-templates/08024c5180004333.xml"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/search-templates/
08024c5180004333.xml"/>
</links>
</search-template>

Example 2-260: JSON response

{
"name": "search-template",
"type": "dmc_search_template",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dmc_search_template",
"properties": {
"object_name": "wangchen",
"subject": "Search template Description for unit tests.",
"r_creation_date": "2015-09-23T01:45:31.000+00:00",
"r_modify_date": "2015-09-23T01:45:31.000+00:00",
"owner_name": "dmadmin",
"r_is_public": true,
"selected_sources": [
"REPO"
],
"r_object_id": "0900000180010d1f"
},
"query-document-template": "{\"all-versions\":false,\"repositories\":
[\"REPO\"],
\"types\":[\"dm_sysobject\"],\"expression-set\":{\"name\":\"expression-
set\",
\"operator\":\"AND\",\"expressions\":[{\"expression-type\":\"fulltext\",
\"value\":\"key word\",\"fuzzy\":false,\"template\":\"true\"},
{\"name\":\"expression-set\",\"operator\":\"AND\",\"expressions\":[
{\"expression-type\":\"property\",\"name\":\"object_name\",
\"operator\":\"CONTAINS\",\"value\":\"attr1\",\"exact-match\":false,
\"repeating\":false,\"case-sensitive\":false,\"fuzzy\":false,
\"template\":\"true\"}]},
{\"expression-type\":\"property-range\",\"name\":\"r_modify_date\",
\"operator\":\"BETWEEN\",\"from\":\"01/26/1973 00:00:00\",
\"to\":\"11/30/2006 00:00:00\",\"repeating\":false,\"template\":\"true
\"},
{\"expression-type\":\"relative-date\",\"name\":\"r_modify_date\",
\"value\":-3,\"time-unit\":\"MONTH\",\"operator\":\"GREATER_THAN\",
\"repeating\":false,\"template\":\"true\"}]}}",
"external-variables": [
{
"id": "/expression[0]",
"expression-type": "fulltext",
"data-type": "string",
"variable-value": "key word"
},
{
"id": "/expression[1]/expression[0]",
"expression-type": "property",
"property-name": "object_name",

630 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

"data-type": "string",
"operator": "CONTAINS",
"variable-value": "attr1"
},
{
"id": "/expression[2]/from",
"expression-type": "property-range",
"property-name": "r_modify_date",
"data-type": "datetime",
"operator": "GREATER_EQUAL",
"variable-value": "01/26/1973 00:00:00"
},
{
"id": "/expression[2]/to",
"expression-type": "property-range",
"property-name": "r_modify_date",
"data-type": "datetime",
"operator": "LESS_EQUAL",
"variable-value": "11/30/2006 00:00:00"
},
{
"id": "/expression[3]",
"expression-type": "relative-date",
"property-name": "r_modify_date",
"data-type": "datetime",
"variable-value": "-3:MONTH"
}
],
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search-
templates/
08024c5180004333"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search-
template/
08024c5180004333"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search-
templates/
08024c5180004333"
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 631

Chapter 2 Resources

2.63.2.4.4 Get search templates

GET a collection of search templates.

2.63.2.4.4.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• inline

• items-per-page

• page

• sort

• filter

• links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.63.2.4.4.2 Request media types

N/A

2.63.2.4.4.3 Request headers

• Accept

• Authorization (optional)

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.63.2.4.4.4 Request body

N/A

2.63.2.4.4.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

632 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

2.63.2.4.4.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.63.2.4.4.7 Response status

• 200 Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985

2.63.2.4.4.8 Response body

Example 2-261: XML response

<feed
xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/search-templates
</id>
<title>Search Templates</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2015-09-23T02:02:59.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/
search-templates.xml?inline=true&items-per-page=1"/>
<link rel="next" href="http://localhost:8080/dctm-rest/repositories/REPO/
search-templates.xml?inline=true&items-per-page=1&page=2"/>
<link rel="first" href="http://localhost:8080/dctm-rest/repositories/REPO/
search-templates.xml?inline=true&items-per-page=1&page=1"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/search-templates/
0900000180010d15</id>
<title>wangchen</title>
<author>
<name>dmadmin</name>
</author>
<summary>Search template Description for unit tests.</summary>
<updated>2015-09-23T02:02:59.526+00:00</updated>
<published>2015-09-23T01:25:57.000+00:00</published>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/
REPO/
search-templates/0900000180010d15.xml"/>
<content>
<dm:search-template
xmlns:dm="http://identifiers.emc.com/vocab/documentum">

EDCPKRST220200-PRE-EN-01 Reference Guide 633

Chapter 2 Resources

<dm:properties>
<dm:object_name>wangchen</dm:object_name>
<dm:r_object_id>0900000180010d15</dm:r_object_id>
<dm:r_is_public>1</dm:r_is_public>
<dm:r_modify_date>2015-09-23T01:25:57.000+00:00
</dm:r_modify_date>
<dm:creation-date>2015-09-23T01:25:57.000+00:00
</dm:creation-date>
<dm:owner_name>dmadmin</dm:owner_name>
<dm:selected_sources>
<dm:item>REPO</dm:item>
</dm:selected_sources>
<dm:subject>Search template Description for unit tests.
</dm:subject>
</dm:properties>
<dm:links>
<link rel="self" href="http://localhost:8080/dctm-rest/
repositories/REPO/search-templates/
0900000180010d15.xml"/>
</dm:links>
</dm:search-template>
</content>
</entry>
</feed>

Example 2-262: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/search-templates",
"title": "Search Templates",
"author": [
{
"name": "OpenText Documentum"
}
],
"updated": "2015-09-23T02:02:17.107+00:00",
"page": 1,
"items-per-page": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search-templates?inline=true&items-per-page=1"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search-templates?inline=true&items-per-page=1&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search-templates?inline=true&items-per-page=1&page=1"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
search-templates/0900000180010d15",

634 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

"title": "wangchen",
"author": [
{
"name": "dmadmin"
}
],
"summary": "Search template Description for unit tests.",
"updated": "2015-09-23T02:02:17.108+00:00",
"published": "2015-09-23T01:25:57.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search-templates/0900000180010d15"
}
],
"content": {
"name": "search-template",
"properties": {
"object_name": "wangchen",
"r_object_id": "0900000180010d15",
"r_is_public": 1,
"r_modify_date": "2015-09-23T01:25:57.000+00:00",
"creation-date": "2015-09-23T01:25:57.000+00:00",
"owner_name": "dmadmin",
"selected_sources": [
"REPO"
],
"subject": "Search template Description for unit tests."
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/
search-templates/0900000180010d15"
}
]
}
}
]
}

2.63.3 Search Template Execution

This resource fills in the variables and allows you to retrieve real time search results
from a search template.

EDCPKRST220200-PRE-EN-01 Reference Guide 635

Chapter 2 Resources

2.63.3.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: About the Diagram on page 17.

For more information, see “Saved Search Templates” on page 619.

2.63.3.2 Feed
Is this resource a feed? Yes.

2.63.3.3 Link relations

Link relation Description Resource reference

self This object resource This resource
first, last, next, previous Pagination links Used for navigation when
more than one page of search
results are available

2.63.3.4 Operations
2.63.3.4.1 Supported HTTP methods

Method Description
POST Retrieves the results of an instantiated search
template

2.63.3.4.2 Get search results of an instantiated search template

This operation is similar to execute as an AQL query document. The AQL used to
execute this operation comes from the Documentum Server and user inputs.

636 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

2.63.3.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
POST • inline For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
• page
• items-
per-
page
• include
-total
• links
facet-id- Contains the string N/A null
constraint key value
s pairs for each
facet id and
its constraint.

For example:
• You can
use <id1>
as the
facet id
for the r_
object_
type
property
• You can
use <id2>
as the
facet id
for the
owner_
name
property

facet-id-
constraints=i
d1=dm_documen
t,id2=Adminis
trator

EDCPKRST220200-PRE-EN-01 Reference Guide 637

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
query-locale A locale used string N/A The default
to evaluate value is en.
the query and
parse words
into a
language
dependent
token.

Only
supported
with xPlore.

2.63.3.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.63.3.4.2.3 Request headers

• Authorization
• Accept
• For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.63.3.4.2.4 Request body

• Only the <external-variables> parameter will have an effect when used in the
request body. The system will ignore the <query-document-template> and
<properties> parameters are ignored when included in the Request.
• In each variable, <id> and <variable-value> are mandatory (for JSON, <variable-
type> is required). Users can skip other elements; but if other elements are used in
the Request body, they must be correct.
• The date type should comply with this pattern yyyy-MM-dd'T'HH:mm:ss.SSSZ,
and as specified in ISO 8601.

Example 2-263: XML request

<?xml version="1.0" encoding="UTF-8"?>
<search-template xmlns="http://identifiers.emc.com/vocab/documentum" xmlns:xsi="http://
www.w3.org/2001/XMLSchema-instance" xsi:type="dmc_search_template" definition="http://
localhost:8080/dctm-rest/repositories/REPO/types/dmc_search_template.xml">
<external-variables>
<fulltext-variable>
<id>/expression[0]</id>
<variable-value>key word</variable-value>
</fulltext-variable>
<property-list-variable>
<id>/expression[1]</id>
<expression-type>property-list</expression-type>

638 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

<property-name>object_name</property-name>
<data-type>string</data-type>
<operator>IN</operator>
<variable-values>
<item>v1</item>
<item>v2</item>
</variable-values>
</property-list-variable>
<property-variable>
<id>/expression[2]/expression[0]</id>
<expression-type>property</expression-type>
<property-name>object_name</property-name>
<data-type>string</data-type>
<operator>CONTAINS</operator>
<variable-value>attr1</variable-value>
</property-variable>
<property-variable>
<id>/expression[3]/from</id>
<variable-value>2014-10-13T07:33:13.009+00:00</variable-value>
</property-variable>
<property-variable>
<id>/expression[3]/to</id>
<expression-type>property-range</expression-type>
<property-name>r_modify_date</property-name>
<data-type>datetime</data-type>
<operator>LESS_EQUAL</operator>
<variable-value>2014-11-13T07:33:13.009+00:00</variable-value>
</property-variable>
<relative-date-variable>
<id>/expression[4]</id>
<expression-type>relative-date</expression-type>
<property-name>r_modify_date</property-name>
<data-type>datetime</data-type>
<variable-value>-3:MONTH</variable-value>
<operator>GREATER_THAN</operator>
</relative-date-variable>
</external-variables>
</search-template>

Example 2-264: JSON request

{
"external-variables": [
{
"variable-type": "fulltext-variable",
"id": "/expression[0]",
"variable-value": "key word"
},
{
"variable-type": "property-list-variable",
"id": "/expression[1]",
"expression-type": "property-list",
"property-name": "object_name",
"data-type": "string",
"operator": "IN",
"variable-values": [
"v1",
"v2"
]
},
{
"variable-type": "property-variable",
"id": "/expression[2]/expression[0]",
"variable-value": "attr1"
},
{

EDCPKRST220200-PRE-EN-01 Reference Guide 639

Chapter 2 Resources

"variable-type": "property-variable",
"id": "/expression[3]/from",
"expression-type": "property-range",
"property-name": "r_modify_date",
"data-type": "datetime",
"operator": "GREATER_EQUAL",
"variable-value": "2014-10-13T07:33:13.009+00:00"
},
{
"variable-type": "property-variable",
"id": "/expression[3]/to",
"expression-type": "property-range",
"property-name": "r_modify_date",
"data-type": "datetime",
"operator": "LESS_EQUAL",
"variable-value": "2014-11-13T07:33:13.009+00:00"
},
{
"variable-type": "relative-date-variable",
"id": "/expression[4]",
"expression-type": "relative-date",
"property-name": "r_modify_date",
"data-type": "datetime",
"variable-value": "3:MONTH",
"operator": "GREATER_THAN"
}
]
}

2.63.3.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.63.3.4.2.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.63.3.4.2.7 Response status

• 200 - Retrieved results successfully

• 400, 401, 403, 404, 406, 409, 415, 500

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

640 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.63. Saved Search Template (s)

2.63.3.4.2.8 Response body

Example 2-265: XML response

<feed
xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c5180005288/
execution</id>
<title>Search results</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2015-08-04T07:19:05.885+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/
08024c5180005288/execution.xml?items-per-page=1"/>
<link rel="next" href="http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c5180005288/execution.xml?items-per-page=1&page=2"/>
<link rel="first" href="http://localhost:8080/dctm-rest/repositories/REPO/saved-
searches/
08024c5180005288/execution.xml?items-per-page=1&page=1"/>
<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>09024c518000488c</id>
<title>ADFS and Shib 0.81.docx</title>
<author>
<name>UnitTestUser</name>
</author>
<summary>Federated Access 18 Step 3: Test AD FS 2.0 as the Identity...
Step 5: Test Shibboleth as the Identity Provider and AD FS 2.0 as...
following sections. AD FS 2.0 The test deployment that is created in the...
domain controller and the federation server in test deployments</summary>
<updated>2015-08-04T06:50:23.000+00:00</updated>
<link rel="edit" href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
09024c518000488c.xml"/>
<content type="application/xml" src="http://localhost:8080/dctm-rest/
repositories/REPO/
objects/09024c518000488c.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>Test</dm:term>
<dm:term>test</dm:term>
<dm:term>testing</dm:term>
<dm:term>rest</dm:term>
<dm:term>Testing</dm:term>
<dm:term>tested</dm:term>
</dm:terms>
</entry>
</feed>

EDCPKRST220200-PRE-EN-01 Reference Guide 641

Chapter 2 Resources

Example 2-266: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c5180005288/
execution",
"title": "Search results",
"author": [
{
"name": "OpenText Documentum"
}
],
"updated": "2015-08-04T07:17:59.804+00:00",
"page": 1,
"items-per-page": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c5180005288/execution?items-per-page=1"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c5180005288/execution?items-per-page=1&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/saved-searches/
08024c5180005288/execution?items-per-page=1&page=1"
},
{
"rel": "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}"
}
],
"entries": [
{
"id": "09024c518000488c",
"title": "ADFS and Shib 0.81.docx",
"author": [
{
"name": "UnitTestUser"
}
],
"summary": "Federated Access\t18 Step 3: Test AD FS 2.0 as the Identity...
Step 5: Test Shibboleth as the Identity Provider and AD FS 2.0 as...
following sections. AD FS 2.0 The test deployment that is created in the...
domain controller and the federation server in test deployments",
"updated": "2015-08-04T06:50:23.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
09024c518000488c"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
09024c518000488c"
},
"score": "1.0",
"terms": [
"Test",
"test",

642 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

"testing",
"rest",
"Testing",
"tested"
]
}
]
}

2.64 Search
The Search resource enables you to search for objects in a repository according to
the criteria that you specify. The search results can be navigated using facets.

For more information about facet searches, see the Facet Search section in the
OpenText&RegMark Documentum REST Services Version 7.3 Development Guide.

Note: The Documentum REST Search Service leverages the Documentum

Foundation Classes (DFC) to perform search operations on the Documentum
Server. The property rest.search.dfc.request.timeout in the rest-api-
runtime.properties configuration file specifies a time-out (in milliseconds)
for the execution of a DFC search request. A value of 0 indicates that there is no
timeout for search request.

2.64.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.64.2 Feed
Is this resource a feed? Yes.

• Feed ID: URI of the Search resource

• Feed Title: Search
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: A dm_sysobject or a subtype

This is a paged feed, and as such, this feed supports pagination.

EDCPKRST220200-PRE-EN-01 Reference Guide 643

Chapter 2 Resources

2.64.3 Link relations

Link relation Description Resource reference

self The URI for Search results “Search” on page 643
sysobjects feed
first, last, next, previous Pagination links Used for navigation when
more than one page of search
results are available
search The URI template or actual “Search” on page 643
URI for subsequent searches
(for example: facet selection)

2.64.4 Operations
2.64.4.1 Supported HTTP methods

Method Description
GET Full-text search using URI parameters.
POST Full-text search using a query document and
URI parameters.

2.64.4.2 Full-text search using URI parameters

This operation enables you to perform a full-text search using Simple Search
Language along with URI parameters. The operation also supports basic facet
navigation.

2.64.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data Value Default

method parameters type range value
GET q Specifies the search criterion with string N/A No search
a full-text expression in Simple criteria is
Search Language. used for
the search.
Parameter q must be encoded
because it may contain non-
English locale characters.

Note: International
characters that are used in
this query parameter must
be sent with URL encoded
by the UTF-8 charset.
Otherwise, the result may
be incorrect.

644 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

HTTP Query Description Data Value Default

method parameters type range value
locations Specifies a list of folder paths string N/A No
separated by comma (,) to which location
the query is scoped. scope
constraints
Parameter locations must be are used
encoded because it may contain for the
non-English locale characters. search.

Note: International
characters that are used in
this query parameter must
be sent with URL encoded
by the UTF-8 charset.
Otherwise, the result may
be incorrect.
collectio Specifies a list of collections string N/A No
ns separated by comma (,). to which collection
the query is scoped. The constraints
collections must exist in xPlore. are used
for the
search.
facet Specifies the property to be used string N/A No
as facet property is
used for
the search.

EDCPKRST220200-PRE-EN-01 Reference Guide 645

Chapter 2 Resources

HTTP Query Description Data Value Default

method parameters type range value
facet- Specifies a property constraint string N/A No
value- expression. For example, when property
constrain facet is set to r_object_type constraints
ts and facet-value- are used
constraints is set to dm_ for the
object, only dm_object search.
instances are returned.

You can use boolean operators +

for AND and | for OR in a
property constraint expression to
define more complex constraints.
For example, the expression dm_
object|dm_folder returns
both dm_object and dm_
folder instances.

Parameter facet-value-constraints
must be encoded because it may
contain non-English locale
characters.

Note: International
characters that are used in
this query parameter must
be sent with URL encoded
by the UTF-8 charset.
Otherwise, the result may
be incorrect.
timezone Indicates the time zone used to string N/A GMT
compute date facets.

Valid time zones include (case-

insensitive):
• Abbreviation, such as GMT
and UTC
• Full names, such as
America/Los_Angeles
• Custom time zones, such as
GMT-8:00
object- Specifies an object type. Only string N/A dm_
type instances of the specified type or SysObjec
its sub types are returned in the t
search result

646 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

HTTP Query Description Data Value Default

method parameters type range value
query-locale A locale used to evaluate the string N/A This is only
query and parse words into a supported
language dependent token with
xPlore.

The default
value is en

2.64.4.2.1.1 URI query parameters

This operation supports the following URI query parameters:

• include-total
The include-total parameter in the Search service returns the total number of
hit results.
• inline
• items-per-page
• page
• sort
The sort order is determined by the data type of the attribute. For example, when
<r_content_size> is used with an attribute value of 123,3555 to sort search results,
the data type is integer and REST sorts the search results by integer.
• view

Notes

• Pagination parameters (page, items-per-page, and include-total) only take

effect on full text search results. As a result, pagination link relations do not
appear when you navigate to the result set of a certain facet by using the
search link relation in a facet section.
A facet is not calculated against the current page, but is instead calculated
against the entire result set. For example, if there are 25 results returned for a
keyword, the parameter items-per-page may have a value of 2. In this case,
the Response contains only 2 results, even though the facets were calculated
against 25 results.
• The inline parameter must be true, or the view parameter has no effect.
• Setting the view parameter to :default and to :all behave the same. Both
settings return the following properties of an object:

– r_object_id
– object_name
– r_object_type

EDCPKRST220200-PRE-EN-01 Reference Guide 647

Chapter 2 Resources

– r_modify_date
– r_modifier
– summary

Example 2-267: A GET request

Here is an example of a GET request to perform a full-text search using URI

parameters:
http://localhost:8080/dctm-rest/repositories/acme01/search?q=search_criterion
&facet=property_name&facet-value-constraints=f_v_constraints

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.64.4.2.2 Request media types

N/A

2.64.4.2.3 Request headers

• Accept
• Content-Type
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.64.4.2.4 Request body

N/A

2.64.4.2.5 Response headers

• Content-Type
• Content-Length

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

648 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

2.64.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/json
• application/xml

2.64.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.64.4.2.8 Response body

XML or JSON representation of the search results with facets.

• The body must contain a list of sysobjects (or subtypes of dm_SysObject), each of
which may or may not contain all attributes of a SysObject, depending on the
setting of the view and inline query parameters.
• The returned sysobjects collection only contains objects for which the user has
access.
• 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 explicitly specified in the request
parameter, along with it the link for last page can be returned.

Example 2-268: XML response - feed

<feed
xmlns="http://www.w3.org/2005/Atom"
xmlns:relevance="http://a9.com/-/opensearch/extensions/relevance/1.0/"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:dm="http://identifiers.emc.com/vocab/documentum">
...
<!--The URI of the GET request sent to the REST server-->
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/acme01/search?
q=test&facet=r_object_type"/>
<!--A URI template that lists all available query parameters you can use-->
<link rel="search"
hreftemplate="http://localhost:8080/dctm-rest/repositories/acme01/search
{?q,collections,locations,facet,inline,page,items-per-page,include-total,
sort,view,facet-value-constraints/>
<!--Search results are listed in the following entries-->
<entry>
...
</entry>
...
...

EDCPKRST220200-PRE-EN-01 Reference Guide 649

Chapter 2 Resources

<entry>
...
</entry>
<!--Facet information-->
<dm:facet>
<!--The property used as the facet-->
<dm:facet-id>r_object_type</dm:facet-id>
<dm:facet-label>Type</dm:facet-label>
<!--Data of the results belonging to this fact-->
<dm:facet-value>
<dm:facet-value-id>san_biz</dm:facet-value-id>
<dm:facet-value-count>13</dm:facet-value-count>
<dm:facet-id>r_object_type</dm:facet-id>
<dm:facet-value-constraint>san_biz</dm:facet-value-constraint>
<!--A link that navigate you to the corresponding results of this fact--
>
<link rel="search"
href="http://localhost:8080/dctm-rest/repositories/acme01/search?
q=test&facet=r_object_type&fact-vale-constraints=san_biz"/>
</dm:facet-value>
<dm:facet-value>
<dm:facet-value-id>dm_document</dm:facet-value-id>
<dm:facet-value-count>12</dm:facet-value-count>
<dm:facet-id>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/acme01/search?
q=test&facet=r_object_type&fact-vale-constraints=dm_document"/>
</dm:facet-value>
</dm:facet>
</feed>

Example 2-269: JSON response - feed

{
"id": "http://localhost:8080/dctm-rest/repositories/acme01/search",
"updated": "2014-04-30T14:27:49.643+08:00",
"author": [
{
"name": "OpenText Documentum"
}
],
"page": 1,
"items-per-page": 3,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/acme01/search.json?
q=test
&items-per-page=3&inline=false&include_total=true"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/acme01/search.json?
q=test
&items-per-page=3&inline=false&include_total=true&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/acme01/search.json?
q=test
&items-per-page=3&inline=false&include_total=true&page=1"
},
{
"rel": "search",
"hreftemplate": "http://localhost:8080/dctm-rest/repositories/acme01/

650 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

search.json{?q,collections,locations,facet,inline,page,items-per-page,
include-total,sort,view}"
}
],
"entries": [
{
"id": "090004d280005117",
"title": "Native UCF Functional Test Plan.doc",
"updated": "2013-05-07T15:56:45.000+08:00",
"summary": "Native UCF Functional Test Plan\t\t09/13/2010 OpenText |
Documentum...
Project Native UCF Functional Test Plan Document.../Updated some tests
Functional
Test Plan Template Version: 1.2... _Toc408805185 _Toc262725323 _Toc272245663
1.
Test Plan Identifier",
"author": [
{
"name": "dmadmin"
}
],
"content": {
"content-type": "application/json",
"src": ""
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/acme01/objects/
090004d280005117.json"
}
],
"score": "1.0",
"terms": [
"Test",
"Tested",
"tests",
"test",
"testing",
"Testing",
"tested"
]
},
{
"id": "090004d280009f72",
"title": "TESTED",
"updated": "2013-09-10T15:33:43.000+08:00",
"author": [
{
"name": "dmadmin"
}
],
"content": {
"content-type": "application/json",
"src": ""
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/acme01/objects/
090004d280009f72.json"
}
],
"score": "0.4935832917690277",
"terms": [
"test"
]
},
{

EDCPKRST220200-PRE-EN-01 Reference Guide 651

Chapter 2 Resources

"id": "090004d2800072ae",
"title": "AAA BACKFLOW TESTING LLC",
"updated": "2013-09-10T15:25:15.000+08:00",
"author": [
{
"name": "dmadmin"
}
],
"content": {
"content-type": "application/json",
"src": ""
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/acme01/objects/
090004d2800072ae.json"
}
],
"score": "0.48992398381233215",
"terms": [
"test"
]
}
]
}

2.64.4.3 Full-text search using query document and URI parameters

Retrieves a list of sysobjects or SysObject subtypes that match the search criteria,
which means that you can perform a search on metadata.

2.64.4.3.1 HTTP Request method and query parameters

POST

The following URI parameters are supported:

• include-total
• page
• items-per-page
• inline
• facet-id-constraints
Contains the key value pairs for each facet id and its constraint. The id should
comply with the facet id in the AQL.
For example:

– You can use <id1> as the facet id for the <r_object_type> property
– You can use <id2> as the facet id for the <owner_name> property

facet-id-constraints=id1=dm_document,id2=Administrator

652 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

Note: Using any other search URI parameters not shown above with AQL
causes an error message to be shown in the Documentum REST Services
system.

2.64.4.3.2 Request media types

• application/vnd.emc.documentum+json
• application/vnd.emc.documentum+xml

2.64.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.64.4.3.4 Request body

XML or JSON representation of the query document.

Example 2-270: XML request

POST http://localhost:8080/dctm-rest/repositories/acme01/search.xml
Content-Type: application/vnd.emc.documentum

<search>
<types>
<type>dm_sysobject</type>
</types>
<expression-set>
<fulltext fuzzy="true">dmadmin</fulltext>
</expression-set>
<columns>
<column>object_name</column>
<column>r_object_id</column>
</columns>
<facets>
<facet id="r_modify_date">
<attributes><attribute>r_modify_date</attribute></attributes>
</facet>
</facets>
</search>

EDCPKRST220200-PRE-EN-01 Reference Guide 653

Chapter 2 Resources

2.64.4.3.5 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.64.4.3.6 Response headers

• Content-Type
• Content-Length

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.64.4.3.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.64.4.3.8 Response body

Same response body as for the GET method: see “Response body” on page 649.

Example 2-271: XML request

POST http://localhost:8080/dctm-rest/repositories/acme01/search
Content-Type: application/vnd.emc.documentum+xml

<search all-versions="true" max-results-for-facets="10"

xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<types>
<type>dm_document</type>
</types>
<columns>
<column>r_object_type</column>
<column>object_name</column>
</columns>
<sorts>
<sort ascii="false" ascending="true" lang="fr">r_content_size</sort>
<sort ascii="true" ascending="false" lang="zh">object_name</sort>
</sorts>
<collections>
<collection>collection1</collection>
<collection>collection2</collection>
</collections>
<locations>
<id-location descendent="true">
<id>0c00000580001914</id>
</id-location>
<path-location descendent="false">
<path>/dmadmin</path>
</path-location>

654 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

</locations>
<facet-definitions>
<facet-definition id="id1" group-by="alpharange" max-values="8">
<attributes>
<attribute>r_object_type</attribute>
</attributes>
<sort>FREQUENCY</sort>
<properties>
<property name="range">a:e, f:z</property>
</properties>
</facet-definition>
<facet-definition id="id2" group-by="relativeDate" max-values="9">
<attributes>
<attribute>r_modify_date</attribute>
</attributes>
<sort>VALUE_ASCENDING</sort>
</facet-definition>
</facet-definitions>
<expression-set>
<expressions>
<property name="object_name" operator="CONTAINS" exact-match="true"
repeating="true"
case-sensitive="false" fuzzy="true">rest
</property>
<fulltext fuzzy="true">rest</fulltext>
<fulltext fuzzy="false">test</fulltext>
<property-range name="r_content_size" operator="BETWEEN" repeating="false">
<from>0</from>
<to>10000</to>
</property-range>
<property-list name="r_object_type" operator="IN" repeating="false">
<values>
<value>dm_document</value>
<value>dm_folder</value>
</values>
</property-list>
<expression-set>
<expressions>
<fulltext fuzzy="false">test</fulltext>
</expressions>
</expression-set>
<relative-date name="r_modify_date"
time-unit="MONTH" operator="GREATER_THAN" >2</relative-date>
</expressions>
</expression-set>
</search>

Example 2-272: JSON request

POST http://localhost:8080/dctm-rest/repositories/acme01/search
Content-Type: application/vnd.emc.documentum+json

{
"types": ["dm_document"],
"columns": [
"r_object_type",
"object_name"
],
"collections": [
"collection1",
"collection2"
],
"locations": [
{
"location-type": "id-location",
"id": "0c00000580001914",

EDCPKRST220200-PRE-EN-01 Reference Guide 655

Chapter 2 Resources

"descendent": true
},
{
"location-type": "path-location",
"path": "/dmadmin",
"descendent": false
}
],
"sorts": [
{
"property": "r_content_size",
"ascending": true,
"lang": "fr",
"ascii": false
},
{
"property": "object_name",
"ascending": false,
"lang": "zh",
"ascii": true
}
],
"facet-definitions": [
{
"id": "id1",
"attributes": ["r_object_type"],
"group-by": "alpharange",
"sort": "FREQUENCY",
"properties": {
"range": "a:e, f:z",
},
"max-values": 8
},
{
"id": "id2",
"attributes": ["r_modify_date"],
"group-by": "r_modify_date",
"sort": "VALUE_ASCENDING",
"max-values": 9
}
],

"expression-set": {
"expression-type": "expression-set",
"expressions": [
{
"expression-type": "property",
"name": "object_name",
"operator": "CONTAINS",
"value": "rest",
"exact-match": true,
"repeated": true,
"case-sensitive": false,
"fuzzy": true
},
{
"expression-type": "fulltext",
"value": "rest",
"fuzzy": true
},
{
"expression-type": "fulltext",
"value": "test",
"fuzzy": false
},
{
"expression-type": "property-range",
"name": "r_content_size",
"operator": "BETWEEN",
"from": "0",

656 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

"to": "10000",
"repeating": false
},
{
"expression-type": "property-list",
"name": "r_object_type",
"operator": "IN",
"values": [
"dm_document",
"dm_folder"
],
"repeating": false
},
{
"expression-type": "expression-set",
"expressions": [
{
"expression-type": "fulltext",
"value": "test",
"fuzzy": false
}
]
},
{
"expression-type": "relative-date",
"name": "r_modify_date",
"value": 2,
"time-unit": "MONTH",
"operator": "EQUAL"
}
]
}
}

Example 2-273: Response

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+json;charset=UTF-8
Date: Tue, 19 Feb 2013 10:15:21 GMTServer: Apache-Coyote/1.1
Transfer-Encoding: chunked

Example 2-274: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/acme01/search",
"updated": "2014-04-30T14:27:49.643+08:00",
"author": [
{
"name": "OpenText Documentum"
}
],
"page": 1,
"items-per-page": 3,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/acme01/searches/
0c10304585007313/execution?items-per-page=3&inline=false&
include_total=true"
},
{
"rel": "next",

EDCPKRST220200-PRE-EN-01 Reference Guide 657

Chapter 2 Resources

"href": "http://localhost:8080/dctm-rest/repositories/acme01/searches/
0c10304585007313/execution?items-per-page=3&inline=false&
include_total=true&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/acme01/searches/
0c10304585007313/execution?items-per-page=3&inline=false&
include_total=true&page=1"
}
],
"entries": [
...
...
]
}

2.64.4.4 Search with facets

Faceted searching allows you to view a collection of search results information by
applying one or more filters. Faceted searching, also known as Faceted Navigation,
uses a classification system to divide information into dimensions, called facets,
allowing the classifications to be used in many ways.

REST services supports faceted navigation in two ways:

• URI parameter (facet) in GET request

• Abstract Query Language (AQL) in the POST body

2.64.4.4.1 Facets using query parameters

A URI facet parameter can be used to specify one attribute as the facet. By default,
the attributes of SysObject that are facet-enabled depends on the xPlore
configuration. The configuration for xPlore must be modified and re-indexed to facet
new attributes or add additional facet values to existing attributes.

Attribute DFC Data type Default Grouped By

r_modifier DF_STRING string
keywords DF_STRING string
r_modify_date DF_TIME relativeDate
r_full_content_size DF_DOUBLE string
a_application_type DF_STRING string
r_object_type DF_STRING string
owner_name DF_STRING string

The strategy used to group facets depends on the data type of the attribute.
Additional grouping strategies can be achieved using AQL language in a POST
statement.

658 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

For more information, see “Facet using query document” on page 660.

Another URI parameter called facet-value-constraints is used to define an

expression that outlines the constraints that are used in the parameter facet. This
parameter allows you to navigate a result set under the constraints that your
expression defines for the attribute in the parameter facet. Facets used in a feed are
returned with the full text search results. You can view the facets in the following
response sample:
"facets": [
{
"facet-id": "facet_r_object_type",
"facet-value": [
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search?facet=r_object_type
&facet-value-constraints=dm_document",
"rel": "search"
},
"facet-id": "facet_r_object_type",
"facet-value-constraint": "dm_document",
"facet-value-count": 116,
"facet-value-id": "dm_document"
},
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search?
facet=r_object_type&
facet-value-constraints=dm_folder",
"rel": "search"
},
"facet-id": "facet_r_object_type",
"facet-value-constraint": "dm_folder",
"facet-value-count": 68,
"facet-value-id": "dm_folder"
},
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search?
facet=r_object_type&facet-value-constraints=dm_cabinet",
"rel": "search"
},
"facet-id": "facet_r_object_type",
"facet-value-constraint": "dm_cabinet",
"facet-value-count": 25,
"facet-value-id": "dm_cabinet"
},
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search?
facet=r_object_type&
facet-value-constraints=dm_sysobject",
"rel": "search"
},
"facet-id": "facet_r_object_type",
"facet-value-constraint": "dm_sysobject",
"facet-value-count": 12,
"facet-value-id": "dm_sysobject"
},
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search?
facet=r_object_type&
facet-value-constraints=rest_core",
"rel": "search"
},
"facet-id": "facet_r_object_type",

EDCPKRST220200-PRE-EN-01 Reference Guide 659

Chapter 2 Resources

"facet-value-constraint": "rest_core",
"facet-value-count": 8,
"facet-value-id": "rest_core"
},
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/search?
facet=r_object_type&
facet-value-constraints=dm_network_location_map",
"rel": "search"
},
"facet-id": "facet_r_object_type",
"facet-value-constraint": "dm_network_location_map",
"facet-value-count": 2,
"facet-value-id": "dm_network_location_map"
}
],
"facet-label": "Type"
}
]

2.64.4.4.2 Facet using query document

Facet navigation using AQL allows you to harness the full power of facets. There are
three kinds of facet requests:

• Single facet
• Multiple facet
• Nested facet

Note: From an implementation perspective, the facet constraints are defined by

the underlying grouping strategy. You can determine facets by the grouping
strategies used. The grouping strategies available for a given attribute depends
on the data type of that attribute. For example, it is not meaningful to use a day
or relativeDate grouping strategy for a string type attribute, such as object_
name.

Grouping Strategies

660 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

Strategy Description Options (properties)

string Applies to string • nullValueFacet (optional): if this
values. property is set, null values will be counted
as a facet. The facet will be named using the
value of the property. By default, the null
values are ignored when computing facets.
• keepDuplicateValues (optional): true/
false. Default: false. For a document,
attributes with repeating values may have
duplicate values. By default, duplicates are
removed. If this property is set to true,
duplicates entries are counted. Since: xPlore
1.1 P03 and 1.2
• caseInsensitive (optional): true/false.
Default: false. If this property is set to
true, facet computation ignores case. For
example, if a results set has a document
with a value 'opentext' and another
'OPENTEXT', then two facets will be
returned, opentext(1) and OPENTEXT(1).
Since: xPlore 1.1 P03 and 1.2
range Applies to numeric range (required). This property defines a list
values. of 'buckets' to use for grouping. Each bucket is
separated by comma (','). A bucket is defined
Range grouping by a lower and upper bounds separated by
requires the use of the colon (':'). Open ended bucket can be defined
<'range'> property, by omitting one of the bounds but keeping the
which defines the comma separator. Overlapping buckets are not
ranges to use in supported and may result in inconsistent
grouping. results.
Example: For 'range':
0:1000,1000:10000,1000 • The boundaries themselves are parsed as
0:
Double
Example:
'0:10,10:100.89,100:'
• The lower-bound is inclusive. The upper-
bound is exclusive. For example, for a facet
value corresponding to '0:1000', the
constraint should be (attribute >= 0 and
attribute <1000).

EDCPKRST220200-PRE-EN-01 Reference Guide 661

Chapter 2 Resources

Strategy Description Options (properties)

alpharange Applies to string The range that is mentioned in the range
values (since xPlore strategy above is also required for the
1.3). Range grouping alpharange strategy. In addition to this, the
requires the use of the following also apply to the alpharange
'range' property, which strategy:
defines the ranges to
use for grouping.
• The boundaries are parsed as one character.
Example:
Example:<\para>
'a:m,n:r,s:z'
1
2
• This grouping strategy is case-insensitive.
3 'a:m,n:r,s:z' Special care must be taken when adding a
constraint based on such a facet value
This grouping strategy because the comparison operators on string
uses Unicode order, (<, <=, >=, >) are case sensitive. As a
not language consequence, one has to add 2 constraints:
dependent order. one on the lowercase range and one on the
uppercase range.
In practice, it is only
The upper-bound and lower-bound are
useful for ASCII
returned as a property of the facet value.
characters.
The boundaries are inclusive. As a
consequence, the constraint on the upper-
bound should add 1 to the actual character.
Example: for a facet value corresponding to
'a-m', the constraint should be (attribute >=
'a' and attribute < 'n') or (attribute >='A' and
attribute < 'N')

For more information, see range on page 661

above

662 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

Strategy Description Options (properties)

The date strategy The facet values • timezone (optional): a timezone code.
including: returned are the start Default: Z (UTC). The timezone to be used
date of the range, using to compute date grouping.
• day
the UTC time zone • returnUTC (optional) - since xPlore 1.3: a
• week boolean. Default: 'true' in REST. When
• month For example, for
timezone is specified and <returnUTC> is
January 2011, the facet
• quarter (since false, the dates in the facets are returned
value is
xPlore v1.3) formatted in the specified timezone. The
2001-01-01T00:00:00
same timezone is used to compute the date
• year (the time is adjusted
range boundaries and to format the facets.
• relativeDate when the <'timezone'>
property is specified). When <returnUTC> is set to 'true', the date
in the facet is formatted in UTC. In this
case, the timezone is only be used for
computation, but not for formatting.
• skipEmptyValues (optional): A boolean
value whose default is 'true'.
When <skipEmptyValues> is set to 'true', only
the facet values with a count strictly greater
than zero are returned.
When <skipEmptyValues> is set to 'false',
the query returns all the facet values
between the oldest non-zero facet value and
the most recent non-zero facet value.

Note: This property only works for

date type with grouping strategy day,
month, year, week or quarter.

Max for Facet Group

The max-values property is the attribute of the facet definition that defines the
greatest number of groups that each facet can return.

Facet Ordering

• FREQUENCY
Ordered by count, descending

• NONE
Keep the order returned by the facet handler
• VALUE_ASCENDING
Ordered by facet value ID (ascending). The sort is alphanumeric. We assume that
even if the data type of the facet is date or numeric, the values are encoded in
such way that they are alphanumerically sortable.

• VALUE_DESCENDING

EDCPKRST220200-PRE-EN-01 Reference Guide 663

Chapter 2 Resources

Ordered by facet value ID (descending). The sort is alphanumeric. We assume

that even if the data type of the facet is date or numeric, the values are encoded
in such way that they are alphanumerically sortable.

Example 2-275: JSON single facet

To navigate the facet results, you can POST the original request body to the link
in the facet value. The following JSON sample uses a Request and a Response
to demonstrate how to use a single facet:

Request
{
...
...
"columns":["owner_name"],
"facet-definitions": [
{
"id": "id1",
"attributes": ["r_object_type"],
"sort": "FREQUENCY"
}
]
}

Response

In the Response, the URL in the facet value has the facet-id-constraints
parameter. This parameter specifies the facet constraint id1=dm_folder:
"facets": [
{
"facet-id": "id1",
"facet-label": "Type",
"facet-value": [
{
"facet-id": "id1",
"facet-value-constraint": "dm_document",
"facet-value-count": 116,
"facet-value-id": "dm_document",
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/acme01/
searches/
0c10304585007313/execution?facet-id-constraints=id1%3Ddm_document",
"rel": "search"
}
},
{
"facet-id": "id1",
"facet-value-constraint": "dm_folder",
"facet-value-count": 68,
"facet-value-id": "dm_folder",
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/acme01/
searches/
0c10304585007313/execution?facet-id-constraints=id1%3Ddm_folder",
"rel": "search"
},
}
]
}
]

664 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

Example 2-276: XML multiple facets

This code sample shows how to use two separate facets against <r_object_type>
and <owner_name>. The facets results have two facet aggregations respectively.

XML request
<search all-versions="true">
<facet-definitions>
<facet-definition id="id1" group-by="alpharange" max-values="8">
<attributes>
<attribute>r_object_type</attribute>
</attributes>
<properties>
<property name="range">a:r, s:z</property>
</properties>
<sort>FREQUENCY</sort>
</facet-definition>
<facet-definition>
<attributes>
<attribute>owner_name</attribute>
</attributes>
</facet-definition>
</facet-definitions>
</search>

JSON response
"facets": [
{
"facet-id": "id1",
"facet-label": "Type",
"facet-value": [
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/acme01/
searches/
0c10304585007313/execution?facet-id-constraints=id1%3Da:r",
"rel": "search"
},
"facet-id": "id1",
"facet-value-constraint": "a:r",
"facet-value-count": 116,
"facet-value-id": "a:r"
},
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/acme01/
searches/
0c10304585007313/execution?&facet-id-constraints=id1%3Ds:z",
"rel": "search"
},
"facet-id": "id1",
"facet-value-constraint": "s:z",
"facet-value-count": 68,
"facet-value-id": "s:z"
}
]
},
{
"facet-id": "facet_owner_name",
"facet-label": "Owner Name",
"facet-value": [
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/acme01/
searches/

EDCPKRST220200-PRE-EN-01 Reference Guide 665

Chapter 2 Resources

0c10304585007313/execution?facet-id-constraints=facet_owner_name
%3Ddave",
"rel": "search"
},
"facet-id": "facet_owner_name",
"facet-value-constraint": "dave",
"facet-value-count": 126,
"facet-value-id": "dave"
},
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/acme01/searches/
0c10304585007313/execution?
facet-id-constraints=facet_owner_name%3Ddmadmin",
"rel": "search"
},
"facet-id": "facet_owner_name",
"facet-value-constraint": "dmadmin",
"facet-value-count": 138,
"facet-value-id": "dmadmin"
}
]
}
]

Example 2-277: JSON nested facet

This code sample shows a nested facet definition, where r_object_type points
to owner_name in a tree like structure. For each r_object_type, the grouping
by owner_name goes a step further. Also, the facet values are hierarchical. The
first nested facet value has constraint id1=dm_document and id2=dmadmin:

JSON request
{
"columns":["owner_name"],
"facet-definitions": [
{
"id": "id1",
"attributes": ["r_object_type"],
"sort": "FREQUENCY",
"facet-definition": {
"id": "id2",
"attributes": ["owner_name"],
"sort": "FREQUENCY"
}
}
]
}

JSON response
{"facets": [
{
"facet-id": "id1",
"facet-label": "Type",
"facet-value": [
{
"facet-value-constraint": "dm_document",
"facet-value-count": 116,
"facet-value-id": "dm_document",
"facet-id": "id1",
"link": {

666 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.64. Search

"href": "http://localhost:8080/dctm-rest/repositories/acme01/
searches/
0c10304585007313/execution&facet-id-constraints=id1%3Ddm_document",
"rel": "search"
},
"facet-value": [
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/acme01/
searches/0c10304585007313/execution&facet-id-constraints=id1%3D
dm_document,id2%3Ddave",
"rel": "search"
},
"facet-id": "id2",
"facet-value-constraint": "dave",
"facet-value-count": 86,
"facet-value-id": "dave"
},
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/acme01/
searches/0c10304585007313/execution&
facet-id-constraints=id1%3Ddm_document,id2%3Ddmadmin",
"rel": "search"
},
"facet-id": "id2",
"facet-value-constraint": "dmadmin",
"facet-value-count": 30,
"facet-value-id": "dmadmin"
}
]
},
{
"facet-value-constraint": "dm_folder",
"facet-value-count": 68,
"facet-value-id": "dm_folder",
"facet-id": "id1",
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/acme01/
searches/
0c10304585007313/execution&facet-id-constraints=id1%3Ddm_folder",
"rel": "search"
},
"facet-value": [
{
"link": {
"href": "http://localhost:8080/dctm-rest/repositories/acme01/
searches/0c10304585007313/execution&
facet-id-constraints=id1%3Ddm_folder,id2%3Ddave",
"rel": "search"
},
"facet-id": "id2",
"facet-value-constraint": "dave",
"facet-value-count": 68,
"facet-value-id": "dave"
}
]
}
]
}
]}

EDCPKRST220200-PRE-EN-01 Reference Guide 667

Chapter 2 Resources

2.65 Significant Terms

The Significant Terms resource forms part of the services of the Documentum
Contextual Content Engine (CCE). This resource delivers a way for us to discover
common and significant terms by comparing the term frequency change in the
requested document and background.

2.65.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Document” on page 217 and About the Diagram on page 17.

2.65.2 Feed
Is this resource a feed? Yes.

• Feed ID: Resource URI

• Feed Title: Significant Terms of <document name> from CCE

• Supports POST: No

• Feed Updated: Current server time

• Entry: No resource

• Entry ID: The Resource URI

• Entry Title: The significant terms of the document

• Entry Updated: Current server time

2.65.3 Link relations

Link relation Description Resource reference

self This collection of significant terms “Significant Terms” on page 668
search [1] A template link formed by keyword “Search” on page 643
to search
[1] The above link relation is defined by Documentum. The fully qualified Documentum
link relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

668 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.65. Significant Terms

2.65.4 Operations
2.65.4.1 Supported HTTP methods

Method Description
GET Retrieves the significant terms of the requested document.

2.65.4.2 Get Significant Terms

Retrieves the significant terms of the requested document.

2.65.4.2.1 HTTP Request method and query parameters

HTTP method Query parameters

GET page, items-per-page, links

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.65.4.2.2 Request media types

N/A

2.65.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.65.4.2.4 Request body

N/A

2.65.4.2.5 Response headers

• Content-Type
• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 669

Chapter 2 Resources

2.65.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json
• application/hal+json

2.65.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.65.4.2.8 Response body

Example 2-278: XML Response

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115b/significant-terms</id>
<title>Significant Terms of document(s) 090000018000115b from CCE</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2018-08-20T03:56:38.419+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">
2
</dm:total>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115b/significant-terms"></link>
<link rel="http://identifiers.emc.com/linkrel/search"
hreftemplate="http://localhost:8080/dctm-rest/repositories/REPO/
search{?collections,facet,inline,
items-per-page,locations,object-type,page,q,sort,
timezone,view}"></link>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115b/significant-terms</id>
<title>desires</title>
<summary>Significant Term Result</summary>
<updated>2018-08-20T03:56:38.420+00:00</updated>
<published>2018-08-20T03:56:38.420+00:00</published>
<relevance:score xmlns:relevance="http://a9.com/-/opensearch/
extensions/relevance/1.0/">
4.058979821368136
</relevance:score>
<link rel="http://identifiers.emc.com/linkrel/search"
href="http://localhost:8080/dctm-rest/repositories/REPO/
search?q=desires"></link>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/

670 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.65. Significant Terms

documents/090000018000115b/significant-terms"></content>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115b/significant-terms</id>
<title>costing</title>
<summary>Significant Term Result</summary>
<updated>2018-08-20T03:56:38.420+00:00</updated>
<published>2018-08-20T03:56:38.420+00:00</published>
<relevance:score xmlns:relevance="http://a9.com/-/opensearch/
extensions/relevance/1.0/">
4.058979821368136
</relevance:score>
<link rel="http://identifiers.emc.com/linkrel/search"
href="http://localhost:8080/dctm-rest/repositories/REPO/
search?q=costing"></link>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115b/significant-terms"></content>
</entry>
</feed>

Example 2-279: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115b/significant-terms",
"title": "Significant Terms of document(s) 090000018000115b from CCE",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-08-20T03:45:30.694+00:00",
"page": 1,
"items-per-page": 100,
"total": 2,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115b/significant-terms"
},
{
"rel": "http://identifiers.emc.com/linkrel/search",
"hreftemplate": "http://localhost:8080/dctm-rest/repositories/REPO/
search{?collections,facet,inline,
items-per-page,locations,object-type,page,q,sort,
timezone,view}"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115b/significant-terms",
"title": "desires",
"summary": "Significant Term Result",
"updated": "2018-08-20T03:45:30.695+00:00",
"published": "2018-08-20T03:45:30.695+00:00",
"score": 4.058979821368136,
"links": [
{
"rel": "http://identifiers.emc.com/linkrel/search",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search?q=desires"
}

EDCPKRST220200-PRE-EN-01 Reference Guide 671

Chapter 2 Resources

],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115b/significant-terms"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115b/significant-terms",
"title": "costing",
"summary": "Significant Term Result",
"updated": "2018-08-20T03:45:30.695+00:00",
"published": "2018-08-20T03:45:30.695+00:00",
"score": 4.058979821368136,
"links": [
{
"rel": "http://identifiers.emc.com/linkrel/search",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search?q=costing"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115b/significant-terms"
}
}
]
}

Example 2-280: HAL: JSON Response

{ "id": "http://localhost:8080/dctm-rest/repositories/REPO/documents/
090000018000115c/significant-terms",
"title": "Significant Terms of document(s) 090000018000115c from CCE",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-09-14T02:08:10.926+00:00",
"page": 1,
"items-per-page": 100,
"_embedded": {
"collection": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115c/significant-terms",
"title": "profitability",
"summary": "Significant Term Result",
"updated": "2018-09-14T02:08:10.927+00:00",
"published": "2018-09-14T02:08:10.927+00:00",
"score": 5.88726916052116,
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/documents/090000018000115c/
significant-terms"
},
"http://identifiers.emc.com/linkrel/search": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/search?q=profitability"
}
}
},

672 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.66. Sub-Group (s)

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115c/significant-terms",
"title": "resource",
"summary": "Significant Term Result",
"updated": "2018-09-14T02:08:10.927+00:00",
"published": "2018-09-14T02:08:10.927+00:00",
"score": 4.03863332553002,
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/documents/090000018000115c/
significant-terms"
},
"http://identifiers.emc.com/linkrel/search": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/search?q=resource"
}
}
}
]
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
documents/090000018000115c/significant-terms"
},
"http://identifiers.emc.com/linkrel/search": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search{?collections,facet,inline,
items-per-page,locations,object-type,page,q,sort,
timezone,view}",
"templated": true
}
}
}

2.66 Sub-Group (s)

2.66.1 Sub Group
The Sub Group resource represents the relationship between a group and one of its
sub groups.

2.66.1.1 Resource relationships

The following diagram illustrates how Sub Group resource is related with other
resources:

See Also: “Sub Groups” on page 675 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 673

Chapter 2 Resources

2.66.1.2 Feed
No feed support.

2.66.1.3 Link relations

N/A

2.66.1.4 Operations
2.66.1.4.1 Supported HTTP methods

Method Description
DELETE Remove a sub group from a group

2.66.1.4.2 Remove a sub group relationship

Removes the relation between a group and it's sub group.

2.66.1.4.2.1 HTTP Request method and query parameters

DELETE

2.66.1.4.2.2 Request media types

N/A

2.66.1.4.2.3 Request headers

• Accept
• Content-Type
• Authentication

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.66.1.4.2.4 Request body

Example 2-281: Removing a user

DELETE http://localhost:8080/dctm-rest/repositories/REPO/groups/
mygroup/groups/mysubgroup

674 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.66. Sub-Group (s)

2.66.1.4.2.5 Response headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.66.1.4.2.6 Response media types

N/A

2.66.1.4.2.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.66.1.4.2.8 Response body

HTTP 204 No Content status upon a successful delete operation.

2.66.2 Sub Groups

The Sub Groups resource represents a collection of sub groups that directly belong to
a specified group.

2.66.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Group” on page 311 and About the Diagram on page 17.

2.66.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: List of groups
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “Group” on page 311
• Entry ID: URI of the group

EDCPKRST220200-PRE-EN-01 Reference Guide 675

Chapter 2 Resources

• Entry Title: Group name

• Entry Summary: Group description
• Entry Updated: r_modify_date of the group

2.66.2.3 Link relations

Link relation Description Resource reference

self This collection of groups. “Groups” on page 320
first, last, next, previous Pagination links. “Groups” on page 320

2.66.2.4 Operations
2.66.2.4.1 Supported HTTP methods

Method Description
GET Retrieves the information about a collection
of groups.

2.66.2.4.2 Add a sub group

Add an existing group into this group as a sub group

2.66.2.4.2.1 HTTP Request method and query parameters

POST

2.66.2.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.66.2.4.2.3 Request headers

• Accept
• Content-Type
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

676 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.66. Sub-Group (s)

2.66.2.4.2.4 Request body

Variable Description Data type Value range Default value

href The specified string N/A null
group resource
URI.

Note: The
href
variable is
mandatory
.

Example 2-282: XML request

<dm:group href="http://localhost:8080/dctm-rest/
repositories/REPO/groups/xxxxx"/>

Example 2-283: JSON request

{
"href":"http://localhost:8080/dctm-rest/repositories/REPO/groups/xxxxx"
}

2.66.2.4.2.5 Response headers

• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.66.2.4.2.6 Response media types

N/A

2.66.2.4.2.7 Response status

• 201 - Added successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 677

Chapter 2 Resources

2.66.2.4.2.8 Response body

N/A

2.66.2.4.3 Get Sub Groups

Retrieve the information about a collection of sub groups for a given parent group.

2.66.2.4.3.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• inline
• view
• items-per-page
• page
• include-total
• sort
• recursive
• links
• filter

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.66.2.4.3.2 Request media types

N/A

2.66.2.4.3.3 Request headers

• Accept
• Authorization (optional)

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

678 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.66. Sub-Group (s)

2.66.2.4.3.4 Request body

N/A

2.66.2.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.66.2.4.3.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.66.2.4.3.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.66.2.4.3.8 Response body

XML or JSON representation of the collection of 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.

EDCPKRST220200-PRE-EN-01 Reference Guide 679

Chapter 2 Resources

2.67 Synonyms
The Synonyms resource is used to get the synonyms of the requested keyword based
on the synonym categories in CCE.

2.67.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Repository” on page 562 and About the Diagrams
on page 17.

2.67.2 Feed
Is this resource a feed? Yes.

• Feed ID: Resource URI

• Feed Title: Synonyms from CCE

• Feed Updated: Server's current time

• Supports POST: No

• Entry: No Resource

• Entry ID: The resource URI with a query parameter. For example {repoUri}/
cce/synonyms?word=xxx

• Entry Title: The synonyms of the specified word

• Entry Updated: Current server time

2.67.3 Link relations

Link relation Description Resource reference

self Link to this resource. “Synonyms” on page 680
synonym-categories [1] A link to the Synonym “Synonym Categories”
Categories resource. on page 684
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

680 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.67. Synonyms

2.67.4 Operations
2.67.4.1 Supported HTTP methods

Method Description
GET Retrieves the synonyms from the static
dictionary of build-in and customized
categories.

2.67.4.2 Get Synonyms

This operation gets the synonyms of the requested words.

2.67.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET page, items- For more information, see Appendix B, REST Common
per-page, Definition - URI Request Query Parameters on page 979
links
word The word String Any string null
whose
synonyms
you want to
retrieve.
category The Synonym String A category null
Category that from the
you want to Synonym
search Categories
within. resource

2.67.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 681

Chapter 2 Resources

2.67.4.2.3 Request media types

N/A

2.67.4.2.4 Request body

N/A

2.67.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.67.4.2.6 Response headers

Content-Type

Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.67.4.2.7 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.67.4.2.8 Response body

Example 2-284: XML response

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/cce/synonyms</id>
<title>Synonyms from CCE</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2018-09-25T02:09:42.528+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/cce/
synonyms?word=opentext"></link>
<link rel="http://identifiers.emc.com/linkrel/synonym-categories"
href="http://localhost:8080/dctm-rest/repositories/REPO/cce/

682 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.67. Synonyms

synonym-categories"></link>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonyms?word=opentext</id>
<title>qi xin</title>
<summary>
Synonym Result from Category Enterprise_Content_Management
</summary>
<updated>2018-09-25T02:09:42.529+00:00</updated>
<published>2018-09-25T02:09:42.529+00:00</published>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonyms?word=opentext"></content>
</entry>
</feed>

Example 2-285: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/synonyms",
"title": "Synonyms from CCE",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-08-20T04:53:28.973+00:00",
"page": 1,
"items-per-page": 100,
"total": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonyms?word=opentext"
},
{
"rel": "http://identifiers.emc.com/linkrel/synonym-categories",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonyms?word=opentext",
"title": "Enterprise_Content_Management",
"summary": "Significant Term Result from Category qi xin",
"updated": "2018-08-20T04:53:28.974+00:00",
"published": "2018-08-20T04:53:28.974+00:00",
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonyms?word=opentext"
}
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 683

Chapter 2 Resources

Example 2-286: HAL: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/synonyms",
"title": "Synonyms from CCE",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-09-17T06:19:14.236+00:00",
"page": 1,
"items-per-page": 100,
"_embedded": {
"collection": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonyms?word=opentext",
"title": "qi xin",
"summary": "Synonym Result from
Category Enterprise_Content_Management",
"updated": "2018-09-17T06:19:14.236+00:00",
"published": "2018-09-17T06:19:14.236+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/cce/synonyms?word=opentext"
}
}
}
]
},
"_links": {
"http://identifiers.emc.com/linkrel/synonym-categories": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonyms?word=opentext"
}
}
}

2.68 Synonym Categories

The Synonym Categories resource is used to get the static synonym categories from
the built-in dictionaries of the Intellisophic taxonomy definitions and customized
ones in CCE.

684 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.68. Synonym Categories

2.68.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Repository” on page 562 and About the Diagrams
on page 17.

2.68.2 Feed
Is this resource a feed? Yes.

• Feed ID: Resource URI

• Feed Title: Synonym Categories from CCE
• Feed Updated: Server's current time
• Supports POST: No
• Entry: No Resource
• Entry ID: Resource URI
• Entry Title: The name of the category
• Entry Updated: Current server time

2.68.3 Link relations

Link relation Description Resource reference
self Link to this resource. “Synonym Categories”
on page 684
synonyms [1] A link to the Synonyms “Synonyms” on page 680
resource.
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

EDCPKRST220200-PRE-EN-01 Reference Guide 685

Chapter 2 Resources

2.68.4 Operations
2.68.4.1 Supported HTTP methods

Method Description
GET Retrieves the static synonym categories of the build-in and
customized categories.

2.68.4.2 Get Synonym Categories

This operation retrieves the Synonym categories.

2.68.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET page, items- For more information, see Appendix B, REST Common
per-page, Definition - URI Request Query Parameters on page 979
links

2.68.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.68.4.2.3 Request media types

N/A

2.68.4.2.4 Request body

N/A

2.68.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

686 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.68. Synonym Categories

2.68.4.2.6 Response headers

Content-Type

Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.68.4.2.7 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.68.4.2.8 Response body

Example 2-287: XML response

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>
http://localhost:8080/dctm-rest/repositories/REPO/cce/synonym-categories
</id>
<title>Synonym Categories from CCE</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2018-08-20T04:34:56.706+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">
21
</dm:total>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories"></link>
<link rel="http://identifiers.emc.com/linkrel/synonyms"
href="http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonyms"></link>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories
</id>
<title>cdisc_send_terminology</title>
<summary>Result from CCE</summary>
<updated>2018-08-20T04:34:56.706+00:00</updated>
<published>2018-08-20T04:34:56.706+00:00</published>
<link rel="search"
href="http://localhost:8080/dctm-rest/repositories/REPO/
search?q=cdisc_send_terminology"></link>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories"></content>
</entry>
<entry>

EDCPKRST220200-PRE-EN-01 Reference Guide 687

Chapter 2 Resources

<id>http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories
</id>
<title>legal_terminology</title>
<summary>Result from CCE</summary>
<updated>2018-08-20T04:34:56.707+00:00</updated>
<published>2018-08-20T04:34:56.707+00:00</published>
<link rel="search"
href="http://localhost:8080/dctm-rest/repositories/REPO/
search?q=legal_terminology"></link>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories"></content>
</entry>
</feed>

Example 2-288: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories",
"title": "Synonym Categories from CCE",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-08-20T04:34:07.805+00:00",
"page": 1,
"items-per-page": 100,
"total": 2,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories"
},
{
"rel": "http://identifiers.emc.com/linkrel/synonyms",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonyms"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories",
"title": "cdisc_send_terminology",
"summary": "Result from CCE",
"updated": "2018-08-20T04:34:07.806+00:00",
"published": "2018-08-20T04:34:07.806+00:00",
"links": [
{
"rel": "search",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search?q=cdisc_send_terminology"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
cce/synonym-categories"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/

688 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.68. Synonym Categories

synonym-categories",
"title": "legal_terminology",
"summary": "Result from CCE",
"updated": "2018-08-20T04:34:07.806+00:00",
"published": "2018-08-20T04:34:07.806+00:00",
"links": [
{
"rel": "search",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/search?q=legal_terminology"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories"
}
}
]
}

Example 2-289: HAL: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories",
"title": "Synonym Categories from CCE",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-09-25T02:04:40.172+00:00",
"page": 1,
"items-per-page": 100,
"_embedded": {
"collection": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories",
"title": "cdisc_send_terminology",
"summary": "Result from CCE",
"updated": "2018-09-25T02:04:40.173+00:00",
"published": "2018-09-25T02:04:40.173+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/cce/synonym-categories"
},
"http://identifiers.emc.com/linkrel/search": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/search?q=cdisc_send_terminology"
}
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories",
"title": "legal_terminology",
"summary": "Result from CCE",
"updated": "2018-09-25T02:04:40.173+00:00",
"published": "2018-09-25T02:04:40.173+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/cce/synonym-categories"

EDCPKRST220200-PRE-EN-01 Reference Guide 689

Chapter 2 Resources

},
"http://identifiers.emc.com/linkrel/search": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/search?q=legal_terminology"
}
}
}
]
},
"_links": {
"http://identifiers.emc.com/linkrel/synonyms": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonyms"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
synonym-categories"
}
}
}

2.69 SysObject
The SysObject resource represents a SysObject instance in a repository, such as a
Document, or a Folder.

2.69.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Folder Child Objects” on page 285 and About the Diagram on page 17.

690 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.69. SysObject

2.69.2 Feed
No feed support.

2.69.3 Link relations

Any SysObject

Link relation Description Resource reference

self This SysObject resource “SysObject” on page 690
parent-links [1] Parent folder (or cabinet) of this “Parent Links” on page 496
SysObject resource
edit [1] Edit this object “SysObject” on page 690
delete [1] Delete this object “SysObject” on page 690
relations [1] Collection of relations that are “Relations” on page 536
related to this SysObject resource
comments [1] The comments associated to this “Comments” on page 159
object
virtual- The virtual document nodes of a “Virtual Document Nodes”
document-nodes Virtual Document SysObject on page 820
[1]
virtual- Convert a simple document into a “Virtual Document Nodes”
document- Virtual Document by adding a new on page 820
conversion node to it. This link is only
displayed when the object is not
already a virtual document.
object-aspects [1] Attached aspect of the SysObject “SysObject” on page 690
permission-set Permission set of the SysObject “Permission Set” on page 505
[1]
permissions [1] Specified user's permissions on a “Permissions” on page 501
given SysObject
snapshots [1] The snapshots associated with this “Virtual Document Snapshots”
virtual document. This link is only on page 838
displayed when the object is a
virtual document.
attachable- Collection of Lifecycles to which “Lifecycles” on page 382
lifecycles [1] the given SysObject can be
attached
object-lifecycle The current Lifecycle state against “Object Lifecycle” on page 457
[1] the given SysObject
[1] The above link relations are defined by Documentum. The fully qualified Documentum
link relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

EDCPKRST220200-PRE-EN-01 Reference Guide 691

Chapter 2 Resources

Folder Specific

Link relation Description Resource reference

folders [1] Collection of child folders that are “Folder Child Folders” on page 271
linked to this SysObject resource
documents [1] Collection of documents that are “Folder Child Documents”
linked to this SysObject resource on page 243
objects [1] Collection of SysObject resources “Folder Child Objects” on page 285
that are linked to this SysObject
resource
child-links [1] Collection of folder children “Folder Child Objects” on page 285
[1] The above link relations are defined by Documentum. The fully qualified Documentum
link relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

Any Non-Folder SysObject

Link relation Description Resource reference

contents Collection of relations that is “Contents” on page 180
related to this SysObject resource
primary-content Points to the primary content “Content” on page 174
[1] metadata of this object
[1] The above link relations are defined by Documentum. The fully qualified Documentum
link relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

Versioning Link for Any Non-Folder SysObject

Link relation Description Resource reference

checkout [1] Check out this object “Lock” on page 413
checkin-next- Check in this object with the next “All Versions” on page 20
major [1] major version policy
checkin-next- Check in this object with the next “All Versions” on page 20
minor [1] minor version policy
checkin-branch Check in this object with the branch “All Versions” on page 20
[1] version policy
cancel-checkout Cancel the check-out operation on “Lock” on page 413
[1] this object.
version-history Collection of versions of this “All Versions” on page 20
document
current-version Current version of the object “Current Version” on page 208
[1]

692 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.69. SysObject

Link relation Description Resource reference

predecessor- Predecessor version of the object “SysObject” on page 690
version
[1] The above link relations are defined by Documentum. The fully qualified Documentum
link relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

Lightweight Object Specific

Link relation Description Resource reference

shared-parent [1] When the object is a lightweight “Lightweight Object Parent”
child object, this is the shared on page 405
parent of the SysObject
lightweight- Primary content metadata “Lightweight Objects” on page 397
objects [1]
materialize [1] Materialize the lightweight object “Lightweight Object
following the link relation Materialization” on page 410
dematerialize [1] Dematerialize the lightweight “Lightweight Object
object following the link relation Materialization” on page 410
[1] The above link relations are defined by Documentum. The fully qualified Documentum
link relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

Caution
• Versioning links for the SysObject collection are not displayed.

• The checkin-next-major, checkin-next-minor, and checkin-branch

links are only displayed when their related version policy is allowed.

• The Documentum Foundation Classes (DFC) or DFC ACL object

retrieves the permission dependant ACL for all of the <checkin-*> links,
such as checkin-next-major, checkin-next-minor, and checkin-
branch, which depend on the DFC object and version policy. When
using any of the above links, the system retrieves the objects one by one
to allow DFC to verify permissions.

• You must have Version user privileges to use the <cancel-checkout> link.

• The <browse> (allows you to view metadata only), <read> (allows you to
view content and metadata), <delete>, and <write> permissions depend
on the ACL and can be retrieved using either the DFC object, or the DFC
ACL object.

Permission-Enabled

EDCPKRST220200-PRE-EN-01 Reference Guide 693

Chapter 2 Resources

Link relation Basic Extended Object state User Version

permission permission privilege policy
self browse
contents read
primary- read
content
edit write not locked lock owner if
the object is
locked
delete delete delete not locked
child-links browse
parent-links browse
checkout version not locked
checkin-next- version allowed next
major major
checkin-next- version checked out lock owner allowed next
minor minor
checkin- version lock owner allowed
branch branch
cancel- version lock owner,
checkout object owner,
or super user
version- browse
history
current- browse
version
predecessor- browse
version

When working with SysObjects the following items apply:

• edit: When the object is locked, then only the lock owner (with write
permissions) can edit the object.
• delete: This can only be performed on a locked object and must allow
versioning.
• checkout: The object is not locked and has versioning permissions.
• checkin: This can only be performed when the lock owner has versioning
permissions and the object version allows a version policy.
• cancel-checkout: This can only be performed by a user who has versioning
permissions, is the lock owner, is the object owner, or by the super user.

Difference Between a Single SysObject and a SysObject Collection Feed

694 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.69. SysObject

A single SysObject resource differs from a collection feed of the SysObject

resource in the following aspects:

• A single SysObject contains versioning links while a collection does not.

• Documentum REST Services does not perform any permission checks on a
collection
• The contents links are shown in a collection without a permission check.
• When an object is not locked in a collection, the edit and delete links are
displayed without a permission check, meaning that even when a user is not the
lock owner or does not have the corresponding permissions, the edit and
delete links are accessible to that user.

• When an object is locked, there's no delete link in either the single or collection
resource.
• When an object is locked in a collection, and a user is the lock owner, the edit
link is displayed without a permission check, meaning that even when the user
does not have the write permission, the edit link is accessible to that user.
• When a single resource is locked and the user is the lock owner. In this case, a
check to determine if the user has write permissions is done.
• When a collection resource is locked and the user is the lock owner, the edit link
is always displayed, without any permission checking.

Tip: A simple performance test to retrieve a 100 items per page has determined
that retrieving the DFC object, calculating the <ACL> and version policy, is up
to 6 times slower than retrieving the collection using DQL with attributes. This
latency may be worsened when using a WAN because of the numerous RPC
calls that are necessary.

To help with the above latency, avoid checking permissions when working
with a collection. When enabling a link requires the use of other objects in
addition to the current object, then the permissions are not checked. For
example, when working with a parent and cabinet link relation, the parent
folder and cabinet do not perform any checks to verify access.

2.69.4 Operations

EDCPKRST220200-PRE-EN-01 Reference Guide 695

Chapter 2 Resources

2.69.4.1 Supported HTTP methods

Method Description
GET Retrieves properties, and other information
of the SysObject resource
POST Updates the attributes of the SysObject
resource
DELETE Deletes the SysObject instance from a
repository

2.69.4.2 Get an object

GET attributes, permissions, and other information on the object instance. Attributes
and permissions are returned as embedded elements in the Response message body.
Other information, such as relationships, versions, and contents, are referenced
using link relations in the Response message body.

2.69.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data Value Default

method parameters type range value
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
view
check- Determines whether or not to string true, false
subscriptio check if the current user is false
n subscribed to the requested
instance.

2.69.4.2.2 Request media types

N/A

2.69.4.2.3 Request headers

• Accept
• Authorization (optional)

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

696 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.69. SysObject

2.69.4.2.4 Request body

N/A

2.69.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.69.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.69.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.69.4.2.8 Response body

Example 2-290: XML response

<?xml version="1.0" encoding="UTF-8"?>
<object 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>
<attr1>value1</attr1>
<repeating_attr2>
<item href="xxx2">value2</item>
<item href="xxx3">value3</item>
</repeating_attr2>
...
</properties>
<link rel="self" href="..."/>
...
</object>

Example 2-291: JSON response

{
"name": "object",
"type": "dm_document",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject",
"properties": {

EDCPKRST220200-PRE-EN-01 Reference Guide 697

Chapter 2 Resources

{
"attr1": "value1",
"repeating_attr2": [value2, value3],
...
},
"links":
[
{
"rel": "self",
"href": "..."
},
...
]
}

2.69.4.2.9 Example

Example 2-292: JSON request - Get an object

GET /dctm-rest/repositories/REPO/objects/0900000580002516?view=object_name,
i_folder_id HTTP/1.1
Host: localhost:8080
Authorization: Basic ZG1hZG1pbjpwYXNzd29yZA==
Accept: application/vnd.emc.documentum+json

Example 2-293: JSON response - GET an object

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"name": "object",
"type": "dm_document",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document",
"properties": {
"object_name": "iig36_Wed_Gal1005_1000_MurphyOil.pptx",
"i_folder_id": [
"0c0000058000211b"
]
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516?view=object_name,i_folder_id"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516"
},
{
"rel": "canonical",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/documents/
0900000580002516"
},

698 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.69. SysObject

{
"rel": "http://identifiers.emc.com/linkrel/parent-links",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516/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/
0900000580002516/contents"
},
{
"rel": "http://identifiers.emc.com/linkrel/primary-content",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516/contents/content"
},
{
"rel": "http://identifiers.emc.com/linkrel/checkout",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516/lock"
},
{
"rel": "version-history",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516/versions"
},
{
"rel": "http://identifiers.emc.com/linkrel/current-version",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516/versions/current"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-nodes",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516/vd-nodes"
},
{
"rel": "http://identifiers.emc.com/linkrel/snapshots",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots?
filter=r_assembled_from_id%20%3D'0900000580002516'"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/relations?related-
object-id=0900000580002516&related-object-role=any"
},
{
"rel": "http://identifiers.emc.com/linkrel/object-aspects",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516/aspects"
},
{
"rel": "http://identifiers.emc.com/linkrel/permission-set",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516/permission-set"
},
{
"rel": "http://identifiers.emc.com/linkrel/permissions",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516/permissions"

EDCPKRST220200-PRE-EN-01 Reference Guide 699

Chapter 2 Resources

},
{
"rel": "http://identifiers.emc.com/linkrel/comments",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516/comments"
},
{
"rel": "http://identifiers.emc.com/linkrel/attachable-lifecycles",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/lifecycles?object-
id=0900000580002516"
},
{
"rel": "http://identifiers.emc.com/linkrel/object-lifecycle",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516/lifecycle"
}
]
}

2.69.4.3 Update an object

You can use this operation to update a SysObject resource by providing new values
for attributes.

Caution
Providing undefined attributes or invalid values for attributes in the
Request body causes an exception to be thrown.

2.69.4.3.1 HTTP Request method and query parameters

POST

2.69.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.69.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

700 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.69. SysObject

2.69.4.3.4 Request body

Only attributes that can be updated should be included in the request message body.
You cannot use this operation to make updates to permissions.

Example 2-294: XML request

<?xml version="1.0" encoding="utf-8"?>
<object xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<properties>
<attr1>value1</attr1>
<repeating_attr2>
<item href="xxx2">value2</item>
<item href="xxx3">value3</item>
</repeating_attr2>...</properties>
</object>

Example 2-295: JSON request

{
"properties":
{
"attr1": "value1",
"repeating_attr2": [value2, value3],
...
}
}

2.69.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.69.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

EDCPKRST220200-PRE-EN-01 Reference Guide 701

Chapter 2 Resources

2.69.4.3.7 Response status

• 200 - Updated successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.69.4.3.8 Response body

XML or JSON representation of the object. A successful response contains all of the
attributes of the updated object. Permission set is not returned.

Example 2-296: XML response

<?xml version="1.0" encoding="UTF-8"?>
<object 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>
<dm:attributes>
<dm:attr1>value1</dm:attr1>
<dm:repeating_attr2>
<dm:item href="xxx2">value2</dm:item>
<dm:item href="xxx3">value3</dm:item>
</dm:repeating_attr2>
...
</dm:attributes>
<link rel="self" href="..."/>
...
</dm:dm_document>

Example 2-297: JSON response

{
"properties":
{
"attr1": "value1",
"repeating_attr2": [value2, value3],
...
},
"links":
[
{
"rel": "self",
"href": "..."
},
...
]
}

702 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.69. SysObject

2.69.4.3.9 Example

Example 2-298: JSON request

POST http://localhost:8080/dctm-rest/repositories/REPO/objects/1900000f80000cd8
Accept:application/vnd.emc.documentum+json
Content-Type:application/vnd.emc.documentum+xml
Authorization:Basic ZG1hZG1pbjpwYXNzd29yZA==

<?xml version="1.0" encoding="UTF-8"?>

<object xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<properties>
<object_name>dm_usage_log_modified</object_name>
</properties>
</object>

Example 2-299: JSON response

Status Code: 200 OK
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"properties":
{
"r_object_id": "1900000f80000cd8",
"object_name": "dm_usage_log_modified",
...
},
"links":
[
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
1900000f80000cd8"
},
{
"rel": "contents",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
1900000f80000cd8/contents"
}
]
}

2.69.4.4 Delete an object

Delete the SysObject resource from the repository.

For a folder object, the deletion of folder children is controlled by query parameters.
When a deletion fails, an exception is thrown and the SysObject resource (including
the folder tree and version history) is reverted back to its original state.

For a document object, the version policy is controlled by query parameters.

EDCPKRST220200-PRE-EN-01 Reference Guide 703

Chapter 2 Resources

2.69.4.4.1 HTTP Request method and query parameters

HTTP Query Description Data Value Default

method parameter type range value
s
DELETE del-non- Specifies whether or not this string true, false
empty operation deletes a non-empty false
folder.
• true - The folder and all its
descendants are deleted.
• false - Only this folder is
deleted. Deleting a non-empty
folder results in an error.
del-all- Specifies whether a multi-linked string true, false
links descendant is deleted or unlinked false
from this specified folder.
• true - This operation deletes a
multi-linked descendant along
with all its folder links.
• false - This operation only
deletes a descendant's link to this
folder. The descendant can still
remain linked to other folders.

Note: Virtual documents are

not supported.
del- Deletion options for multi-version string N/A <all>
version document objects.
• selected - The version
associated with the given object
ID is removed.
• unused - (Default) The versions
that do not have symbolic labels
associated are removed.
• all - All revisions on the same
version tree are removed.

704 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.69. SysObject

HTTP Query Description Data Value Default

method parameter type range value
s
del-vd- Specifies whether this operation string true, false
all should delete a virtual document false
and all of its descendants.

false: Deletes only the virtual

document, the containments, and its
direct children. It does not delete
any other descendants of the virtual
document.

true: Deletes the virtual document

and all of the descendants of that
virtual document.

For more information, see Note

2.69.4.4.2 Request media types

N/A

2.69.4.4.3 Delete a virtual document

When the del-vd-all parameter is true, it traverses the virtual document and
applies the strategy specified by the del-version parameter to each node in the
hierarchy. The virtual document hierarchy depends on the following:

• The criteria defined for each node when it was added or last updated.
• The value of the version data that is present in the resolution_label attribute
of the virtual document object being deleted. When the resolution_label
attribute exists; the virtual document uses it to determine the version. Otherwise,
the virtual document must use CURRENT to retrieve the virtual document
hierarchy. When the virtual document uses CURRENT to retrieve the virtual
document hierarchy, late binding nodes may have their version data, which is
specified by the resolution_label, deleted.
• The include-broken attribute is always set to true when determining the
virtual document hierarchy.

The following table displays the strategies that can be used to delete nodes.

del-vd-all Value del-version Transactional Non-transactional

Strategy
true all If an object appears in the Delete what can be
Virtual Document hierarchy deleted and leave
more than once, it does not the other existing
get the object more than one nodes.
time and the transaction
will fail.

EDCPKRST220200-PRE-EN-01 Reference Guide 705

Chapter 2 Resources

del-vd-all Value del-version Transactional Non-transactional

Strategy
selected If the virtual document
object has multiple
versions, its nodes a have
virtual document
relationship with all of
these objects.

Deletion will fail because

the nodes are referenced by
the unselected virtual
document object.
unused Always fail for simplest
virtual document structure.

2.69.4.4.4 Request headers

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.69.4.4.5 Request body

N/A

2.69.4.4.6 Response headers

N/A

2.69.4.4.7 Response media types

N/A

2.69.4.4.8 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

706 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.70. Task Package (s)

2.69.4.4.9 Response body

The following status code indicates a successful deletion:

Status Code: 204 No Content Success

The Response body contains no content.

2.69.5 Example
Example 2-300: JSON request
DELETE http://localhost:8080/dctm-rest/repositories/REPO/objects/1900000f80000cd8
Accept:application/vnd.emc.documentum+json
Authorization:Basic ZG1hZG1pbjpwYXNzd29yZA==

Example 2-301: JSON response

Status Code: 204 No Content Success

2.70 Task Package (s)

2.70.1 Task Package
The Task Package resource is used to get the package, known as an attachment, of a
specified workflow task or to add contents to the package of a specified workflow
task.

2.70.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also:“Task Packages” on page 718 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 707

Chapter 2 Resources

2.70.1.2 Feed
No feed support.

2.70.1.3 Link relations

Link relation Description Resource reference

self A link to itself “Task Package” on page 707
delete-documents To delete all of the documents in a “Task Package Documents”
[1] package on page 722
delete-note [1] To delete a specified note in a “Task Package Note”
package on page 724
document [1] To fetch an attached document “SysObject” on page 690
work-item [1] To fetch the associated work item “Work Item” on page 869
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.70.1.4 Operations
2.70.1.4.1 Supported HTTP methods

Method Description
GET Retrieves the task package
POST Add documents and notes to a task package

2.70.1.4.2 Get a Task Package

Retrieves a task package.

2.70.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

708 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.70. Task Package (s)

2.70.1.4.2.2 Request media types

N/A

2.70.1.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.70.1.4.2.4 Request body

N/A

2.70.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.70.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.70.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 709

Chapter 2 Resources

2.70.1.4.2.8 Response body

Example 2-302: XML response

<?xml version='1.0' encoding='UTF-8'?>

<package xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<package-name>DocumentToReview</package-name>
<status>FULL</status>
<optional>false</optional>
<visible>false</visible>
<operation></operation>
<required-type>dm_document</required-type>
<note-count>1</note-count>
<notes>
<note>
<id>410000018005410c</id>
<text>this is the first note. true-persistent
</text>
<creation-date>2019-08-21T06:37:54.000+00:00
</creation-date>
<flag>1</flag>
<persistent>true</persistent>
<writer>dave</writer>
<is-new>false</is-new>
</note>
</notes>
<document-count>1</document-count>
<document-ids>
<document-id>0900000180011fad</document-id>
</document-ids>
<skill-level>0</skill-level>
<form-template-defined>true</form-template-defined>
<form-for-properties>false</form-for-properties>
<task-id>4a00000180002900</task-id>
<index>0</index>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0"/>
<link rel="http://identifiers.emc.com/linkrel/
delete-documents"
href="http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0/
documents"/>
<link rel="http://identifiers.emc.com/linkrel/
document"
title="0900000180011fad"
href="http://localhost:8080/dctm-rest/
repositories/REPO/objects/
0900000180011fad"/>
<link rel="http://identifiers.emc.com/linkrel/
delete-note"
title="410000018005410c"
href="http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0/notes/
410000018005410c"/>
<link rel="http://identifiers.emc.com/linkrel/
work-item"
href="http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900"/>
</links>
</package>

710 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.70. Task Package (s)

Example 2-303: JSON response

{
"package-name": "DocumentToReview",
"status": "FULL",
"optional": false,
"visible": false,
"operation": "",
"required-type": "dm_document",
"note-count": 1,
"notes": [{
"id": "410000018005410c",
"text": "this is the first note. true-persistent",
"creation-date": "2019-08-21T06:37:54.000+00:00",
"flag": 1,
"persistent": true,
"writer": "dave",
"is-new": false
}
],
"document-count": 1,
"document-ids": [
"0900000180011fad"
],
"skill-level": 0,
"form-template-defined": true,
"form-for-properties": false,
"task-id": "4a00000180002900",
"index": 0,
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0"
}, {
"rel": "http://identifiers.emc.com/linkrel/
delete-documents",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0/
documents"
}, {
"rel": "http://identifiers.emc.com/linkrel/
document",
"title": "0900000180011fad",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/objects/
0900000180011fad"
}, {
"rel": "http://identifiers.emc.com/linkrel/
delete-note",
"title": "410000018005410c",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0/notes/
410000018005410c"
}, {
"rel": "http://identifiers.emc.com/linkrel/
work-item",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900"
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 711

Chapter 2 Resources

Example 2-304: HAL + JSON response

{
"package-name": "DocumentToReview",
"status": "FULL",
"optional": false,
"visible": false,
"operation": "",
"required-type": "dm_document",
"note-count": 1,
"notes": [{
"id": "410000018005410c",
"text": "this is the first note. true-persistent",
"creation-date": "2019-08-21T06:37:54.000+00:00",
"flag": 1,
"persistent": true,
"writer": "dave",
"is-new": false
}
],
"document-count": 1,
"document-ids": [
"0900000180011fad"
],
"skill-level": 0,
"form-template-defined": true,
"form-for-properties": false,
"task-id": "4a00000180002900",
"index": 0,
"_links": {
"http://identifiers.emc.com/linkrel/document": {
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/objects/
0900000180011fad",
"title": "0900000180011fad"
},
"http://identifiers.emc.com/linkrel/delete-note": {
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0/notes/
410000018005410c",
"title": "410000018005410c"
},
"http://identifiers.emc.com/linkrel/work-item": {
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900"
},
"self": {
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0"
},
"http://identifiers.emc.com/linkrel/
delete-documents": {
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0/
documents"
}
}
}

712 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.70. Task Package (s)

2.70.1.4.3 Add documents and notes

Adds documents or notes to a package.

2.70.1.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
POST N/A N/A

2.70.1.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/hal+json

2.70.1.4.3.3 Request headers

• Authorization
• Accept
• Content-Type

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.70.1.4.3.4 Request body

Example 2-305: XML request

<?xml version="1.0" encoding="UTF-8"?>
<package>
<notes>
<note>
<text>note abc</text>
<persistent>false</persistent>
</note>
<note>
<text>note def</text>
<persistent>false</persistent>
</note>
</notes>
<document-ids>
<document-id>0900000180002379</document-id>
</document-ids>
</package>

Example 2-306: JSON request

{
"document-ids": [
"0900000180000220"
],
"notes": [{

EDCPKRST220200-PRE-EN-01 Reference Guide 713

Chapter 2 Resources

"text": "note abc",

"persistent": false
}, {
"text": "note def",
"persistent": false
}
]
}

Example 2-307: HAL + JSON request

{
"document-ids": [
"0900000180000220"
],
"notes": [{
"text": "note abc",
"persistent": false
}, {
"text": "note def",
"persistent": false
}
]
}

Note: The following are the only attributes that apply to notes, all others are
ignored.

• text: The note message that is being added

• persistent:

– When true, then the note is visible to all subsequent workflow tasks.
– When false, then the note is visible in the next task only

2.70.1.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

714 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.70. Task Package (s)

2.70.1.4.3.6 Response media types

N/A

2.70.1.4.3.7 Response status

• 200 - Successfully added

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.70.1.4.3.8 Response body

Note: The Response body for this operation will be the same as the Response
body for the Get a Task Package operation. It is shown below for your
convenience.

Example 2-308: XML response

<?xml version='1.0' encoding='UTF-8'?>
<package xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<package-name>DocumentToReview</package-name>
<status>FULL</status>
<optional>false</optional>
<visible>false</visible>
<operation></operation>
<required-type>dm_document</required-type>
<note-count>1</note-count>
<notes>
<note>
<id>410000018005410c</id>
<text>this is the first note. true-persistent
</text>
<creation-date>2019-08-21T06:37:54.000+00:00
</creation-date>
<flag>1</flag>
<persistent>true</persistent>
<writer>dave</writer>
<is-new>false</is-new>
</note>
</notes>
<document-count>1</document-count>
<document-ids>
<document-id>0900000180011fad</document-id>
</document-ids>
<skill-level>0</skill-level>
<form-template-defined>true</form-template-defined>
<form-for-properties>false</form-for-properties>
<task-id>4a00000180002900</task-id>
<index>0</index>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/
REPO/work-items/4a00000180002900/packages/
0"/>
<link rel="http://identifiers.emc.com/linkrel/
delete-documents"
href="http://localhost:8080/dctm-rest/repositories/
REPO/work-items/4a00000180002900/
packages/0/documents"/>
<link rel="http://identifiers.emc.com/linkrel/document"

EDCPKRST220200-PRE-EN-01 Reference Guide 715

Chapter 2 Resources

title="0900000180011fad"
href="http://localhost:8080/dctm-rest/repositories/
REPO/objects/0900000180011fad"/>
<link rel="http://identifiers.emc.com/linkrel/
delete-note"
title="410000018005410c"
href="http://localhost:8080/dctm-rest/repositories/
REPO/work-items/4a00000180002900/
packages/0/notes/410000018005410c"/>
<link rel="http://identifiers.emc.com/linkrel/work-item"
href="http://localhost:8080/dctm-rest/repositories/
REPO/work-items/4a00000180002900"/>
</links>
</package>

Example 2-309: JSON response

{
"package-name": "DocumentToReview",
"status": "FULL",
"optional": false,
"visible": false,
"operation": "",
"required-type": "dm_document",
"note-count": 1,
"notes": [{
"id": "410000018005410c",
"text": "this is the first note. true-persistent",
"creation-date": "2019-08-21T06:37:54.000+00:00",
"flag": 1,
"persistent": true,
"writer": "dave",
"is-new": false
}
],
"document-count": 1,
"document-ids": [
"0900000180011fad"
],
"skill-level": 0,
"form-template-defined": true,
"form-for-properties": false,
"task-id": "4a00000180002900",
"index": 0,
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0"
}, {
"rel": "http://identifiers.emc.com/linkrel/
delete-documents",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0/documents"
}, {
"rel": "http://identifiers.emc.com/linkrel/document",
"title": "0900000180011fad",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/objects/0900000180011fad"
}, {
"rel": "http://identifiers.emc.com/linkrel/
delete-note",
"title": "410000018005410c",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/

716 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.70. Task Package (s)

4a00000180002900/packages/0/notes/
410000018005410c"
}, {
"rel": "http://identifiers.emc.com/linkrel/
work-item",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900"
}
]
}

Example 2-310: HAL + JSON response

{
"package-name": "DocumentToReview",
"status": "FULL",
"optional": false,
"visible": false,
"operation": "",
"required-type": "dm_document",
"note-count": 1,
"notes": [{
"id": "410000018005410c",
"text": "this is the first note. true-persistent",
"creation-date": "2019-08-21T06:37:54.000+00:00",
"flag": 1,
"persistent": true,
"writer": "dave",
"is-new": false
}
],
"document-count": 1,
"document-ids": [
"0900000180011fad"
],
"skill-level": 0,
"form-template-defined": true,
"form-for-properties": false,
"task-id": "4a00000180002900",
"index": 0,
"_links": {
"http://identifiers.emc.com/linkrel/document": {
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/objects/
0900000180011fad",
"title": "0900000180011fad"
},
"http://identifiers.emc.com/linkrel/delete-note": {
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0/notes/
410000018005410c",
"title": "410000018005410c"
},
"http://identifiers.emc.com/linkrel/work-item": {
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900"
},
"self": {
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0"
},
"http://identifiers.emc.com/linkrel/delete-documents":

EDCPKRST220200-PRE-EN-01 Reference Guide 717

Chapter 2 Resources

{
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/work-items/
4a00000180002900/packages/0/
documents"
}
}
}

2.70.2 Task Packages

The Task Packages resource is used to get the packages, otherwise known as
attachments, of a specified workflow task.

2.70.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Inbox Item” on page 340 and About the Diagram on page 17.

2.70.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: The resource URI

• Feed Title: Workflow task packages
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “Task Package” on page 707
• Entry ID: The entry URI
• Entry Title: The name of the package
• Entry Updated: Server’s current time

718 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.70. Task Package (s)

2.70.2.3 Link relations

Link relation Description Resource reference

self Link to itself “Task Packages” on page 718

2.70.2.4 Operations
2.70.2.4.1 Supported HTTP methods

Method Description
GET Get the workflow task attachment packages.

2.70.2.4.2 Get Workflow Task Packages

Retrieves all packages of a workflow task.

2.70.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
inline

Note: Please note that page, items-per-page, include-total, sort, view,

and filter parameters are not supported.

2.70.2.4.2.2 Request media types

N/A

2.70.2.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 719

Chapter 2 Resources

2.70.2.4.2.4 Request body

N/A

2.70.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.70.2.4.2.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.70.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.70.2.4.2.8 Response body

Example 2-311: XML response

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/work-items/
1b000001800011fb/packages</id>
<title>Workflow task packages</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2019-02-28T06:35:27.756+00:00</updated>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/work-items/
1b000001800011fb/packages" rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/work-items/
1b000001800011fb/packages/0</id>
<title>Package1</title>
<summary>EMPTY</summary>
<updated>2019-02-28T06:35:27.759+00:00</updated>
<published>2019-02-28T06:35:27.759+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/work-items/
1b000001800011fb/packages/0" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/work-items/

720 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.70. Task Package (s)

1b000001800011fb/packages/0" type="application/vnd.emc.documentum+xml"/>
</entry>
</feed>

Example 2-312: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/work-items/
1b000001800011fb/packages",
"title": "Workflow task packages",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-28T06:35:56.803+00:00",
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/work-items/
1b000001800011fb/packages"
}
],
"entries": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/work-items/
1b000001800011fb/packages/0",
"title": "Package1",
"summary": "EMPTY",
"updated": "2019-02-28T06:35:56.803+00:00",
"published": "2019-02-28T06:35:56.803+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
work-items/1b000001800011fb/packages/0"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/work-items/
1b000001800011fb/packages/0"
}
}
]
}

Example 2-313: HAL+JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/work-items/
1b000001800011fb/packages",
"title": "Workflow task packages",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-28T06:35:46.191+00:00",
"_embedded": {
"collection": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/work-items/
1b000001800011fb/packages/0",
"title": "Package1",
"summary": "EMPTY",
"updated": "2019-02-28T06:35:46.191+00:00",
"published": "2019-02-28T06:35:46.191+00:00",

EDCPKRST220200-PRE-EN-01 Reference Guide 721

Chapter 2 Resources

"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
work-items/1b000001800011fb/packages/0"
}
}
}
]
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/work-items/
1b000001800011fb/packages"
}
}
}

2.71 Task Package Documents

The Task Package Documents resource is used to remove all the documents in a
package.

2.71.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Task Package” on page 707 and About the Diagram on page 17.

2.71.2 Feed
No feed support.

2.71.3 Link relations

N/A

722 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.71. Task Package Documents

2.71.4 Operations
2.71.4.1 Supported HTTP methods

Method Description
DELETE Removes all of the documents in a package

2.71.4.2 Remove all the documents in the package

Remove all of the documents from a package.

2.71.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
DELETE For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.71.4.2.2 Request media types

N/A

2.71.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.71.4.2.4 Request body

N/A

2.71.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 723

Chapter 2 Resources

2.71.4.2.6 Response media types

N/A

2.71.4.2.7 Response status

• 204 - Removed successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.71.4.2.8 Response body

N/A

2.72 Task Package Note

The Task Package Note resource represents a note in a user’s inbox is used to remove
the specified note in a Workflow Task Package.

2.72.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Task Package” on page 707 and About the Diagram on page 17.

2.72.2 Feed
No feed support.

2.72.3 Link relations

N/A

724 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.72. Task Package Note

2.72.4 Operations
2.72.4.1 Supported HTTP methods

Method Description
DELETE Remove a specified Package Note.

2.72.4.2 Remove specified Package Note

Remove a specified Package Note.

2.72.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
DELETE For more information, see Appendix B, REST Common Definition - URI
Request Query Parameters on page 979.

2.72.4.2.2 Request media types

N/A

2.72.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.72.4.2.4 Request body

N/A

2.72.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 725

Chapter 2 Resources

2.72.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.72.4.2.7 Response status

• 204 - Successfully deleted

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.72.4.2.8 Response body

N/A

2.73 Type (s)

2.73.1 Type
The Type resource represents a single type object.

2.73.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Types” on page 754 and About the Diagram on page 17.

726 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

2.73.1.2 Feed
No feed support.

2.73.1.3 Link relations

Link relation Description Resource reference

self This Type resource. “Type” on page 726
types [1] Sub types of this Type object. “Type” on page 726
parent Link to the associated Type object. “Type” on page 726
lightweight-types The lightweight types of current “Types” on page 754
[1] Shareable Type.
parent-shareable- The parent shareable Type of “Type” on page 726
type [1] current lightweight Type.
assist-values [1] The Value Assistance of the Type. “Value Assistances” on page 801
lifecycle [1] The Lifecycle that is attached. “Lifecycle” on page 367
attachable-lifecycles The Lifecycles that can be “Lifecycle” on page 367
[1] attached to the current type.
registered-audit- The Registered Audit Events of “Available Audit Events”
events [1] the current type on page 112

Note: You must have the

required privileges to access
these events.
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.73.1.4 Operations
2.73.1.4.1 Supported HTTP methods

Method Description
GET Retrieves a Type object in the repository

EDCPKRST220200-PRE-EN-01 Reference Guide 727

Chapter 2 Resources

2.73.1.4.2 Get a Type

Retrieves the metadata and content properties of the current type object.

2.73.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET inherited Specifies boolean true, false true
whether or
not to return
inherited
properties
from the
parent type.
• true -
Returns
inherited
properties
from the
parent
type.
• false -
Only
returns
properties
that
directly
belong to
this type
object.
locale Specifies the string Valid locale null
locale of the
Request.

Note: If
the
corresp
onding
label of
the
specifie
d locale
cannot
be
found,
the
label is
null.

728 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

HTTP Query Description Data type Value range Default value

method parameters
include- Specifies string true, false false
value- whether the
assist Response
includes the
definition
information
of the value
assist
include- Specifies string true, false false
lifecycle whether to
get the type
and
properties
related
information
for the
different
lifecycles and
states
include- Specifies string true, false false
auditable- whether to
events get the type
auditable
system and
app events
include- Specifies string true, false false
display- whether to
configs get the type
display
configuration
information
include- Specifies string true, false false
mapping- whether to
tables get the type
and
properties
mapping
tables
information
include- Specifies string true, false false
value- whether to
constraint get the type
s and
properties
value
constraints
information

EDCPKRST220200-PRE-EN-01 Reference Guide 729

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
GET include- Specifies string true, false false
all whether to
get the value
assist,
lifecycle
based type
information
and auditable
events.

When either
<include-all>
or <include-
value-assist>
are true, the
value assist
information
is returned.

When either
<include-all>
or <include-
lifecycle> are
true, the
lifecycles
based type
information
is returned.

When either
<include-all>
or <include-
auditable-
events> are
true, the
type
auditable
events are
returned.

When either
<include-all>
or <include-
display-
configs> are
true, the
type display
configuration
information
is returned.

When either
<include-all>

730 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

HTTP Query Description Data type Value range Default value

method parameters
or <include-
mapping-
tables> are
true, the
type and
properties
mapping
table
information
is returned.

When either
<include-all>
or <include-
value-
constraints>
are true, the
type and
properties
value
constraints
information
is returned.
scope- Specifies string scope config null
config whether to name
get type
properties
based on the
specified
scope and
display
configuration
. The value
you can set is
the scope
configuration
name. The
scope-
configuration
and the
display-
configuration
must be
provided
together.

EDCPKRST220200-PRE-EN-01 Reference Guide 731

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
display- Specifies string display null
config whether to config name
get type
properties
based on the
specified
scope and
display
configuration
. The value
you can set is
the display
configuration
display name.
The scope-
configuration
and display-
configuration
must be
provided
together.

Note: When the relative label value of the specified locale is invalid, locale is
not returned. Nevertheless, all other attributes are returned.

2.73.1.4.2.2 Request media types

N/A

2.73.1.4.2.3 Request headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.73.1.4.2.4 Request body

N/A

2.73.1.4.2.5 Response headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

732 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

2.73.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.73.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.73.1.4.2.8 Response body

Example 2-314: XML response

<?xml version="1.0" encoding="UTF-8"?>
<type
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:dm="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi=http://www.w3.org/2001/XMLSchema-instance
name="my_document" label="My Document" category="standard"
default-lifecycle="a_default_lifecycle" default-lifecycle-version="CURRENT"

ignore-parent-constraints="false"
parent="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject.xml">
<help-text>xxx</help-text>
<comment-text>xxx</comment-text>
<auditable-system-events>
<event>dm_unaudit</event>
<event>dm_audit</event>
...
</auditable-system-events>
<auditable-app-events>
<event>my_app_event2</event>
<event>my_app_event1</event>
...
</auditable-app-events>
<mapping-table>
<mapping>
<value>1</value>
<display>one</display>
</mapping>
<mapping>
<value>2</value>
<display>two</display>
<description>2 to two</description>
</mapping>
</mapping-table>

<constraints>
<contraint>
<expression>a_property&amp;lt;10000</expression>
<enforce>BY_APPLICATION</enforce>
<dependency>a_property</dependency>
<message>a_property must be less than 10000</message>
</contraint>
<contraint>

EDCPKRST220200-PRE-EN-01 Reference Guide 733

Chapter 2 Resources

<expression>Len(b_property)&amp;lt;100</expression>
<enforce>DISABLED</enforce>
<dependency>b_property</dependency>
<message>b_property must have less than 100 characters</message>
</contraint>
</constraints>
<scope-configs>
<scope-config>
<id>6c0000058000050a</id>
<scope>
<item>webtop</item>
</scope>
<category>
<item>application</item>
</category>
<display-configs>
<display-config>
<name>config1</name>
<id>6b0000058000050a</id>
<attribute-source>dm_document</attribute-source>
<fixed-display>false</fixed-display>
<attribute-hints>
<attribute-hint>
<attribute>int_attr1</attribute>
<display-hint>1</display-hint>
</attribute-hint>
</attribute-hints>
</display-config>
</display-configs>
</scope-config>
</scope-configs>
<properties>
<property name="a_property" category="category a_property" repeating="false"
type="string" length="32" label="Type" hidden="false"
required="false" notnull="false" notnull-enforce="BY_APPLICATION"
notnull-message="a_property is not nullable" readonly="true"
searchable="true" display-hint="0" ignore-immutable="true"
ignore-parent-constraints="true">
<dependencies>
<item>attr1</item>
<item>attr2</item>
<dependencies>
<value-assist>
<query allow-caching="false" allow-user-values="false"
condition="..." query-attribute="..."></query>
<query allow-caching="false" allow-user-values="true"
query-attribute="...">...</query>
</value-assist>
<mapping-tables>
<mapping-table>
<value>10</value>
<display>Ten</display>
<description>10 to Ten</description>
</mapping-table>
<mapping-table>
<value>20</value>
<display>Twenty</display>
<description>20 to Twenty</description>
</mapping-table>
</mapping-tables>
<constraints>
<contraint>
<expression>a_property&amp;gt;10</expression>
<enforce>BY_APPLICATION</enforce>
<dependency>a_property</dependency>
<message>a_property is larger than 10</message>
</contraint>
<contraint>
<expression>a_property&amp;lt;1000</expression>
<enforce>BY_APPLICATION</enforce>

734 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

<dependency>a_property</dependency>
<message>a_property is less than 1000</message>
</contraint>
</constraints>
<help-text>The help of the attr a_property</help-text>
<comment-text>The comment of the attr a_property</comment-text>
<lifecycles>
<lifecycle id="4600000580004914">
<state name="state1">
<property-of-lifecycle hidden="false" label="..."
notnull="false" notnull-enforce="BY_APPLICATION"
notnull-message="a_property is not nullable"
readonly="false" required="false" searchable="true"
ignore-immutable="true" ignore-parent-constraints="true">
<value-assist>
<fixed-list allow-user-values="true">
<value>...</value>
</fixed-list>
</value-assist>
<constraints>
...
</constraints>
</property-of-lifecycle>
</state>
<state name="state2">
<property-of-lifecycle hidden="false" label="..."
notnull="false" notnull-enforce="BY_APPLICATION"
notnull-message="a_property is not nullable"
readonly="false" required="false" searchable="true"
ignore-immutable="true" ignore-parent-constraints="true">
<dependencies>
<item>...</item>
</dependencies>
<value-assist>
<fixed-list allow-user-values="false" condition="...">
<value>...</value>
</fixed-list>
<fixed-list allow-user-values="false" condition="...">
<value>...</value>
</fixed-list>
<fixed-list allow-user-values="false">
<value>...</value>
</fixed-list>
</value-assist>
<constraints>
...
</constraints>
</property-of-lifecycle>
</state>
</lifecycle>
</property>
...
</properties>

<lifecycles>
<lifecycle id="4600000580004914">
<state name="state1">
<type-of-lifecycle default-lifecycle="xx"
default-lifecycle-version="xx" label="xx"/>
</state>
<state name="state2">
<type-of-lifecycle default-lifecycle="yy"
default-lifecycle-version="yy" label="yy"/>
</state>
</lifecycle>
</lifecycles>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_document.xml"/>

EDCPKRST220200-PRE-EN-01 Reference Guide 735

Chapter 2 Resources

<link rel="http://identifiers.emc.com/linkrel/types"
href="http://localhost:8080/dctm-rest/repositories/REPO/types.xml?
parent-type=dm_document"/>
<link rel="parent"
href="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_sysobject.xml"/>
<link rel="http://identifiers.emc.com/linkrel/assist-values"
href="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_document/
assist-values"/>
<link rel="http://identifiers.emc.com/linkrel/lifecycle"
title="xxx"
href="xxx"/>
</links>
</type>

Example 2-315: JSON response

{
"name": "my_document",
"label": "My Document",
"category": "standard",
"default-lifecycle" : "a_default_lifecycle",
"default-lifecycle-version" : "CURRENT",
"parent": http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject,
"help-text" : "xxx",
"comment-text" : "xxx",
"ignore-parent-constraints" : false,
"auditable-system-events" : [
"dm_unaudit",
"dm_audit",
...
],
"auditable-app-events" : [
"my_app_event1",
"my_app_event2",
...
],
"mapping-table" : [
{
"value" : "1",
"display" : "one"
},
{
"value" : "2",
"display" : "two",
"description" : "2 to two"
}],
"constraints" : [
{
"expression" : "a_property<10000",
"enforce" : "BY_APPLICATION",
"dependency" : "a_property",
"message" : "a_property must be less than 10000"
},
{
"expression" : "Len(b_property) < 100",
"enforce" : "DISABLED",
"dependency" : "b_property",
"message" : "b_property must have less than 100 characters"
}
],
"scope-configs" : [ {
"id" : "6c0000058000050a",
"scope" : [ "webtop" ],
"category" : [ "application" ],

736 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

"display-configs" : [ {
"name" : "config1",
"id" : "6b0000058000050a",
"attribute-source" : "dm_document",
"fixed-display" : false,
"attribute-hints" : [ {
"attribute" : "int_attr1",
"display-hint" : 1
}]
}]
}],
"properties": [
{
"name": "object_name",
"repeating": false,
"type": "string",
"length": 255,
"label": "Name",
"hidden": false,
"required": false,
"notnull": true,
"notnull-enforce" : "BY_APPLICATION",
"notnull-message" : "a_property is not null",
"readonly": false,
"searchable": true,
"display-hint" : 0,
"help-text" : "The help of the attr a_property",
"comment-text" : "The comment of the attr a_property",
"category" : "category a_property",
"ignore-immutable" : true,
"ignore-parent-constraints" : true,
"dependencies":["attr1","attr2"],

"mapping-tables" : [
{
"value" : "10",
"display" : "Ten",
"description" : "10 to Ten"
},
{
"value" : "20",
"display" : "Twenty",
"description" : "20 to Twenty"
}
],
"constraints" : [
{
"expression" : "a_property>10",
"enforce" : "BY_APPLICATION",
"dependency" : "a_property",
"message" : "a_property is larger than 10"
},
{
"expression" : "a_property<1000",
"enforce" : "DISABLED",
"dependency" : "a_property",
"message" : "a_property is less than 1000"
}
],
"value-assist" : [
{
"type" : "query",
"condition" : "...",
"query-attribute" : "...",
"query-expression" : "...",
"allow-caching" : false,
"allow-user-values" : false
},
{
"type" : "query",

EDCPKRST220200-PRE-EN-01 Reference Guide 737

Chapter 2 Resources

"query-attribute" : "...",
"query-expression" : "...",
"allow-caching" : false,
"allow-user-values" : true
}
],
"lifecycles" : {
"4600000580004914" : {
"state1" : {
"label" : "...",
"hidden" : false,
"required" : false,
"notnull" : false,
"notnull-enforce" : "BY_APPLICATION",
"notnull-message" : "a_property is not null",
"readonly" : false,
"searchable" : true,

"ignore-immutable" : true,
"ignore-parent-constraints" : true,
"dependencies" : [
"..."
],
"value-assist" : [
{
"type" : "query",
"condition" : "...",
"query-attribute" : "...",
"query-expression" : "...",
"allow-caching" : true,
"allow-user-values" : false
},
{
"type" : "query",
"query-attribute" : "...",
"query-expression" : "...",
"allow-caching" : false,
"allow-user-values" : true
}
],
"constraints" : [
...
]
},
"state2" : {
"label" : "b",
"hidden" : false,
"required" : false,
"notnull" : false,
"notnull-enforce" : "BY_APPLICATION",
"notnull-message" : "a_property is not null",
"readonly" : false,
"searchable" : true,
"ignore-immutable" : true,
"ignore-parent-constraints" : true,
"dependencies" : [
"..."
],
"value-assist" : [
{
"type" : "query",
"condition" : "...",
"query-attribute" : "...",
"query-expression" : "...",
"allow-caching" : true,
"allow-user-values" : true
},
{
"type" : "fixed-list",
"values" : [

738 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

"..."
],
"allow-user-values" : false
}
],
"constraints" : [
...
]
}
}
},
{
"name": "r_object_type",
"repeating": false,
"type": "string",
"length": 32,
"label": "Type",
"hidden": false,
"required": false,
"notnull": false,
"readonly": true,
"searchable": true
},
{
"name": "title",
"repeating": false,
"type": "string",
"length": 400,
"label": "Title",
"hidden": false,
"required": false,
"notnull": false,
"readonly": false,
"searchable": true
},
...
{
"name": "i_is_replica",
"repeating": false,
"type": "boolean",
"label": "Is Replica",
"hidden": true,
"required": false,
"notnull": false,
"readonly": true,
"searchable": true
},
{
"name": "i_vstamp",
"repeating": false,
"type": "integer",
"label": "Version Stamp",
"hidden": true,
"required": false,
"notnull": false,
"readonly": true,
"searchable": false
}
],
"lifecycles" : {
"4600000580004914" : {
"state1" : {
"label" : "Document",
"default-lifecycle" : "xx",
"default-lifecycle-version" : "xx"
},
"state2" : {
"label" : "Document",
"default-lifecycle" : "xx",
"default-lifecycle-version" : "xx"

EDCPKRST220200-PRE-EN-01 Reference Guide 739

Chapter 2 Resources

}
}
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document"
},
{
"rel": "http://identifiers.emc.com/linkrel/types",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types?parent-
type=dm_document"
},
{
"rel": "parent",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_sysobject"
},
{
"rel": "http://identifiers.emc.com/linkrel/assist-values",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document/
assist-values"
},
{
"rel": "http://identifiers.emc.com/linkrel/lifecycle",
"title" : "xxx",
"href": "xxx"
}
]
}

2.73.1.5 Elements and attributes

Tip: New for the 16.4 release

• <default-lifecycle> (type level only): The type default lifecycle id

• <default-lifecycle-version> (type level only): The version of the default lifecycle
• <help-text> (under both type and property level): The type and properties help
text
• <comment-text> (under both type and property level): The type and properties
comment text
• <auditable-system-events> (type level only): The names of the auditable system
events
• <auditable-app-events> (type level only): The names of the auditable application
events
• <mapping-table> (under both type and property level): The mapping table of the
type and properties
• <scope-configs> (type level only): The scope configuration and the display
configuration information of the type
• <lifecycles> (under both type and property level): The type or property
information based on different lifecycle states

740 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

• <display-hint> (property level only): Display-hint is the related display hint for the
property, which is added only when both the <scope-config> and <display-config>
are provided as Request parameters
• <ignore-parent-constraints> (under both type and property level): Whether or not
to ignore the parent type's constraints
• <constraints> (under both type and property level): The value constraints for the
type and properties
• <notnull-enforce> (property level only): How the <notnull> is enforced, can be BY_
APPLICATION or DISABLED

• <notnull-message> (property level only): The error message for <notnull>

• <ignore-immutable> (property level only): Whether or not the property is
changeable even if the containing object is immutable
• <category> (property level only): The user defined property category

2.73.1.6 Examples of response

The following sample show you how to use the elements and attributes of this
resource.

2.73.1.6.1 Auditable events

When you use the <include-auditable-events> parameter and set its value to true, the
response will contain both the <auditable-system-events> and the<auditable-app-events>.

Example 2-316: XML response

<type>
...
<auditable-system-events>
<event>dm_all</event>
<event>dm_checkin</event>
<event>dm_checkout</event>
...
</auditable-system-events>
<auditable-app-events>
<event>my_app_event1</event>
<event>my_app_event2</event>
<event>my_app_event3</event>
...
</auditable-app-events>

...
</type>

Example 2-317: JSON response

{
...
"auditable-system-events" : [
"dm_all",
"dm_checkin",
"dm_checkout",

EDCPKRST220200-PRE-EN-01 Reference Guide 741

Chapter 2 Resources

...
],
"auditable-app-events" : [
"my_app_event1",
"my_app_event2",
"my_app_event3",
...
],
...
}

2.73.1.6.2 Display configurations

When you use the <include-display-configs> parameter and set its value to <true>, the
Response will contain both the scope configuration and the display configuration
information.

Example 2-318: XML response

<type>
...
<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>r_creation_date</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-configs>
</scope-config>
...

742 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

</scope-configs>
...
</type>

Example 2-319: JSON response

{
...
"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" : "r_creation_date",
"display-hint" : 2
},
...
]
}
]
},
{
"id" : "6c00000580000101",
"scope" : [
"DcDesktopClient"
],
"category" : [
"application"
],
"display-configs" : [
...
]
}
],
...
}

EDCPKRST220200-PRE-EN-01 Reference Guide 743

Chapter 2 Resources

2.73.1.6.3 Mapping tables

When you use the <include-mapping-tables> parameter and set its value to <true>, the
Response will contain the mapping table information for both the type and the
properties.

Example 2-320: XML response

<type>
...
<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-tables>
<properties>
<property name="owner_permit" ...>
<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-tables>
</property>
...
</properties>
...
</type>

Example 2-321: JSON response

{
...
"mapping-tables" : [
{
"value" : "dm_info",
"display" : "Info"
},
{
"value" : "dm_general",
"display" : "General"
},
...
],
"properties" : [
{
"name" : "owner_permit",
...
"mapping-tables" : [

744 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

{
"value" : "1",
"display" : "None"
},
{
"value" : "2",
"display" : "Browse"
},
{
"value" : "3",
"display" : "Read"
},
...
]
},
...
],
...
}

2.73.1.6.4 Value constraints

When you use the <include-value-constraints> parameter and set its value to true, the
Response will contain constraints for both the type and properties.

Example 2-322: XML response

<type>
...
<constraints>
<constraint>
<expression>property_c&lt;10000</expression>
<enforce>BY_APPLICATION</enforce>
<dependency>property_c</dependency>
<message>property_c must be less than 10000</message>
</constraint>
<constraint>
<expression>Len(property_d) &lt; 100</expression>
<enforce>DISABLED</enforce>
<dependency>property_d</dependency>
<message>property_d must have less than 100 characters</message>
</constraint>
...
</constraints>
<properties>
<property name="property_a" ...>
...
<constraints>
<constraint>
<expression>property_a &gt; 10</expression>
<enforce>BY_APPLICATION</enforce>
<dependency>property_a</dependency>
<message>property_a is larger than 10</message>
</constraint>
<constraint>
<expression>property_a&lt;1000</expression>
<enforce>BY_APPLICATION</enforce>
<dependency>property_a</dependency>
<message>property_a is less than 1000</message>
</constraint>
</constraints>
</property>
...
</properties>

EDCPKRST220200-PRE-EN-01 Reference Guide 745

Chapter 2 Resources

...
</type>

Example 2-323: JSON response

{
...
"constraints" : [
{
"expression" : "property_c<10000",
"enforce" : "BY_APPLICATION",
"dependency" : "property_c",
"message" : "property_c must be less than 10000"
},
{
"expression" : "Len(property_d) < 100",
"enforce" : "DISABLED",
"dependency" : "property_d",
"message" : "property_d must have less than 100 characters"
}
...
],
"properties" : [
{
"name" : "property_a",
...
"constraints" : [
{
"expression" : "property_a > 10",
"enforce" : "BY_APPLICATION",
"dependency" : "property_a",
"message" : "property_a is larger than 10"
},
{
"expression" : "property_a<1000",
"enforce" : "BY_APPLICATION",
"dependency" : "property_a",
"message" : "property_a is less than 1000"
}
]
},
...
],
...
}

2.73.1.6.5 Value assistances

When you use the <include-value-assist> parameter and set its value to true, the
Response will contain the value assistance definition.

Note: Dependencies are returned as basic property information.

Example 2-324: XML response

<type>
...
<properties>
<property name="property_a">

746 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

...
<value-assist>
<fixed-list allow-user-values="false">
<value>1</value>
<value>2</value>
<value>3</value>
</fixed-list>
</value-assist>
</property>
<property name="property_b">
...
<dependencies>
<item>property_b</item>
</dependencies>
<value-assist>
<query allow-caching="false" allow-user-values="false"
condition="property_a=1"
query-attribute="user_name">select user_name from dm_user</query>
<query allow-caching="false" allow-user-values="true"
condition="property_a=2"
query-attribute="name">select name from dm_format</query>
<fixed-list allow-user-values="false">
<value>b</value>
<value>bb</value>
<value>bbb</value>
</fixed-list>
</value-assist>
</property>
...
</properties>
...
</type>

Example 2-325: JSON response

{
...
"properties" : [
{
"name" : "property_a",
...
"value-assist" : [
{
"type" : "fixed-list",
"values" : [
"1",
"2",
"3"
],
"allow-user-values" : false
}
]
},
{
"name" : "property_b",
...
"dependencies" : [
"property_aa"
],
"value-assist" : [
{
"type" : "query",
"condition" : "property_a=1",
"query-attribute" : "user_name",
"query-expression" : "select user_name from dm_user",
"allow-caching" : false,

EDCPKRST220200-PRE-EN-01 Reference Guide 747

Chapter 2 Resources

"allow-user-values" : false
},
{
"type" : "query",
"condition" : "property_a=2",
"query-attribute" : "name",
"query-expression" : "select name from dm_format",
"allow-caching" : false,
"allow-user-values" : true
},
{
"type" : "fixed-list",
"values" : [
"b",
"bb",
"bbb"
],
"allow-user-values" : false
}
]
},
...
],
...
}

2.73.1.6.6 Definition of lifecycle states

When you use the <include-lifecycle> parameter and set its value to true, the
Response contains different lifecycle values according to individual lifecycle states.

Currently, the server supports the information retrieval for the following Lifecycle
states:

Type

• <default-lifecycle>
• <default-lifecycle-version>
• <ignore-parent-constraints>
• <constraints>

Property

• <label>
• <hidden>
• <required>
• <notnull>
• <notnull-enforce>
• <notnull-message>
• <readonly>
• <searchable>

748 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

• <ignore-parent-constraints>
• <ignore-immutable>
• <dependencies>
• <value-assist>
• <constraints>

Only those values that are different than the <type> or <property> without the
Lifecycle are returned. Duplicate values are not returned.

In addition to the <include-lifecycle> parameter, other 'include-xxx' type parameters

are required when you want to get the value of each Lifecycle state.

For example, when:

• include-lifecycle=true and include-value-assist=true, this returns the

value assist definition of the properties. In addition to this, when value assist
definitions exists for the different lifecycle states, then they are also returned.

Example 2-326: XML response

<type>
...
<properties>
<property name="property_a" ...>
...
<lifecycles>
<lifecycle id="4600000580006b20">
<state name="state_1">
<property-of-lifecycle>
<dependencies>
<item>property_b</item>
</dependencies>
<value-assist>
<fixed-list allow-user-values="false"
condition="property_b>1">
<value>1000</value>
</fixed-list>
<fixed-list allow-user-values="false">
<value>9999</value>
</fixed-list>
</value-assist>
</property-of-lifecycle>
</state>
<state name="state_2">
<property-of-lifecycle>
...
</property-of-lifecycle>
</state>
</lifecycle>
<lifecycle id="4600000580006b21">
...
</lifecycle>
</lifecycles>
</property>
...
</properties>
<lifecycles>
<lifecycle id="4600000580006b20">
<state name="state_1">
<type-of-lifecycle default-lifecycle="4600000580006b20"

EDCPKRST220200-PRE-EN-01 Reference Guide 749

Chapter 2 Resources

default-lifecycle-version="CURRENT"/>
</state>
<state name="state_2">
<type-of-lifecycle default-lifecycle="4600000580006b21"
default-lifecycle-version="CURRENT"/>
</state>
</lifecycle>
</lifecycles>
...
</type>

Example 2-327: JSON response

{
...
"properties" : [
{
"name" : "property_a",
...
"lifecycles" : {
"4600000580006b20" : {
"state_1" : {
"dependencies" : [
"property_b"
],
"value-assist" : [
{
"type" : "fixed-list",
"condition" : "property_b>1",
"values" : [
"1000"
],
"allow-user-values" : false
},
{
"type" : "fixed-list",
"values" : [
"9999"
],
"allow-user-values" : false
}
]
},
"DzCzCXAizTwKyP8_0" : {
...
}
},
"4600000580006b21" : {
...
}
}
},
...
]
"lifecycles" : {
"4600000580006b20" : {
"state_1" : {
"default-lifecycle" : "4600000580006b20",
"default-lifecycle-version" : "CURRENT"
},
"state_2" : {
"default-lifecycle" : "4600000580006b21",
"default-lifecycle-version" : "CURRENT"
}
}
},

750 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

...
}

2.73.1.6.7 Include all

When you want to retrieve all of the ‘<include-xxx>’ type values in the response, use
the <include-all> parameter and set its value to true.

2.73.1.6.8 Get the properties of scope-config or display-config

When you use the <scope-config> and <display-config> parameters, then only those
properties that are defined in the related display config are returned. These two
parameters must be provided together. The <display-hint> value is returned in
addition to the normal information that is returned.

Other ‘<include-xxx>’ type parameters may be used as well.

Example 2-328: XML response

<?xml version="1.0" encoding="UTF-8"?>
<type>
...
<properties>
<property display-hint="0" name="object_name" .../>
<property display-hint="0" name="title" .../>
...
<property display-hint="2" name="log_entry" .../>
...
</properties>
...
</type>

Example 2-329: JSON response

{
"name" : "dm_document",
...
"properties" : [
{
"name" : "object_name",
...
"display-hint" : 0
},
{
"name" : "title",
...
"display-hint" : 0
},
...
{
"name" : "log_entry",
"display-hint" : 2
},
...
],
...
}

EDCPKRST220200-PRE-EN-01 Reference Guide 751

Chapter 2 Resources

2.73.1.7 Example of request and response

Example 2-330: XML request
GET http://localhost:8080/dctm-rest/repositories/acme/types/dm_document
Accept:application/vnd.emc.documentum+xml

Example 2-331: XML response

Status Code: 200 OK
Content-Type: application/vnd.emc.documentum+xml;charset=UTF-8
<?xml version="1.0" encoding="UTF-8"?>
<type category="standard" ignore-parent-constraints="false"
label="Document" name="dm_document"
parent="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject"
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<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"/>
...
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document"
rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types?parent-
type=dm_document"
rel="http://identifiers.emc.com/linkrel/types"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject"
rel="parent"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document/
assist-values"
rel="http://identifiers.emc.com/linkrel/assist-values"/>
</links>
</type>

Example 2-332: JSON request

GET http://localhost:8080/dctm-rest/repositories/acme/types/dm_document
Accept:application/vnd.emc.documentum+json

752 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

Example 2-333: JSON response

Status Code: 200 OK
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"name" : "dm_document",
"label" : "Document",
"category" : "standard",
"parent" : "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject",
"ignore-parent-constraints" : false,
"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
},
...
],
"links" : [
{
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document"
},
{
"rel" : "http://identifiers.emc.com/linkrel/types",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/types?parent-
type=dm_document"
},
{
"rel" : "parent",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject"
},
{
"rel" : "http://identifiers.emc.com/linkrel/assist-values",
"href" : "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_document/
assist-values"
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 753

Chapter 2 Resources

2.73.2 Types
The Types collection resource represents the collection of type objects in a
repository.

2.73.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.73.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: Types collection
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “Type” on page 726
• Entry ID: Type URI
• Entry Title: Display name of the type.
• Entry Updated: r_modify_date of the object

2.73.2.3 Link relations

Link relation Description Resource reference

self This collection of type objects “Types” on page 754

754 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

2.73.2.4 Operations
2.73.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a collection of types from the
repository.

2.73.2.4.2 Get Types

Retrieve a collection of types from the repository.

2.73.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data Value Default

method parameter type range value
s
GET parent- Gets direct sub types or all sub string N/A null
type types of the specified type.

You can combine this variable

with recursive to determine
whether or not to return all sub
types or just the direct sub types
of the specified type.

EDCPKRST220200-PRE-EN-01 Reference Guide 755

Chapter 2 Resources

HTTP Query Description Data Value Default

method parameter type range value
s
dml-view Specifies what shall be returned string N/A basic
for the collection. Valid only
when inline=true:
• dml-view=all: Returns all
type and types properties
attributes, including:
– name, label, and
parent
– All properties of the
properties in the type,
including:
name, label, type,
length, repeating,
hidden, notnull,
readonly, required,
default, and
searchable
• dml-view=basic: Returns
only basic dml, including:
– The basic properties of the
type:
name, and parent
– The basic properties of the
properties in the type,
including:
name, type, length, and
repeating
• dml-view=none: Returns
only a minimum set of the
content, including the name,
and the parent of the type.
Type label and all
information about the
properties in the type are not
returned.
inherite Specifies whether or not to string true, true
d include all of the properties of a false
type including the inherited
properties from the parent type.
This parameter does not work
when dml-view=none.
locale Specifies the locale of the string N/A null
Request. This parameter only
works when dml-view=all.

756 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

HTTP Query Description Data Value Default

method parameter type range value
s
include- Specifies whether or not to get string true, false
lifecycl the type related information for false
e the different lifecycles and states,
the parameter is valid only when
dml-view=all.
include- Specifies whether or not to get string true, false
auditabl the type auditable system and false
e-events app events, the parameter is
valid only when dml-view=all.
include- Specifies whether or not to get string true, false
display- the type display configuration false
configs information, the parameter is
valid only when dml-view=all.
include- Specifies whether or not to get string true, false
mapping- the type and properties mapping false
tables table information, the parameter
is valid only when dml-view=
all.
include- Specifies whether or not to get string true, false
value- the type and properties value false
constrai constraints information.
nts

EDCPKRST220200-PRE-EN-01 Reference Guide 757

Chapter 2 Resources

HTTP Query Description Data Value Default

method parameter type range value
s
include- Specifies whether or not to get string true, false
all both lifecycle based type false
information, and auditable
events. the parameter is valid
only when dml-view=all.

When one of include-all and

include-lifecycle is true,
the Lifecycles based type
information is returned.

When one of include-all and

include-auditable-events
is true, the type auditable
events are returned.

When one of include-all and

include-display-configs is
true, the type display
configuration information is
returned.

When one of include-all and

include-mapping-tables is
true, the type mapping table
information is returned.

When one of include-all and

include-value-
constraints is true, the type
and properties value constraints
information are returned.

This method also supports the following standard query parameters:

• sort
• start-with
• inline
• recursive
• items-per-page
• page
• include-total

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

Note: The default sort order is by type name.

758 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

The view query parameter is not supported by this resource.

2.73.2.4.2.2 Request media types

N/A

2.73.2.4.2.3 Request headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.73.2.4.2.4 Request body

N/A

2.73.2.4.2.5 Response headers

• Content-Type
• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.73.2.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.73.2.4.2.7 Response status

• 200 - Retrieved successfully

• 201, 204, 400, 401, 403, 404, 406, 409, 415, 500
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.73.2.4.2.8 Response body

XML or JSON representation of the collection of type objects.

Note: The type name in the URL must be encoded.

Example 2-334: XML request

<?xml version="1.0" encoding="UTF-8"?>
<feed
xmlns="http://www.w3.org/2005/Atom"
xmlns:dm="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

EDCPKRST220200-PRE-EN-01 Reference Guide 759

Chapter 2 Resources

<id>http://localhost:8080/dctm-rest/repositories/REPO/types</id>
<title>Types</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2015-11-18T02:43:19.185+00:00</updated>
<dm:page>1</dm:page>
<dm:items-per-page>1</dm:items-per-page>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/types.xml?items-per-
page=1"/>
<link rel="next"
href="http://localhost:8080/dctm-rest/repositories/REPO/types.xml?
items-per-page=1&page=2"/>
<link rel="first"
href="http://localhost:8080/dctm-rest/repositories/REPO/types.xml?
items-per-page=1&page=1"/>
<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.xml</
uri>
</author>
<summary>0300000580000101</summary>
<updated>2015-11-18T02:43:19.185+00:00</updated>
<published>2015-11-18T02:43:19.185+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl.xml"/>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_acl.xml"/>
</entry>
</feed>

Example 2-335: JSON request

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/types",
"title": "Types",
"author": [
{
"name": "OpenText Documentum"
}
],
"updated": "2015-11-18T02:42:39.442+00:00",
"page": 1,
"items-per-page": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types?items-per-
page=1"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types?
items-per-page=1&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types?
items-per-page=1&page=1"
}
],

760 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

"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-11-18T02:42:39.443+00:00",
"published": "2015-11-18T02:42:39.443+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"
}
}
]
}

Note: In release 7.1, the MIME type property was named content-type. This
name was deprecated and replaced with MIME type property name type. You
can set the rest.api.compatibility.version property in rest-api-
runtime.properties to 7.1 for backward compatibility.

2.73.2.4.2.9 Examples of request and response

Example 2-336: XML request

GET http://localhost:8080/dctm-rest/repositories/REPO/types?
items-per-page=1&inline=true&dml-view=all
Accept:application/vnd.emc.documentum+xml

Example 2-337: XML response

Status Code: 200 OK
Content-Type: application/vnd.emc.documentum+xml;charset=UTF-8

<?xml version='1.0' encoding='UTF-8'?>

<feed
xmlns="http://www.w3.org/2005/Atom"
xmlns:dm="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/types</id>
<title>Types</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2015-11-18T02:51:22.186+00:00</updated>
<dm:page>1</dm:page>

EDCPKRST220200-PRE-EN-01 Reference Guide 761

Chapter 2 Resources

<dm:items-per-page>1</dm:items-per-page>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/types.xml?
items-per-page=1&amp;amp;inline=true&amp;amp;dml-view=all"/>
<link rel="next"
href="http://localhost:8080/dctm-rest/repositories/REPO/types.xml?
items-per-page=1&amp;amp;inline=true&amp;amp;dml-
view=all&amp;amp;page=2"/>
<link rel="first"
href="http://localhost:8080/dctm-rest/repositories/REPO/types.xml?
items-per-page=1&amp;amp;inline=true&amp;amp;dml-
view=all&amp;amp;page=1"/>
<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.xml</uri>
</author>
<summary>0300000580000101</summary>
<updated>2015-11-18T02:51:22.187+00:00</updated>
<published>2015-11-18T02:51:22.187+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl.xml"/>
<content>
<dm:type name="dm_acl" label="ACL" category="standard">
<dm:properties>
<property name="object_name" repeating="false" type="string" length="32"
label="Permissions Set Name" hidden="false" required="false"
notnull="false" readonly="false" searchable="true"/>
<property name="description" repeating="false" type="string" length="128"
label="Permissions Set Description" hidden="false"
required="false"
notnull="false" readonly="false" searchable="true"/>
<property name="owner_name" repeating="false" type="string" length="255"
label="Permissions Set Owner" hidden="false" required="false"
notnull="false" readonly="false" searchable="true"/>
<property name="r_is_internal" repeating="false" type="boolean" label="Is
Internal"
hidden="false" required="false" notnull="false" readonly="true"
searchable="false"/>
<property name="r_accessor_name" repeating="true" type="string" length="255"
label="Permissions Set Members" hidden="false" required="false"
notnull="false" readonly="true" searchable="true"/>
<property name="r_accessor_permit" repeating="true" type="integer"
label="Assigned Permission" hidden="false" required="false"
notnull="false" readonly="true" searchable="true"/>
<property name="r_accessor_xpermit" repeating="true" type="integer"
label="Extended Permissions" hidden="false" required="false"
notnull="false" readonly="true" searchable="true"/>
<property name="r_is_group" repeating="true" type="boolean" label="Is Group"
hidden="false" required="false" notnull="false" readonly="true"
searchable="true"/>
<property name="globally_managed" repeating="false" type="boolean"
label="Global"
hidden="false" required="false" notnull="false" readonly="false"
searchable="true"/>
<property name="acl_class" repeating="false" type="integer" label="ACL
Class"
hidden="false" required="false" notnull="false" readonly="false"
searchable="true"/>
<property name="r_has_events" repeating="false" type="boolean" label="Has
Events"
hidden="false" required="false" notnull="false" readonly="true"
searchable="true"/>
<property name="r_permit_type" repeating="true" type="integer" label="Permit
Type"
hidden="false" required="false" notnull="false" readonly="true"
searchable="true"/>
<property name="r_application_permit" repeating="true" type="string"

762 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.73. Type (s)

length="128"
label="Application Permit" hidden="false" required="false"
notnull="false" readonly="true" searchable="true"/>
<property name="i_has_required_groups" repeating="false" type="boolean"
label="Has Yes Group(s)" hidden="true" required="false"
notnull="false" readonly="true" searchable="true"/>
<property name="i_has_required_group_set" repeating="false" type="boolean"
label="Has Yes Group Set" hidden="true" required="false"
notnull="false" readonly="true" searchable="true"/>
<property name="i_has_access_restrictions" repeating="false" type="boolean"
label="Has Access Restrictions" hidden="true" required="false"
notnull="false" readonly="true" searchable="true"/>
<property name="r_template_id" repeating="false" type="String" length="16"
label="Template ID" hidden="false" required="false"
notnull="false"
readonly="true" searchable="true"/>
<property name="r_alias_set_id" repeating="false" type="String" length="16"
label="Alias Set ID" hidden="false" required="false"
notnull="false"
readonly="true" searchable="true"/>
<property name="i_partition" repeating="false" type="integer"
label="Partition Number" hidden="true" required="false"
notnull="false" readonly="true" searchable="true"/>
<property name="i_is_replica" repeating="false" type="boolean"
label="Replica"
hidden="true" required="false" notnull="false" readonly="true"
searchable="true"/>
<property name="i_vstamp" repeating="false" type="integer" label="Version
Stamp"
hidden="true" required="false" notnull="false" readonly="true"
searchable="true"/>
</dm:properties>
<dm:links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_acl.xml"/>
<link rel="http://identifiers.emc.com/linkrel/types"
href="http://localhost:8080/dctm-rest/repositories/REPO/types.xml?
parent-type=dm_acl"/>
</dm:links>
</dm:type>
</content>
</entry>
</feed>

Example 2-338: JSON request

GET http://localhost:8080/dctm-rest/repositories/REPO/types?
items-per-page=1&inline=true&dml-view=all
Accept:application/vnd.emc.documentum+json

Example 2-339: JSON response

Status Code: 200 OK

Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/types",
"title": "Types",
"author": [
{
"name": "OpenText Documentum"

EDCPKRST220200-PRE-EN-01 Reference Guide 763

Chapter 2 Resources

}
],
"updated": "2015-11-18T02:54:09.968+00:00",
"page": 1,
"items-per-page": 1,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types?
items-per-page=1&inline=true&dml-view=none"
},
{
"rel": "next",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types?
items-per-page=1&inline=true&dml-view=none&page=2"
},
{
"rel": "first",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types?
items-per-page=1&inline=true&dml-view=none&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-11-18T02:54:09.969+00:00",
"published": "2015-11-18T02:54:09.969+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl"
}
],
"content": {
"name": "dm_acl",
"category" : "standard",
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_acl"
},
{
"rel": "http://identifiers.emc.com/linkrel/types",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types?parent-
type=dm_acl"
}
]
}
}
]
}

GET a category of types

The following type of categories are available:

• 0 - standard object type

764 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.74. User (s)

• 1 - aspect property object type

• 2 - shareable object type
• 4 - lightweight object type
• 8 - data table type

The type_category attribute is used along with the filter query parameter and
the category type value to retrieve all of the types of a specified category. Here are
some examples that show you how to use the above type category values with the
filter query parameter. In each example, we use a repository name in the URL, the
filter query parameter, the type_category attribute, and one of the category
values (shown above) to retrieve all of the objects of that type.

Example 2-340: GET all lightweight object types

In this example, we use a category value of 4 to get all of the lightweight object
types.
GET http://localhost:8080/dctm-rest/repositories/{repositoryName}/types?
filter=type_category=4

Example 2-341: GET all shareable object types

In this example, we use a category value of 2 to get all of the shareable object
types.
GET http://localhost:8080/dctm-rest/repositories/{repositoryName}/types?
filter=type_category=2

2.74 User (s)

2.74.1 User
The User resource represents the metadata of a user in a repository.

2.74.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

EDCPKRST220200-PRE-EN-01 Reference Guide 765

Chapter 2 Resources

See Also: “Users” on page 774 and About the Diagram on page 17.

2.74.1.2 Feed
No feed support.

2.74.1.3 Link relations

Link relation Description Resource reference

self This User resource. “User” on page 765
default-folder Default folder (home cabinet) of the “User Default Folder” on page 779
[1] user.
parent Groups that the user belongs to. “Groups” on page 320
edit This User resource. Only SysAdmin “User” on page 765
or SuperUser can view this link
delete [1] This User resource. Only SysAdmin “User” on page 765
or SuperUser can view this link
permission-set The permission set definition for the “Permission Set” on page 505
[1] User
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.74.1.4 Operations
2.74.1.4.1 Supported HTTP methods

Method Description
GET Retrieves a User
POST Update a User
DELETE Delete a User

2.74.1.4.2 Get a User

Retrieves a user and all of its metadata.

766 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.74. User (s)

2.74.1.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• view

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.74.1.4.2.2 Request media types

N/A

2.74.1.4.2.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.74.1.4.2.4 Request body

N/A

2.74.1.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.74.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

EDCPKRST220200-PRE-EN-01 Reference Guide 767

Chapter 2 Resources

2.74.1.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.74.1.4.2.8 Response body

Note: The password attribute is not displayed.

Example 2-342: XML response

<user xsi:type="dm_user" definition="http://localhost:8080/dctm-rest/repositories/REPO/
types/dm_user.xml">
<properties>
<user_name>Administrator</user_name>
<user_os_name>Administrator</user_os_name>
<user_address>[email protected]</user_address>
<user_group_name>docu</user_group_name>
<user_privileges>8</user_privileges>
<owner_def_permit>7</owner_def_permit>
<world_def_permit>3</world_def_permit>
<group_def_permit>5</group_def_permit>
<default_folder>/Administrator</default_folder>
<r_is_group>false</r_is_group>
<user_db_name>Administrator</user_db_name>
<description />
<acl_domain>Administrator</acl_domain>
<acl_name>dm_4500000580000101</acl_name>
<user_os_domain>restcs72ga</user_os_domain>
<home_docbase />
<user_state>0</user_state>
<client_capability>8</client_capability>
<globally_managed>false</globally_managed>
<r_modify_date>2015-03-05T07:55:35.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>restcs72ga:Administrator</user_global_unique_id>
<user_login_name>Administrator</user_login_name>
<user_login_domain>restcs72ga</user_login_domain>
<user_initials />
<user_web_page />
<first_failed_auth_utc_time xsi:nil="true" />
<last_login_utc_time>2015-03-02T18:15:33.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>4</i_vstamp>
<r_object_id>1100000580000102</r_object_id>
</properties>
<links>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/REPO/users/
Administrator" />
<link rel="parent" href="http://localhost:8080/dctm-rest/repositories/REPO/

768 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.74. User (s)

groups.xml?user-name=Administrator" />
<link rel="http://identifiers.emc.com/linkrel/default-folder"
href="http://localhost:8080/dctm-rest/repositories/REPO/users/
Administrator/home.xml" />
</links>
</user>

Example 2-343: JSON response

{
"name":"user",
"type":"dm_user",
"definition":"http://localhost:8080/dctm-rest/repositories/REPO/types/dm_user.json",
"properties":{
"user_name":"Administrator",
"user_os_name":"Administrator",
"user_address":"[email protected]",
"user_group_name":"docu",
"user_privileges":8,
"owner_def_permit":7,
"world_def_permit":3,
"group_def_permit":5,
"default_folder":"/Administrator",
"r_is_group":false,
"user_db_name":"Administrator",
"description":"",
"acl_domain":"Administrator",
"acl_name":"dm_4500000580000101",
"user_os_domain":"restcs72ga",
"home_docbase":"",
"user_state":0,
"client_capability":8,
"globally_managed":false,
"r_modify_date":"2015-03-05T07:55:35.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":"restcs72ga:Administrator",
"user_login_name":"Administrator",
"user_login_domain":"restcs72ga",
"user_initials":"",
"user_web_page":"",
"first_failed_auth_utc_time":null,
"last_login_utc_time":"2015-03-02T18:15:33.000+00:00",
"deactivated_utc_time":null,
"deactivated_ip_addr":"",
"restricted_folder_ids":null,
"root_log_dir":"",
"i_is_replica":false,
"i_vstamp":4,
"r_object_id":"1100000580000102"
},
"links":[{"rel":"self",
"href":"http://localhost:8080/dctm-rest/repositories/REPO/users/Administrator.json"},
{"rel":"parent",
"href":"http://localhost:8080/dctm-rest/repositories/REPO/groups.json?
user-name=Administrator"},
{"rel":"http://identifiers.emc.com/linkrel/default-folder",
"href":"http://localhost:8080/dctm-rest/repositories/REPO/users/

EDCPKRST220200-PRE-EN-01 Reference Guide 769

Chapter 2 Resources

Administrator/home.json"}]
}

2.74.1.4.3 Update a User

Updates the attributes of a user.

2.74.1.4.3.1 HTTP Request method and query parameters

POST

2.74.1.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.74.1.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.74.1.4.3.4 Request body

The following read-only properties cannot be updated:

• i_vstamp
• i_is_replica
• r_has_events
• r_modify_date
• r_is_group

Example 2-344: XML request

<user xsi:type="dm_user" definition="http://localhost:8080/dctm-rest/repositories/
REPO/types/dm_user.xml">
<properties>
<user_address>[email protected]</user_address>
<user_group_name>docu</user_group_name>
<user_privileges>8</user_privileges>
......

770 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.74. User (s)

</properties>
</user>

Example 2-345: JSON request

{
"properties":{
"user_address":"[email protected]",
"user_group_name":"docu",
"user_privileges":8,
...
}
}

2.74.1.4.3.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.74.1.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.74.1.4.3.7 Response status

• 200 - Updated successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.74.1.4.3.8 Response body

Note: The password attribute is not displayed.

Example 2-346: XML response

<?xml version="1.0" encoding="UTF-8"?>
<dm:dm_user xmlns:dm="http://ns.emc.com/documentum"
xmlns="http://www.w3.org/2005/Atom">
<dm:attributes>
<dm:r_object_id>1100000180000101</dm:r_object_id>
<dm:user_name>acme</dm:user_name>
<dm:user_os_name>acme</dm:user_os_name>
<dm:user_address>acme</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>

EDCPKRST220200-PRE-EN-01 Reference Guide 771

Chapter 2 Resources

<dm:group_def_permit>5</dm:group_def_permit>
<dm:default_folder href="http://localhost:8080/dctm-rest/repositories/acme/users
/61636d65/home.xml">/acme</dm:default_folder>
<dm:r_is_group>false</dm:r_is_group>
<dm:user_db_name>acme</dm:user_db_name>
<dm:acl_domain>acme</dm:acl_domain>
<dm:acl_name>dm_4500000180000100</dm:acl_name>
<dm:user_os_domain>2k8vm</dm:user_os_domain>
<dm:user_state>0</dm:user_state>
<dm:client_capability>8</dm:client_capability>
<dm:globally_managed>false</dm:globally_managed>
<dm:r_modify_date>2012-08-31T22:42:42.000+0800</dm:r_modify_date>
<dm:workflow_disabled>false</dm:workflow_disabled>
<dm:alias_set_id>0000000000000000</dm:alias_set_id>
<dm:user_xprivileges>0</dm:user_xprivileges>
<dm:r_has_events>false</dm:r_has_events>
<dm:failed_auth_attempt>0</dm:failed_auth_attempt>
<dm:user_global_unique_id>2k8vm:acme</dm:user_global_unique_id>
<dm:user_login_name>acme</dm:user_login_name>
<dm:user_login_domain>2k8vm</dm:user_login_domain>
<dm:last_login_utc_time>2012-08-31T14:42:42.000+0800
</dm:last_login_utc_time>
<dm:i_is_replica>false</dm:i_is_replica>
<dm:i_vstamp>0</dm:i_vstamp>
</dm:attributes>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/acme/users/61636d65.xml"/>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/acme/users/61636d65.xml"/>
<link rel="delete"
href="http://localhost:8080/dctm-rest/repositories/acme/users/61636d65.xml"/>
<link rel="parent"
href="http://localhost:8080/dctm-rest/repositories/acme/groups.xml?
username=61636d65"/>
<link rel="http://names.emc.com/link/documentum/relations/default-folder"
href="http://localhost:8080/dctm-rest/repositories/acme/users/61636d65/
home.xml"/>
</dm:dm_user>

Example 2-347: JSON response

{
"attributes" : {
"r_object_id" : "1100000180000101",
"user_name" : "acme",
"user_os_name" : "acme",
"user_address" : "acme",
"user_group_name" : "docu",
"user_privileges" : 16,
"owner_def_permit" : 7,
"world_def_permit" : 3,
"group_def_permit" : 5,
"default_folder" : "/acme",
"r_is_group" : false,
"user_db_name" : "acme",
"acl_domain" : "acme",
"acl_name" : "dm_4500000180000100",
"user_os_domain" : "2k8vm",
"user_state" : 0,
"client_capability" : 8,
"globally_managed" : false,
"r_modify_date" : "2012-08-31T22:42:42.000+0800",
"workflow_disabled" : false,
"alias_set_id" : "0000000000000000",
"user_xprivileges" : 0,
"r_has_events" : false,

772 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.74. User (s)

"failed_auth_attempt" : 0,
"user_global_unique_id" : "2k8vm:acme",
"user_login_name" : "acme",
"user_login_domain" : "2k8vm",
"last_login_utc_time" : "2012-08-31T14:42:42.000+0800",
"i_is_replica" : false,
"i_vstamp" : 0
},
"links" : [ {
"rel" : "self",
"href" : "http://localhost:8080/dctm-rest/repositories/acme/users/61636d65.json"
}, {
"rel" : "edit",
"href" : "http://localhost:8080/dctm-rest/repositories/acme/users/61636d65.json"
}, {
"rel" : "delete",
"href" : "http://localhost:8080/dctm-rest/repositories/acme/users/61636d65.json"
}, {
"rel" : "parent",
"href" : "http://localhost:8080/dctm-rest/repositories/acme/groups.json?
username=61636d65"
}, {
"rel" : "http://names.emc.com/link/documentum/relations/default-folder",
"href" : "http://localhost:8080/dctm-rest/repositories/acme/users/61636d65/home.json"
} ]
}

2.74.1.4.4 Delete a User

Only the SysAdmin or SuperUser can perform a delete operation. When a user has
been deleted, the deletion may have an impact on the user's authentication.

2.74.1.4.4.1 HTTP Request method and query parameters

DELETE

2.74.1.4.4.2 Request media types

N/A

2.74.1.4.4.3 Request headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 773

Chapter 2 Resources

2.74.1.4.4.4 Request body

N/A

2.74.1.4.4.5 Response headers

N/A

2.74.1.4.4.6 Response media types

N/A

2.74.1.4.4.7 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.74.1.4.4.8 Response body

N/A

2.74.2 Users
The Users resource represents the metadata of a collection of users in a repository.

2.74.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.74.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: List of users
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “User” on page 765

774 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.74. User (s)

• Entry ID: URI of the user

• Entry Title: User name
• Entry Summary: User description
• Entry Updated: The r_modify_date of the user

2.74.2.3 Link relations

Link relation Description Resource reference

self This collection of Users “Users” on page 774
first, last, next, previous Pagination links “Users” on page 774

2.74.2.4 Operations
2.74.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a collection of Users and their
metadata
POST Creates a new User in a repository

2.74.2.4.2 GET Users

Retrieve the metadata of a collection of users with the specified filters.

2.74.2.4.2.1 HTTP Request method and query parameters

GET

This method supports the following common query parameters:

• sort
• view
Please see the Note below.
• inline
Please see the Note below.
• page
• items-per-page
• include-total
• links
• filter

Note: When a collection of Users is retrieved with the parameter inline=true,

the Users feed will contain the default attribute values for the Users retrieved.

EDCPKRST220200-PRE-EN-01 Reference Guide 775

Chapter 2 Resources

One of these attributes, the definition property, which is used to identify the
entity's type, will always be set to dm_user by default. This is the case even
when the entity is in fact a subtype of dm_user.

To retrieve the correct entity type definition for the Users retrieved, you must
set the view=:all parameter to retrieve Users.

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.74.2.4.2.2 Request media types

N/A

2.74.2.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.74.2.4.2.4 Request body

N/A

2.74.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.74.2.4.2.6 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

776 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.74. User (s)

2.74.2.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.74.2.4.2.8 Response body

XML or JSON representation of the collection of users.

Note: The user name in the URL is encoded.

2.74.2.4.3 Create a user

Create a new user in a repository. The Sysadmin, SuperUser, or any other users that
have the <Create Group> privilege can create a user.

2.74.2.4.3.1 HTTP Request method and query parameters

POST

For more information, see Appendix B, REST Common Definition - URI Request
Query Parameters on page 979.

2.74.2.4.3.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/xml
• application/json

2.74.2.4.3.3 Request headers

• Accept
• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 777

Chapter 2 Resources

2.74.2.4.3.4 Request body

• The <user_name> property is mandatory

• The <user_login_name> or <user_os_name> is mandatory

Example 2-348: Request body in XML

<?xml version="1.0" encoding="UTF-8"?>
<dm:dm_user xmlns:dm="http://ns.emc.com/documentum" xmlns="http://www.w3.org/2005/Atom">
<dm:properties>
<dm:user_name>acme</dm:user_name>
<dm:user_login_name>acme</dm:user_login_name>
// ...
</dm:properties>
</dm:dm_user>

Example 2-349: Request body in JSON

{
"properties" : {
"user_name" : "acme",
"user_login_name" : "acme"
// ...
}
}

2.74.2.4.3.5 Response headers

• Location - The URL of the newly created user.

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.74.2.4.3.6 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.74.2.4.3.7 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

778 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.75. User Default Folder

2.74.2.4.3.8 Response body

N/A

2.75 User Default Folder

The User Default Folder resource represents the default folder (the home cabinet)
for a given user.

2.75.1 Resource relationships

The following diagram illustrates how this resource is related to other resources.

See Also: “User” on page 765 and About the Diagram on page 17.

2.75.2 Feed
No feed support.

2.75.3 Link relations

Link relation Description Resource reference
self This default folder. “User Default Folder”
on page 779
canonical Canonical URI for the default “Cabinet” on page 137
folder resource.
“Folder” on page 236

2.75.4 Operations
2.75.4.1 Supported HTTP methods

Method Description
GET Retrieves the default folder for a given user.

EDCPKRST220200-PRE-EN-01 Reference Guide 779

Chapter 2 Resources

2.75.4.2 Get a user default folder

Retrieve information about the default folder for a given user. Typically, the default
folder is a cabinet, a type of dm_cabinet, and is referred to as the “user’s home
cabinet”. The default folder can also be an instance of dm_folder or one of its
subtypes.

2.75.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameter
GET • view For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
• permiss
ions

2.75.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.75.4.2.3 Request headers

• Accept
• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.75.4.2.4 Request body

N/A

2.75.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

780 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.75. User Default Folder

2.75.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.75.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.75.4.2.8 Response body

XML or JSON representation of the specified user's default folder:

• The body must contain information about the default folder of the specified user.
• The body may contain all attributes of the default folder, depending on the value
that is set for the view parameter.

Here is a sample of a typical Request and response.

Example 2-350: XML request

Accept: application/vnd.emc.documentum+xml

GET http://localhost:8080/dctm-rest/repositories/acme01/users/<username>/home

Example 2-351: XML response

<?xml version="1.0" encoding="UTF-8"?>
<dm:dm_cabinet xmlns:dm="http://ns.emc.com/documentum" xmlns="http://www.w3.org/2005/
Atom">
<dm:attributes>
<dm:r_object_id
href="http://localhost:8080/dctm-rest/repositories/acme01/objects/
0c00000c80000104.xml">
0c00000c80000104
</dm:r_object_id>
<dm:object_name>acme01</dm:object_name>
<dm:title>Super User Cabinet</dm:title>
...
<dm:r_object_type>dm_cabinet</dm:r_object_type>
<dm:r_creation_date>2012-06-13T05:36:08.000+0800</dm:r_creation_date>
<dm:r_modify_date>2012-06-13T05:36:08.000+0800</dm:r_modify_date>
</dm:attributes>
<link rel="self" href="http://localhost:8080/dctm-rest/repositories/acme01/users/john/
home.xml"/>
<link rel="canonical"
href="http://localhost:8080/dctm-rest/repositories/acme01/cabinets/
0c00000c80000104.xml"/>

EDCPKRST220200-PRE-EN-01 Reference Guide 781

Chapter 2 Resources

<link rel="http://names.emc.com/link/documentum/relations/folders"
href="http://localhost:8080/dctm-rest/repositories/acme01/cabinets/
0c00000c80000104/
folders.xml"/>
<link rel="http://names.emc.com/link/documentum/relations/documents"
href="http://localhost:8080/dctm-rest/repositories/acme01/cabinets/
0c00000c80000104/
documents.xml"/>
<link rel="http://names.emc.com/link/documentum/relations/objects"
href="http://localhost:8080/dctm-rest/repositories/acme01/cabinets/
0c00000c80000104/
objects.xml"/>
</dm:dm_cabinet>

Example 2-352: JSON request

Accept: application/vnd.emc.documentum+json

GET http://localhost:8080/dctm-rest/repositories/acme01/users/<username>/home

Example 2-353: JSON response

{
{
"attributes":
{
"r_object_id": "0c00000c80000104",
"object_name": "acme01",
"title": "Super User Cabinet",
"subject": "",
...
},
"links":
[
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/repo/users/Administrator/
home.json"
},
{
"rel": "canonical",
"href": "http://localhost:8080/dctm-rest/repositories/acme01/cabinets/
0c00000c80000104.json"
}
...
]
}
}

782 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.76. User Permission Set

2.76 User Permission Set

The User Permission Set resource represents the associated permission set of a
user.

Documentum Server uses the default_acl property of the server configuration

object to specify which ACL the server uses as the default ACL. When creating a
new object, if an ACL is not explicitly associated with the object you can use the
following values:

• <1:> The ACL associated with the object's primary folder

• <2:> The ACL associated with the object's type
• <3:> The ACL associated with the user who created the object
• <4:> No default ACL is specified
The default is <3>

When the default_acl property of the server configuration object has a value of
<3>, the creator's default permissions (or ACL) are used as the default ACL of the
new object. This is the case when an ACL is not explicitly associated with the object.

When you have the associated permission set of a user, you can view the default
permission set of all the sysobjects that were created by that user. You can also see
any change of that user's permission set to determine how that change may effect the
default permission set of any sysobjects that are created by that user in the future.

2.76.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “User” on page 765 and About the Diagram on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 783

Chapter 2 Resources

2.76.2 Feed
No feed support.

2.76.3 Link relations

The following table lists link relations for the User Permission Set resource.

Link relation Description Resource reference

self This user permission set resource “User Permission Set” on page 783
acl [1] The current user's associated ACL “ACL” on page 42
object
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.76.4 Operations
2.76.4.1 Supported HTTP methods

Method Description
GET GET the permission set for a specific user

2.76.4.2 Get the User Permission Set

Retrieve the definition of the associated permission set for a specific user. The user
permission set has the same representation as the object's permission set. The
permission set returned may contain one or more sections of the complete
permission set, which includes the <permitted>, <restricted>, <required-group>, and
<required-group-set> sections. Sections that do not appear in the permission set
returned are not set by that permission set.

2.76.4.2.1 HTTP Request method and query parameters

HTTP method Query Description Data type Default value

parameters
GET links For more information, see Appendix B, REST
Common Definition - URI Request Query Parameters
on page 979.

784 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.76. User Permission Set

2.76.4.2.2 Request media types

N/A

2.76.4.2.3 Request headers

• Accept
• Authorization
• For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.76.4.2.4 Request body

N/A

2.76.4.2.5 Response headers

• Content-Type
• For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.76.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.76.4.2.7 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.76.4.2.8 Response body

Example 2-354: XML response

<?xml version='1.0' encoding='UTF-8'?>
<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="Delete"
extend-permissions="EXECUTE_PROC,CHANGE_LOCATION"/>
......
</permitted>
<links>
<link rel="self" href="{userPermissionSetResourceUri}"/>
<link rel="http://identifiers.emc.com/linkrel/acl"

EDCPKRST220200-PRE-EN-01 Reference Guide 785

Chapter 2 Resources

href="{aclResourceUri}"/>
</links>
</permission-set>

Example 2-355: JSON response

{
"permitted": [
{
"accessor": "dm_world",
"basic-permission": "Read",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
},
{
"accessor": "dm_owner",
"basic-permission": "Delete",
"extend-permissions": "EXECUTE_PROC,CHANGE_LOCATION"
},
......
],
"links": [
{
"rel": "self",
"href": "{userPermissionSetResourceUri}"
},
{
"rel": "http://identifiers.emc.com/linkrel/acl",
"href": "{aclResourceUri}"
}
]
}

2.77 User Subscription (s)

2.77.1 User Subscription
The User Subscription resource allows you to subscribe to a sysobject, document,
folder, or cabinet. You can use this resource to subscribe to favorite resources.

2.77.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “User Subscriptions” on page 797 and About the Diagram on page 17.

786 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.77. User Subscription (s)

2.77.1.2 Feed
No feed support.

2.77.1.3 Link relations

Link relation Description Resource reference

self This resource “User Subscription” on page 786
relations The collection of relations related “Relations” on page 536
to this object
unsubscribe Unsubscribe to this sysobject “User Subscription” on page 786
parent-links [1] The collection of parents. “Parent Links” on page 496

Note: Does not apply to

cabinets.
comments [1] Comments associated to this object “Comments” on page 159
virtual-document- GET virtual document nodes “Virtual Document Nodes”
nodes [1] when the sysobject is a virtual on page 820
document
virtual-document- Convert a simple document to “Virtual Document Nodes”
conversion [1] virtual one by adding a new node on page 820
snapshots [1] GET the snapshots associated with “Virtual Document Snapshots”
this virtual document on page 838

Note: This link only

available for virtual
documents.
object-aspects [1] Attached aspect of the sysobject “Object Aspect” on page 449
permission-set [1] Permission set of the sysobject “Permission Set” on page 505
permissions [1] Specified user's permissions on the “Permissions” on page 501
given sysobject
attachable- Collection of lifecycles to which “Lifecycles” on page 382
lifecycles [1] the given sysobject can be attached
object-lifecycle [1] The current lifecycle state of the “Object Lifecycle” on page 457
given sysobject
audit-trails The audit trails associated with “Audit Trails” on page 107
this object
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

Note: The link relations for this resource are the same as those for the
SysObject resource.

EDCPKRST220200-PRE-EN-01 Reference Guide 787

Chapter 2 Resources

2.77.1.4 Operations
2.77.1.4.1 Supported HTTP methods

Method Description
PUT Subscribes users to the object
DELETE Unsubscribes the current user from the object

2.77.1.4.2 Subscribe to an object

2.77.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
PUT N/A For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.77.1.4.2.2 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.77.1.4.2.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.77.1.4.2.4 Request body

The value of the subscribed user is that user’s username or its URI.

Example 2-356: XML request

<?xml version='1.0' encoding='UTF-8'?>
<subscribers>
<subscriber>someUser</subscriber>
</subscribers>

Example 2-357: XML response

<?xml version='1.0' encoding='UTF-8'?>
<subscribers>
<subscriber>http://localhost:8080/dctm-rest/repositories/REPO/users/someUser</
subscriber>
</subscribers>

788 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.77. User Subscription (s)

Example 2-358: JSON request

{
"subscribers": ["someUser"]
}

Example 2-359: JSON response

{
"subscribers": ["http://localhost/dctm-rest/repositories/REPO/users/someUser"]
}

2.77.1.4.2.5 Response headers

• Content-Type
• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.77.1.4.2.6 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.77.1.4.2.7 Response status

• 201- Subscribed successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 789

Chapter 2 Resources

2.77.1.4.2.8 Response body

Example 2-360: XML

<?xml version='1.0' encoding='UTF-8'?>
<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>ff</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>2016-12-15T02:33:24.000+00:00</r_creation_date>
<r_modify_date>2017-09-28T02:53:13.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_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>0c02791780009423</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>060279178002fab2</i_contents_id>
<a_content_type>jpeg</a_content_type>
<r_page_cnt>1</r_page_cnt>
<r_content_size>18040</r_content_size>
<a_full_text>true</a_full_text>
<a_storage_type>filestore_01</a_storage_type>
<i_cabinet_id>0c02791780009423</i_cabinet_id>
<owner_name>dmadmin</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>09027917800106dd</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>

790 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.77. User Subscription (s)

<r_frozen_flag>false</r_frozen_flag>
<r_has_events>false</r_has_events>
<acl_domain>dmadmin</acl_domain>
<acl_name>dm_4502791780002500</acl_name>
<a_special_app></a_special_app>
<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_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>18040.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>17</i_vstamp>
<r_object_id>09027917800106dd</r_object_id>
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
subscription"/>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd"/>
<link rel="canonical"
href="http://localhost:8080/dctm-rest/repositories/repo/documents/
09027917800106dd"/>
<link rel="http://identifiers.emc.com/linkrel/parent-links"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
parent-links"/>
<link rel="parent" title="0c02791780009423"
href="http://localhost:8080/dctm-rest/repositories/repo/folders/
0c02791780009423"/>
<link rel="http://identifiers.emc.com/linkrel/cabinet"
href="http://localhost:8080/dctm-rest/repositories/repo/cabinets/
0c02791780009423"/>
<link rel="contents"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
contents"/>
<link rel="http://identifiers.emc.com/linkrel/primary-content"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
contents/content"/>
<link rel="http://identifiers.emc.com/linkrel/checkout"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/lock"/>
<link rel="version-history"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/

EDCPKRST220200-PRE-EN-01 Reference Guide 791

Chapter 2 Resources

09027917800106dd/
versions"/>
<link rel="http://identifiers.emc.com/linkrel/current-version"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
versions/current"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-conversion"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
vd-nodes"/>
<link rel="http://identifiers.emc.com/linkrel/relations"
href="http://localhost:8080/dctm-rest/repositories/repo/relations?
related-object-id=09027917800106dd&amp;related-object-role=any"/>
<link rel="http://identifiers.emc.com/linkrel/object-aspects"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
aspects"/>
<link rel="http://identifiers.emc.com/linkrel/permission-set"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
permission-set"/>
<link rel="http://identifiers.emc.com/linkrel/permissions"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
permissions"/>
<link rel="http://identifiers.emc.com/linkrel/comments"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
comments"/>
<link rel="http://identifiers.emc.com/linkrel/attachable-lifecycles"
href="http://localhost:8080/dctm-rest/repositories/repo/lifecycles?
object-id=09027917800106dd"/>
<link rel="http://identifiers.emc.com/linkrel/object-lifecycle"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
lifecycle"/>
<link rel="http://identifiers.emc.com/linkrel/audit-trails"
href="http://localhost:8080/dctm-rest/repositories/repo/audit-trails?
filter=audited_obj_id='09027917800106dd'"/>
<link rel="http://identifiers.emc.com/linkrel/unsubscribe"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
subscription"/>
</links>
</object>

Example 2-361: JSON

{
"name": "object",
"type": "dm_document",
"definition": "http://localhost:8080/dctm-rest/repositories/repo/types/dm_document",
"properties": {
"object_name": "ff",
"r_object_type": "dm_document",
"title": "",
"subject": "",
"authors": null,
"keywords": null,
"a_application_type": "",
"a_status": "",
"r_creation_date": "2016-12-15T02:33:24.000+00:00",
"r_modify_date": "2017-09-28T02:52:10.000+00:00",
"r_modifier": "Administrator",
"r_access_date": null,
"a_is_hidden": false,

792 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.77. User Subscription (s)

"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": [
"0c02791780009423"
],
"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": "060279178002fab2",
"a_content_type": "jpeg",
"r_page_cnt": 1,
"r_content_size": 18040,
"a_full_text": true,
"a_storage_type": "filestore_01",
"i_cabinet_id": "0c02791780009423",
"owner_name": "dmadmin",
"owner_permit": 7,
"group_name": "",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "09027917800106dd",
"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_4502791780002500",
"a_special_app": "",
"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_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": 18040,
"a_extended_properties": null,

EDCPKRST220200-PRE-EN-01 Reference Guide 793

Chapter 2 Resources

"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": 16,
"r_object_id": "09027917800106dd"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
subscription"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd"
},
{
"rel": "canonical",
"href": "http://localhost:8080/dctm-rest/repositories/repo/documents/
09027917800106dd"
},
{
"rel": "http://identifiers.emc.com/linkrel/parent-links",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
parent-links"
},
{
"rel": "parent",
"title": "0c02791780009423",
"href": "http://localhost:8080/dctm-rest/repositories/repo/folders/
0c02791780009423"
},
{
"rel": "http://identifiers.emc.com/linkrel/cabinet",
"href": "http://localhost:8080/dctm-rest/repositories/repo/cabinets/
0c02791780009423"
},
{
"rel": "contents",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/contents"
},
{
"rel": "http://identifiers.emc.com/linkrel/primary-content",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/contents/
content"
},
{
"rel": "http://identifiers.emc.com/linkrel/checkout",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/lock"
},
{
"rel": "version-history",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/versions"
},

794 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.77. User Subscription (s)

{
"rel": "http://identifiers.emc.com/linkrel/current-version",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/versions/
current"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-conversion",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/vd-nodes"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "http://localhost:8080/dctm-rest/repositories/repo/relations?
related-object-id=09027917800106dd&related-object-role=any"
},
{
"rel": "http://identifiers.emc.com/linkrel/object-aspects",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/aspects"
},
{
"rel": "http://identifiers.emc.com/linkrel/permission-set",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
permission-set"
},
{
"rel": "http://identifiers.emc.com/linkrel/permissions",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
permissions"
},
{
"rel": "http://identifiers.emc.com/linkrel/comments",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/comments"
},
{
"rel": "http://identifiers.emc.com/linkrel/attachable-lifecycles",
"href": "http://localhost:8080/dctm-rest/repositories/repo/lifecycles?
object-id=09027917800106dd"
},
{
"rel": "http://identifiers.emc.com/linkrel/object-lifecycle",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/lifecycle"
},
{
"rel": "http://identifiers.emc.com/linkrel/audit-trails",
"href": "http://localhost:8080/dctm-rest/repositories/repo/audit-trails?
filter=audited_obj_id='09027917800106dd'"
},
{
"rel": "http://identifiers.emc.com/linkrel/unsubscribe",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd/
subscription"
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 795

Chapter 2 Resources

2.77.1.4.3 Unsubscribe from an object

2.77.1.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
DELETE For more information, see Appendix B, REST Common Definition - URI
Request Query Parameters on page 979.

2.77.1.4.3.2 Request media types

N/A

2.77.1.4.3.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.77.1.4.3.4 Request body

N/A

2.77.1.4.3.5 Response headers

N/A

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.77.1.4.3.6 Response media types

N/A

2.77.1.4.3.7 Response status

• 204- Unsubscribed successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

796 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.77. User Subscription (s)

2.77.1.4.3.8 Response body

N/A

2.77.2 User Subscriptions

This resource represents a collection of objects to which the current user has
subscribed.

2.77.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Repository” on page 562 and About the Diagram on page 17.

2.77.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: /repositories/<repositoryName>/subscriptions

• Feed Title: My Subscriptions
• Feed Updated: Server's current time
• Supports POST: No
• Entry: SysObject Resource
• Entry ID: The sysobject resource URI
• Entry Title: The id of subscription related object
• Entry Updated: The updated time of the subscription related object

2.77.2.3 Link relations

Link relation Description Resource reference

self This resource “User Subscriptions”
on page 797

EDCPKRST220200-PRE-EN-01 Reference Guide 797

Chapter 2 Resources

2.77.2.4 Operations
2.77.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a listing of all objects to which the
current user has subscribed.

2.77.2.4.2 Get all subscriptions

This operation retrieves all of the objects to which the current user has subscribed.

2.77.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET • view For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
• inline
• items-
per-
page
• page
• include
-total
• filter

2.77.2.4.2.2 Request media types

N/A

2.77.2.4.2.3 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

798 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.77. User Subscription (s)

2.77.2.4.2.4 Request body

N/A

2.77.2.4.2.5 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.77.2.4.2.6 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.77.2.4.2.7 Response status

• 200 - Retrieved Successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

2.77.2.4.2.8 Response body

Example 2-362: XML

<?xml version='1.0' encoding='UTF-8'?>

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:xsi="http://www.w3.org/2001/XMLSchema-
instance">
<id>http://localhost:8080/dctm-rest/repositories/repo/subscriptions</id>
<title>My Subscriptions</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2017-09-28T03:24:38.863+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/
subscriptions"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/repo/objects/09027917800106dd</id>
<title>Subscription Samples</title>
<author>
<name>dmadmin</name>
<uri>http://localhost:8080/dctm-rest/repositories/repo/users/dmadmin</uri>
</author>
<summary>dm_document 09027917800106dd</summary>
<updated>2017-09-28T02:53:13.000+00:00</updated>
<published>2016-12-15T02:33:24.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd"/>
<content type="application/xml"
src="http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd"/>

EDCPKRST220200-PRE-EN-01 Reference Guide 799

Chapter 2 Resources

</entry>
</feed>

Example 2-363: JSON

{
"id": "http://localhost:8080/dctm-rest/repositories/repo/subscriptions",
"title": "My Subscriptions",
"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2017-09-28T03:23:16.470+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/repo/subscriptions"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/repo/objects/09027917800106dd",
"title": "Subscription Samples",
"author": [
{
"name": "dmadmin",
"uri": "http://localhost:8080/dctm-rest/repositories/repo/users/dmadmin"
}
],
"summary": "dm_document 09027917800106dd",
"updated": "2017-09-28T02:53:13.000+00:00",
"published": "2016-12-15T02:33:24.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/repo/objects/
09027917800106dd"
}
}
]
}

800 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.78. Value Assistances

2.78 Value Assistances

The Value Assistances resource represents the value assistances of a Type.

2.78.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

See Also: “Type” on page 726 and About the Diagram on page 17.

2.78.2 Feed
No feed support.

2.78.3 Link relations

Link relation Description Resource reference
self This Value Assistances “Value Assistances”
resource on page 801

2.78.4 Operations
2.78.4.1 Supported HTTP methods

Method Description
POST Retrieves the Value Assistance and
dependency properties of the specified Type

2.78.4.2 Get the value assistance of the type

GET the Value Assistance and dependency properties of the specified type

EDCPKRST220200-PRE-EN-01 Reference Guide 801

Chapter 2 Resources

2.78.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
POST included- The property string N/A All properties
properties names to be belonging to
included in the Type
the Response.

The property
names are
comma
separated.
For example,
included-
properties
=attr1,
attr2,
attr3
lifecycle- The lifecycle string N/A null
id id property.
state The Lifecycle string N/A null
state string.

2.78.4.2.2 Request headers

• Authorization
• Accept
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.78.4.2.3 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

802 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.78. Value Assistances

2.78.4.2.4 Request body

The input available for one property of a certain type may depend on the value of
other properties. When you want to get the assist values for a property, you must
provide the values of dependent properties if there are dependencies.

Resources return multi-properties assist values, therefore you must provide all of
the dependent values that the assist values require.

Every property’s dependency information is displayed within the Type resource.

This information is within the <dependencies> element, which is within the
<property> element.

Here are two code samples (one in XML and one in JSON) that illustrates this point:

Example 2-364: XML request

<assist-value-request>
<!-- Includes all of the dependency values for input -->
<properties>
<!-- Some assist values may be dependent upon the value of attr1,
so this element provides the value of attr1.-->
<attr1>value1</attr1>

<!-- When the dependency value is a list, inputing it as an array

is supported, as shown here in the attr2 element-->
<attr2>
<item>XXX</item>
<item>YYY</item>
</attr2>
<attr3>4</attr3>
</properties>
</assist-value-request>

Example 2-365: JSON request

{
// Includes all of the dependency values for input.
"properties": {
// Some assist values may be dependent upon the value of attr1,
// so this element provides the value of attr1.
"attr1":"value1",

// When the dependency value is a list, inputing it as an array

// is supported, as shown here in the attr2 element.
"attr2":[
"XXX",
"YYY"
],
"attr3":3
}
}

EDCPKRST220200-PRE-EN-01 Reference Guide 803

Chapter 2 Resources

2.78.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.78.4.2.6 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.78.4.2.7 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.78.4.2.8 Response body

Example 2-366: XML response

<?xml version='1.0' encoding='UTF-8'?>
<assist-values>
<properties>
<attr1 allow-user-values="false">
<value label="One">1</value>
<value label="Two">2</value>
</attr1>
<attr2 allow-user-values="false">
<value label="Three">3</value>
<value label="Four">4</value>
</attr2>
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/types/a_new_type/
assist-values.xml"/>
</links>
</assist-values>

Example 2-367: JSON response

{
"properties": {
"attr1": {
"allow-user-values": false,
"values": [
{"value": 1, "label": "One"},
{"value": 2, "label": "Two"},
]
},
"attr2": {
"allow-user-values": true,
"values": [
{"value": 3, "label": "Three"},

804 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

{"value": 4, "label": "Four"},

]
}
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/types/a_new_type/
assist-values.xml"
}
]
}

2.79 Virtual Document Node (s)

2.79.1 Virtual Document Node
This resource can represent a Virtual Document Node or a Snapshot Node in a
repository. You can use this resource to retrieve, update, or remove a Virtual
Document Node from Documentum Server.

2.79.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Virtual Document Nodes” on page 820 and About the
Diagrams on page 17.

2.79.1.2 Feed
No feed support.

EDCPKRST220200-PRE-EN-01 Reference Guide 805

Chapter 2 Resources

2.79.1.3 Link relations

Link relation Description Resource reference

self This Virtual Document Node “Virtual Document Node”
resource on page 805
edit Update the Virtual Document “Virtual Document Node”
Node resource on page 805
delete [1] Delete the Virtual Document “Virtual Document Node”
Node resource on page 805
virtual-document- The component object of the “SysObject” on page 690
component [1] Virtual Document Node
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.79.1.4 Operations
2.79.1.4.1 Supported HTTP methods

Method Description
GET GET a Virtual Document Node
POST Update a Virtual Document Node
DELETE Delete a Virtual Document Node

2.79.1.4.2 Get a virtual document node

Retrieves a Virtual Document Node, its metadata including the parent-id,

chronicle-id, relation-id, binding, copy-behavior, follow-assembly, order-
number, and the override-late-binding attributes. It also retrieves the properties
of the corresponding component.

2.79.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

806 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

HTTP Query Description Data type Value range Default value

method parameters
object-id The object id string N/A N/A
of the virtual
document
component of
the current
virtual
document
node.

When the
<object-id>
parameter is
set, the
properties of
the virtual
document
component,
defined by
the <object-
id>, is
returned.

When the
<object-id>
parameter is
not specified,
the properties
of the
CURRENT
version
virtual
document
component
are returned.

2.79.1.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 807

Chapter 2 Resources

2.79.1.4.2.3 Request media types

N/A

2.79.1.4.2.4 Request body

N/A

2.79.1.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.79.1.4.2.6 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.79.1.4.2.7 Response media types

• application/vnd.emc.documentum+xml

• application/xml

• application/vnd.emc.documentum+json

• application/json

2.79.1.4.2.8 Response body

The following table lists the attributes in the response payload of the virtual
document node:

Attribute Description
parent-id The r_object_id attribute of the node's
parent object.
chronicle-id The chronicle_id attribute of the node
object.
relation-id The r_object_id attribute of the dmr_
containment instance that connects the
parent and node.

808 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

Attribute Description
order-number The order_no attribute of the dmr_
containment instance that connects the
parent and node.

Note: The underlying attribute has a

float data type, however REST uses
an integer to represent it.
binding The version_label attribute of the dmr_
containment instance that connects the
parent and node. It defines the version label
of the Virtual Document Node. When this
attribute has no value, it indicates that late
binding has been defined for the node.
override-late-binding Returns the use_node_ver_label
attribute value from the dmr_containment
instance that connects the parent and node. It
defines a strategy to resolve the version label
of its late binding descendants. This attribute
value is important when the node is early-
bound to the virtual document and is itself a
virtual document. In these cases, the use_
node_ver_label attribute value
determines whether the system uses the
node's early-bound version label to select the
node's late-bound children.

Returns true when the system can use the

node's early-bound version label to select its
late-bound children, and false otherwise.
The return value of this attribute is always
false for assembly nodes and the root
node.
copy-behavior The copy_child attribute of the dmr_
containment instance that connects the
parent and node. It defines the copy strategy.
When you are working with REST services,
use UNSPECIFIED, REFERENCE, and
DUPLICATION as its values.
follow-assembly The follow_assembly attribute of the
dmr_containment instance that connects
the parent and node. It determines whether
the server selects component descendants
using the containment objects, or a snapshot
associated with the component instead.
Simply put, this attribute determines
whether the server treats the SysObject as
a Virtual Document or a Snapshot for the
purposes of retrieving its nodes or snapshot
nodes accordingly.

EDCPKRST220200-PRE-EN-01 Reference Guide 809

Chapter 2 Resources

Example 2-368: XML response

<?xml version='1.0' encoding='UTF-8'?>

<vd-node xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_document">
<parent-id>0900000580004993</parent-id>
<chronicle-id>0900000580004994</chronicle-id>
<relation-id>050000058000010c</relation-id>
<order-number>3000</order-number>
<binding></binding>
<override-late-binding>false</override-late-binding>
<copy-behavior>UNSPECIFIED</copy-behavior>
<follow-assembly>false</follow-assembly>
<properties>
<object_name>restDoc70c04679-bfc6-4ea0-9548-c07184b74742</object_name>
<r_object_type>dm_document</r_object_type>
<r_creation_date>2017-07-05T02:30:51.000+00:00</r_creation_date>
<r_modify_date>2017-07-05T02:30:51.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>0c00000580000107</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>1</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>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>0c00000580000107</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>0900000580004994</i_chronicle_id>
<i_latest_flag>true</i_latest_flag>
<r_lock_owner>dmadmin</r_lock_owner>
<r_lock_date>2017-07-06T03:23:31.000+00:00</r_lock_date>
<r_lock_machine>cnenwangc31m2.corp.emc.com</r_lock_machine>
<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>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>

810 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

<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>1</i_vstamp>
<r_object_id>0900000580004994</r_object_id>
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010c?object-id=0900000580004994&inline=true"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004994"/>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010c?object-id="/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010c?object-id="/>
</links>
</vd-node>

Example 2-369: JSON response

{
"name": "vd-node",
"type": "dm_document",
"parent-id": "0900000580004993",
"chronicle-id": "0900000580004994",
"relation-id": "050000058000010c",
"order-number": 3000,
"binding": "",
"override-late-binding": false,
"copy-behavior": "UNSPECIFIED",
"follow-assembly": false,
"properties": {
"object_name": "restDoc70c04679-bfc6-4ea0-9548-c07184b74742",
"r_object_type": "dm_document",
"r_creation_date": "2017-07-05T02:30:51.000+00:00",
"r_modify_date": "2017-07-05T02:30:51.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": [
"0c00000580000107"
],
"r_link_cnt": 0,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0000000000000000",
"r_frzn_assembly_cnt": 1,
"r_has_frzn_assembly": false,
"r_is_virtual_doc": 0,
"i_contents_id": "0000000000000000",
"r_page_cnt": 0,
"r_content_size": 0,
"a_full_text": true,
"i_cabinet_id": "0c00000580000107",
"owner_name": "dave",
"owner_permit": 7,
"group_permit": 5,

EDCPKRST220200-PRE-EN-01 Reference Guide 811

Chapter 2 Resources

"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "0900000580004994",
"i_latest_flag": true,
"r_lock_owner": "dmadmin",
"r_lock_date": "2017-07-06T03:23:31.000+00:00",
"r_lock_machine": "cnenwangc31m2.corp.emc.com",
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": true,
"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": 1,
"r_object_id": "0900000580004994"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010c?object-id=0900000580004994&inline=true"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004994"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
vd-relations/050000058000010c?object-id="
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010c?object-id="
}
]
}

812 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

2.79.1.4.3 Update a virtual document node

This operation is used to modify the attributes of a virtual document node.

Modifying the attributes of virtual document nodes has an impact on the retrieval of
those virtual document nodes.

The following attributes can be updated using this operation:

• order-number
• binding
• override-late-binding
• copy-behavior
• follow-assembly

When you are updating a virtual document node, that node remains within its
specific parent virtual document. When attributes that are not to be updated are
included as part of an update operation, you must make sure that their defined
values align with their existing values. Otherwise, unwanted changes may occur.

Caution
Updating the relation-id, parent-id, or the chronicle-id attributes is
not supported by Documentum REST Services.

You can use the DFC to update the parent-id, and the chronicle-id
attributes. If you are updating any of these attributes, please note the
following items:

• Updating the parent-id of a node causes that node to move to another

virtual document.
• Updating the chronicle-id attribute of a node causes that node to be
removed and replaced with another SysObject.
• The relation-id cannot be updated by DFC or Documentum REST
Services.

2.79.1.4.3.1 HTTP Request method and query parameters

POST

EDCPKRST220200-PRE-EN-01 Reference Guide 813

Chapter 2 Resources

2.79.1.4.3.2 Request headers

• Authorization
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.79.1.4.3.3 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.79.1.4.3.4 Request body

A request is the representation of the virtual document node, with the exception of
the relation-id, the parent-id, and the chronicle-id attributes.

Example 2-370: XML request

Request media type: application/vnd.emc.documentum+xml

POST http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/050000058000010c
Accept: application/vnd.emc.documentum+xml

<dm:vd-node xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:order-number>3000</dm:order-number>
<dm:binding>CURRENT</dm:binding>
<dm:override-late-binding>true</dm:override-late-binding>
<dm:copy-behavior>UNSPECIFIED</dm:copy-behavior>
<dm:follow-assembly>false</dm:follow-assembly>
</dm:vd-node>

Example 2-371: JSON request

Request media type: application/vnd.emc.documentum+json

POST http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/050000058000010c
Accept: application/vnd.emc.documentum+json
{
"order-number": 3000,
"binding": "CURRENT",
"override-late-binding": true,
"copy-behavior": "UNSPECIFIED",
"follow-assembly": falseEEC
}

814 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

2.79.1.4.3.5 Response status

• 200 - Updated successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.79.1.4.3.6 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987

2.79.1.4.3.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.79.1.4.3.8 Response body

Example 2-372: XML response

Status Code: 200 OK
Content-Type: application/vnd.emc.documentum+xml;charset=UTF-8

<?xml version='1.0' encoding='UTF-8'?>

<vd-node xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<parent-id>0900000580005555</parent-id>
<chronicle-id>0900000580005556</chronicle-id>
<relation-id>0500000580000511</relation-id>
<order-number>3000</order-number>
<binding>CURRENT</binding>
<override-late-binding>true</override-late-binding>
<copy-behavior>UNSPECIFIED</copy-behavior>
<follow-assembly>false</follow-assembly>
<properties>
<object_name>restDoc70c04679-bfc6-4ea0-9548-c07184b74742</object_name>
<r_object_type>dm_document</r_object_type>
<r_creation_date>2017-07-05T02:30:51.000+00:00</r_creation_date>
<r_modify_date>2017-07-05T02:30:51.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>0c00000580000107</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>1</r_frzn_assembly_cnt>

EDCPKRST220200-PRE-EN-01 Reference Guide 815

Chapter 2 Resources

<r_has_frzn_assembly>false</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>0c00000580000107</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>0900000580005556</i_chronicle_id>
<i_latest_flag>true</i_latest_flag>
<r_lock_owner>dmadmin</r_lock_owner>
<r_lock_date>2017-07-06T03:23:31.000+00:00</r_lock_date>
<r_lock_machine>cnenwangc31m2.corp.emc.com</r_lock_machine>
<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>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>1</i_vstamp>
<r_object_id>0900000580004994</r_object_id>
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
0500000580000511"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580005556"/>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
0500000580000511"/>
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
0500000580000511"/>
</links>
</vd-node>

Example 2-373: JSON response

Status Code: 200 OK
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"name": "vd-node",

816 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

"parent-id": "09000005800048b3",
"chronicle-id": "0900000580002516",
"relation-id": "050000058000010c",
"order-number": 3000,
"binding": "CURRENT",
"override-late-binding": true,
"copy-behavior": "UNSPECIFIED",
"follow-assembly": false,
"properties": {
"object_name": "restDoc70c04679-bfc6-4ea0-9548-c07184b74742",
"r_object_type": "dm_document",
"r_creation_date": "2017-07-05T02:30:51.000+00:00",
"r_modify_date": "2017-07-05T02:30:51.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": [
"0c00000580000107"
],
"r_link_cnt": 0,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0000000000000000",
"r_frzn_assembly_cnt": 1,
"r_has_frzn_assembly": false,
"r_is_virtual_doc": 0,
"i_contents_id": "0000000000000000",
"r_page_cnt": 0,
"r_content_size": 0,
"a_full_text": true,
"i_cabinet_id": "0c00000580000107",
"owner_name": "dave",
"owner_permit": 7,
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "0900000580005556",
"i_latest_flag": true,
"r_lock_owner": "dmadmin",
"r_lock_date": "2017-07-06T03:23:31.000+00:00",
"r_lock_machine": "cnenwangc31m2.corp.emc.com",
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": true,
"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": 1,
"r_object_id": "0900000580004994"
},

EDCPKRST220200-PRE-EN-01 Reference Guide 817

Chapter 2 Resources

"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010c"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010c"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010c"
}
]
}

2.79.1.4.4 Delete a virtual document node

This operation removes the current node from the virtual document that is specified
in the parent-id attribute.

Tip: When a virtual document has only its root node, deleting that remaining
root node converts the virtual document into a simple document.

2.79.1.4.4.1 HTTP Request method and query parameters

DELETE

2.79.1.4.4.2 Request headers

Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.79.1.4.4.3 Request media types

N/A

818 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

2.79.1.4.4.4 Request body

N/A

2.79.1.4.4.5 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.79.1.4.4.6 Response headers

N/A

2.79.1.4.4.7 Response media types

N/A

2.79.1.4.4.8 Response body

N/A

2.79.1.4.4.9 Examples

Example 2-374: Delete a child node

In the following sample we use the ID of a child node (050000058000010c) to

define the child node that will be removed.

Request
DELETE http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/050000058000010c

Response
Status Code: 204 No Content

Example 2-375: Delete the root node

In the following sample we use the ID of the root node (_root_node_

id_<VIRTUAL_DOCUMENT_ID>) to indicate that the root node will be deleted.
When a virtual document has only its root node, deleting that remaining root
node converts the virtual document into a simple document.

Request
DELETE http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_050000058000010c

Response

EDCPKRST220200-PRE-EN-01 Reference Guide 819

Chapter 2 Resources

Status Code: 204 No Content

2.79.2 Virtual Document Nodes

The Virtual Document Nodes resource represents the virtual document hierarchy of
a flattened feed. You can use this resource to GET the Virtual Document-Hierarchy ,
or Add a Child Node to a Virtual Document.

For information on how to GET a Virtual Document Node, Update a Virtual

Document Node, or Delete a Virtual Document Node, see “Virtual Document Node”
on page 805.

2.79.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “SysObject” on page 690 and About the Diagrams
on page 17.

2.79.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: Feed URI

• Feed Title: Virtual Document Nodes
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: {Link to entry resource definition}
• Entry ID: <EntryURI>
• Entry Title: Object name
• Entry Updated: The modified date

820 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

2.79.2.3 Link relations

Link relation Description Resource reference

self This Virtual Document “Virtual Document Nodes”
Nodes resource on page 820
first, last, next, and previous Pagination links to additional “Virtual Document Nodes”
Virtual Document nodes on page 820

2.79.2.4 Operations
2.79.2.4.1 Supported HTTP methods

Method Description
GET Gets the virtual document hierarchy
POST Add a child node to a virtual document

2.79.2.4.2 Get the virtual document hierarchy

Retrieves the virtual document hierarchy of a specified object. The object can be a
virtual document or an assembly object, which is also known as a “Virtual
Document Snapshot” on page 832.

2.79.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value Default

method parameters range value
GET binding- The symbolic version string N/A null
label label to use when
resolving late binding
nodes.

EDCPKRST220200-PRE-EN-01 Reference Guide 821

Chapter 2 Resources

HTTP Query Description Data type Value Default

method parameters range value
follow- Determines whether the string true, false
assembly server treats the false
SysObject as a Virtual
Document or a Snapshot
for the purposes of
retrieving its nodes or
snapshot nodes
accordingly.

When this parameter is

set to true, the server
treats the SysObject as
a Virtual Document and
retrieves its nodes.

When this parameter is

set to false, the server
treats the SysObject as
a Snapshot, when a
snapshot is available, the
server retrieves its
snapshot nodes.
include- Determines whether to string true, false
broken display nodes with false
broken bindings using
the CURRENT label. When
nodes cannot be bound to
a Virtual Document with
a binding condition, and
this parameter is set to
true, the nodes are
given the CURRENT label
and are then bound to
the Virtual Document.
depth Determines the level of integer -1 or >= 0 1
depth that the virtual
document hierarchy will
be returned. Setting a
value of -1 will return the
whole virtual directory
tree.

822 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

HTTP Query Description Data type Value Default

method parameters range value
inline Whether to include not string true, false
only the attributes of false
virtual document node
but also the properties of <true> -
virtual document Returns
component in the entry the virtual
of atom. document
node and
componen
t within
the entry's
content
element

<false> -
Does not
return the
virtual
document
node.
page For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
links

items-per-
page
vdm-number The node's number in the string N/A null
virtual document tree.
For example 1.2.3

2.79.2.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 823

Chapter 2 Resources

2.79.2.4.2.3 Request media types

N/A

2.79.2.4.2.4 Request body

N/A

2.79.2.4.2.5 Response status

• 200 - Operation was successful

• 400, 401, 403, 404, 500, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.79.2.4.2.6 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.79.2.4.2.7 Response media types

• application/atom+xml
• application/vnd.emc.documentum+json

2.79.2.4.2.8 Response body

XML or JSON representation of the virtual document.

Note: A virtual document, even a childless virtual document, always has at

least one node, the root node.

• The response body contains a list of nodes that are present in the virtual
document.
• The vdm-number attribute is displayed in the summary property of each node,
with the exception of the root node.
• The collection of nodes displayed includes only those nodes to which the REST
client has access.
• Pagination is supported.

Example 2-376: XML - GET the virtual document hierarchy

XML request
GET http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800048b3/
vd-nodes?inline=true
Accept: application/atom+xml

824 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

XML response
Status Code: 200 OK
Content-Type: application/atom+xml;charset=UTF-8

<?xml version='1.0' encoding='utf-8'?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>
http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580004959/vd-nodes</
id>
<title>Virtual Document Nodes</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2017-04-24T02:14:56.531+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/
0900000580004959/vd-nodes?inline=true" />
<entry>
<id>0900000580004959</id>
<title>node-0</title>
<updated>2017-04-24T02:11:51.000+00:00</updated>
<published>2017-04-24T02:11:49.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959" />
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004959" />
<content>
<dm:vd-node xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:selected-object-name>node-0</dm:selected-object-name>
<dm:selected-object-id>0900000580004959</dm:selected-object-id>
<dm:parent-id>0900000580004959</dm:parent-id>
<dm:chronicle-id>0900000580004959</dm:chronicle-id>
<dm:relation-id>_root_node_id_0900000580004959</dm:relation-id>
<dm:order-number>0</dm:order-number>
<dm:binding>CURRENT</dm:binding>
<dm:override-late-binding>true</dm:override-late-binding>
<dm:copy-behavior>0</dm:copy-behavior>
<dm:follow-assembly>false</dm:follow-assembly>
<dm:node-id>0000000000000000</dm:node-id>
<dm:is-virtual-document>true</dm:is-virtual-document>
<dm:late-binding-value>CURRENT</dm:late-binding-value>
<dm:is-binding-broken>false</dm:is-binding-broken>
<dm:are-children-compound>false</dm:are-children-compound>
<dm:available-versions>
<dm:item>CURRENT</dm:item>
<dm:item>1.0</dm:item>
</dm:available-versions>
<dm:can-be-removed>true</dm:can-be-removed>
<dm:can-be-restructured>true</dm:can-be-restructured>
<dm:child-count>1</dm:child-count>
<dm:is-compound>false</dm:is-compound>
<dm:is-from-assembly>false</dm:is-from-assembly>
<dm:is-structurally-modified>false</dm:is-structurally-modified>
<dm:links>
<dm:link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959" />
<dm:link rel="http://identifiers.emc.com/linkrel/virtual-document-component"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004959" />
<dm:link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959" />

EDCPKRST220200-PRE-EN-01 Reference Guide 825

Chapter 2 Resources

<dm:link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959" />
</dm:links>
</dm:vd-node>
</content>
</entry>
<entry>
<id>0900000580004964</id>
<title>node-1.1</title>
<summary>1</summary>
<updated>2017-04-24T02:11:50.000+00:00</updated>
<published>2017-04-24T02:11:50.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b" />
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004964" />
<content>
<dm:vd-node xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:selected-object-name>node-1.1</dm:selected-object-name>
<dm:selected-object-id>0900000580004964</dm:selected-object-id>
<dm:parent-id>0900000580004959</dm:parent-id>
<dm:chronicle-id>090000058000495a</dm:chronicle-id>
<dm:relation-id>050000058000010b</dm:relation-id>
<dm:order-number>1000</dm:order-number>
<dm:binding>2.0</dm:binding>
<dm:override-late-binding>true</dm:override-late-binding>
<dm:copy-behavior>0</dm:copy-behavior>
<dm:follow-assembly>false</dm:follow-assembly>
<dm:node-id>0000000000000001</dm:node-id>
<dm:vdm-number>1</dm:vdm-number>
<dm:is-virtual-document>false</dm:is-virtual-document>
<dm:late-binding-value>2.0</dm:late-binding-value>
<dm:is-binding-broken>false</dm:is-binding-broken>
<dm:are-children-compound>false</dm:are-children-compound>
<dm:available-versions>
<dm:item>CURRENT</dm:item>
<dm:item>3.0</dm:item>
<dm:item>2.0</dm:item>
<dm:item>1.0</dm:item>
</dm:available-versions>
<dm:can-be-removed>true</dm:can-be-removed>
<dm:can-be-restructured>true</dm:can-be-restructured>
<dm:child-count>0</dm:child-count>
<dm:is-compound>false</dm:is-compound>
<dm:is-from-assembly>false</dm:is-from-assembly>
<dm:is-structurally-modified>false</dm:is-structurally-modified>
<dm:links>
<dm:link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b" />
<dm:link rel="http://identifiers.emc.com/linkrel/virtual-document-component"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000058000495a" />
<dm:link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b" />
<dm:link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b" />
</dm:links>
</dm:vd-node>
</content>
</entry>
</feed>

826 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

Example 2-377: JSON - GET the virtual document hierarchy

JSON request
GET http://localhost:8080/dctm-rest/repositories/REPO/objects/09000005800048b3/
vd-nodes?inline=true
Accept: application/vnd.emc.documentum+json

JSON response
Status Code: 200 OK
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/objects/0900000580004959/
vd-nodes",
"title": "Virtual Document Nodes",
"author": [
{
"name": "OpenText Documentum"
}
],
"updated": "2017-04-24T02:15:26.498+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004959/
vd-nodes?inline=true"
}
],
"entries": [
{
"id": "0900000580004959",
"title": "node-0",
"updated": "2017-04-24T02:11:51.000+00:00",
"published": "2017-04-24T02:11:49.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004959"
}
],
"content": {
"name": "vd-node",
"selected-object-name": "node-0",
"selected-object-id": "0900000580004959",
"parent-id": "0900000580004959",
"chronicle-id": "0900000580004959",
"relation-id": "_root_node_id_0900000580004959",
"order-number": 0,
"binding": "CURRENT",
"override-late-binding": true,
"copy-behavior": 0,
"follow-assembly": false,
"node-id": "0000000000000000",
"is-virtual-document": true,
"late-binding-value": "CURRENT",
"is-binding-broken": false,
"are-children-compound": false,

EDCPKRST220200-PRE-EN-01 Reference Guide 827

Chapter 2 Resources

"available-versions": [
"CURRENT",
"1.0"
],
"can-be-removed": true,
"can-be-restructured": true,
"child-count": 1,
"is-compound": false,
"is-from-assembly": false,
"is-structurally-modified": false,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004959"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959"
}
]
}
},
{
"id": "0900000580004964",
"title": "node-1.1",
"summary": "1",
"updated": "2017-04-24T02:11:50.000+00:00",
"published": "2017-04-24T02:11:50.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004964"
}
],
"content": {
"name": "vd-node",
"selected-object-name": "node-1.1",
"selected-object-id": "0900000580004964",
"parent-id": "0900000580004959",
"chronicle-id": "090000058000495a",
"relation-id": "050000058000010b",
"order-number": 1000,
"binding": "2.0",
"override-late-binding": true,
"copy-behavior": 0,
"follow-assembly": false,
"node-id": "0000000000000001",
"vdm-number": "1",
"is-virtual-document": false,
"late-binding-value": "2.0",
"is-binding-broken": false,
"are-children-compound": false,

828 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

"available-versions": [
"CURRENT",
"3.0",
"2.0",
"1.0"
],
"can-be-removed": true,
"can-be-restructured": true,
"child-count": 0,
"is-compound": false,
"is-from-assembly": false,
"is-structurally-modified": false,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000058000495a"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b"
}
]
}
}
]
}

2.79.2.4.3 Add a child node to a virtual document

You can use this operation when you want to add a new child node to a SysObject
that is either a virtual document or a simple document. When the SysObject is a
simple document, using this operation converts it into a virtual document after a
child node is added to it.

Converting a simple document into virtual document is considered a special usage

for adding a node. When you want to convert a simple document into a childless
virtual document, you can submit an empty Request body using the POST method.
After the Request has successfully completed, the virtual document has only a root
node.

EDCPKRST220200-PRE-EN-01 Reference Guide 829

Chapter 2 Resources

2.79.2.4.3.1 HTTP Request method and query parameters

POST

2.79.2.4.3.2 Request headers

Authorization,

Accept

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.79.2.4.3.3 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.79.2.4.3.4 Request body

When adding a node, the <order-number> attribute takes effect only when the new
node is not the last child node. Otherwise, DFC automatically assigns a value for the
<order-number>. For example, if there are two nodes with <order-numbers> 1000 and
2000; and a new node with <order-number> 3500 is added, the resulting <order-
number> for the new node will be 3000, not 3500.

Similarly, when adding the first node to a virtual document; the <order-number> is
automatically set and will always be 1000.

Example 2-378: XML request

<dm:vd-node xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<dm:chronicle-id>0900000580002516</dm:chronicle-id>
<dm:order-number>3000</dm:order-number>
<dm:binding>CURRENT</dm:binding>
<dm:override-late-binding>true</dm:override-late-binding>
<dm:copy-behavior>0</dm:copy-behavior>
<dm:follow-assembly>false</dm:follow-assembly>
</dm:vd-node>

Example 2-379: JSON request

{
"binding": "CURRENT",
"copy-behavior": 0,
"follow-assembly": false,
"order-number": 3000,
"override-late-binding": true,
"chronicle-id": "0900000580002516"
}

830 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.79. Virtual Document Node (s)

2.79.2.4.3.5 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, etc.
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985

2.79.2.4.3.6 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987

2.79.2.4.3.7 Response media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.79.2.4.3.8 Response body

Example 2-380: XML response

<?xml version='1.0' encoding='utf-8'?>
<vd-node xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<parent-id>09000005800048b3</parent-id>
<chronicle-id>0900000580002516</chronicle-id>
<relation-id>050000058000010b</relation-id>
<order-number>3000</order-number>
<binding>CURRENT</binding>
<override-late-binding>true</override-late-binding>
<copy-behavior>0</copy-behavior>
<follow-assembly>false</follow-assembly>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b" />
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516" />
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b" />
<link rel="http://identifiers.emc.com/linkrel/delete"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b" />
</links>
</vd-node>

Example 2-381: JSON response

{
"name": "vd-node",
"parent-id": "09000005800048b3",
"chronicle-id": "0900000580002516",
"relation-id": "050000058000010a",

EDCPKRST220200-PRE-EN-01 Reference Guide 831

Chapter 2 Resources

"order-number": 3000,
"binding": "CURRENT",
"override-late-binding": true,
"copy-behavior": 0,
"follow-assembly": false,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010a"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580002516"
},
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010a"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010a"
}
]
}

2.80 Virtual Document Snapshot(s)

2.80.1 Virtual Document Snapshot
This resource represents a snapshot of a virtual document. A snapshot allows you to
view the details of a virtual document at a specific point in time. You can use this
resource to view the details of a snapshot or to remove a specific snapshot.

Note: For information on how to create a snapshot, see “Create a snapshot”

on page 843.

2.80.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

832 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.80. Virtual Document Snapshot(s)

For more information, see “Virtual Document Snapshots” on page 838 and About
the Diagrams on page 17.

2.80.1.2 Feed
No feed support.

2.80.1.3 Link relations

Link relation Description Resource reference

self This object resource “Virtual Document Snapshot”
on page 832
snapshot-nodes The virtual document nodes in a “Virtual Document Snapshot
[1] snapshot Nodes” on page 848
freeze [1] Used to freeze a snapshot “Virtual Document Snapshot
Frozen” on page 853
unfreeze [1] Used to unfreeze a snapshot “Virtual Document Snapshot
Frozen” on page 853
virtual- The virtual document object that is “SysObject” on page 690
document [1] associated with the snapshot
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.80.1.4 Operations
2.80.1.4.1 Supported HTTP methods

Method Description
GET Retrieves the snapshot from a repository
DELETE Deletes the snapshot, but leaves the existing
SysObject used to create the snapshot

2.80.1.4.2 Get a Snapshot

This operation retrieves the associated Snapshot of a specified virtual document.

EDCPKRST220200-PRE-EN-01 Reference Guide 833

Chapter 2 Resources

2.80.1.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.

2.80.1.4.2.2 Request headers

• Authorization

• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.80.1.4.2.3 Request media types

N/A

2.80.1.4.2.4 Request body

N/A

2.80.1.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on

For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.80.1.4.2.6 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.80.1.4.2.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml

• application/vnd.emc.documentum+json

• application/json

834 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.80. Virtual Document Snapshot(s)

2.80.1.4.2.8 Response body

Example 2-382: XML response

<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>snaphot for vd 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>

EDCPKRST220200-PRE-EN-01 Reference Guide 835

Chapter 2 Resources

<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>

Example 2-383: JSON response

{
"name": "vd-snapshot",
"type": "dm_sysobject",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject",
"properties": {
"object_name": "snaphot for vd 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",

836 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.80. Virtual Document Snapshot(s)

"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"
}
]
}

2.80.1.4.3 Delete a snapshot

This operation deletes a snapshot that is associated with a virtual document. The
delete link is not available when the snapshot is frozen.

2.80.1.4.3.1 HTTP Request method and query parameters

DELETE

EDCPKRST220200-PRE-EN-01 Reference Guide 837

Chapter 2 Resources

2.80.1.4.3.2 Request headers

Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.80.1.4.3.3 Request media types

N/A

2.80.1.4.3.4 Request body

N/A

2.80.1.4.3.5 Response status

• 204 - Deleted successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.80.1.4.3.6 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987

2.80.1.4.3.7 Response media types

N/A

2.80.1.4.3.8 Response body

N/A

2.80.2 Virtual Document Snapshots

This resource provides a list of Virtual Document Snapshots in a repository as a
feed. You can use this resource to get a list of Snapshots, or to create a new Snapshot
of a Virtual Document.

838 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.80. Virtual Document Snapshot(s)

2.80.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Repository” on page 562 and About the Diagrams
on page 17.

2.80.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: <Feed_URI>

• Feed Title: Virtual Document Snapshots
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: Virtual-document-snapshot
• Entry ID: <Entry_URI>
• Entry Title: Object name
• Entry Updated: Modified date

2.80.2.3 Link relations

Link relation Description Resource reference

self This Virtual Document “Virtual Document
Snapshots resource. Snapshots” on page 838
first, last, next, previous Pagination links “Virtual Document
Snapshots” on page 838

2.80.2.4 Operations

EDCPKRST220200-PRE-EN-01 Reference Guide 839

Chapter 2 Resources

2.80.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a list of Snapshots from a
repository and presents them as a feed.
POST Creates a snapshot for a Virtual Document
and associates it with an existing
SysObject or a new SysObject.

2.80.2.4.2 Get Snapshots

This operation retrieves a list of snapshots for a specified virtual document and
presents them as a feed.

2.80.2.4.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
GET • inline For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
• page
• items-
per-
page
• filter
• links

Example 2-384: Use a filter to get a snapshot for a specific virtual

document

Here's a code sample that demonstrates how to use a filter expression to get a
list of Snapshots for a specific virtual document. In the following example, the
object id of the virtual document is used as the criteria to retrieve a list of
Snapshots.
filter=r_assembled_from_id='<VIRTUAL_DOCUMENT_OBJECT_ID>'

840 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.80. Virtual Document Snapshot(s)

2.80.2.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.80.2.4.2.3 Request media types

N/A

2.80.2.4.2.4 Request body

N/A

2.80.2.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.80.2.4.2.6 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.80.2.4.2.7 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.80.2.4.2.8 Response body

Example 2-385: XML response

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/snapshots</id>
<title>Virtual Document Snapshots</title>
<author>
<name>OpenText 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>

EDCPKRST220200-PRE-EN-01 Reference Guide 841

Chapter 2 Resources

<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>snaphot for vd 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>

Example 2-386: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots",
"title": "Virtual Document Snapshots",
"author": [
{
"name": "OpenText 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": "snaphot for vd 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"
}

842 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.80. Virtual Document Snapshot(s)

],
"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"
}
}
]
}

2.80.2.4.3 Create a snapshot

This operation creates a new snapshot of a virtual document.

2.80.2.4.3.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
POST binding- The symbolic string N/A CURRENT
label version label
to use to
resolve late
bound nodes
include- Specifies string true/false false
broken whether to
display nodes
with broken
bindings
using the
CURRENT
label

EDCPKRST220200-PRE-EN-01 Reference Guide 843

Chapter 2 Resources

HTTP Query Description Data type Value range Default value

method parameters
frozen Specifies string true/false true
whether to
freeze the
snapshot
right after
creation

2.80.2.4.3.2 Request headers

• Authorization
• Accept
• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.80.2.4.3.3 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json

2.80.2.4.3.4 Request body

Example 2-387: Create a new snapshot

In the request shown below, the metadata of the snapshot is used to create a
new snapshot from scratch and the virtual document reference is used to
associate it with a virtual document. The system creates a new object as a
Snapshot.

XML - Request media type: application/vnd.emc.documentum+xml

<vd-snapshot vd-href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000058000fe6c">
<properties>
<object_name>snaphot for vd 2f0479c4-7bb8-4904-abb0-95a2999c6043</object_name>
<r_object_type>dm_sysobject</r_object_type>
</properties>
</vd-snapshot>

JSON - Request media type: application/vnd.emc.documentum+json

{
"name": "vd-snapshot",
"vd-href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000058000fe6c",
"properties": {
"object_name":"snaphot for vd 2f0479c4-7bb8-4904-abb0-95a2999c6043",
"r_object_type":"dm_sysobject"
}
}

844 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.80. Virtual Document Snapshot(s)

Example 2-388: Create a snapshot from an existing SysObject

In the Request below, a snapshot is created from an existing SysObject. A

reference to an existing SysObject and a virtual document are defined in the
Request. The system creates a new object as a Snapshot of the specified
SysObject.

XML - Request media type: application/vnd.emc.documentum+xml

<vd-snapshot vd-href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000058000fe6c"
snapshot-href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000058000ff20">
</virtual-document-snapshot>

JSON - Request media type: application/vnd.emc.documentum+json

{
"name": "vd-snapshot",
"vd-href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000058000fe6c",
"snapshot-href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
080000058000ccd8",
}

2.80.2.4.3.5 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.80.2.4.3.6 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987

2.80.2.4.3.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

EDCPKRST220200-PRE-EN-01 Reference Guide 845

Chapter 2 Resources

2.80.2.4.3.8 Response body

Example 2-389: XML response

<?xml version='1.0' encoding='UTF-8'?>
<vd-snapshot definition="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_sysobject" xmlns="http://identifiers.emc.com/vocab/
documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_sysobject">
<properties>
<object_name>snaphot for vd 2f0479c4-7bb8-4904-abb0-95a2999c6043</object_name>
<r_object_type>dm_sysobject</r_object_type>
<r_creation_date>2017-05-14T09:58:35.000+00:00</r_creation_date>
<r_modify_date>2017-05-14T09:58:40.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>2</i_reference_cnt>
<i_has_folder>true</i_has_folder>
<i_folder_id>
<item>0c00000580001909</item>
<item>0c00000580000107</item>
</i_folder_id>
<r_link_cnt>0</r_link_cnt>
<r_link_high_cnt>0</r_link_high_cnt>
<r_assembled_from_id>090000058000ccce</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>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>080000058000ccd8</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>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>3</i_vstamp>
<r_object_id>080000058000ccd8</r_object_id>
</properties>

846 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.80. Virtual Document Snapshot(s)

<links>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/
080000058000ccd8" rel="self"/>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/snapshots/
080000058000ccd8/frozen" rel="http://identifiers.emc.com/linkrel/
unfreeze"/>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
090000058000ccce"
rel="http://identifiers.emc.com/linkrel/virtual-document"/>
</links>
</vd-snapshot>

Example 2-390: JSON response

{
"name":"vd-snapshot",
"type":"dm_sysobject",
"definition":"http://localhost:8080/dctm-rest/repositories/REPO/types/dm_sysobject",
"properties":{
"object_name":"snaphot for vd 2f0479c4-7bb8-4904-abb0-95a2999c6043",
"r_object_type":"dm_sysobject",
"r_creation_date":"2017-05-14T09:58:35.000+00:00",
"r_modify_date":"2017-05-14T09:58:40.000+00:00",
"r_modifier":"dave",
"a_is_hidden":false,
"i_is_deleted":false,
"a_archive":false,
"a_link_resolved":false,
"i_reference_cnt":2,
"i_has_folder":true,
"i_folder_id":[
"0c00000580001909",
"0c00000580000107"
],
"r_link_cnt":0,
"r_link_high_cnt":0,
"r_assembled_from_id":"090000058000ccce",
"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":"0c00000580001909",
"owner_name":"dave",
"owner_permit":7,
"group_permit":5,
"world_permit":3,
"i_antecedent_id":"0000000000000000",
"i_chronicle_id":"080000058000ccd8",
"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":"dave",
"acl_name":"dm_4500000580000d07",
"i_is_reference":false,
"r_creator_name":"dave",
"r_is_public":true,

EDCPKRST220200-PRE-EN-01 Reference Guide 847

Chapter 2 Resources

"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.0,
"a_is_signed":false,
"i_partition":0,
"i_is_replica":false,
"i_vstamp":3,
"r_object_id":"080000058000ccd8"
},
"links":[
{
"rel":"self",
"href":"http://localhost:8080/dctm-rest/repositories/REPO/snapshots/
080000058000ccd8"
},
{
"rel":"http://identifiers.emc.com/linkrel/unfreeze",
"href":"http://localhost:8080/dctm-rest/repositories/REPO/snapshots/
080000058000ccd8/frozen"
},
{
"rel":"http://identifiers.emc.com/linkrel/virtual-document",
"href":"http://localhost:8080/dctm-rest/repositories/REPO/objects/090000058000ccce"
}
]
}

2.81 Virtual Document Snapshot Nodes

This resource represents the components hierarchy of a virtual document snapshot .

2.81.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Virtual Document Snapshot” on page 832 and About the
Diagrams on page 17.

848 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.81. Virtual Document Snapshot Nodes

2.81.2 Feed
Is this resource a feed? Yes.

• Feed ID: <Feed_URI>

• Feed Title: Virtual Document Nodes
• Feed Updated: Server's current time
• Supports POST: No
• Entry: Link to entry resource definition
• Entry ID: <Entry_URI>
• Entry Title: Object name
• Entry Updated: Modified date

Link relations Description Resource reference

self This resource “Virtual Document Snapshot
Nodes” on page 848
first, last, next, previous Pagination links “Virtual Document Snapshot
Nodes” on page 848

2.81.3 Operations
2.81.3.1 Supported HTTP methods

Method Description
GET Retrieves the virtual document nodes
hierarchy of a specified snapshot object.

2.81.3.2 Get snapshot nodes

This operation retrieves the virtual document nodes hierarchy of a specified
snapshot object.

2.81.3.2.1 HTTP Request method and query parameters

EDCPKRST220200-PRE-EN-01 Reference Guide 849

Chapter 2 Resources

HTTP Query Description Data type Value Default

method parameters range value
GET • inline For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979.
• page
• items-
per-
page
• filter
• links
depth To what depth level in the int -1 or any 1
virtual document integer >=0
hierarchy that is returned.

A value of -1 returns the

whole virtual document
tree.
vdm-number The node's number in the string N/A null
virtual document tree. The
schema of <vdm-number> is
based on the level of the
node, for example:
• 1st level: 1, 2, 3, ...
• 2nd level: 1.1, 1.2,
1.3, ...
• 3rd level: 1.1.1, 1.1.2,
1.1.3, ...
• ...
object-id The object id of the virtual string N/A N/A
document component of
the current virtual
document node.

When the <object-id>

parameter is set, the
properties of the virtual
document component,
defined by the <object-id>,
is returned.

When the <object-id>

parameter is not specified,
the properties of the
CURRENT version virtual
document component are
returned.

850 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.81. Virtual Document Snapshot Nodes

2.81.3.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.81.3.2.3 Request media types

N/A

2.81.3.2.4 Request body

N/A

2.81.3.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.81.3.2.6 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.81.3.2.7 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.81.3.2.8 Response body

Example 2-391: XML response

<?xml version='1.0' encoding='UTF-8'?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/snapshots/0900000580004959/
vd-nodes</id>
<title>Virtual Document Nodes</title>
<author>
<name>OpenText Documentum</name>
</author>
<updated>2017-04-24T02:14:18.901+00:00</updated>
<dm:page xmlns:dm="http://identifiers.emc.com/vocab/documentum">1</dm:page>

EDCPKRST220200-PRE-EN-01 Reference Guide 851

Chapter 2 Resources

<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/
0900000580004959/vd-nodes"/>
<entry>
<id>0900000580004959</id>
<title>node-0</title>
<updated>2017-04-24T02:11:51.000+00:00</updated>
<published>2017-04-24T02:11:49.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004959"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959"/>
</entry>
<entry>
<id>0900000580004964</id>
<title>node-1.1</title>
<summary>1</summary>
<updated>2017-04-24T02:11:50.000+00:00</updated>
<published>2017-04-24T02:11:50.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document-component"
href="http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004964"/>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b"/>
</entry>
</feed>

Example 2-392: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/0900000580004959/
vd-nodes",
"title": "Virtual Document Nodes",
"author": [
{
"name": "OpenText Documentum"
}
],
"updated": "2017-04-24T02:13:33.010+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/snapshots/
0900000580004959/vd-nodes"
}
],
"entries": [
{
"id": "0900000580004959",
"title": "node-0",
"updated": "2017-04-24T02:11:51.000+00:00",
"published": "2017-04-24T02:11:49.000+00:00",

852 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.82. Virtual Document Snapshot Frozen

"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004959"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
_root_node_id_0900000580004959"
}
},
{
"id": "0900000580004964",
"title": "node-1.1",
"summary": "1",
"updated": "2017-04-24T02:11:50.000+00:00",
"published": "2017-04-24T02:11:50.000+00:00",
"links": [
{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document-component",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/objects/
0900000580004964"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/vd-relations/
050000058000010b"
}
}
]
}

2.82 Virtual Document Snapshot Frozen

This resource allows you to freeze an unfrozen snapshot or unfreeze a frozen
snapshot.

EDCPKRST220200-PRE-EN-01 Reference Guide 853

Chapter 2 Resources

2.82.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Virtual Document Snapshot” on page 832 and About the
Diagrams on page 17.

2.82.2 Feed
No feed support.

2.82.3 Operations
2.82.3.1 Supported HTTP methods

Method Description
PUT Freeze an unfrozen snapshot.
DELETE Unfreezes a frozen snapshot.

2.82.3.2 Freeze a snapshot

This operation freezes an unfrozen snapshot. An attempt to freeze a snapshot that is
already frozen will cause a 409 error to occur.

A frozen snapshot is a document that has been explicitly marked as immutable. You
cannot modify the content or properties of a frozen snapshot, nor can you add or
remove any snapshot components. The contents and attributes of objects that are
included in a frozen snapshot cannot be modified and these objects cannot be
destroyed.

2.82.3.2.1 HTTP Request method and query parameters

HTTP Query Description Data type Value range Default value

method parameters
PUT N/A For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979

854 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.82. Virtual Document Snapshot Frozen

2.82.3.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.82.3.2.3 Request media types

N/A

2.82.3.2.4 Request body

N/A

2.82.3.2.5 Response status

• 200 - Freeze of the snapshot was successful

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.82.3.2.6 Response headers

Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.82.3.2.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json

2.82.3.2.8 Response body

When the freeze operation is successful, the response body contains a frozen
snapshot object. There is an unfreeze link in the response snapshot object that
allows the client to unfreeze this snapshot. Since a frozen snapshot cannot be
removed, there is no delete link.

Example 2-393: XML response

<?xml version='1.0' encoding='UTF-8'?>
<vd-snapshot
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

EDCPKRST220200-PRE-EN-01 Reference Guide 855

Chapter 2 Resources

xsi:type="dm_sysobject"
definition="http://localhost:8080/dctm-rest/repositories/ubuntudb/types/
dm_sysobject">
<properties>
<object_name>TEST-SNAPSHOT-c5c2d13d-dfe5-43a3-bd6d-b485504f0d7b</object_name>
<r_object_type>dm_sysobject</r_object_type>
<r_creation_date>2017-06-02T08:52:15.000+00:00</r_creation_date>
<r_modify_date>2017-06-02T08:57:57.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>0c00a79e80002128</item>
</i_folder_id>
<r_link_cnt>0</r_link_cnt>
<r_link_high_cnt>0</r_link_high_cnt>
<r_assembled_from_id>0900a79e80002407</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>0c00a79e80002128</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>0800a79e800022f7</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>dave</acl_domain>
<acl_name>dm_4500a79e80000916</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>0800a79e800022f7</r_object_id>
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7"/>
<link rel="canonical"
href="http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document"

856 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.82. Virtual Document Snapshot Frozen

href="http://localhost:8080/dctm-rest/repositories/ubuntudb/objects/
0900a79e80002407"/>
<link rel="http://identifiers.emc.com/linkrel/unfreeze"
href="http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7/frozen"/>
</links>
</vd-snapshot>

Example 2-394: JSON response

{
"name": "vd-snapshot",
"type": "dm_sysobject",
"definition":"http://localhost:8080/dctm-rest/repositories/ubuntudb/types/
dm_sysobject",
"properties": {
"object_name": "TEST-SNAPSHOT-c5c2d13d-dfe5-43a3-bd6d-b485504f0d7b",
"r_object_type": "dm_sysobject",
"r_creation_date": "2017-06-02T08:52:15.000+00:00",
"r_modify_date": "2017-06-02T08:58:24.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": [
"0c00a79e80002128"
],
"r_link_cnt": 0,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0900a79e80002407",
"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": "0c00a79e80002128",
"owner_name": "dave",
"owner_permit": 7,
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "0800a79e800022f7",
"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": "dave",
"acl_name": "dm_4500a79e80000916",
"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",

EDCPKRST220200-PRE-EN-01 Reference Guide 857

Chapter 2 Resources

"a_is_template": false,
"r_full_content_size": 0,
"a_is_signed": false,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 7,
"r_object_id": "0800a79e800022f7"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7"
},
{
"rel": "canonical",
"href": "http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document",
"href": "http://localhost:8080/dctm-rest/repositories/ubuntudb/objects/
0900a79e80002407"
},
{
"rel": "http://identifiers.emc.com/linkrel/unfreeze",
"href": "http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7/frozen"
}
]
}

2.82.3.2.9 More samples

Example 2-395: An XML request

PUT /dctm-rest/repositories/ubuntudb/snapshots/0800a79e800022f7/frozen HTTP/1.1

Host: localhost:8080
Accept: application/vnd.emc.documentum+xml

Example 2-396: An XML response

Status: 200
Content-Type: application/vnd.emc.documentum+xml;charset=UTF-8

<?xml version='1.0' encoding='UTF-8'?>

<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/ubuntudb/types/
dm_sysobject">
<properties>
<object_name>TEST-SNAPSHOT-c5c2d13d-dfe5-43a3-bd6d-b485504f0d7b</object_name>
<r_object_type>dm_sysobject</r_object_type>
<r_creation_date>2017-06-02T08:52:15.000+00:00</r_creation_date>
<r_modify_date>2017-06-02T08:57:57.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>

858 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.82. Virtual Document Snapshot Frozen

<i_reference_cnt>1</i_reference_cnt>
<i_has_folder>true</i_has_folder>
<i_folder_id>
<item>0c00a79e80002128</item>
</i_folder_id>
<r_link_cnt>0</r_link_cnt>
<r_link_high_cnt>0</r_link_high_cnt>
<r_assembled_from_id>0900a79e80002407</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>0c00a79e80002128</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>0800a79e800022f7</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>dave</acl_domain>
<acl_name>dm_4500a79e80000916</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>0800a79e800022f7</r_object_id>
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7"/>
<link rel="canonical"
href="http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7"/>
<link rel="http://identifiers.emc.com/linkrel/virtual-document"
href="http://localhost:8080/dctm-rest/repositories/ubuntudb/objects/
0900a79e80002407"/>
<link rel="http://identifiers.emc.com/linkrel/unfreeze"
href="http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7/frozen"/>
</links>
</vd-snapshot>

EDCPKRST220200-PRE-EN-01 Reference Guide 859

Chapter 2 Resources

Example 2-397: A JSON request

PUT /dctm-rest/repositories/ubuntudb/snapshots/0800a79e800022f7/frozen HTTP/1.1

Host: localhost:8080
Accept: application/vnd.emc.documentum+json

Example 2-398: A JSON response

Status: 200
Content-Type: application/vnd.emc.documentum+json;charset=UTF-8

{
"name": "vd-snapshot",
"type": "dm_sysobject",
"definition": "http://localhost:8080/dctm-rest/repositories/ubuntudb/types/
dm_sysobject",
"properties": {
"object_name": "TEST-SNAPSHOT-c5c2d13d-dfe5-43a3-bd6d-b485504f0d7b",
"r_object_type": "dm_sysobject",
"r_creation_date": "2017-06-02T08:52:15.000+00:00",
"r_modify_date": "2017-06-02T08:58:24.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": [
"0c00a79e80002128"
],
"r_link_cnt": 0,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0900a79e80002407",
"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": "0c00a79e80002128",
"owner_name": "dave",
"owner_permit": 7,
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "0800a79e800022f7",
"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": "dave",
"acl_name": "dm_4500a79e80000916",
"i_is_reference": false,
"r_creator_name": "dave",
"r_is_public": true,
"r_policy_id": "0000000000000000",
"r_resume_state": 0,

860 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.82. Virtual Document Snapshot Frozen

"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": 7,
"r_object_id": "0800a79e800022f7"
},
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7"
},
{
"rel": "canonical",
"href": "http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7"
},
{
"rel": "http://identifiers.emc.com/linkrel/virtual-document",
"href": "http://localhost:8080/dctm-rest/repositories/ubuntudb/objects/
0900a79e80002407"
},
{
"rel": "http://identifiers.emc.com/linkrel/unfreeze",
"href": "http://localhost:8080/dctm-rest/repositories/ubuntudb/snapshots/
0800a79e800022f7/frozen"
}
]
}

2.82.3.3 Unfreeze a snapshot

This operation unfreezes a snapshot. Unfreezing a snapshot makes the snapshot
changeable again.

Note: An attempt to unfreeze a snapshot that is already unfrozen will cause a

409 error to occur.

2.82.3.3.1 HTTP Request method and query parameters

DELETE

2.82.3.3.2 Request headers

• Authorization
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 861

Chapter 2 Resources

2.82.3.3.3 Request media types

N/A

2.82.3.3.4 Request body

N/A

2.82.3.3.5 Response status

• 204 - Unfrozen successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.82.3.3.6 Response headers

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987

2.82.3.3.7 Response media types

N/A

2.82.3.3.8 Response body

N/A

2.82.3.4 More samples

Example 2-399: Request
DELETE /dctm-rest/repositories/ubuntudb/snapshots/0800a79e800022f7/frozen HTTP/1.1
Host: localhost:8080
Authorization: Basic ZG1hZG1pbjpwYXNzd29yZA==

Example 2-400: Response

Status: 204

862 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.83. Word Suggestions

2.83 Word Suggestions

The Word Suggestions resource is part of a suite of services that allows you to use the
Documentum Contextual Content Engine (CCE). This particular resource is used to
suggest words that can be used in searches. It suggests words that are pronounced
similarly but have different meanings, known as Homophones. It also suggests words
by using auto-complete or auto-suggest, also known as Typeahead, functionality. In
each of the above cases, this resource makes word suggestions that help users get the
highest and best use of the Documentum CCE to search for content.

2.83.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Repository” on page 562 and About the Diagrams
on page 17.

2.83.2 Feed
Is this resource a feed? Yes.

• Feed ID: Resource URI

• Feed Title: Word Suggestions from CCE
• Feed Updated: Server's current time
• Supports POST: No
• Entry: No Resource
• Entry ID: The resource URI with a word as a query parameter. For example
{repoUri}/cce/suggestions?word=xxx

• Entry Title: The word suggestion from CCE

• Entry Updated: Current server time

EDCPKRST220200-PRE-EN-01 Reference Guide 863

Chapter 2 Resources

2.83.3 Link relations

Link relation Description Resource reference
self Link to this resource “Word Suggestions” on page 863
search [1] A template link formed by the “Search” on page 643
search keyword
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.83.4 Operations
2.83.4.1 Supported HTTP methods

Method Description
GET Retrieves the word suggestions for requested
words.

2.83.4.2 Get Word Suggestions

This operation retrieves word suggestions for requested words.

2.83.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
GET page, items- For more information, see Appendix B, REST Common
per-page, Definition - URI Request Query Parameters on page 979
links
word The word Any string String null
that you want
to get content
suggestions
for
suggestion- Determines all, String typeahead null
view whether to homophone,
show all typeahead
suggestions,
only
homophones
suggestions,
or just
typeahead
suggestions

864 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.83. Word Suggestions

2.83.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.83.4.2.3 Request media types

N/A

2.83.4.2.4 Request body

N/A

2.83.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.83.4.2.6 Response headers

• Content-Type
• Location

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.83.4.2.7 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

EDCPKRST220200-PRE-EN-01 Reference Guide 865

Chapter 2 Resources

2.83.4.2.8 Response body

Example 2-401: XML response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:xsi="http://www.w3.org/
2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/cce/suggestions</id>
<title>Word Suggestion from CCE</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2018-08-10T08:24:04.374+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/
cce/suggestions?word=manager"></link>
<link rel="http://identifiers.emc.com/linkrel/search"
hreftemplate="http://localhost:8080/dctm-rest/repositories/REPO/
search{?collections,facet,inline,items-per-page,
locations,object-type,page,q,sort,timezone,view}">
</link>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/cce/suggestions?
word=manager</id>
<title>managers</title>
<summary>Type Ahead Service Result</summary>
<updated>2018-08-10T08:24:04.375+00:00</updated>
<published>2018-08-10T08:24:04.375+00:00</published>
<link rel="http://identifiers.emc.com/linkrel/search"
href="http://localhost:8080/dctm-rest/repositories/
REPO/search?q=managers"></link>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/cce/
suggestions?word=manager"></content>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/cce/suggestions?
word=manager</id>
<title>manager job</title>
<summary>Type Ahead Service Result</summary>
<updated>2018-08-10T08:24:04.375+00:00</updated>
<published>2018-08-10T08:24:04.375+00:00</published>
<link rel="http://identifiers.emc.com/linkrel/search"
href="http://localhost:8080/dctm-rest/repositories/REPO/search?
q=manager%20job"></link>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/cce/
suggestions?word=manager"></content>
</entry>
</feed>

Example 2-402: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/suggestions",
"title": "Word Suggestion from CCE",
"author": [
{
"name": "Open Text Documentum"
}
],

866 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.83. Word Suggestions

"updated": "2018-08-10T08:15:12.160+00:00",
"page": 1,
"items-per-page": 100,
"links": [
{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
suggestions?word=manager"
},
{
"rel": "http://identifiers.emc.com/linkrel/search",
"hreftemplate": "http://localhost:8080/dctm-rest/repositories/
REPO/search{?collections,facet,inline,
items-per-page,locations,object-type,page,q,sort,
timezone,view}"
}
],
"entries": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
suggestions?word=manager",
"title": "managers",
"summary": "Type Ahead Service Result ",
"updated": "2018-08-10T08:15:12.166+00:00",
"published": "2018-08-10T08:15:12.166+00:00",
"links": [
{
"rel": "http://identifiers.emc.com/linkrel/search",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/search?q=managers"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
suggestions?word=manager"
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
suggestions?word=manager",
"title": "manager job",
"summary": "Type Ahead Service Result ",
"updated": "2018-08-10T08:15:12.167+00:00",
"published": "2018-08-10T08:15:12.167+00:00",
"links": [
{
"rel": "http://identifiers.emc.com/linkrel/search",
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/search?q=manager%20job"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
suggestions?word=manager"
}
}
]
}

Example 2-403: HAL: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/suggestions",
"title": "Word Suggestion from CCE",

EDCPKRST220200-PRE-EN-01 Reference Guide 867

Chapter 2 Resources

"author": [
{
"name": "Open Text Documentum"
}
],
"updated": "2018-08-10T08:24:42.101+00:00",
"page": 1,
"items-per-page": 100,
"_embedded": {
"collection": [
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
suggestions?word=manager",
"title": "managers",
"summary": "Type Ahead Service Result ",
"updated": "2018-08-10T08:24:42.102+00:00",
"published": "2018-08-10T08:24:42.102+00:00",
"_links": {
"http://identifiers.emc.com/linkrel/search": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/search?q=managers"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/cce/suggestions?word=manager"
}
}
},
{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
suggestions?word=manager",
"title": "manager job",
"summary": "Type Ahead Service Result ",
"updated": "2018-08-10T08:24:42.102+00:00",
"published": "2018-08-10T08:24:42.102+00:00",
"_links": {
"http://identifiers.emc.com/linkrel/search": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/search?q=manager%20job"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/cce/suggestions?word=manager"
}
}
}
]
},
"_links": {
"http://identifiers.emc.com/linkrel/search": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
search{?collections,facet,inline,
items-per-page,locations,object-type,page,q,sort,
timezone,view}",
"templated": true
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/cce/
suggestions?word=manager"
}
}
}

868 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.84. Work Item(s)

2.84 Work Item(s)

2.84.1 Work Item
The Work Item resource is used to get a specified work item.

2.84.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Work Items” on page 873 and About the Diagrams
on page 17.

2.84.1.2 Feed
No feed support.

2.84.1.3 Link relations

Link relation Description Resource reference

self Link to this resource “Work Item” on page 869
workflow [1] A workflow object “Workflow” on page 906
workflow-activity A workflow-activity object “Workflow Activity”
[1] on page 935
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.84.1.4 Operations

EDCPKRST220200-PRE-EN-01 Reference Guide 869

Chapter 2 Resources

2.84.1.4.1 Supported HTTP methods

Method Description
GET Retrieves a work item

2.84.1.4.2 Get Work Item

This operation retrieves a Work Item object.

2.84.1.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data Value Defaul

method parameters type range t value
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979
view

2.84.1.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.84.1.4.2.3 Request media types

N/A

2.84.1.4.2.4 Request body

N/A

2.84.1.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

870 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.84. Work Item(s)

2.84.1.4.2.6 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.84.1.4.2.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.84.1.4.2.8 Response body

Example 2-404: XML response

<?xml version="1.0" encoding="UTF-8"?>
<work-item
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/
dmi_workitem"
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dmi_workitem">
<properties>
<r_workflow_id>4d00000180000100</r_workflow_id>
<r_act_seqno>4</r_act_seqno>
<r_performer_name>dmadmin</r_performer_name>
<r_creation_date>2018-12-25T09:18:45.000+00:00</r_creation_date>
<r_priority>0</r_priority>
<r_auto_method_id>1000000180000268</r_auto_method_id>
<return_value>0</return_value>
<r_exec_result_id>0000000000000000</r_exec_result_id>
<r_exec_launch>false</r_exec_launch>
<r_exec_time_out>false</r_exec_time_out>
<r_runtime_state>2</r_runtime_state>
<r_queue_item_id>0000000000000000</r_queue_item_id>
<r_act_def_id>4c000001800025c4</r_act_def_id>
<r_sign_off_req>false</r_sign_off_req>
<r_launch_timeout>2018-12-25T09:19:45.000+00:00</r_launch_timeout>
<a_wq_name>3d00000180000102</a_wq_name>
<a_wq_flag>0</a_wq_flag>
<a_wq_policy_id>0000000000000000</a_wq_policy_id>
<user_time>0</user_time>
<user_cost>0.0</user_cost>
<r_exec_retried_count>0</r_exec_retried_count>
<r_handling_instruction>0</r_handling_instruction>
<r_target_task_id>0000000000000000</r_target_task_id>
<i_is_replica>false</i_is_replica>
<i_vstamp>4</i_vstamp>
<r_object_id>4a00000180000103</r_object_id>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/work-items/
4a00000180000103"
rel="self"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/

EDCPKRST220200-PRE-EN-01 Reference Guide 871

Chapter 2 Resources

4d00000180000100"
rel="http://identifiers.emc.com/linkrel/workflow"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c4"
rel="http://identifiers.emc.com/linkrel/workflow-activity"/>
</links>
</work-item>

Example 2-405: JSON response

{
"type": "dmi_workitem",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dmi_workitem",
"properties": {
"r_workflow_id": "4d00000180000100",
"r_act_seqno": 4,
"r_performer_name": "dmadmin",
"r_creation_date": "2018-12-25T09:18:45.000+00:00",
"r_priority": 0,
"r_auto_method_id": "1000000180000268",
"return_value": 0,
"r_exec_result_id": "0000000000000000",
"r_exec_launch": false,
"r_exec_time_out": false,
"r_runtime_state": 2,
"r_queue_item_id": "0000000000000000",
"r_act_def_id": "4c000001800025c4",
"r_sign_off_req": false,
"r_launch_timeout": "2018-12-25T09:19:45.000+00:00",
"a_wq_name": "3d00000180000102",
"a_wq_flag": 0,
"a_wq_policy_id": "0000000000000000",
"user_time": 0,
"user_cost": 0.0,
"r_exec_retried_count": 0,
"r_handling_instruction": 0,
"r_target_task_id": "0000000000000000",
"i_is_replica": false,
"i_vstamp": 4,
"r_object_id": "4a00000180000103"
},
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/work-items/
4a00000180000103"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c4"
}
]
}

872 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.84. Work Item(s)

Example 2-406: HAL: JSON Response

{
"type": "dmi_workitem",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/dmi_workitem",
"properties": {
"r_workflow_id": "4d00000180000100",
"r_act_seqno": 4,
"r_performer_name": "dmadmin",
"r_creation_date": "2018-12-25T09:18:45.000+00:00",
"r_priority": 0,
"r_auto_method_id": "1000000180000268",
"return_value": 0,
"r_exec_result_id": "0000000000000000",
"r_exec_launch": false,
"r_exec_time_out": false,
"r_runtime_state": 2,
"r_queue_item_id": "0000000000000000",
"r_act_def_id": "4c000001800025c4",
"r_sign_off_req": false,
"r_launch_timeout": "2018-12-25T09:19:45.000+00:00",
"a_wq_name": "3d00000180000102",
"a_wq_flag": 0,
"a_wq_policy_id": "0000000000000000",
"user_time": 0,
"user_cost": 0.0,
"r_exec_retried_count": 0,
"r_handling_instruction": 0,
"r_target_task_id": "0000000000000000",
"i_is_replica": false,
"i_vstamp": 4,
"r_object_id": "4a00000180000103"
},
"_links": {
"http://identifiers.emc.com/linkrel/workflow": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100"
},
"http://identifiers.emc.com/linkrel/workflow-activity": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c4"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/work-items/
4a00000180000103"
}
}
}

2.84.2 Work Items

The Work Items resource is used to get the Work Items of a specified Workflow
instance.

EDCPKRST220200-PRE-EN-01 Reference Guide 873

Chapter 2 Resources

2.84.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Workflow” on page 906 and About the Diagrams
on page 17.

2.84.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: The resource URI

• Feed Title: Work items
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “Work Item” on page 869 resource
• Entry ID: The entity URI
• Entry Title: The id of the Work Item
• Entry Updated: The last modify date

2.84.2.3 Link relations

Link relation Description Resource reference

self Link to this resource “Work Items” on page 873

2.84.2.4 Operations
2.84.2.4.1 Supported HTTP methods

Method Description
GET Retrieves the Work Items of the specified Workflow instance

874 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.84. Work Item(s)

2.84.2.4.2 Get Work Items

This operation retrieves the Work Items of the specified Workflow instance

2.84.2.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data Value Defaul

method parameters type range t value
GET page, items- For more information, see Appendix B, REST Common
per-page, Definition - URI Request Query Parameters on page 979
include-total,
links, sort,
view, filter,
inline

2.84.2.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.84.2.4.2.3 Request media types

N/A

2.84.2.4.2.4 Request body

N/A

2.84.2.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.84.2.4.2.6 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 875

Chapter 2 Resources

2.84.2.4.2.7 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.84.2.4.2.8 Response body

Example 2-407: XML response

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>
http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100/work-items
</id>
<title>Work items</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2019-02-27T02:30:14.521+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/workflows/
4d00000180000100/work-items" rel="self"/>
<entry>
<id>
http://localhost:8080/dctm-rest/repositories/REPO/work-items/
4a00000180000103
</id>
<title>4a00000180000103</title>
<author>
<name>dmadmin</name>
<uri>
http://localhost:8080/dctm-rest/repositories/REPO/users/dmadmin
</uri>
</author>
<summary>FINISHED</summary>
<updated>2019-02-27T02:30:14.521+00:00</updated>
<published>2018-12-25T09:18:45.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/work-items/
4a00000180000103" rel="edit"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100"
rel="http://identifiers.emc.com/linkrel/workflow"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c4"
rel="http://identifiers.emc.com/linkrel/workflow-activity"/>
<content src="http://localhost:8080/dctm-rest/repositories/REPO/
work-items/4a00000180000103"
type="application/vnd.emc.documentum+xml"/>
</entry>
</feed>

876 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.84. Work Item(s)

Example 2-408: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100/work-items",
"title": "Work items",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-27T02:30:20.412+00:00",
"page": 1,
"items-per-page": 100,
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100/work-items"
}
],
"entries": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/work-items/
4a00000180000103",
"title": "4a00000180000103",
"author": [{
"name": "dmadmin",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/users/
dmadmin"
}
],
"summary": "FINISHED",
"updated": "2019-02-27T02:30:20.412+00:00",
"published": "2018-12-25T09:18:45.000+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
work-items/4a00000180000103"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflows/4d00000180000100"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c4"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
work-items/4a00000180000103"
}

],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
work-items/4a00000180000100"
}
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 877

Chapter 2 Resources

Example 2-409: HAL: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100/work-items",
"title": "Work items",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-27T02:30:22.797+00:00",
"page": 1,
"items-per-page": 100,
"_embedded": {
"collection": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
work-items/4a00000180000103",
"title": "4a00000180000103",
"author": [{
"name": "dmadmin",
"uri": "http://localhost:8080/dctm-rest/repositories/REPO/
users/dmadmin"
}
],
"summary": "FINISHED",
"updated": "2019-02-27T02:30:22.797+00:00",
"published": "2018-12-25T09:18:45.000+00:00",
"_links": {
"http://identifiers.emc.com/linkrel/workflow": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflows/4d00000180000100"
},
"http://identifiers.emc.com/linkrel/workflow-activity": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c4"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
work-items/4a00000180000103"
}
}
}
]
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100/work-items"
}
}
}

878 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.85. Work Queue(s)

2.85 Work Queue(s)

2.85.1 Work Queue
The Work Queue resource is used to get a specified single work queue.

2.85.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Work Queues” on page 882 and About the Diagrams
on page 17.

2.85.1.2 Feed
No feed support.

2.85.1.3 Link relations

Link relation Description Resource reference

self Link to this resource “Work Queue” on page 879
queue-tasks [1] Get the queue tasks under this work “Work Queue Tasks” on page 898
queue
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.85.1.4 Operations
2.85.1.4.1 Supported HTTP methods

Method Description
GET Retrieves a Work Queue

EDCPKRST220200-PRE-EN-01 Reference Guide 879

Chapter 2 Resources

2.85.1.4.2 Get work queue

This operation retrieves a Work Queue object.

2.85.1.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links, views For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979

2.85.1.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.85.1.4.2.3 Request media types

N/A

2.85.1.4.2.4 Request body

N/A

2.85.1.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.85.1.4.2.6 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

880 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.85. Work Queue(s)

2.85.1.4.2.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.85.1.4.2.8 Response body

Example 2-410: XML response

<?xml version="1.0" encoding="UTF-8"?>
<work-queue xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dmc_workqueue" definition="http://localhost:8080/dctm-rest/repositories/REPO/
types/dmc_workqueue">
<properties>
<wq_name>test work queue</wq_name>
<wq_category_id>0b00000180008068</wq_category_id>
<wq_policy_id>0000000180000d1d</wq_policy_id>
<i_is_replica>false</i_is_replica>
<i_vstamp>0</i_vstamp>
<r_object_id>0000000180000d20</r_object_id>
</properties>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/
work-queues/0000000180000d20"></link>
<link rel="http://identifiers.emc.com/linkrel/queue-tasks"
href="http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks?queue-names=test%2Bwork%2Bqueue"></link>
</links>
</work-queue>

Example 2-411: A request and JSON response

This code sample shows you the Work Queue Request and the Response.

Request
GET /dctm-rest/repositories/REPO/work-queue/0000000180000d20 HTTP/1.1
Host: localhost:8080
Accept: application/vnd.emc.documentum+json
Authorization: Basic QWRtaW5pc3RyYXRvcjpQYXNzd29yZEAxMjM=

JSON Response
{
"name": "work-queue",
"type": "dmc_workqueue",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dmc_workqueue",
"properties": {
"wq_name": "test work queue",
"wq_category_id": "0b00000180008068",
"wq_policy_id": "0000000180000d1d",
"i_is_replica": false,
"i_vstamp": 0,

EDCPKRST220200-PRE-EN-01 Reference Guide 881

Chapter 2 Resources

"r_object_id": "0000000180000d20"
},
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/work-queues/
0000000180000d20"
}, {
"rel": "http://identifiers.emc.com/linkrel/queue-tasks",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks?queue-names=test%2Bwork%2Bqueue"
}
]
}

Example 2-412: HAL: JSON Response

{
"name": "work-queue",
"type": "dmc_workqueue",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dmc_workqueue",
"properties": {
"wq_name": "test work queue",
"wq_category_id": "0b00000180008068",
"wq_policy_id": "0000000180000d1d",
"i_is_replica": false,
"i_vstamp": 0,
"r_object_id": "0000000180000d20"
},
"_links": {
"http://identifiers.emc.com/linkrel/queue-tasks": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks?queue-names=test%2Bwork%2Bqueue"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/work-queues/
0000000180000d20"
}
}
}

2.85.2 Work Queues

The Work Queues resource is used to get a collection of work queues to which a
specific user belongs.

882 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.85. Work Queue(s)

2.85.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Repository” on page 562 and About the Diagrams
on page 17.

2.85.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: The resource URI

• Feed Title: Work queues
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “Work Queue” on page 879 resource
• Entry ID: The entity URI
• Entry Title: The name (wq_name) of the Work Queue
• Entry Updated: The current time of the server

2.85.2.3 Link relations

Link relation Description Resource reference

self Link to this resource “Work Queues” on page 882

2.85.2.4 Operations
2.85.2.4.1 Supported HTTP methods

Method Description
GET Retrieves Work Queues

EDCPKRST220200-PRE-EN-01 Reference Guide 883

Chapter 2 Resources

2.85.2.4.2 Get work queues

This operation retrieves a list of work queues to which the specified user belongs. It
retrieves, by default, the queue name of the user that is currently logged in.

2.85.2.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
GET inline, inline For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979
user-name Specifies the String N/A The user that
name of the is currently
user logged in

2.85.2.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.85.2.4.2.3 Request media types

N/A

2.85.2.4.2.4 Request body

N/A

2.85.2.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

884 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.85. Work Queue(s)

2.85.2.4.2.6 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.85.2.4.2.7 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.85.2.4.2.8 Response body

Example 2-413: XML response

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/work-queues</id>
<title>Work queues</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2019-06-12T09:20:30.728+00:00</updated>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/
work-queues"></link>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/work-queues/
0000000180000d2a</id>
<title>test-work-queue-2</title>
<summary>0000000180000d2a test-work-queue-2</summary>
<updated>2019-06-12T09:20:30.728+00:00</updated>
<published>2019-06-12T09:20:30.728+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/work-queues/
0000000180000d2a"></link>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/
work-queues/0000000180000d2a"></content>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/work-queues/
0000000180000d20</id>
<title>test work queue</title>
<summary>0000000180000d20 test work queue</summary>
<updated>2019-06-12T09:20:30.728+00:00</updated>
<published>2019-06-12T09:20:30.728+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/repositories/REPO/work-queues/
0000000180000d20"></link>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/repositories/REPO/
work-queues/0000000180000d20"></content>
</entry>
</feed>

EDCPKRST220200-PRE-EN-01 Reference Guide 885

Chapter 2 Resources

Example 2-414: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/work-queues",
"title": "Work queues",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-06-12T09:18:31.925+00:00",
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
work-queues"
}
],
"entries": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/work-queues/
0000000180000d2a",
"title": "test-work-queue-2",
"summary": "0000000180000d2a test-work-queue-2",
"updated": "2019-06-12T09:18:31.939+00:00",
"published": "2019-06-12T09:18:31.939+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
work-queues/0000000180000d2a"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
work-queues/0000000180000d2a"
}
}, {
"id": "http://localhost:8080/dctm-rest/repositories/REPO/work-queues/
0000000180000d20",
"title": "test work queue",
"summary": "0000000180000d20 test work queue",
"updated": "2019-06-12T09:18:31.939+00:00",
"published": "2019-06-12T09:18:31.939+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO
work-queues/0000000180000d20"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
work-queues/0000000180000d20"
}
}
]
}

Example 2-415: HAL: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/work-queues",
"title": "Work queues",
"author": [{
"name": "Open Text Documentum"
}
],

886 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.86. Work Queue Task(s)

"updated": "2019-06-12T09:20:57.243+00:00",
"_embedded": {
"collection": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
work-queues/0000000180000d2a",
"title": "test-work-queue-2",
"summary": "0000000180000d2a test-work-queue-2",
"updated": "2019-06-12T09:20:57.243+00:00",
"published": "2019-06-12T09:20:57.243+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/work-queues/0000000180000d2a"
}
}
}, {
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
work-queues/0000000180000d20",
"title": "test work queue",
"summary": "0000000180000d20 test work queue",
"updated": "2019-06-12T09:20:57.243+00:00",
"published": "2019-06-12T09:20:57.243+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/work-queues/0000000180000d20"
}
}
}
]
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
work-queues"
}
}
}

2.86 Work Queue Task(s)

2.86.1 Work Queue Task
The Work Queue Task resource is used to retrieve a queue task, which allows you to
perform some actions on it.

2.86.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

EDCPKRST220200-PRE-EN-01 Reference Guide 887

Chapter 2 Resources

For more information, see “Work Queue Tasks” on page 898 and About the
Diagrams on page 17.

2.86.1.2 Feed
No feed support.

2.86.1.3 Link relations

Link relation Description Resource reference

self Link to this resource “Work Queue Task” on page 887
workflow [1] Link to the workflow that this “Workflow” on page 906
queue task belongs to
workflow- Link to a workflow activity “Workflow Activity” on page 935
activity [1]
inbox-item [1] Link to an inbox item “Inbox Item” on page 340
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.86.1.4 Operations
2.86.1.4.1 Supported HTTP methods

Method Description
GET Retrieves a work queue task
PUT Perform actions on a work queue task

888 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.86. Work Queue Task(s)

2.86.1.4.2 Get work queue task

This operation retrieves a Work Queue task.

2.86.1.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979

2.86.1.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.86.1.4.2.3 Request media types

N/A

2.86.1.4.2.4 Request body

N/A

2.86.1.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.86.1.4.2.6 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

EDCPKRST220200-PRE-EN-01 Reference Guide 889

Chapter 2 Resources

2.86.1.4.2.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.86.1.4.2.8 Response body

Example 2-416: XML response

<?xml version="1.0" encoding="UTF-8"?>
<work-queue-task xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<original-wq-name>test-work-queue-2</original-wq-name>
<pulled>true</pulled>
<held>false</held>
<held-by></held-by>
<wq-policy-id>0000000180000d1d</wq-policy-id>
<wq-doc-profile></wq-doc-profile>
<increment-priority>1</increment-priority>
<skill-level>0</skill-level>
<process-id>4b0000018001f56c</process-id>
<is-signoff-required>false</is-signoff-required>
<is-repeatable>true</is-repeatable>
<is-delegable>true</is-delegable>
<is-end-activity>true</is-end-activity>
<is-distribution-listtsak>false</is-distribution-listtsak>
<is-group-owned>false</is-group-owned>
<runtime-state>DORMANT</runtime-state>
<is-failed-autotask>false</is-failed-autotask>
<is-manual-transition>false</is-manual-transition>
<instruction></instruction>
<is-sequentiala-activity>false</is-sequentiala-activity>
<has-self-reject-link>false</has-self-reject-link>
<is-first-performer>false</is-first-performer>
<is-last-performer>false</is-last-performer>
<has-forward-activities>false</has-forward-activities>
<has-reject-activities>false</has-reject-activities>
<queue-item-id>1b0000018000e550</queue-item-id>
<activity-id>4c0000018001f578</activity-id>
<activity-name>work queue2</activity-name>
<is-performer-assignment-required>false</is-performer-assignment-required>
<complete-error-status>COMPLETE_UNKNOWN</complete-error-status>
<task-name>work queue2</task-name>
<task-type>WORKFLOWTASK</task-type>
<task-state>DORMANT</task-state>
<priority>171</priority>
<sent-date>2019-06-06T05:00:29.000+00:00</sent-date>
<item-id>4a00000180001114</item-id>
<workflow-id>4d00000180001114</workflow-id>
<workflow-task-type>UNKNOWN</workflow-task-type>
<performer>Administrator</performer>
<stamp>1b0000018000e550</stamp>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/queue-tasks/
4a00000180001114"></link>
<link rel="http://identifiers.emc.com/linkrel/workflow"
href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180001114"></link>
<link rel="http://identifiers.emc.com/linkrel/workflow-activity"
href="http://localhost:8080/dctm-rest/repositories/REPO/

890 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.86. Work Queue Task(s)

workflow-activities/4c0000018001f578"></link>
<link rel="http://identifiers.emc.com/linkrel/inbox-item"
href="http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b0000018000e550"></link>
</links>
</work-queue-task>

Example 2-417: JSON response

{
"name": "work-queue-task",
"original-wq-name": "test-work-queue-2",
"pulled": true,
"held": false,
"held-by": "",
"wq-policy-id": "0000000180000d1d",
"wq-doc-profile": "",
"increment-priority": 1,
"skill-level": 0,
"process-id": "4b0000018001f56c",
"is-signoff-required": false,
"is-repeatable": true,
"is-delegable": true,
"is-end-activity": true,
"is-distribution-listtsak": false,
"is-group-owned": false,
"runtime-state": "DORMANT",
"is-failed-autotask": false,
"is-manual-transition": false,
"instruction": "",
"is-sequentiala-activity": false,
"has-self-reject-link": false,
"is-first-performer": false,
"is-last-performer": false,
"has-forward-activities": false,
"has-reject-activities": false,
"queue-item-id": "1b0000018000e550",
"activity-id": "4c0000018001f578",
"activity-name": "work queue2",
"is-performer-assignment-required": false,
"complete-error-status": "COMPLETE_UNKNOWN",
"task-name": "work queue2",
"task-type": "WORKFLOWTASK",
"task-state": "DORMANT",
"priority": 171,
"sent-date": "2019-06-06T05:00:29.000+00:00",
"item-id": "4a00000180001114",
"workflow-id": "4d00000180001114",
"workflow-task-type": "UNKNOWN",
"performer": "Administrator",
"stamp": "1b0000018000e550",
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks/4a00000180001114"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180001114"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c0000018001f578"
}, {
"rel": "http://identifiers.emc.com/linkrel/inbox-item",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/inbox/

EDCPKRST220200-PRE-EN-01 Reference Guide 891

Chapter 2 Resources

1b0000018000e550"
}
]
}

Example 2-418: HAL: JSON Response

{
"name": "work-queue-task",
"original-wq-name": "test-work-queue-2",
"pulled": true,
"held": false,
"held-by": "",
"wq-policy-id": "0000000180000d1d",
"wq-doc-profile": "",
"increment-priority": 1,
"skill-level": 0,
"process-id": "4b0000018001f56c",
"is-signoff-required": false,
"is-repeatable": true,
"is-delegable": true,
"is-end-activity": true,
"is-distribution-listtsak": false,
"is-group-owned": false,
"runtime-state": "DORMANT",
"is-failed-autotask": false,
"is-manual-transition": false,
"instruction": "",
"is-sequentiala-activity": false,
"has-self-reject-link": false,
"is-first-performer": false,
"is-last-performer": false,
"has-forward-activities": false,
"has-reject-activities": false,
"queue-item-id": "1b0000018000e550",
"activity-id": "4c0000018001f578",
"activity-name": "work queue2",
"is-performer-assignment-required": false,
"complete-error-status": "COMPLETE_UNKNOWN",
"task-name": "work queue2",
"task-type": "WORKFLOWTASK",
"task-state": "DORMANT",
"priority": 171,
"sent-date": "2019-06-06T05:00:29.000+00:00",
"item-id": "4a00000180001114",
"workflow-id": "4d00000180001114",
"workflow-task-type": "UNKNOWN",
"performer": "Administrator",
"stamp": "1b0000018000e550",
"_links": {
"http://identifiers.emc.com/linkrel/workflow": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180001114"
},
"http://identifiers.emc.com/linkrel/workflow-activity": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c0000018001f578"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks/4a00000180001114"
},
"http://identifiers.emc.com/linkrel/inbox-item": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b0000018000e550"
}

892 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.86. Work Queue Task(s)

}
}

2.86.1.4.3 Do actions on queue task

The Work Queue Task is also a Workflow Task. In addition to supporting the actions
on a workflow task such as acquire, forward, reject, delegate, repeat,
signoff, assign and complete through the Inbox Item resource, it also supports
the actions, shown below, on the Work Queue Task resource.

2.86.1.4.3.1 HTTP Request Method and Query Parameters

HTTP Query Description Data Value Default

method parameters type range value
PUT action The specific action to be String N/A N/A
performed on the current
Work Queue Task resource.
Currently, the following
actions are supported:
• HOLD: Sets the work item
a_held_by parameter to
indicate if the task is being
worked on
• REASSIGN: Reassigns this
task to the specified user,
the user-name parameter
is required, but the
pulled parameter is
optional. This action
unsuspends a suspended
task
• SUSPEND: Suspends the
specified task with the
specified expected
unsuspend date and time.
The unsuspend-time is
optional
• UNSUSPEND:
Unsuspends or resumes
the specified task
• UNHOLD: Releases the
task
user-name Specifies the user name of the String N/A
user to whom the task is
reassigned

EDCPKRST220200-PRE-EN-01 Reference Guide 893

Chapter 2 Resources

HTTP Query Description Data Value Default

method parameters type range value
pulled It is true to indicate when an Boolean N/A false
end user assigns the task, or
false if a supervisor or
administrator assigns the task
unsuspend Specifies the absolute date and String N/A null
-time time when the task must be
automatically unsuspended
when the action is SUSPEND.
Pass in NULL if the timer is
not used for suspending the
task. The date format should
comply with ISO 8601, e.g.
2050-12-31T23:59:59+08:00

2.86.1.4.3.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.86.1.4.3.3 Request media types

N/A

2.86.1.4.3.4 Request body

N/A

2.86.1.4.3.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

894 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.86. Work Queue Task(s)

2.86.1.4.3.6 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.86.1.4.3.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.86.1.4.3.8 Response body

Example 2-419: XML response

<?xml version="1.0" encoding="UTF-8"?>
<work-queue-task xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<original-wq-name>test-work-queue-2</original-wq-name>
<pulled>true</pulled>
<held>false</held>
<held-by></held-by>
<wq-policy-id>0000000180000d1d</wq-policy-id>
<wq-doc-profile></wq-doc-profile>
<increment-priority>1</increment-priority>
<skill-level>0</skill-level>
<process-id>4b0000018001f56c</process-id>
<is-signoff-required>false</is-signoff-required>
<is-repeatable>true</is-repeatable>
<is-delegable>true</is-delegable>
<is-end-activity>true</is-end-activity>
<is-distribution-listtsak>false</is-distribution-listtsak>
<is-group-owned>false</is-group-owned>
<runtime-state>DORMANT</runtime-state>
<is-failed-autotask>false</is-failed-autotask>
<is-manual-transition>false</is-manual-transition>
<instruction></instruction>
<is-sequentiala-activity>false</is-sequentiala-activity>
<has-self-reject-link>false</has-self-reject-link>
<is-first-performer>false</is-first-performer>
<is-last-performer>false</is-last-performer>
<has-forward-activities>false</has-forward-activities>
<has-reject-activities>false</has-reject-activities>
<queue-item-id>1b0000018000e550</queue-item-id>
<activity-id>4c0000018001f578</activity-id>
<activity-name>work queue2</activity-name>
<is-performer-assignment-required>false</is-performer-assignment-required>
<complete-error-status>COMPLETE_UNKNOWN</complete-error-status>
<task-name>work queue2</task-name>
<task-type>WORKFLOWTASK</task-type>
<task-state>DORMANT</task-state>
<priority>171</priority>
<sent-date>2019-06-06T05:00:29.000+00:00</sent-date>
<item-id>4a00000180001114</item-id>
<workflow-id>4d00000180001114</workflow-id>
<workflow-task-type>UNKNOWN</workflow-task-type>
<performer>Administrator</performer>

EDCPKRST220200-PRE-EN-01 Reference Guide 895

Chapter 2 Resources

<stamp>1b0000018000e550</stamp>
<links>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/REPO/queue-tasks/
4a00000180001114"></link>
<link rel="http://identifiers.emc.com/linkrel/workflow"
href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180001114"></link>
<link rel="http://identifiers.emc.com/linkrel/workflow-activity"
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c0000018001f578"></link>
<link rel="http://identifiers.emc.com/linkrel/inbox-item"
href="http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b0000018000e550"></link>
</links>
</work-queue-task>

Example 2-420: JSON response

{
"name": "work-queue-task",
"original-wq-name": "test-work-queue-2",
"pulled": true,
"held": false,
"held-by": "",
"wq-policy-id": "0000000180000d1d",
"wq-doc-profile": "",
"increment-priority": 1,
"skill-level": 0,
"process-id": "4b0000018001f56c",
"is-signoff-required": false,
"is-repeatable": true,
"is-delegable": true,
"is-end-activity": true,
"is-distribution-listtsak": false,
"is-group-owned": false,
"runtime-state": "DORMANT",
"is-failed-autotask": false,
"is-manual-transition": false,
"instruction": "",
"is-sequentiala-activity": false,
"has-self-reject-link": false,
"is-first-performer": false,
"is-last-performer": false,
"has-forward-activities": false,
"has-reject-activities": false,
"queue-item-id": "1b0000018000e550",
"activity-id": "4c0000018001f578",
"activity-name": "work queue2",
"is-performer-assignment-required": false,
"complete-error-status": "COMPLETE_UNKNOWN",
"task-name": "work queue2",
"task-type": "WORKFLOWTASK",
"task-state": "DORMANT",
"priority": 171,
"sent-date": "2019-06-06T05:00:29.000+00:00",
"item-id": "4a00000180001114",
"workflow-id": "4d00000180001114",
"workflow-task-type": "UNKNOWN",
"performer": "Administrator",
"stamp": "1b0000018000e550",
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks/4a00000180001114"
}, {

896 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.86. Work Queue Task(s)

"rel": "http://identifiers.emc.com/linkrel/workflow",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180001114"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c0000018001f578"
}, {
"rel": "http://identifiers.emc.com/linkrel/inbox-item",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b0000018000e550"
}
]
}

Example 2-421: HAL: JSON Response

{
"name": "work-queue-task",
"original-wq-name": "test-work-queue-2",
"pulled": true,
"held": false,
"held-by": "",
"wq-policy-id": "0000000180000d1d",
"wq-doc-profile": "",
"increment-priority": 1,
"skill-level": 0,
"process-id": "4b0000018001f56c",
"is-signoff-required": false,
"is-repeatable": true,
"is-delegable": true,
"is-end-activity": true,
"is-distribution-listtsak": false,
"is-group-owned": false,
"runtime-state": "DORMANT",
"is-failed-autotask": false,
"is-manual-transition": false,
"instruction": "",
"is-sequentiala-activity": false,
"has-self-reject-link": false,
"is-first-performer": false,
"is-last-performer": false,
"has-forward-activities": false,
"has-reject-activities": false,
"queue-item-id": "1b0000018000e550",
"activity-id": "4c0000018001f578",
"activity-name": "work queue2",
"is-performer-assignment-required": false,
"complete-error-status": "COMPLETE_UNKNOWN",
"task-name": "work queue2",
"task-type": "WORKFLOWTASK",
"task-state": "DORMANT",
"priority": 171,
"sent-date": "2019-06-06T05:00:29.000+00:00",
"item-id": "4a00000180001114",
"workflow-id": "4d00000180001114",
"workflow-task-type": "UNKNOWN",
"performer": "Administrator",
"stamp": "1b0000018000e550",
"_links": {
"http://identifiers.emc.com/linkrel/workflow": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180001114"
},
"http://identifiers.emc.com/linkrel/workflow-activity": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/

EDCPKRST220200-PRE-EN-01 Reference Guide 897

Chapter 2 Resources

workflow-activities/4c0000018001f578"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks/4a00000180001114"
},
"http://identifiers.emc.com/linkrel/inbox-item": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/inbox/
1b0000018000e550"
}
}
}

2.86.2 Work Queue Tasks

The Work Queue Tasks resource is used to get a collection of work queues to which a
specific user belongs.

2.86.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Repository” on page 562 and About the Diagrams
on page 17.

2.86.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: The resource URI

• Feed Title: Work queue tasks
• Feed Updated: Server's current time
• Supports POST: No
• Entry: “Work Queue Task” on page 887 resource
• Entry ID: The entity URI
• Entry Title: The name (original-wq-name) of the Work Queue
• Entry Updated: The current time of the server

898 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.86. Work Queue Task(s)

2.86.2.3 Link relations

Link relation Description Resource reference

self Link to this resource “Work Queues” on page 882

2.86.2.4 Operations
2.86.2.4.1 Supported HTTP methods

Method Description
GET Retrieves Work Queues

2.86.2.4.2 Get work queues

This operation retrieves a list of Work Queue Tasks that belong to the specified user.

2.86.2.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default

method paramet value
ers
GET inline, For more information, see Appendix B, REST Common Definition -
links URI Request Query Parameters on page 979
user- Specifies the name of the String N/A The user that
name user is currently
logged in
queue- Get the queue tasks String existing All work
names under the work queues work queues queues to
to which the specified which a
user belongs. specified
user belongs.

EDCPKRST220200-PRE-EN-01 Reference Guide 899

Chapter 2 Resources

HTTP Query Description Data type Value range Default

method paramet value
ers
filter- Specify task type to be String One of the ELIGIBLE_A
type returned, valid values valid values. ND_OWNE
are not case-sensitive: D
• ALL: Shows all tasks
in the work queue.
• UNASSIGNED:
Shows unassigned
tasks in the work
queue.
• ELIGIBLE_AND_O
WNED: Shows the
tasks that the
processor can work
on and the tasks that
the processor owns in
the work queue.
• ELIGIBLE: Shows
the tasks that the
processor can work
on in the work queue.

2.86.2.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.86.2.4.2.3 Request media types

N/A

2.86.2.4.2.4 Request bodfy

N/A

900 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.86. Work Queue Task(s)

2.86.2.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.86.2.4.2.6 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.86.2.4.2.7 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.86.2.4.2.8 Response body

Example 2-422: XML response

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks</id>
<title>Work queue tasks</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2019-06-13T03:11:13.272+00:00</updated>
<link rel="self"
href="http://localhost:8080/dctm-rest/repositories/
REPO/queue-tasks"></link>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/
REPO/queue-tasks/4a00000180001112</id>
<title>test work queue</title>
<author>
<name>dmadmin</name>
<uri>http://localhost:8080/dctm-rest/repositories/
REPO/users/dmadmin</uri>
</author>
<summary>4a00000180001112 170</summary>
<updated>2019-06-06T04:59:06.000+00:00</updated>
<published>2019-06-06T04:59:06.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001112"></link>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/

EDCPKRST220200-PRE-EN-01 Reference Guide 901

Chapter 2 Resources

repositories/REPO/queue-tasks/
4a00000180001112"></content>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks/4a00000180001113</id>
<title>test work queue</title>
<author>
<name>test work queue</name>
<uri>http://localhost:8080/dctm-rest/repositories/
REPO/users/test%2Bwork%2Bqueue</uri>
</author>
<summary>4a00000180001113 170</summary>
<updated>2019-06-06T04:59:17.000+00:00</updated>
<published>2019-06-06T04:59:17.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001113"></link>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001113"></content>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks/4a00000180001114</id>
<title>test-work-queue-2</title>
<author>
<name>test-work-queue-2</name>
<uri>http://localhost:8080/dctm-rest/repositories/
REPO/users/test-work-queue-2</uri>
</author>
<summary>4a00000180001114 170</summary>
<updated>2019-06-06T05:00:29.000+00:00</updated>
<published>2019-06-06T05:00:29.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001114"></link>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001114"></content>
</entry>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks/4a00000180001115</id>
<title>test-work-queue-2</title>
<author>
<name>test-work-queue-2</name>
<uri>http://localhost:8080/dctm-rest/repositories/
REPO/users/test-work-queue-2</uri>
</author>
<summary>4a00000180001115 169</summary>
<updated>2019-06-06T05:52:43.000+00:00</updated>
<published>2019-06-06T05:52:43.000+00:00</published>
<link rel="edit"
href="http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001115"></link>
<content type="application/vnd.emc.documentum+xml"
src="http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001115"></content>
</entry>
</feed>

902 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.86. Work Queue Task(s)

Example 2-423: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/
REPO/queue-tasks",
"title": "Work queue tasks",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-06-13T03:13:37.441+00:00",
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks"
}
],
"entries": [{
"id": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001112",
"title": "test work queue",
"author": [{
"name": "dmadmin",
"uri": "http://localhost:8080/dctm-rest/
repositories/REPO/users/dmadmin"
}
],
"summary": "4a00000180001112 170",
"updated": "2019-06-06T04:59:06.000+00:00",
"published": "2019-06-06T04:59:06.000+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001112"
}
],
"content": {
"type": "application/json",
"src": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001112"
}
}, {
"id": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a0000018000110c",
"title": "test-work-queue-2",
"author": [{
"name": "sysadmin",
"uri": "http://localhost:8080/dctm-rest/
repositories/REPO/users/
sysadmin"
}
],
"summary": "4a0000018000110c 196",
"updated": "2019-06-05T03:05:10.000+00:00",
"published": "2019-06-05T03:05:10.000+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a0000018000110c"
}
],
"content": {
"type": "application/json",
"src": "http://localhost:8080/dctm-rest/

EDCPKRST220200-PRE-EN-01 Reference Guide 903

Chapter 2 Resources

repositories/REPO/queue-tasks/
4a0000018000110c"
}
}, {
"id": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001114",
"title": "test-work-queue-2",
"author": [{
"name": "test-work-queue-2",
"uri": "http://localhost:8080/dctm-rest/
repositories/REPO/users/
test-work-queue-2"
}
],
"summary": "4a00000180001114 170",
"updated": "2019-06-06T05:00:29.000+00:00",
"published": "2019-06-06T05:00:29.000+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001114"
}
],
"content": {
"type": "application/json",
"src": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001114"
}
}, {
"id": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001115",
"title": "test-work-queue-2",
"author": [{
"name": "test-work-queue-2",
"uri": "http://localhost:8080/dctm-rest/
repositories/REPO/users/
test-work-queue-2"
}
],
"summary": "4a00000180001115 169",
"updated": "2019-06-06T05:52:43.000+00:00",
"published": "2019-06-06T05:52:43.000+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001115"
}
],
"content": {
"type": "application/json",
"src": "http://localhost:8080/dctm-rest/
repositories/REPO/queue-tasks/
4a00000180001115"
}
}
]
}

904 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.86. Work Queue Task(s)

Example 2-424: HAL: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/queue-tasks",
"title": "Work queue tasks",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-06-13T03:15:27.348+00:00",
"_embedded": {
"collection": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks/4a00000180001112",
"title": "test work queue",
"author": [{
"name": "dmadmin",
"uri": "http://localhost:8080/dctm-rest/repositories/
REPO/users/dmadmin"
}
],
"summary": "4a00000180001112 170",
"updated": "2019-06-06T04:59:06.000+00:00",
"published": "2019-06-06T04:59:06.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/queue-tasks/4a00000180001112"
}
}
}, {
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks/4a0000018000110c",
"title": "test-work-queue-2",
"author": [{
"name": "sysadmin",
"uri": "http://localhost:8080/dctm-rest/repositories/
REPO/users/sysadmin"
}
],
"summary": "4a0000018000110c 196",
"updated": "2019-06-05T03:05:10.000+00:00",
"published": "2019-06-05T03:05:10.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/queue-tasks/4a0000018000110c"
}
}
}, {
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks/4a00000180001114",
"title": "test-work-queue-2",
"author": [{
"name": "test-work-queue-2",
"uri": "http://localhost:8080/dctm-rest/repositories/
REPO/users/test-work-queue-2"
}
],
"summary": "4a00000180001114 170",
"updated": "2019-06-06T05:00:29.000+00:00",
"published": "2019-06-06T05:00:29.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/queue-tasks/4a00000180001114"
}
}
}, {

EDCPKRST220200-PRE-EN-01 Reference Guide 905

Chapter 2 Resources

"id": "http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks/4a00000180001115",
"title": "test-work-queue-2",
"author": [{
"name": "test-work-queue-2",
"uri": "http://localhost:8080/dctm-rest/repositories/
REPO/users/test-work-queue-2"
}
],
"summary": "4a00000180001115 169",
"updated": "2019-06-06T05:52:43.000+00:00",
"published": "2019-06-06T05:52:43.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/
REPO/queue-tasks/4a00000180001115"
}
}
}
]
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
queue-tasks"
}
}
}

2.87 Workflow(s)
2.87.1 Workflow
The Workflow resource is used to get a specified Workflow instance.

2.87.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Workflows” on page 920 and About the Diagrams
on page 17.

906 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

2.87.1.2 Feed
No feed support.

2.87.1.3 Link relations

Link relation Description Resource reference

self Link to this resource “Workflow” on page 906
workflow- A workflow template “Workflow Template”
template [1] on page 959
workflow- activity The workflow activity “Workflow Activity”
[1] on page 935
workflow- The workflow attachments “Workflow Attachments”
attachments [1] on page 952
work- items [1] The work items “Work Items” on page 873
[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.87.1.4 Operations
2.87.1.4.1 Supported HTTP methods

Method Description
GET Retrieves a Workflow instance
PUT Performs Workflow actions

2.87.1.4.2 Get a Workflow instance

This operation retrieves an instance of a Workflow.

2.87.1.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links, view For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979

EDCPKRST220200-PRE-EN-01 Reference Guide 907

Chapter 2 Resources

2.87.1.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.87.1.4.2.3 Request media types

N/A

2.87.1.4.2.4 Request body

N/A

2.87.1.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.87.1.4.2.6 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.87.1.4.2.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

908 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

2.87.1.4.2.8 Response body

Example 2-425: XML response

<?xml version="1.0" encoding="UTF-8"?>
<workflow
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_workflow"
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_workflow">
<properties>
<object_name>a_test_workflow 2019-02-26</object_name>
<process_id>4b0000018000236e</process_id>
<r_creator_name>dmadmin</r_creator_name>
<supervisor_name>dmadmin</supervisor_name>
<r_runtime_state>1</r_runtime_state>
<r_start_date>2019-02-26T06:35:58.000+00:00</r_start_date>
<i_next_seqno>1</i_next_seqno>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<parent_id>0000000000000000</parent_id>
<parent_act_seqno>0</parent_act_seqno>
<correlation_identifier>
9f000661a430d930db3138306730303f
</correlation_identifier>
<i_next_act_group_seqno>0</i_next_act_group_seqno>
<r_act_seqno>
<item>0</item>
</r_act_seqno>
<r_act_name>
<item>Activity-1</item>
</r_act_name>
<r_act_def_id>
<item>4c000001800025c9</item>
</r_act_def_id>
<r_act_errorno>
<item>0</item>
</r_act_errorno>
<r_act_state>
<item>1</item>
</r_act_state>
<r_repeat_invoke>
<item>true</item>
</r_repeat_invoke>
<r_trigger_thresh>
<item>0</item>
</r_trigger_thresh>
<r_trigger_input>
<item>0</item>
</r_trigger_input>
<r_trigger_revert>
<item>0</item>
</r_trigger_revert>
<r_pre_timer>
<item xsi:nil="true"/>
</r_pre_timer>
<r_post_timer>
<item xsi:nil="true"/>
</r_post_timer>
<r_total_witem>
<item>1</item>
</r_total_witem>
<r_complete_witem>
<item>0</item>
</r_complete_witem>
<r_last_performer>
<item/>
</r_last_performer>
<r_last_witem_id>
<item>0000000000000000</item>

EDCPKRST220200-PRE-EN-01 Reference Guide 909

Chapter 2 Resources

</r_last_witem_id>
<i_performer_flag>
<item>0</item>
</i_performer_flag>
<r_target_act_seqno>
<item>-1</item>
</r_target_act_seqno>
<i_is_replica>false</i_is_replica>
<i_vstamp>1</i_vstamp>
<r_object_id>4d0000018000010a</r_object_id>
</properties>
<links>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a"
rel="self"/>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
rel="http://identifiers.emc.com/linkrel/workflow-template"/>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments"
rel="http://identifiers.emc.com/linkrel/workflow-attachments"/>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/work-items"
rel="http://identifiers.emc.com/linkrel/work-items"/>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
rel="http://identifiers.emc.com/linkrel/workflow-activity"
title="Activity-1"/>
</links>
</workflow>

Example 2-426: JSON response

{
"name": "workflow",
"type": "dm_workflow",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_workflow",
"properties": {
"object_name": "a_test_workflow 2019-02-26",
"process_id": "4b0000018000236e",
"r_creator_name": "dmadmin",
"supervisor_name": "dmadmin",
"r_runtime_state": 1,
"r_start_date": "2019-02-26T06:35:58.000+00:00",
"i_next_seqno": 1,
"r_alias_set_id": "0000000000000000",
"parent_id": "0000000000000000",
"parent_act_seqno": 0,
"correlation_identifier": "9f000661a430d930db3138306730303f",
"i_next_act_group_seqno": 0,
"r_act_seqno": [
0
],
"r_act_name": [
"Activity-1"
],
"r_act_def_id": [
"4c000001800025c9"
],
"r_act_errorno": [
0
],
"r_act_state": [
1
],

910 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

"r_repeat_invoke": [
true
],
"r_trigger_thresh": [
0
],
"r_trigger_input": [
0
],
"r_trigger_revert": [
0
],
"r_pre_timer": [
null
],
"r_post_timer": [
null
],
"r_total_witem": [
1
],
"r_complete_witem": [
0
],
"r_last_performer": [
""
],
"r_last_witem_id": [
"0000000000000000"
],
"i_performer_flag": [
0
],
"r_target_act_seqno": [
-1
],
"i_is_replica": false,
"i_vstamp": 1,
"r_object_id": "4d0000018000010a"
},
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-template",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-attachments",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments"
}, {
"rel": "http://identifiers.emc.com/linkrel/work-items",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/work-items"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"title": "Activity-1",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 911

Chapter 2 Resources

Example 2-427: HAL: JSON Response

{
"name": "workflow",
"type": "dm_workflow",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_workflow",
"properties": {
"object_name": "a_test_workflow 2019-02-26",
"process_id": "4b0000018000236e",
"r_creator_name": "dmadmin",
"supervisor_name": "dmadmin",
"r_runtime_state": 1,
"r_start_date": "2019-02-26T06:35:58.000+00:00",
"i_next_seqno": 1,
"r_alias_set_id": "0000000000000000",
"parent_id": "0000000000000000",
"parent_act_seqno": 0,
"correlation_identifier": "9f000661a430d930db3138306730303f",
"i_next_act_group_seqno": 0,
"r_act_seqno": [
0
],
"r_act_name": [
"Activity-1"
],
"r_act_def_id": [
"4c000001800025c9"
],
"r_act_errorno": [
0
],
"r_act_state": [
1
],
"r_repeat_invoke": [
true
],
"r_trigger_thresh": [
0
],
"r_trigger_input": [
0
],
"r_trigger_revert": [
0
],
"r_pre_timer": [
null
],
"r_post_timer": [
null
],
"r_total_witem": [
1
],
"r_complete_witem": [
0
],
"r_last_performer": [
""
],
"r_last_witem_id": [
"0000000000000000"
],
"i_performer_flag": [
0
],
"r_target_act_seqno": [

912 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

-1
],
"i_is_replica": false,
"i_vstamp": 1,
"r_object_id": "4d0000018000010a"
},
"_links": {
"http://identifiers.emc.com/linkrel/work-items": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/work-items"
},
"http://identifiers.emc.com/linkrel/workflow-activity": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9",
"title": "Activity-1"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflows/4d0000018000010a"
},
"http://identifiers.emc.com/linkrel/workflow-attachments": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments"
},
"http://identifiers.emc.com/linkrel/workflow-template": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}
}
}

2.87.1.4.3 Perform actions on a Workflow instance

This operation performs actions on a Workflow instance.

2.87.1.4.3.1 HTTP Request Method and Query Parameters

HTTP Query Description Data Value Default

method parameter type range value
s
PUT action The specified action that is string One of the null
performed on the Workflow supported
instance. The following actions actions
are supported:
• HALT
• HALT-ALL
• RESUME
• RESUME-ALL
• ABORT
• CHANGE-SUPERVISOR

This parameter is required.

EDCPKRST220200-PRE-EN-01 Reference Guide 913

Chapter 2 Resources

HTTP Query Description Data Value Default

method parameter type range value
s
activity The name of the activity to be string N/A null
halted, resumed, or restarted.

This parameter is required

when the action is one of: HALT,
RESUME
supervisor The name of the new string N/A null
supervisor.

This parameter is required

when the action specified is
CHANGE-SUPERVISOR

2.87.1.4.3.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.87.1.4.3.3 Request media types

N/A

2.87.1.4.3.4 Request body

N/A

2.87.1.4.3.5 Response status

• 200 - Action performed successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

914 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

2.87.1.4.3.6 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.87.1.4.3.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.87.1.4.3.8 Response body

The response body is the same as that of the GET operation. We have included here
for your convenience.

Example 2-428: XML response

<?xml version="1.0" encoding="UTF-8"?>
<workflow
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_workflow"
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_workflow">
<properties>
<object_name>a_test_workflow 2019-02-26</object_name>
<process_id>4b0000018000236e</process_id>
<r_creator_name>dmadmin</r_creator_name>
<supervisor_name>dmadmin</supervisor_name>
<r_runtime_state>1</r_runtime_state>
<r_start_date>2019-02-26T06:35:58.000+00:00</r_start_date>
<i_next_seqno>1</i_next_seqno>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<parent_id>0000000000000000</parent_id>
<parent_act_seqno>0</parent_act_seqno>
<correlation_identifier>
9f000661a430d930db3138306730303f
</correlation_identifier>
<i_next_act_group_seqno>0</i_next_act_group_seqno>
<r_act_seqno>
<item>0</item>
</r_act_seqno>
<r_act_name>
<item>Activity-1</item>
</r_act_name>
<r_act_def_id>
<item>4c000001800025c9</item>
</r_act_def_id>
<r_act_errorno>
<item>0</item>
</r_act_errorno>
<r_act_state>
<item>1</item>
</r_act_state>
<r_repeat_invoke>
<item>true</item>

EDCPKRST220200-PRE-EN-01 Reference Guide 915

Chapter 2 Resources

</r_repeat_invoke>
<r_trigger_thresh>
<item>0</item>
</r_trigger_thresh>
<r_trigger_input>
<item>0</item>
</r_trigger_input>
<r_trigger_revert>
<item>0</item>
</r_trigger_revert>
<r_pre_timer>
<item xsi:nil="true"/>
</r_pre_timer>
<r_post_timer>
<item xsi:nil="true"/>
</r_post_timer>
<r_total_witem>
<item>1</item>
</r_total_witem>
<r_complete_witem>
<item>0</item>
</r_complete_witem>
<r_last_performer>
<item/>
</r_last_performer>
<r_last_witem_id>
<item>0000000000000000</item>
</r_last_witem_id>
<i_performer_flag>
<item>0</item>
</i_performer_flag>
<r_target_act_seqno>
<item>-1</item>
</r_target_act_seqno>
<i_is_replica>false</i_is_replica>
<i_vstamp>1</i_vstamp>
<r_object_id>4d0000018000010a</r_object_id>
</properties>
<links>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a"
rel="self"/>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
rel="http://identifiers.emc.com/linkrel/workflow-template"/>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments"
rel="http://identifiers.emc.com/linkrel/workflow-attachments"/>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/work-items"
rel="http://identifiers.emc.com/linkrel/work-items"/>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
rel="http://identifiers.emc.com/linkrel/workflow-activity"
title="Activity-1"/>
</links>
</workflow>

Example 2-429: JSON response

{
"name": "workflow",
"type": "dm_workflow",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_workflow",
"properties": {

916 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

"object_name": "a_test_workflow 2019-02-26",

"process_id": "4b0000018000236e",
"r_creator_name": "dmadmin",
"supervisor_name": "dmadmin",
"r_runtime_state": 1,
"r_start_date": "2019-02-26T06:35:58.000+00:00",
"i_next_seqno": 1,
"r_alias_set_id": "0000000000000000",
"parent_id": "0000000000000000",
"parent_act_seqno": 0,
"correlation_identifier": "9f000661a430d930db3138306730303f",
"i_next_act_group_seqno": 0,
"r_act_seqno": [
0
],
"r_act_name": [
"Activity-1"
],
"r_act_def_id": [
"4c000001800025c9"
],
"r_act_errorno": [
0
],
"r_act_state": [
1
],
"r_repeat_invoke": [
true
],
"r_trigger_thresh": [
0
],
"r_trigger_input": [
0
],
"r_trigger_revert": [
0
],
"r_pre_timer": [
null
],
"r_post_timer": [
null
],
"r_total_witem": [
1
],
"r_complete_witem": [
0
],
"r_last_performer": [
""
],
"r_last_witem_id": [
"0000000000000000"
],
"i_performer_flag": [
0
],
"r_target_act_seqno": [
-1
],
"i_is_replica": false,
"i_vstamp": 1,
"r_object_id": "4d0000018000010a"
},
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/

EDCPKRST220200-PRE-EN-01 Reference Guide 917

Chapter 2 Resources

4d0000018000010a"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-template",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-attachments",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments"
}, {
"rel": "http://identifiers.emc.com/linkrel/work-items",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/work-items"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"title": "Activity-1",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
}
]
}

Example 2-430: HAL: JSON Response

{
"name": "workflow",
"type": "dm_workflow",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_workflow",
"properties": {
"object_name": "a_test_workflow 2019-02-26",
"process_id": "4b0000018000236e",
"r_creator_name": "dmadmin",
"supervisor_name": "dmadmin",
"r_runtime_state": 1,
"r_start_date": "2019-02-26T06:35:58.000+00:00",
"i_next_seqno": 1,
"r_alias_set_id": "0000000000000000",
"parent_id": "0000000000000000",
"parent_act_seqno": 0,
"correlation_identifier": "9f000661a430d930db3138306730303f",
"i_next_act_group_seqno": 0,
"r_act_seqno": [
0
],
"r_act_name": [
"Activity-1"
],
"r_act_def_id": [
"4c000001800025c9"
],
"r_act_errorno": [
0
],
"r_act_state": [
1
],
"r_repeat_invoke": [
true
],
"r_trigger_thresh": [
0
],
"r_trigger_input": [
0
],

918 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

"r_trigger_revert": [
0
],
"r_pre_timer": [
null
],
"r_post_timer": [
null
],
"r_total_witem": [
1
],
"r_complete_witem": [
0
],
"r_last_performer": [
""
],
"r_last_witem_id": [
"0000000000000000"
],
"i_performer_flag": [
0
],
"r_target_act_seqno": [
-1
],
"i_is_replica": false,
"i_vstamp": 1,
"r_object_id": "4d0000018000010a"
},
"_links": {
"http://identifiers.emc.com/linkrel/work-items": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/work-items"
},
"http://identifiers.emc.com/linkrel/workflow-activity": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9",
"title": "Activity-1"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflows/4d0000018000010a"
},
"http://identifiers.emc.com/linkrel/workflow-attachments": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments"
},
"http://identifiers.emc.com/linkrel/workflow-template": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}
}
}

EDCPKRST220200-PRE-EN-01 Reference Guide 919

Chapter 2 Resources

2.87.2 Workflows
The Workflows resource is used to get Workflow instances as a feed.

2.87.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Repository” on page 562 and About the Diagrams
on page 17.

2.87.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: The resource URI

• Feed Title: Workflows
• Feed Updated: Server's current time
• Supports POST: Yes
• Entry: Workflow resource
• Entry ID: The entry URI
• Entry Title: The name of the Workflow
• Entry Updated: The last modify date

2.87.2.3 Link relations

Link relation Description Resource reference

self Link to this resource “Workflows” on page 920

2.87.2.4 Operations

920 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

2.87.2.4.1 Supported HTTP methods

Method Description
GET Retrieves Workflows as a feed
POST Used to start a Workflow

2.87.2.4.2 Get Workflows

This operation retrieves Workflows as a feed.

2.87.2.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
GET page, items- For more information, see Appendix B, REST Common
per-page, Definition - URI Request Query Parameters on page 979
include-total,
links, sort,
view, filter,
inline

2.87.2.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.87.2.4.2.3 Request media types

N/A

2.87.2.4.2.4 Request body

N/A

2.87.2.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 921

Chapter 2 Resources

2.87.2.4.2.6 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.87.2.4.2.7 Response media types

• application/atom+xml
• application/xml

• application/vnd.emc.documentum+json

• application/json

• application/hal+json

2.87.2.4.2.8 Response body

Example 2-431: XML response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/workflows</id>
<title>Workflows</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2019-02-26T06:20:35.128+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/workflows"
rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100</id>
<title>a_test_workflow 2018-12-25</title>
<updated>2019-02-26T06:20:35.146+00:00</updated>
<published>2018-12-25T09:18:22.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100"
rel="edit"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
rel="http://identifiers.emc.com/linkrel/workflow-template"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100"
type="application/vnd.emc.documentum+xml"/>
</entry>
</feed>

922 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

Example 2-432: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/workflows",
"title": "Workflows",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-26T06:23:05.510+00:00",
"page": 1,
"items-per-page": 100,
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows"
}
],
"entries": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100",
"title": "a_test_workflow 2018-12-25",
"updated": "2019-02-26T06:23:05.510+00:00",
"published": "2018-12-25T09:18:22.000+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflows/4d00000180000100"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-template",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
workflows/4d00000180000100"
}
}
]
}

Example 2-433: HAL: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/workflows",
"title": "Workflows",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-26T06:23:21.597+00:00",
"page": 1,
"items-per-page": 100,
"_embedded": {
"collection": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d00000180000100",
"title": "a_test_workflow 2018-12-25",
"updated": "2019-02-26T06:23:21.597+00:00",
"published": "2018-12-25T09:18:22.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflows/4d00000180000100"

EDCPKRST220200-PRE-EN-01 Reference Guide 923

Chapter 2 Resources

},
"http://identifiers.emc.com/linkrel/workflow-template": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}
}
}
]
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows"
}
}
}

2.87.2.4.3 Start Workflows

This operation creates and then starts a workflow from a template or it can be used
to create and then start a quick flow that is not based on a workflow template. Quick
flows can be used to route objects to users or groups.

2.87.2.4.3.1 HTTP Request Method and Query Parameters

HTTP Query Description Data Value Default

method paramete type range value
rs
POST quick- Specifies whether to start an ad-hoc string true, false
flow workflow or start a workflow from a false
template.
• true: Creates and then starts an
ad-hoc workflow to route objects
to users and groups
• false: Creates and then starts a
workflow from a template

2.87.2.4.3.2 Request headers

• Authorization

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

924 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

2.87.2.4.3.3 Request media types

• application/vnd.emc.documentum+xml
• application/vnd.emc.documentum+json
• application/hal+json

2.87.2.4.3.4 Request body

A Workflow can be created and started ad-hoc or using a template.

Start a Workflow from a template

The default behavior is to create and start a Workflow from a template. In this case,
creating a reference to the Workflow template in XML or JSON is mandatory. You
can use the workflow-name property to specify the object name of the Workflow
instance.

When the Workflow is created with a start activity that does not have any input
ports, the start activity becomes active and then appears in the recipient’s inbox.

When the Workflow is designed with a start activity that does contain an input port,
the start activity does not become active until you attach a package to its input port.
To do this, just add a package to a start activity during the workflow instance
creation from a template. When an activity name is not provided, a default start
activity is used.

To add documents or notes to the packages in the template definition, with the
exception of the mandatory href attribute, you can use a list of packages, and one of
those packages can contain the following attributes:

• package-name: The name of a workflow package. This attribute is mandatory.

• document-ids: The object IDs of the package's components. This attribute is only
mandatory when adding a package action.
• note#text: Defines a message to send to the package's recipients.
• note#persistent: Set this to TRUE when you want to send the note defined in
note#text to the performers of all activities receiving this package. When this is
set to FALSE, the note is sent only to the performers of the activities that
immediately follow the start activity.

Starts an ad-hoc Workflow

When you are starting an ad-hoc flow, the quick-flow Request parameter must be
set to true. This method allows you to create and start a workflow that is not based
on a workflow template. Creating and starting a workflow this way enables you to
route one or more objects to one or more users, groups, or users and groups.

When you send tasks to multiple users, you can select whether each user receives
those tasks simultaneously or sequentially.

EDCPKRST220200-PRE-EN-01 Reference Guide 925

Chapter 2 Resources

The following parameters can be set when starting an ad-hoc workflow:

• users: A list of users who are assigned workflow tasks

• groups: A list of groups that are assigned workflow tasks
• object-ids: This mandatory attribute is a list of documents that you want to send
to the specified users and groups. You can only send persistent objects in a
workflow.
• instruction: The task instructions for the recipients of workflow tasks.
• priority: A representation of the urgency or importance of a task. The values that
are valid as priority levels include: LOW, MEDIUM, and HIGH. Each value is case
sensitive.
• flags: Any combination of the options shown in the table below, bitwise OR'ed
together. For example 1, 2, 3, 4, 7, 12, 20...

Name in IDfWorkflow (DFC Description Value

interface)
DF_REQ_END_NOTIFICATION Use this flag when you want the 0x0001
sender to receive a notification when
all recipients have completed their
workflow tasks
DF_REQ_SIGN_OFF Use this flag when you want the 0x0002
recipients to sign off the workflow
tasks
DF_SEQUENTIAL Use this flag when you want the 0x0004
recipients to receive the workflow
tasks sequentially
DF_ALLOW_REJECT_PREVIOUS Use this flag when you want the 0x000c
recipients to be able to reject their
workflow tasks to the previous
recipient if they are in a sequential ad-
hoc workflow
DF_ALLOW_REJECT_INITIATOR Use this flag when you want the 0x0014
recipients to be able to reject their
workflow tasks to the sender if they
are in a sequential ad-hoc workflow

Example 2-434: XML: Workflow from a template

This creates and starts a workflow from a template, but does not add a package
to the start activity.
<?xml version="1.0" encoding="UTF-8"?>
<workflow>
<href>http://localhost:8080/dctm-rest/repositories/REPO/workflow-templates/
4b0000018000236e</href>
<workflow-name>the name of this workflow</workflow-name>
</workflow>

926 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

Example 2-435: XML: Workflow from a template with a package

This creates a workflow instance from a template, adds a package to the start
activity, and starts the workflow.
<workflow>
<href>http://localhost:8080/dctm-rest/repositories/REPO/workflow-templates/
4b0000018003e395</href>
<workflow-name>the name of this workflow</workflow-name>
<packages>
<package>
<package-name>Package0</package-name>
<document-ids>
<document-id>0900000180011f0d</document-id>
</document-ids>
<notes>
<note>
<text>this is the first note for package0. true-persistent</text>
<persistent>true</persistent>
</note>
<note>
<text>this is the second note for package0. false-persistent</text>
<persistent>false</persistent>
</note>
</notes>
</package>
<package>
<package-name>Package1</package-name>
<document-ids>
<document-id>0900000180011fad</document-id>
</document-ids>
<notes>
<note>
<text>this is the first note for package1. true-persistent</text>
<persistent>true</persistent>
</note>
<note>
<text>this is the second note for package1. false-persistent</text>
<persistent>false</persistent>
</note>
</notes>
</package>
</packages>
</workflow>

Example 2-436: XML: Start an ad-hoc workflow

This creates and then starts an ad-hoc workflow.

<?xml version="1.0" encoding="UTF-8"?>
<workflow>
<users>
<user>dave</user>
<user>dmadmin</user>
</users>
<groups>
<group>docu</group>
</groups>
<object-ids>
<object-id>09000001800021bf</object-id>
<object-id>09000001800021be</object-id>
</object-ids>
<instruction>Create and start a quick flow that is not based on a self
workflow template.</instruction>
<priority>MEDIUM</priority>

EDCPKRST220200-PRE-EN-01 Reference Guide 927

Chapter 2 Resources

<flags>3</flags>
</workflow>

Example 2-437: JSON: A workflow from a template

This creates and then starts a workflow from a template, but it does not add a
package to the start activity.
{
"href":"http://localhost:8080/dctm-rest/repositories/REPO/workflow-templates/
4b0000018000236e",
"workflow-name":"the name of this workflow"
}

Example 2-438: JSON: A workflow from template with package

{
"href": "/repositories/REPO/workflow-templates/4b0000018003e395",
"packages": [{
"package-name": "Package0",
"document-ids": [
"0900000180011f0d"

],
"notes": [{
"text": "this is the first note for package0. true-persistent",
"persistent": true
}, {
"text": "this is the second note for package0. false-persistent",
"persistent": false
}
]
}, {
"package-name": "Package1",
"document-ids": [
"0900000180011fad"
],
"notes": [{
"text": "this is the first note for package1. true-persistent",
"persistent": true
}, {
"text": "this is the second note for package1. false-persistent",
"persistent": false
}
]
}
],
"workflow-name": "Document review Workflow Instance 2019-7-03"
}

Example 2-439: JSON: Start an ad-hoc workflow

This creates and then starts an ad-hoc workflow.

{
"users": [
"dave",
"dmadmin",
"Administrator"

928 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

],
"groups": [
"docu"
],
"object-ids": [
"09000001800021c0",
"09000001800021bf",
"09000001800021be"
],
"instruction": "A quickflow is a single task you send to one or more users
usually for review or acknowledgement use cases. If you
send a quickflow to multiple users, you can select whether
each user receives the task simultaneously or sequentially.",
"priority": "LOW",
"flags": 7
}

Example 2-440: HAL+JSON: A workflow from a template

This creates and then starts a workflow from a template, but does not add a
package to the start activity.
{
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e",
"workflow-name": "the name of this workflow"
}

Example 2-441: HAL+JSON: A workflow from a template with a package

This creates and then starts a workflow from a template, and adds a package to
the start activity of the workflow instance.
{
"href": "/repositories/REPO/workflow-templates/4b0000018003e395",
"packages": [{
"package-name": "Package0",
"document-ids": [
"0900000180011f0d"

],
"notes": [{
"text": "this is the first note for package0. true-persistent",
"persistent": true
}, {
"text": "this is the second note for package0. false-persistent",
"persistent": false
}
]
}, {
"package-name": "Package1",
"document-ids": [
"0900000180011fad"
],
"notes": [{
"text": "this is the first note for package1. true-persistent",
"persistent": true
}, {
"text": "this is the second note for package1. false-persistent",
"persistent": false
}
]

EDCPKRST220200-PRE-EN-01 Reference Guide 929

Chapter 2 Resources

}
],
"workflow-name": "Document review Workflow Instance 2019-7-03"
}

Example 2-442: HAL+JSON: start an ad-hoc workflow

This creates and then starts an ad-hoc workflow.

{
"workflow-name": "the name of this quick flow",
"users": [
"dave",
"dmadmin",
"Administrator"
],
"groups": [
"docu"
],
"object-ids": [
"09000001800021c0",
"09000001800021bf",
"09000001800021be"
],
"instruction": "A quickflow is a single task you send to one or more users
usually for review or acknowledgement use cases. If you send
a quickflow to multiple users, you can select whether each
user receives the task simultaneously or sequentially.",
"priority": "LOW",
"flags": 7
}

2.87.2.4.3.5 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.87.2.4.3.6 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

930 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

2.87.2.4.3.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.87.2.4.3.8 Response body

Example 2-443: XML response

<?xml version="1.0" encoding="UTF-8"?>
<workflow
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_workflow"
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_workflow">
<properties>
<object_name>a_test_workflow 2019-02-26</object_name>
<process_id>4b0000018000236e</process_id>
<r_creator_name>dmadmin</r_creator_name>
<supervisor_name>dmadmin</supervisor_name>
<r_runtime_state>1</r_runtime_state>
<r_start_date>2019-02-26T06:35:58.000+00:00</r_start_date>
<i_next_seqno>1</i_next_seqno>
<r_alias_set_id>0000000000000000</r_alias_set_id>
<parent_id>0000000000000000</parent_id>
<parent_act_seqno>0</parent_act_seqno>
<correlation_identifier>
9f000661a430d930db3138306730303f
</correlation_identifier>
<i_next_act_group_seqno>0</i_next_act_group_seqno>
<r_act_seqno>
<item>0</item>
</r_act_seqno>
<r_act_name>
<item>Activity-1</item>
</r_act_name>
<r_act_def_id>
<item>4c000001800025c9</item>
</r_act_def_id>
<r_act_errorno>
<item>0</item>
</r_act_errorno>
<r_act_state>
<item>1</item>
</r_act_state>
<r_repeat_invoke>
<item>true</item>
</r_repeat_invoke>
<r_trigger_thresh>
<item>0</item>
</r_trigger_thresh>
<r_trigger_input>
<item>0</item>
</r_trigger_input>
<r_trigger_revert>
<item>0</item>
</r_trigger_revert>
<r_pre_timer>
<item xsi:nil="true"/>
</r_pre_timer>

EDCPKRST220200-PRE-EN-01 Reference Guide 931

Chapter 2 Resources

<r_post_timer>
<item xsi:nil="true"/>
</r_post_timer>
<r_total_witem>
<item>1</item>
</r_total_witem>
<r_complete_witem>
<item>0</item>
</r_complete_witem>
<r_last_performer>
<item/>
</r_last_performer>
<r_last_witem_id>
<item>0000000000000000</item>
</r_last_witem_id>
<i_performer_flag>
<item>0</item>
</i_performer_flag>
<r_target_act_seqno>
<item>-1</item>
</r_target_act_seqno>
<i_is_replica>false</i_is_replica>
<i_vstamp>1</i_vstamp>
<r_object_id>4d0000018000010a</r_object_id>
</properties>
<links>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a"
rel="self"/>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
rel="http://identifiers.emc.com/linkrel/workflow-template"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
rel="http://identifiers.emc.com/linkrel/workflow-activity"
title="Activity-1"/>
</links>
</workflow>

Example 2-444: JSON response

{
"name": "workflow",
"type": "dm_workflow",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_workflow",
"properties": {
"object_name": "a_test_workflow 2019-02-26",
"process_id": "4b0000018000236e",
"r_creator_name": "dmadmin",
"supervisor_name": "dmadmin",
"r_runtime_state": 1,
"r_start_date": "2019-02-26T06:35:58.000+00:00",
"i_next_seqno": 1,
"r_alias_set_id": "0000000000000000",
"parent_id": "0000000000000000",
"parent_act_seqno": 0,
"correlation_identifier": "9f000661a430d930db3138306730303f",
"i_next_act_group_seqno": 0,
"r_act_seqno": [
0
],
"r_act_name": [
"Activity-1"
],

932 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.87. Workflow(s)

"r_act_def_id": [
"4c000001800025c9"
],
"r_act_errorno": [
0
],
"r_act_state": [
1
],
"r_repeat_invoke": [
true
],
"r_trigger_thresh": [
0
],
"r_trigger_input": [
0
],
"r_trigger_revert": [
0
],
"r_pre_timer": [
null
],
"r_post_timer": [
null
],
"r_total_witem": [
1
],
"r_complete_witem": [
0
],
"r_last_performer": [
""
],
"r_last_witem_id": [
"0000000000000000"
],
"i_performer_flag": [
0
],
"r_target_act_seqno": [
-1
],
"i_is_replica": false,
"i_vstamp": 1,
"r_object_id": "4d0000018000010a"
},
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-template",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"title": "Activity-1",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
}
]
}

EDCPKRST220200-PRE-EN-01 Reference Guide 933

Chapter 2 Resources

Example 2-445: HAL + JSON Response

{
"name": "workflow",
"type": "dm_workflow",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_workflow",
"properties": {
"object_name": "a_test_workflow 2019-02-26",
"process_id": "4b0000018000236e",
"r_creator_name": "dmadmin",
"supervisor_name": "dmadmin",
"r_runtime_state": 1,
"r_start_date": "2019-02-26T06:35:58.000+00:00",
"i_next_seqno": 1,
"r_alias_set_id": "0000000000000000",
"parent_id": "0000000000000000",
"parent_act_seqno": 0,
"correlation_identifier": "9f000661a430d930db3138306730303f",
"i_next_act_group_seqno": 0,
"r_act_seqno": [
0
],
"r_act_name": [
"Activity-1"
],
"r_act_def_id": [
"4c000001800025c9"
],
"r_act_errorno": [
0
],
"r_act_state": [
1
],
"r_repeat_invoke": [
true
],
"r_trigger_thresh": [
0
],
"r_trigger_input": [
0
],
"r_trigger_revert": [
0
],
"r_pre_timer": [
null
],
"r_post_timer": [
null
],
"r_total_witem": [
1
],
"r_complete_witem": [
0
],
"r_last_performer": [
""
],
"r_last_witem_id": [
"0000000000000000"
],
"i_performer_flag": [
0
],
"r_target_act_seqno": [

934 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.88. Workflow Activity (ies)

-1
],
"i_is_replica": false,
"i_vstamp": 1,
"r_object_id": "4d0000018000010a"
},
"_links": {
"http://identifiers.emc.com/linkrel/workflow-activity": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9",
"title": "Activity-1"
},
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a"
},
"http://identifiers.emc.com/linkrel/workflow-template": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}
}
}

2.88 Workflow Activity (ies)

2.88.1 Workflow Activity
The Workflow Activity resource is used to retrieve a Workflow Activity from the
Workflow Activities resource.

2.88.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Workflow Activities” on page 946 and About the
Diagrams on page 17.

EDCPKRST220200-PRE-EN-01 Reference Guide 935

Chapter 2 Resources

2.88.1.2 Feed
No feed support.

2.88.1.3 Link relations

Link relation Description Resource reference

self Link to this resource “Workflow Activity”
on page 935

2.88.1.4 Operations
2.88.1.4.1 Supported HTTP methods

Method Description
GET Retrieve a Workflow Activity.

2.88.1.4.2 Get a Workflow Activity

This operation retrieves a Workflow Activity.

2.88.1.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links, view For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979

2.88.1.4.2.2 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.88.1.4.2.3 Request media types

N/A

936 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.88. Workflow Activity (ies)

2.88.1.4.2.4 Request body

N/A

2.88.1.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.88.1.4.2.6 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.88.1.4.2.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.88.1.4.2.8 Response body

Example 2-446: XML response

<?xml version="1.0" encoding="UTF-8"?>
<workflow-activity
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_activity"
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_activity">
<properties>
<object_name>Activity-1</object_name>
<r_object_type>dm_activity</r_object_type>
<r_creation_date>2018-12-25T09:17:29.000+00:00</r_creation_date>
<r_modify_date>2018-12-25T09:17:30.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>0b00000180002364</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>

EDCPKRST220200-PRE-EN-01 Reference Guide 937

Chapter 2 Resources

<r_has_frzn_assembly>false</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>0c00000180002114</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>4c000001800025c9</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_4500000180000914</acl_name>
<a_special_app>palette/activity.gif</a_special_app>
<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>
<is_private>false</is_private>
<r_definition_state>2</r_definition_state>
<trigger_threshold>1</trigger_threshold>
<pre_timer>0</pre_timer>
<post_timer>0</post_timer>
<repeatable_invoke>true</repeatable_invoke>
<exec_type>0</exec_type>
<exec_method_id>0000000000000000</exec_method_id>
<exec_save_results>false</exec_save_results>
<exec_time_out>0</exec_time_out>
<exec_err_handling>0</exec_err_handling>
<performer_type>0</performer_type>
<performer_flag>0</performer_flag>
<transition_type>0</transition_type>
<r_condition_id>0000000000000000</r_condition_id>
<sign_off_required>false</sign_off_required>
<resolve_type>0</resolve_type>
<control_flag>0</control_flag>
<transition_max_output_cnt>0</transition_max_output_cnt>
<transition_eval_cnt>0</transition_eval_cnt>
<transition_flag>0</transition_flag>
<pre_timer_repeat_last>0</pre_timer_repeat_last>
<pre_timer_calendar_flag>0</pre_timer_calendar_flag>
<pre_timer_calendar_id>0000000000000000</pre_timer_calendar_id>
<post_timer_repeat_last>0</post_timer_repeat_last>
<post_timer_calendar_flag>0</post_timer_calendar_flag>
<post_timer_calendar_id>0000000000000000</post_timer_calendar_id>
<r_performer_cond_id>0000000000000000</r_performer_cond_id>
<exec_retry_max>0</exec_retry_max>
<exec_retry_interval>0</exec_retry_interval>

938 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.88. Workflow Activity (ies)

<exec_subtype>0</exec_subtype>
<activity_group_id>0000000000000000</activity_group_id>
<activity_group_flag>0</activity_group_flag>
<lsm_id>0000000000000000</lsm_id>
<performer_name>
<item>N/A</item>
</performer_name>
<r_port_name>
<item>Input:0</item>
<item>Input:1</item>
<item>Input:1</item>
<item>Output:2</item>
<item>Output:1</item>
<item>Output:0</item>
</r_port_name>
<r_port_type>
<item>INPUT</item>
<item>REVERT</item>
<item>REVERT</item>
<item>OUTPUT</item>
<item>OUTPUT</item>
<item>OUTPUT</item>
</r_port_type>
<r_package_name>
<item/>
<item>Package0</item>
<item>Package1</item>
<item>Package0</item>
<item/>
<item>Package0</item>
</r_package_name>
<r_package_type>
<item/>
<item>dm_sysobject</item>
<item>dm_sysobject</item>
<item>dm_sysobject</item>
<item/>
<item>dm_sysobject</item>
</r_package_type>
<r_package_oprtn>
<item/>
<item/>
<item/>
<item/>
<item/>
<item/>
</r_package_oprtn>
<r_package_id>
<item>0000000000000000</item>
<item>0000000000000000</item>
<item>0000000000000000</item>
<item>0000000000000000</item>
<item>0000000000000000</item>
<item>0000000000000000</item>
</r_package_id>
<r_package_label>
<item/>
<item>CURRENT</item>
<item>CURRENT</item>
<item>CURRENT</item>
<item/>
<item>CURRENT</item>
</r_package_label>
<r_package_flag>
<item>1</item>
<item>1</item>
<item>1</item>
<item>1</item>
<item>1</item>
<item>1</item>

EDCPKRST220200-PRE-EN-01 Reference Guide 939

Chapter 2 Resources

</r_package_flag>
<r_package_report_flag>
<item>0</item>
<item>0</item>
<item>0</item>
<item>0</item>
<item>0</item>
<item>0</item>
</r_package_report_flag>
<r_object_id>4c000001800025c9</r_object_id>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9" rel="self"/>
</links>
</workflow-activity>

Example 2-447: JSON response

{
"name": "workflow-activity",
"type": "dm_activity",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_activity",
"properties": {
"object_name": "Activity-1",
"r_object_type": "dm_activity",
"r_creation_date": "2018-12-25T09:17:29.000+00:00",
"r_modify_date": "2018-12-25T09:17:30.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": [
"0b00000180002364"
],
"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": "0000000000000000",
"r_page_cnt": 0,
"r_content_size": 0,
"a_full_text": true,
"i_cabinet_id": "0c00000180002114",
"owner_name": "dmadmin",
"owner_permit": 7,
"group_name": "docu",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "4c000001800025c9",
"i_latest_flag": true,
"r_version_label": [
"1.0",
"CURRENT"
],
"i_branch_cnt": 0,
"i_direct_dsc": false,
"r_immutable_flag": false,

940 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.88. Workflow Activity (ies)

"r_frozen_flag": false,
"r_has_events": false,
"acl_domain": "dmadmin",
"acl_name": "dm_4500000180000914",
"a_special_app": "palette/activity.gif",
"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.0,
"a_is_signed": false,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 5,
"is_private": false,
"r_definition_state": 2,
"trigger_threshold": 1,
"pre_timer": 0,
"post_timer": 0,
"repeatable_invoke": true,
"exec_type": 0,
"exec_method_id": "0000000000000000",
"exec_save_results": false,
"exec_time_out": 0,
"exec_err_handling": 0,
"performer_type": 0,
"performer_flag": 0,
"transition_type": 0,
"r_condition_id": "0000000000000000",
"sign_off_required": false,
"resolve_type": 0,
"control_flag": 0,
"transition_max_output_cnt": 0,
"transition_eval_cnt": 0,
"transition_flag": 0,
"pre_timer_repeat_last": 0,
"pre_timer_calendar_flag": 0,
"pre_timer_calendar_id": "0000000000000000",
"post_timer_repeat_last": 0,
"post_timer_calendar_flag": 0,
"post_timer_calendar_id": "0000000000000000",
"r_performer_cond_id": "0000000000000000",
"exec_retry_max": 0,
"exec_retry_interval": 0,
"exec_subtype": 0,
"activity_group_id": "0000000000000000",
"activity_group_flag": 0,
"lsm_id": "0000000000000000",
"performer_name": [
"N/A"
],
"r_port_name": [
"Input:0",
"Input:1",
"Input:1",
"Output:2",
"Output:1",
"Output:0"
],
"r_port_type": [
"INPUT",
"REVERT",
"REVERT",
"OUTPUT",
"OUTPUT",
"OUTPUT"

EDCPKRST220200-PRE-EN-01 Reference Guide 941

Chapter 2 Resources

],
"r_package_name": [
"",
"Package0",
"Package1",
"Package0",
"",
"Package0"
],
"r_package_type": [
"",
"dm_sysobject",
"dm_sysobject",
"dm_sysobject",
"",
"dm_sysobject"
],
"r_package_oprtn": [
"",
"",
"",
"",
"",
""
],
"r_package_id": [
"0000000000000000",
"0000000000000000",
"0000000000000000",
"0000000000000000",
"0000000000000000",
"0000000000000000"
],
"r_package_label": [
"",
"CURRENT",
"CURRENT",
"CURRENT",
"",
"CURRENT"
],
"r_package_flag": [
1,
1,
1,
1,
1,
1
],
"r_package_report_flag": [
0,
0,
0,
0,
0,
0
],
"r_object_id": "4c000001800025c9"
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
}
}
}

942 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.88. Workflow Activity (ies)

Example 2-448: HAL: JSON Response

{
"name": "workflow-template",
"type": "dm_process",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_process",
"properties": {
"object_name": "a_test_workflow",
"r_object_type": "dm_process",
"r_creation_date": "2018-12-25T09:17:22.000+00:00",
"r_modify_date": "2018-12-25T09:17:32.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": [
"0b00000180002364"
],
"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": "0600000180001500",
"a_content_type": "dm_internal",
"r_page_cnt": 1,
"r_content_size": 2525,
"a_full_text": true,
"a_storage_type": "filestore_01",
"i_cabinet_id": "0c00000180002114",
"owner_name": "dmadmin",
"owner_permit": 7,
"group_name": "docu",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "4b0000018000236e",
"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_4500000180000914",
"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": 2525.0,
"a_is_signed": false,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 4,
"is_private": false,
"r_definition_state": 2,

EDCPKRST220200-PRE-EN-01 Reference Guide 943

Chapter 2 Resources

"perf_alias_set_id": "0000000000000000",
"package_control": 0,
"sd_element_default_acl": "0000000000000000",
"calendar_id": "0000000000000000",
"execution_flag": 0,
"r_act_name": [
"Auto-Activity-2",
"Auto-Activity-1",
"Activity-4",
"Activity-3",
"Activity-2",
"Activity-1"
],
"r_act_priority": [
0,
0,
0,
0,
0,
0
],
"r_act_type": [
0,
0,
0,
2,
0,
1
],
"r_act_def_id": [
"4c000001800025c4",
"4c000001800025c5",
"4c000001800025c6",
"4c000001800025c7",
"4c000001800025c8",
"4c000001800025c9"
],
"r_link_name": [
"L20",
"L16",
"L15",
"L14",
"L11",
"L10",
"L27",
"L26",
"L19",
"L30"
],
"r_link_src_act": [
"Auto-Activity-2",
"Activity-4",
"Activity-2",
"Activity-2",
"Activity-2",
"Activity-1",
"Activity-1",
"Activity-1",
"Auto-Activity-1",
"Activity-4"
],
"r_link_src_port": [
"Output:0",
"Output:0",
"Output:2",
"Output:1",
"Output:0",
"Output:0",
"Output:2",
"Output:1",

944 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.88. Workflow Activity (ies)

"Output:0",
"Output:1"
],
"r_link_dest_act": [
"Activity-3",
"Activity-3",
"Activity-4",
"Activity-1",
"Activity-3",
"Activity-2",
"Activity-4",
"Auto-Activity-1",
"Auto-Activity-2",
"Activity-4"
],
"r_link_dest_port": [
"Input:2",
"Input:1",
"Input:0",
"Input:1",
"Input:0",
"Input:0",
"Input:1",
"Input:0",
"Input:0",
"Input:2"
],
"r_object_id": "4b0000018000236e"
},
"_links": {
"http://identifiers.emc.com/linkrel/workflow-activity": [{
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c4",
"title": "Auto-Activity-2"
}, {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c5",
"title": "Auto-Activity-1"
}, {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c6",
"title": "Activity-4"
}, {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c7",
"title": "Activity-3"
}, {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c8",
"title": "Activity-2"
}, {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9",
"title": "Activity-1"
}
],
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
},
"http://identifiers.emc.com/linkrel/workflow-activities": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e/activities"
}
}
}

EDCPKRST220200-PRE-EN-01 Reference Guide 945

Chapter 2 Resources

2.88.2 Workflow Activities

The Workflow Activities resource retrieves a list of Workflow Activities.

2.88.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Workflow Template” on page 959 and About the
Diagrams on page 17.

2.88.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: The resource URI

• Feed Title: Workflow activities
• Feed Updated: Server's current time
• Supports POST: No
• Entry: Workflow Activity resource
• Entry ID: The entry URI
• Entry Title: The name of the workflow activity
• Entry Updated: The last modify date

2.88.2.3 Link relations

Link relation Description Resource reference

self Link to this resource “Workflow Activities”
on page 946

946 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.88. Workflow Activity (ies)

2.88.2.4 Operations
2.88.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a collection of Workflow Activity
templates as a feed.

2.88.2.4.2 Get Workflow template activities

This operation retrieves a collection of Workflow Activities from a Workflow Template

instance.

2.88.2.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links, sort, For more information, see Appendix B, REST Common
view, filter, Definition - URI Request Query Parameters on page 979
inline

Note: The page, items-per-page, and include-total parameters are not

supported.

2.88.2.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.88.2.4.2.3 Request media types

N/A

2.88.2.4.2.4 Request body

N/A

EDCPKRST220200-PRE-EN-01 Reference Guide 947

Chapter 2 Resources

2.88.2.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.88.2.4.2.6 Response headers

• Content-Type

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.88.2.4.2.7 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.88.2.4.2.8 Response body

Example 2-449: XML response

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/workflow-templates/
4b0000018000236e/activities</id>
<title>Workflow activities</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2019-02-25T08:42:04.881+00:00</updated>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e/activities" rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9</id>
<title>Activity-1</title>
<summary>dm_activity 4c000001800025c9</summary>
<updated>2018-12-25T09:17:30.000+00:00</updated>
<published>2018-12-25T09:17:29.000+00:00</published>
<link href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
rel="edit"/>
<content src="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
type="application/vnd.emc.documentum+xml"/>
</entry>
</feed>

948 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.88. Workflow Activity (ies)

Example 2-450: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e/activities",
"title": "Workflow activities",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-25T08:45:29.341+00:00",
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e/activities"
}
],
"entries": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9",
"title": "Activity-1",
"summary": "dm_activity 4c000001800025c9",
"updated": "2018-12-25T09:17:30.000+00:00",
"published": "2018-12-25T09:17:29.000+00:00",
"links": [{
"rel": "edit",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
}
}
]
}

Example 2-451: HAL: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e/activities",
"title": "Workflow activities",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-25T08:45:30.654+00:00",
"_embedded": {
"collection": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9",
"title": "Activity-1",
"summary": "dm_activity 4c000001800025c9",
"updated": "2018-12-25T09:17:30.000+00:00",
"published": "2018-12-25T09:17:29.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
}
}
}

EDCPKRST220200-PRE-EN-01 Reference Guide 949

Chapter 2 Resources

]
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e/activities"
}
}
}

2.89 Workflow Attachment(s)

2.89.1 Workflow Attachment
The Workflow Attachment resource is used to remove a specified Workflow Attachment.

2.89.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Workflow Attachments” on page 952 and About the
Diagrams on page 17.

2.89.1.2 Feed
No feed support.

2.89.1.3 Link relations

N/A

2.89.1.4 Operations

950 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.89. Workflow Attachment(s)

2.89.1.4.1 Supported HTTP methods

Method Description
DELETE Removes a specified Workflow Attachment.

2.89.1.4.2 Remove a Workflow Attachment

This operation removes a specified Workflow Attachment.

2.89.1.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
DELETE For more information, see Appendix B, REST Common Definition - URI
Request Query Parameters on page 979

2.89.1.4.2.2 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.89.1.4.2.3 Request media types

N/A

2.89.1.4.2.4 Request body

N/A

2.89.1.4.2.5 Response status

• 204 - Removed successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 951

Chapter 2 Resources

2.89.1.4.2.6 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.89.1.4.2.7 Response media types

N/A

2.89.1.4.2.8 Response body

N/A

2.89.2 Workflow Attachments

This resource is used to retrieve a collection of Workflow Attachments.

2.89.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Workflow” on page 906 and About the Diagrams
on page 17.

2.89.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: The resource URI

• Feed Title: Workflow Attachments

• Feed Updated: Server's current time

• Supports POST: Yes

• Entry: Workflow Attachment resource

• Entry ID: The entry URI

• Entry Title: The name of the attachment

• Entry Updated: The last modify date

952 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.89. Workflow Attachment(s)

2.89.2.3 Link relations

Link relation Description Resource reference

self Link to this resource “Workflow Attachments”
on page 952

2.89.2.4 Operations
2.89.2.4.1 Supported HTTP methods

Method Description
GET Retrieves the workflow attachments.
POST Adds an attachment to a Workflow.

2.89.2.4.2 Get Workflow attachments

This operation retrieves workflow attachments.

2.89.2.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links, inline For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979

Note: Please note, page, items-per-page, include-total, sort, view, and

filter parameters are not supported.

2.89.2.4.2.2 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.89.2.4.2.3 Request media types

N/A

EDCPKRST220200-PRE-EN-01 Reference Guide 953

Chapter 2 Resources

2.89.2.4.2.4 Request body

N/A

2.89.2.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.89.2.4.2.6 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.89.2.4.2.7 Response media types

• application/atom+xm
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.89.2.4.2.8 Response body

Example 2-452: XML response

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments</id>
<title>Workflow attachments</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2019-02-26T09:19:49.144+00:00</updated>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments" rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments/0000000180000554</id>
<title>TargetSetup.Result</title>
<author>
<name>dmadmin</name>
</author>
<summary>dm_sysobject</summary>
<updated>2019-02-26T09:19:49.144+00:00</updated>
<published>2019-02-26T08:32:51.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments/0000000180000554"
rel="http://identifiers.emc.com/linkrel/delete"/>

954 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.89. Workflow Attachment(s)

<content
src="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments/0000000180000554"
type="application/vnd.emc.documentum+xml"/>
</entry>
</feed>

Example 2-453: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments",
"title": "Workflow attachments",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-26T09:19:54.624+00:00",
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments"
}
],
"entries": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments/0000000180000554",
"title": "TargetSetup.Result",
"author": [{
"name": "dmadmin"
}
],
"summary": "dm_sysobject",
"updated": "2019-02-26T09:19:54.624+00:00",
"published": "2019-02-26T08:32:51.000+00:00",
"links": [{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflows/4d0000018000010a/attachments/0000000180000554"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
workflows/4d0000018000010a/attachments/0000000180000554"
}
}
]
}

Example 2-454: HAL+JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments",
"title": "Workflow attachments",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-26T09:19:57.162+00:00",
"_embedded": {

EDCPKRST220200-PRE-EN-01 Reference Guide 955

Chapter 2 Resources

"collection": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments/0000000180000554",
"title": "TargetSetup.Result",
"author": [{
"name": "dmadmin"
}
],
"summary": "dm_sysobject",
"updated": "2019-02-26T09:19:57.162+00:00",
"published": "2019-02-26T08:32:51.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflows/4d0000018000010a/attachments/
0000000180000554"
},
"http://identifiers.emc.com/linkrel/delete": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflows/4d0000018000010a/attachments/
0000000180000554"
}
}
}
]
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments"
}
}
}

2.89.2.4.3 Add attachment to a Workflow

This operation adds an attachment to a Workflow.

2.89.2.4.3.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
POST Appendix B, REST Common Definition - URI Request Query Parameters
on page 979

2.89.2.4.3.2 Request headers

• Authorization
• Accept
• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

956 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.89. Workflow Attachment(s)

2.89.2.4.3.3 Request media types

• application/vnd.emc.documentum+xm
• application/vnd.emc.documentum+json
• application/hal+json

2.89.2.4.3.4 Request body

Example 2-455: XML request

<?xml version="1.0" encoding="UTF-8"?>
<attachment>
<component-id>0900000180000220</component-id>
<component-type>dm_sysobject</component-type>
</attachment>

Example 2-456: JSON request

{
"component-id":"0900000180000220",
"component-type":"dm_sysobject"
}

Example 2-457: JSON + HAL request

{
"component-id":"0900000180000220",
"component-type":"dm_sysobject"
}

2.89.2.4.3.5 Response status

• 201 - Created successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

EDCPKRST220200-PRE-EN-01 Reference Guide 957

Chapter 2 Resources

2.89.2.4.3.6 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.89.2.4.3.7 Response media types

• application/vnd.emc.documentum+xm
• application/xml

• application/vnd.emc.documentum+json

• application/json

• application/hal+json

2.89.2.4.3.8 Response body

Example 2-458: XML response

<?xml version="1.0" encoding="UTF-8"?>

<attachment xmlns:dm="http://identifiers.emc.com/vocab/documentum">
<object-id>0000000180000554</object-id>
<component-id>0900000180000220</component-id>
<component-name>TargetSetup.Result</component-name>
<component-type>dm_sysobject</component-type>
<creator-name>dmadmin</creator-name>
<creation-date>2019-02-26T08:32:51.000+00:00</creation-date>
<workflow-id>4d0000018000010a</workflow-id>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments/0000000180000554"
rel="http://identifiers.emc.com/linkrel/delete"/>
</links>
</attachment>

Example 2-459: JSON response

{
"object-id": "0000000180000554",
"component-id": "0900000180000220",
"component-name": "TargetSetup.Result",
"component-type": "dm_sysobject",
"creator-name": "dmadmin",
"creation-date": "2019-02-26T08:32:51.000+00:00",
"workflow-id": "4d0000018000010a",
"links": [{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments/0000000180000554"
}
]
}

958 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.90. Workflow Template(s)

Example 2-460: HAL+JSON response

{
"object-id": "0000000180000554",
"component-id": "0900000180000220",
"component-name": "TargetSetup.Result",
"component-type": "dm_sysobject",
"creator-name": "dmadmin",
"creation-date": "2019-02-26T08:32:51.000+00:00",
"workflow-id": "4d0000018000010a",
"_links": {
"http://identifiers.emc.com/linkrel/delete": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/workflows/
4d0000018000010a/attachments/0000000180000554"
}
}

2.90 Workflow Template(s)

2.90.1 Workflow Template
The Workflow Template resource is used to get a specified Workflow Template.

2.90.1.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Workflow Templates” on page 970 and About the
Diagrams on page 17.

2.90.1.2 Feed
No feed support.

2.90.1.3 Link relations

Link relation Description Resource reference

self Link to this resource “Workflow Template” on page 959
workflow- Link to a specific Workflow “Workflow Activities” on page 946
activities [1] Activities collection
workflow-activity Link to a specific Workflow Activity “Workflow Activity” on page 935
[1]

EDCPKRST220200-PRE-EN-01 Reference Guide 959

Chapter 2 Resources

Link relation Description Resource reference

[1] This link relation is defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

2.90.1.4 Operations
2.90.1.4.1 Supported HTTP methods

Method Description
GET Retrieves a Workflow Template

2.90.1.4.2 Get Workflow Template

This operation retrieves a specified Workflow Template.

2.90.1.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
GET links, view For more information, see Appendix B, REST Common
Definition - URI Request Query Parameters on page 979

2.90.1.4.2.2 Request headers

• Authorization
• Accept
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.90.1.4.2.3 Request media types

N/A

2.90.1.4.2.4 Request body

N/A

960 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.90. Workflow Template(s)

2.90.1.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.90.1.4.2.6 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.90.1.4.2.7 Response media types

• application/vnd.emc.documentum+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

2.90.1.4.2.8 Response body

Example 2-461: XML response

<?xml version="1.0" encoding="UTF-8"?>
<workflow-template
definition="http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_process"
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dm_process">
<properties>
<object_name>a_test_workflow</object_name>
<r_object_type>dm_process</r_object_type>
<r_creation_date>2018-12-25T09:17:22.000+00:00</r_creation_date>
<r_modify_date>2018-12-25T09:17:32.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>0b00000180002364</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>0600000180001500</i_contents_id>
<a_content_type>dm_internal</a_content_type>
<r_page_cnt>1</r_page_cnt>
<r_content_size>2525</r_content_size>

EDCPKRST220200-PRE-EN-01 Reference Guide 961

Chapter 2 Resources

<a_full_text>true</a_full_text>
<a_storage_type>filestore_01</a_storage_type>
<i_cabinet_id>0c00000180002114</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>4b0000018000236e</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_4500000180000914</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>2525.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>4</i_vstamp>
<is_private>false</is_private>
<r_definition_state>2</r_definition_state>
<perf_alias_set_id>0000000000000000</perf_alias_set_id>
<package_control>0</package_control>
<sd_element_default_acl>0000000000000000</sd_element_default_acl>
<calendar_id>0000000000000000</calendar_id>
<execution_flag>0</execution_flag>
<r_act_name>
<item>Auto-Activity-2</item>
<item>Auto-Activity-1</item>
<item>Activity-4</item>
<item>Activity-3</item>
<item>Activity-2</item>
<item>Activity-1</item>
</r_act_name>
<r_act_priority>
<item>0</item>
<item>0</item>
<item>0</item>
<item>0</item>
<item>0</item>
<item>0</item>
</r_act_priority>
<r_act_type>
<item>0</item>
<item>0</item>
<item>0</item>
<item>2</item>
<item>0</item>
<item>1</item>
</r_act_type>
<r_act_def_id>
<item>4c000001800025c4</item>
<item>4c000001800025c5</item>
<item>4c000001800025c6</item>

962 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.90. Workflow Template(s)

<item>4c000001800025c7</item>
<item>4c000001800025c8</item>
<item>4c000001800025c9</item>
</r_act_def_id>
<r_link_name>
<item>L20</item>
<item>L16</item>
<item>L15</item>
<item>L14</item>
<item>L11</item>
<item>L10</item>
<item>L27</item>
<item>L26</item>
<item>L19</item>
<item>L30</item>
</r_link_name>
<r_link_src_act>
<item>Auto-Activity-2</item>
<item>Activity-4</item>
<item>Activity-2</item>
<item>Activity-2</item>
<item>Activity-2</item>
<item>Activity-1</item>
<item>Activity-1</item>
<item>Activity-1</item>
<item>Auto-Activity-1</item>
<item>Activity-4</item>
</r_link_src_act>
<r_link_src_port>
<item>Output:0</item>
<item>Output:0</item>
<item>Output:2</item>
<item>Output:1</item>
<item>Output:0</item>
<item>Output:0</item>
<item>Output:2</item>
<item>Output:1</item>
<item>Output:0</item>
<item>Output:1</item>
</r_link_src_port>
<r_link_dest_act>
<item>Activity-3</item>
<item>Activity-3</item>
<item>Activity-4</item>
<item>Activity-1</item>
<item>Activity-3</item>
<item>Activity-2</item>
<item>Activity-4</item>
<item>Auto-Activity-1</item>
<item>Auto-Activity-2</item>
<item>Activity-4</item>
</r_link_dest_act>
<r_link_dest_port>
<item>Input:2</item>
<item>Input:1</item>
<item>Input:0</item>
<item>Input:1</item>
<item>Input:0</item>
<item>Input:0</item>
<item>Input:1</item>
<item>Input:0</item>
<item>Input:0</item>
<item>Input:2</item>
</r_link_dest_port>
<r_object_id>4b0000018000236e</r_object_id>
</properties>
<links>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e" rel="self"/>

EDCPKRST220200-PRE-EN-01 Reference Guide 963

Chapter 2 Resources

<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e/activities"
rel="http://identifiers.emc.com/linkrel/workflow-activities"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c4"
rel="http://identifiers.emc.com/linkrel/workflow-activity"
title="Auto-Activity-2"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c5"
rel="http://identifiers.emc.com/linkrel/workflow-activity"
title="Auto-Activity-1"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c6"
rel="http://identifiers.emc.com/linkrel/workflow-activity"
title="Activity-4"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c7"
rel="http://identifiers.emc.com/linkrel/workflow-activity"
title="Activity-3"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c8"
rel="http://identifiers.emc.com/linkrel/workflow-activity"
title="Activity-2"/>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
rel="http://identifiers.emc.com/linkrel/workflow-activity"
title="Activity-1"/>
</links>
</workflow-template>

Example 2-462: JSON response

{
"name": "workflow-template",
"type": "dm_process",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_process",
"properties": {
"object_name": "a_test_workflow",
"r_object_type": "dm_process",
"r_creation_date": "2018-12-25T09:17:22.000+00:00",
"r_modify_date": "2018-12-25T09:17:32.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": [
"0b00000180002364"
],
"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": "0600000180001500",

964 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.90. Workflow Template(s)

"a_content_type": "dm_internal",
"r_page_cnt": 1,
"r_content_size": 2525,
"a_full_text": true,
"a_storage_type": "filestore_01",
"i_cabinet_id": "0c00000180002114",
"owner_name": "dmadmin",
"owner_permit": 7,
"group_name": "docu",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "4b0000018000236e",
"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_4500000180000914",
"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": 2525.0,
"a_is_signed": false,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 4,
"is_private": false,
"r_definition_state": 2,
"perf_alias_set_id": "0000000000000000",
"package_control": 0,
"sd_element_default_acl": "0000000000000000",
"calendar_id": "0000000000000000",
"execution_flag": 0,
"r_act_name": [
"Auto-Activity-2",
"Auto-Activity-1",
"Activity-4",
"Activity-3",
"Activity-2",
"Activity-1"
],
"r_act_priority": [
0,
0,
0,
0,
0,
0
],
"r_act_type": [
0,
0,
0,
2,
0,
1
],
"r_act_def_id": [

EDCPKRST220200-PRE-EN-01 Reference Guide 965

Chapter 2 Resources

"4c000001800025c4",
"4c000001800025c5",
"4c000001800025c6",
"4c000001800025c7",
"4c000001800025c8",
"4c000001800025c9"
],
"r_link_name": [
"L20",
"L16",
"L15",
"L14",
"L11",
"L10",
"L27",
"L26",
"L19",
"L30"
],
"r_link_src_act": [
"Auto-Activity-2",
"Activity-4",
"Activity-2",
"Activity-2",
"Activity-2",
"Activity-1",
"Activity-1",
"Activity-1",
"Auto-Activity-1",
"Activity-4"
],
"r_link_src_port": [
"Output:0",
"Output:0",
"Output:2",
"Output:1",
"Output:0",
"Output:0",
"Output:2",
"Output:1",
"Output:0",
"Output:1"
],
"r_link_dest_act": [
"Activity-3",
"Activity-3",
"Activity-4",
"Activity-1",
"Activity-3",
"Activity-2",
"Activity-4",
"Auto-Activity-1",
"Auto-Activity-2",
"Activity-4"
],
"r_link_dest_port": [
"Input:2",
"Input:1",
"Input:0",
"Input:1",
"Input:0",
"Input:0",
"Input:1",
"Input:0",
"Input:0",
"Input:2"
],
"r_object_id": "4b0000018000236e"
},
"links": [{

966 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.90. Workflow Template(s)

"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activities",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e/activities"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"title": "Auto-Activity-2",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c4"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"title": "Auto-Activity-1",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c5"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"title": "Activity-4",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c6"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"title": "Activity-3",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c7"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"title": "Activity-2",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c8"
}, {
"rel": "http://identifiers.emc.com/linkrel/workflow-activity",
"title": "Activity-1",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9"
}
]
}

Example 2-463: HAL: JSON response

{
"name": "workflow-template",
"type": "dm_process",
"definition": "http://localhost:8080/dctm-rest/repositories/REPO/types/
dm_process",
"properties": {
"object_name": "a_test_workflow",
"r_object_type": "dm_process",
"r_creation_date": "2018-12-25T09:17:22.000+00:00",
"r_modify_date": "2018-12-25T09:17:32.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": [
"0b00000180002364"
],
"r_link_cnt": 0,
"r_link_high_cnt": 0,
"r_assembled_from_id": "0000000000000000",

EDCPKRST220200-PRE-EN-01 Reference Guide 967

Chapter 2 Resources

"r_frzn_assembly_cnt": 0,
"r_has_frzn_assembly": false,
"r_is_virtual_doc": 0,
"i_contents_id": "0600000180001500",
"a_content_type": "dm_internal",
"r_page_cnt": 1,
"r_content_size": 2525,
"a_full_text": true,
"a_storage_type": "filestore_01",
"i_cabinet_id": "0c00000180002114",
"owner_name": "dmadmin",
"owner_permit": 7,
"group_name": "docu",
"group_permit": 5,
"world_permit": 3,
"i_antecedent_id": "0000000000000000",
"i_chronicle_id": "4b0000018000236e",
"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_4500000180000914",
"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": 2525.0,
"a_is_signed": false,
"i_partition": 0,
"i_is_replica": false,
"i_vstamp": 4,
"is_private": false,
"r_definition_state": 2,
"perf_alias_set_id": "0000000000000000",
"package_control": 0,
"sd_element_default_acl": "0000000000000000",
"calendar_id": "0000000000000000",
"execution_flag": 0,
"r_act_name": [
"Auto-Activity-2",
"Auto-Activity-1",
"Activity-4",
"Activity-3",
"Activity-2",
"Activity-1"
],
"r_act_priority": [
0,
0,
0,
0,
0,
0
],
"r_act_type": [
0,
0,
0,
2,

968 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.90. Workflow Template(s)

0,
1
],
"r_act_def_id": [
"4c000001800025c4",
"4c000001800025c5",
"4c000001800025c6",
"4c000001800025c7",
"4c000001800025c8",
"4c000001800025c9"
],
"r_link_name": [
"L20",
"L16",
"L15",
"L14",
"L11",
"L10",
"L27",
"L26",
"L19",
"L30"
],
"r_link_src_act": [
"Auto-Activity-2",
"Activity-4",
"Activity-2",
"Activity-2",
"Activity-2",
"Activity-1",
"Activity-1",
"Activity-1",
"Auto-Activity-1",
"Activity-4"
],
"r_link_src_port": [
"Output:0",
"Output:0",
"Output:2",
"Output:1",
"Output:0",
"Output:0",
"Output:2",
"Output:1",
"Output:0",
"Output:1"
],
"r_link_dest_act": [
"Activity-3",
"Activity-3",
"Activity-4",
"Activity-1",
"Activity-3",
"Activity-2",
"Activity-4",
"Auto-Activity-1",
"Auto-Activity-2",
"Activity-4"
],
"r_link_dest_port": [
"Input:2",
"Input:1",
"Input:0",
"Input:1",
"Input:0",
"Input:0",
"Input:1",
"Input:0",
"Input:0",
"Input:2"

EDCPKRST220200-PRE-EN-01 Reference Guide 969

Chapter 2 Resources

],
"r_object_id": "4b0000018000236e"
},
"_links": {
"http://identifiers.emc.com/linkrel/workflow-activity": [{
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c4",
"title": "Auto-Activity-2"
}, {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c5",
"title": "Auto-Activity-1"
}, {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c6",
"title": "Activity-4"
}, {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c7",
"title": "Activity-3"
}, {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c8",
"title": "Activity-2"
}, {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-activities/4c000001800025c9",
"title": "Activity-1"
}
],
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
},
"http://identifiers.emc.com/linkrel/workflow-activities": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e/activities"
}
}
}

2.90.2 Workflow Templates

This resource is used to get a collection of Workflow Templates, also called Processes.

2.90.2.1 Resource relationships

The following diagram illustrates how this resource is related to other resources:

For more information, see “Repository” on page 562 and About the Diagrams
on page 17.

970 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.90. Workflow Template(s)

2.90.2.2 Feed
Is this resource a feed? Yes.

• Feed ID: The resource URI

• Feed Title: Workflow Templates

• Feed Updated: Server's current time

• Supports POST: No
• Entry: Workflow Template Resource

• Entry ID: The entry URI

• Entry Title: The name of the Workflow Template

• Entry Updated: The last modify date

2.90.2.3 Link relations

Link relation Description Resource reference

self Link to this resource “Workflow Templates”
on page 970

2.90.2.4 Operations

2.90.2.4.1 Supported HTTP methods

Method Description
GET Retrieves a collection of Workflow Templates

2.90.2.4.2 Get Workflow Templates

This operation retrieves a collection of Workflow Templates.

2.90.2.4.2.1 HTTP Request Method and Query Parameters

HTTP Query Description Data type Value range Default value

method parameters
GET page, items- For more information, see Appendix B, REST Common
per-page, Definition - URI Request Query Parameters on page 979
include-total,
links, sort,
view, filter,
inline

EDCPKRST220200-PRE-EN-01 Reference Guide 971

Chapter 2 Resources

2.90.2.4.2.2 Request headers

• Authorization
• Accept

For more information, see Appendix D, REST Common Definition - HTTP Headers
on page 987.

2.90.2.4.2.3 Request media types

N/A

2.90.2.4.2.4 Request body

N/A

2.90.2.4.2.5 Response status

• 200 - Retrieved successfully

• 400, 401, 403, 404, 406, 409, 415, 500, and so on
For more information, see Appendix C, REST Common Definition - HTTP Status
Codes on page 985.

2.90.2.4.2.6 Response headers

• Content-Type
For more information, see Appendix D, REST Common Definition - HTTP
Headers on page 987.

2.90.2.4.2.7 Response media types

• application/atom+xml
• application/xml
• application/vnd.emc.documentum+json
• application/json
• application/hal+json

972 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 2.90. Workflow Template(s)

2.90.2.4.2.8 Response body

Example 2-464: XML response

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<id>http://localhost:8080/dctm-rest/repositories/REPO/workflow-templates</id>
<title>Workflow templates</title>
<author>
<name>Open Text Documentum</name>
</author>
<updated>2019-02-25T07:15:29.574+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/
workflow-templates"
rel="self"/>
<entry>
<id>http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e</id>
<title>a_test_workflow</title>
<summary>dm_process 4b0000018000236e</summary>
<updated>2018-12-25T09:17:32.000+00:00</updated>
<published>2018-12-25T09:17:22.000+00:00</published>
<link
href="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e" rel="edit"/>
<content
src="http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
type="application/vnd.emc.documentum+xml"/>
</entry>
</feed>

Example 2-465: JSON response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates",
"title": "Workflow templates",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-25T07:07:37.869+00:00",
"page": 1,
"items-per-page": 100,
"links": [{
"rel": "self",
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates"
}
],
"entries": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e",
"title": "a_test_workflow",
"summary": "dm_process 4b0000018000236e",
"updated": "2018-12-25T09:17:32.000+00:00",
"published": "2018-12-25T09:17:22.000+00:00",
"links": [{
"rel": "edit",

EDCPKRST220200-PRE-EN-01 Reference Guide 973

Chapter 2 Resources

"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}
],
"content": {
"type": "application/vnd.emc.documentum+json",
"src": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}
}
]
}

Example 2-466: HAL: JSON Response

{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/workflow-templates",
"title": "Workflow templates",
"author": [{
"name": "Open Text Documentum"
}
],
"updated": "2019-02-25T07:23:53.443+00:00",
"page": 1,
"items-per-page": 100,
"_embedded": {
"collection": [{
"id": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e",
"title": "a_test_workflow",
"summary": "dm_process 4b0000018000236e",
"updated": "2018-12-25T09:17:32.000+00:00",
"published": "2018-12-25T09:17:22.000+00:00",
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates/4b0000018000236e"
}
}
}
]
},
"_links": {
"self": {
"href": "http://localhost:8080/dctm-rest/repositories/REPO/
workflow-templates"
}
}
}

974 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

Appendix A. Link Relations
Documentum REST Services uses the following link relations:

Table A-1: Public link relations

Link relation Description Specification

about Returns product information RFC6903
canonical Designates an Internationalized RFC6596
Resource Identifier (IRI) as
preferred over resources with
duplicative content.
child Points to a hierarchical child, or
subobject, of the current object.
contents Points to the contents metadata HTML 4.01 specification
feed for a content object.
edit Points to a resource that can be RFC5023
used to edit the link's context.
enclosure Identifies a related resource that is RFC5023
potentially large and might require
special handling.
first An IRI that refers to the furthest RFC5005
preceding resource in a series of
resources.
icon Points to the icon for an entry, a WHATWG website
page or a site.
last An IRI that refers to the furthest RFC5005
following resource in a series of
resources.
next Indicates that the link's context is a RFC5005
part of a series, and that the next in
the series is the link target.
parent Refers to one of the following:
• parent type of a type
• parent folder of a SysObject
• parent document of a document
• parent object of a relation
• parent group of a group, a role,
or a user.
predecessor- Points to a resource containing the RFC5829
version predecessor version in the version
history.

EDCPKRST220200-PRE-EN-01 Reference Guide 975

Appendix A. Link Relations

Link relation Description Specification

previous Points to the previous resource in RFC5005
an ordered series of resources.
related Points to the feed for a SysObject RFC4287
related to specified relation type(s).
self Conveys an identifier for the link's RFC4287
context.
version-history Points to a resource containing the RFC5829
version history for the context.

Table A-2: Link relations introduced in Documentum REST Services

Link relation Description

acl Points to the ACL resource for a specific permission set object
acls Points to the ACLs feed under a repository
as-search-template Points to the save as search template behavior for a saved search
associations Points to the associated Sysobjects feed for a specific ACL object
assist-values Points to the type assist values resource to obtain the value
assistance of a type
aspect-types Points to the aspect types resource to show all aspect types of a
repository
aspect-type Points to the single aspect type resource
batches Points to the batches resource under a repository.
batch-capabilities Points to the batch capabilities resource under a repository.
cabinets Points to the cabinets feed under a repository.
cancel-checkout Points to the cancel-checkout behavior for a versionable object.
checkin-branch Points to the checkin as branch version behavior for an object that is
checked out.
checkin-next-major Points to the checkin as next major version behavior for an object
that is checked out.
checkin-next-minor Points to the checkin as next minor version behavior for an object
that is checked out.
checkout Points to the checkout behavior for a versionable object .
child-links Points to the child links feed resource of a folder.
content-media Indicates that the content can be downloaded.
comments Points to top level comments for a SysObject.
current-user Points to the current login user resource under a repository.
current-user- Points to the current user preferences resource to manipulate the
preferences user preference

976 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 Link Relations

Link relation Description

current-version Points to the current version resource for a versionable object.
default-folder Points to the default folder resource for a user.
delete Points to the delete behavior of an object.
dematerialize link to dematerialize a lightweight object
documents Points to the documents feed under a repository.
folders Points to the folders feed under a repository.
format Points to the format resource for a content resource.
formats Points to the formats feed under a repository.
groups Points to the groups feed under a repository or direct member
groups under a group.
lightweight-types Points to the types resource which contains the collection of children
lightweight types of a shareable type
lightweight-objects Points to the collection of lightweight objects shares one shareable
object
logoff Points to the log out action for single sign on user.
materialize link to materialize a lightweight object
objects lists folder contents.
object-aspects Points to the object aspects resource to get attached aspects of an
object, or attache an aspect to the object
parent-links Points to the parent links resource of a non-cabinet SysObject.
parent-shareable- Points to the parent shareable type of a lightweight type
type
permissions Points to the permissions resource for a Sysobject
permission-set Points to the permission set resource for a Sysobject or a user
primary-content Points to the primary content resource for a content SysObject
type.
relate Indicates that the object can be related to other objects.
relation-type Points to the relation type resource for a relation instance.
relation-types Points to the relation types feed under a repository.
relations Points to the relations feed under a repository, relations feed for a
specific relation type, or relations feed related to a specified object.
replies Points to replied comments for a parent comment.
repositories Points to the repositories feed from the docbrokers.
saved-searches Points to the saved searches resource under a repository
search-templates Points to the search templates resource under a repository

EDCPKRST220200-PRE-EN-01 Reference Guide 977

Appendix A. Link Relations

Link relation Description

search-execution Points to the execution behavior for a saved search or search
template
saved-search-results Points to the results resource of a saved search
shared-parent Points the parent shareable object of a lightweight object
types Points to the data dictionary types feed under a repository.
users Points to the users feed under a repository, or direct member users
under a group.
virtual-document- Points to the virtual document nodes resource to fetch all nodes of
nodes an virtual document
These link relations are defined by Documentum. The fully qualified Documentum link
relation path is prefixed with the following string: http://identifiers.emc.com/
linkrel/.

978 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

Appendix B. REST Common Definition - URI
Request Query Parameters
Table B-1: URI request query parameters

Query Description Data Value range Default value

parameter type
dql a DQL query DQL N/A N/A
expressio
n
filter A filter expression in a N/A N/A no filtering
subset of XPath

For more information,

see the Filter Expression
section of the OpenText
Documentum REST
Services Development
Guide.
include- Calculates the total string true, false false
total number of feed items
instead of returning When true the
them all in one page total number of feed
items are calculated
by the server and
returned

When false no
calculation of the
total count is done

EDCPKRST220200-PRE-EN-01 Reference Guide 979

Appendix B. REST Common Definition - URI Request Query Parameters

Query Description Data Value range Default value

parameter type
inline Specifies whether or not string true, false false
to show content (the
object instance) in the When set to true it Note:
atom entry for a returns the object Although the
collection instance embedded default value
into the entry's is false, we
content element recommend
that you try
When false it does setting this
not return an object parameter to
instance true in your
development
environment
to get the
entire content
of resources
and explore
the complete
data
structure.

In your
production
environment,
you can set
this
parameter to
false for
better
performance.
items- The number of entries integer >=1 100
per-page per page

When the result feed is

paged, an element
<dm:items-per-page>xx</
dm:items-per-page> is
displayed under the
feed root
links Specifies whether or not boolean true , false true
the link relations are
returned for this object A value of false
representation means that no links
that are too
expensive to
calculate are
returned. Only easy
to navigate links are
returned

980 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 REST Common Definition - URI Request Query Parameters

Query Description Data Value range Default value

parameter type
page The number of the page integer >=1 1
to be served
When set to true, For example when
When the result feed is an element item_per_page=
paged, an element <dm:total>xx</ 200
<dm:page>xx</dm:page> is dm:total> is
displayed under the displayed under the &page=2
feed root feed root
Returns items
number 201 to 400
q Specifies full text search string String that follows N/A
criterion when sending a the Simple Search
GET request to the Language syntax
Search resource or
certain collection
resources

For more information,

see the Full Text Query
in Collection Resources
section of the OpenText
Documentum REST
Services Development
Guide.
recursiv When get children of an boolean true , false false
e object, whether include
all indirect children
recursively, e.g.
children's children

EDCPKRST220200-PRE-EN-01 Reference Guide 981

Appendix B. REST Common Definition - URI Request Query Parameters

Query Description Data Value range Default value

parameter type
sort Sorting collection result string Defining a sort Varies by resource
entries. This parameter consists of using and each resource
can also be used to multiple sort has its own default
perform case insensitive specifications, order.
sorting. separated by
comma (',') Notes
• sort=object_
character.
name: Sort by • Whether
attribute the default
Each sort
<object_name> in repository
specification
ascending order, supports
consists of an
which is the default case
attribute to be
sort order. sensitive
sorted and its sort
• sort=object_name sort or not
order, separated by
asc no-case: Sort is
a space (' ')
by attribute depending
character.
<object_name> in on the
ascending and case Sort results can be database
insensitive order. returned in either installation
<DESC> or <ASC> . In REST,
• sort=r_modify_ you can
date desc, sort order. Using a
sort order is use the sort
object-id asc parameter
no-case: Sort optional and when a
sort order is not to make
primarily by the sort
attribute specified, the
default sort order, mode case
<r_modify_date> in insensitive,
descending order which is <ASC>,
gets used. but you
and secondarily by cannot use
attribute this
<object_name> in You can use the
optional <no-case> parameter
ascending case to make
insensitive order. parameter to
perform a case the sort
insensitive sort. mode case
sensitive.
You also have the • Using the
option to sort with no-case
non-repeating parameter
attributes. For has side
example: sort=r_ effects on
modify_date non-string
desc,object_id attributes.
asc,title For
example,
Important sort=r_
When an creation
attribute with _date
an invalid desc no-
name is case sorts
specified, an the date
error is time
thrown. attribute in

982 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 REST Common Definition - URI Request Query Parameters

Query Description Data Value range Default value

parameter type
string
value
order,
which may
not be
what is
expected.
view Properties to return string For example, ? default
view=[view
For more name]?
informati (.column)*
on, see
the The view-name
Property and columns*
View parameters must be
section of mutually exclusive.
the
OpenText Names of
Documen predefined views
tum start with a colon
Platform “:” character.
REST
Services The following
Developm view-name values
ent Guide. are defined:
• all
• default

When no view-
name is specified,
the names of
properties or
predefined views
are returned as a
comma separated
list.

Notes

• Please see the individual resource sections to see how each of the above
parameters are used, as this may vary by resource.
• When the view parameter is used on a single object resource that supports
this parameter (such as the Cabinet resource, Document resource, and so
on). the view attribute names must match the definition of the object data
type. A Bad request (400) error is returned if any unknown attributes for
the object data type are specified in the view parameter.
When the view parameter is used on a collection based resource that
supports this parameter (such as the Cabinets resource, Folder Child

EDCPKRST220200-PRE-EN-01 Reference Guide 983

Appendix B. REST Common Definition - URI Request Query Parameters

Documents resource, etc.), a comma separated list of view attributes can

contain both base type attribute names and arbitrary extended attribute
names.
For example, let’s assume that a folder X has a number of documents in it
with the object type <dm_document> and document sub types <doc_ext1>,
<doc_ext2>, and so on. When a REST client retrieves the folder children, it can
specify the view attributes from both <dm_document> and its sub types.
Here is a code sample that shows you the request:
// GET a folder child documents feed.
// In this sample, attributes 'r_object_id' and 'object_name' come from dm_document.
// 'doc_ext1_attr' comes from doc_ext1, and 'doc_ext2_attr' comes from dmc_ext2.
GET /documents?inline=true&
view=r_object_id,object_name,doc_ext1_attr,doc_ext2_attr HTTP/1.1

Please also note the following view usage on a collection based resource:

– Aspect type attributes can also be put into the view when the aspect type
is attachable to the collection base type, such as . <dm_document> is in the
above sample.
– Collection items return the specified attributes only when the attributes
exist in those objects.
– Unknown attributes for collection items are ignored.

984 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

Appendix C. REST Common Definition - HTTP
Status Codes
Table C-1: HTTP Status Codes

HTTP Status Description

200 OK 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; PUT an entity describing or containing the
modified resource
201 Created 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 No Content The Server fulfilled the Request, but does not need to return a
response message body
304 Not Modified The Request performs a GET on the resource, but the resource has
not been modified since last GET
3xx Redirections Future use
400 Bad Request 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 Unauthorized 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 Forbidden The Server recognized your credentials, but you do not possess
authorization to perform this request, and the Request SHOULD
NOT be repeated
404 Not Found The Request specified a URI of a resource that does not exist
405 Method Not The HTTP verb specified in the Request (DELETE, GET, HEAD,
Allowed POST, PUT) is not supported for this request URI
406 Not Acceptable 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

EDCPKRST220200-PRE-EN-01 Reference Guide 985

Appendix C. REST Common Definition - HTTP Status Codes

HTTP Status Description

409 Conflict 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 Unsupported The Server is refusing to service the Request because the entity of
Media Type the Request is in a format not supported by the requested resource
for the requested method
500 Internal Server The Server encountered an unexpected condition which prevented
Error it from fulfilling the Request

986 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

Appendix D. REST Common Definition - HTTP
Headers
Table D-1: HTTP headers

HTTP header Description In request or Value range

response?
Accept- Indicates the preferred Request A language range complying
Language language(s) for error with RFC4647.
messages
Authorization The authorization Request BASE64 encoded HTTP basic
header for authentication header with
authentication encoded credential.

For example:
Authorization: Basic
QWxhZGRpbjpvcGVu
IHNlc2FtZQ==

Or, Kerberos authentication

header with encoded
credential.

For example:
Authorization: Negotiate
YIIZG1hZG1p
bjpwYXNzd29yZ...

Note: Kerberos
constrained delegation is
supported.
Accept Acceptable media type Request See note at the end of this table.
for the response
Content-Type Media type of the Request See note at the end of this table.
request or response
body Response
Content-Length The length of the Request Non-negative number
request body in octets
(8-bit bytes) Response
Location URI of the newly Response URI
created resource
ETag ETag value generated Response String value
by REST server
If-None-Match Checks whether the Request ETag value in previous server's
resource has changed response
Last-Modified Last modified time of Response HTTP-Date
the resource

EDCPKRST220200-PRE-EN-01 Reference Guide 987

Appendix D. REST Common Definition - HTTP Headers

HTTP header Description In request or Value range

response?
If-Modified- Checks whether the Request Last-modified value in the
Since resource has changed previous server's response
since last modified
time
Set-Cookie Set an HTTP cookie Response Used by client token
WWW- Indicates the Response Used by HTTP basic
Authenticate authentication scheme authentication and HTTP
that should be used to Kerberos to negotiate
access the requested authentication
entity

Notes

• The Accept request-header field can be used to specify certain media types
which are acceptable for the response. Accept headers can be used to
indicate that the request is specifically limited to a small set of desired types,
as in the case of a request for an in-line image.
The asterisk “*” character is used to group media types into ranges, with “*/
*” indicating all media types and “type/*” indicating all subtypes of that
type. The media-range MAY include media type parameters that are
applicable to that range.
Each media-range can be followed by one or more accept-params,
beginning with the “q” parameter for indicating a relative quality factor. The
first “q” parameter (if any) separates the media-range parameter(s) from the
accept-params. Quality factors allow the user or user agent to indicate the
relative degree of preference for that media-range, using the qvalue scale
from 0 to 1. The default value of q is 1.

Example D-1: Example

Accept: audio/*; q=0.2, audio/basic

The above statement is interpreted as “I prefer audio/basic, but send me

any audio type if it is the best available after an 80% reduction in
quality.”

• The Content-Type entity-header field indicates the media type of the entity-
body sent to the recipient, or in the case of the HEAD method, the media
type that would have been sent had the Request been a GET.

Example D-2: Example

Content-Type = "Content-Type" ":" media-type

Specify a value for media-type above. Here is an example of a field:

988 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 REST Common Definition - HTTP Headers

Content-Type: text/html; charset=ISO-8859-4

EDCPKRST220200-PRE-EN-01 Reference Guide 989

Appendix E. AQL
The Abstract Query Language (AQL) is an implementation-independent search
description language. The language hides the actual query language used for
Documentum components (DQL, xQuery) or external sources. In REST services, the
Search resource utilizes AQL to represent its query document.

Example E-1: Query document in AQL - XML

<?xml version='1.0' encoding='UTF-8'?>

<search all-versions="true" max-results-for-facets="10"
xmlns="http://identifiers.emc.com/vocab/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<types>
<type>dm_document</type>
</types>
<columns>
<column>r_object_type</column>
<column>object_name</column>
</columns>
<sorts>
<sort ascii="false" ascending="true" lang="fr">r_content_size</sort>
<sort ascii="true" ascending="false" lang="zh">object_name</sort>
</sorts>
<collections>
<collection>collection1</collection>
<collection>collection2</collection>
</collections>
<locations>
<id-location descendent="true">
<id>0c00000580001914</id>
</id-location>
<path-location descendent="false">
<path>/dmadmin</path>
</path-location>
</locations>
<facet-definitions>
<facet-definition id="id1" group-by="alpharange" max-values="8">
<attributes>
<attribute>r_object_type</attribute>
</attributes>
<sort>FREQUENCY</sort>
<properties>
<property name="range">a:e, f:z</property>
</properties>
</facet-definition>
<facet-definition id="id2" group-by="relativeDate" max-values="9">
<attributes>
<attribute>r_modify_date</attribute>
</attributes>
<sort>VALUE_ASCENDING</sort>
</facet-definition>
</facet-definitions>
<expression-set>
<expressions>
<property name="object_name" operator="CONTAINS" exact-
match="true"
repeating="true" fuzzy="true">rest

EDCPKRST220200-PRE-EN-01 Reference Guide 991

Appendix E. AQL

</property>
<fulltext fuzzy="true">rest</fulltext>
<fulltext fuzzy="false">test</fulltext>
<property-range name="r_content_size" operator="BETWEEN"
repeating="false">
<from>0</from>
<to>10000</to>
</property-range>
<property-list name="r_object_type" operator="IN"
repeating="false">
<values>
<value>dm_document</value>
<value>dm_folder</value>
</values>
</property-list>
<expression-set>
<expressions>
<fulltext fuzzy="false">test</fulltext>
</expressions>
</expression-set>
<relative-date name="r_modify_date" time-unit="MONTH"
operator="GREATER THAN" >-2</relative-date>
</expressions>
</expression-set>
</search>

Example E-2: Query document in AQL - JSON

{
"all-versions": true,
"include-hidden-objects": false,
"max-results-for-facets": 10,
"types": [
"dm_document"
],
"columns": [
"r_object_type",
"object_name"
],
"sorts": [
{
"property": "r_content_size",
"ascending": true,
"lang": "fr",
"ascii": false
},
{
"property": "object_name",
"ascending": false,
"ascii": true
}
],
"collections": [
"collection1",
"collection2"
],
"locations": [
{
"location-type": "id-location",
"id": "0c00000580001914",
"repository": "REPO",

992 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 AQL

"descendent": true
},
{
"location-type": "path-location",
"path": "/dmadmin",
"repository": "REPO",
"descendent": false
}
],
"facet-definitions": [
{
"id": "id1",
"attributes": [
"r_object_type"
],
"group-by": "alpharange",
"sort": "FREQUENCY",
"properties": {
"skipEmptyValues": "true",
"range": "a:e, f:z"
},
"max-values": 8
},
{
"id": "id2",
"attributes": [
"r_modify_date"
],
"group-by": "relativeDate",
"sort": "VALUE_ASCENDING",
"properties": {
"returnUTC": "true",
"skipEmptyValues": "true"
},
"max-values": 9
}
],
"repositories": [
"REPO"
],
"expression-set": {
"expression-type": "expression-set",
"operator": "AND",
"expressions": [
{
"expression-type": "property",
"name": "object_name",
"operator": "CONTAINS",
"value": "rest",
"exact-match": true,
"repeating": true,
"case-sensitive": true,
"fuzzy": true
},
{
"expression-type": "fulltext",
"value": "rest",
"fuzzy": true
},
{
"expression-type": "fulltext",
"value": "test",
"fuzzy": false
},
{
"expression-type": "property-range",
"name": "r_content_size",
"operator": "BETWEEN",
"from": "0",
"to": "10000",

EDCPKRST220200-PRE-EN-01 Reference Guide 993

Appendix E. AQL

"repeating": false
},
{
"expression-type": "property-list",
"name": "r_object_type",
"operator": "IN",
"values": [
"dm_document",
"dm_folder"
],
"repeating": false
},
{
"expression-type": "expression-set",
"operator": "AND",
"expressions": [
{
"expression-type": "fulltext",
"value": "test",
"fuzzy": false
}
]
},
{
"expression-type": "relative-date",
"name": "r_modify_date",
"value": -2,
"time-unit": "MONTH",
"operator": "GREATER_THAN",
"repeating": false
}
]
}
}

The following table contains AQL elements.

Element Description
all-versions Indicates whether or not all versions of the objects are expected to be
included in the query results.
include-hidden- Indicates whether or not the hidden objects should be included in the
objects query results.

Its default value is false.

types Defines the type of the objects to search.

You cannot define multiple types.

The URL parameter object-type cannot be used in a search

operation with AQL.
columns Defines the properties of the object to display in the result set.

This element works when the URL parameter inline is set to true.

The URL parameter view cannot be used in a search operation with

AQL.

994 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 AQL

Element Description
collections Defines the collections to search.

The URL parameter collections cannot be used in a search

operation with AQL.
locations Defines the folders to search.

You can specify locations in the following two ways:

The URL parameter locations cannot be used in a search operation

with AQL.
Location Type Option Example
id location id: The ID of the
folder to search <id-location
descendent="true">
descendent: Whether <id>0c00000580001914<
to search the sub- /id>
</id-location>
folders or not

Default value: false

path location path: The path of the
folder to search <path-location
descendent="false">
descendent: Whether <path>/dmadmin</path>
to search the sub- </path-location>
folders or not

Default value: false

The URL parameter locations cannot be used in a search operation
with AQL.
sorts Defines how the system sorts results.

REST services uses two strategies, ASCII sort and locale sort. The
following table describes the details:
Option Description
property Property to sort against
ascending Specifies whether or not to sort the results in
ascending order

Default value: true

ascii Specifies whether or not to sort items using
the ASCII table.

Default value: true

When this value is set to false, you must

specify a locale using lang.

EDCPKRST220200-PRE-EN-01 Reference Guide 995

Appendix E. AQL

Element Description
lang Specifies the locale that the system uses to sort
the results. The supported locale depends on
the xPlore configuration.
You can specify multiple sort items. In this case, the system sorts
results by the first sort item first, the by the second one, and so on so
forth. For example, with the sorts element defined as follows, the
system sorts results by <r_content_size> first, and then by <object_name>
for objects with the same <r_content_size>.
expression-set Defines the search criteria by using a set of expressions. Expression-
sets can be nested and associated with each other using logical AND
(default) or logical OR. The following five expressions are supported:
• fulltext expression
• property expression
• property list expression
• property range expression
• relative date expression

facet-definitions List of facet definitions. See Facet in AQL.

The URL parameters facet and facet-value-constraints

cannot be used in a search operation with AQL.
max-results-for- Sets the maximum number of results to return.
facets

E.1 Expressions in AQL

The expression-set element defines the search criteria by using a set of
expressions. Expressions can be nested and associated with each other using logical
AND (default) or logical OR.

Example E-3: XML

<expression-set>
<expressions>
<property name="object_name" operator="CONTAINS" exact-match="true"
repeating="true" fuzzy="true">rest
</property>
<fulltext fuzzy="true">rest</fulltext>
<fulltext fuzzy="false">test</fulltext>
<property-range name="r_content_size" operator="BETWEEN" repeating="false">
<from>0</from>
<to>10000</to>
</property-range>
<property-list name="r_object_type" operator="IN" repeating="false">
<values>
<value>dm_document</value>
<value>dm_folder</value>
</values>
</property-list>
<expression-set>
<expressions>
<fulltext case-sensitive="false" fuzzy="false">test</fulltext>
</expressions>

996 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 AQL

</expression-set>
<relative-date name="r_modify_date" time-unit="MONTH"
operator="GREATER_THAN" >-2</relative-date>
</expressions>
</expression-set>

Example E-4: JSON

"expression-set": {
"expression-type": "expression-set",
"operator": "AND",
"expressions": [
{
"expression-type": "property",
"name": "object_name",
"operator": "CONTAINS",
"value": "rest",
"exact-match": true,
"repeating": true,
"case-sensitive": true,
"fuzzy": true
},
{
"expression-type": "fulltext",
"value": "rest",
"fuzzy": true
},
{
"expression-type": "fulltext",
"value": "test",
"fuzzy": false
},
{
"expression-type": "property-range",
"name": "r_content_size",
"operator": "BETWEEN",
"from": "0",
"to": "10000",
"repeating": false
},
{
"expression-type": "property-list",
"name": "r_object_type",
"operator": "IN",
"values": [
"dm_document",
"dm_folder"
],
"repeating": false
},
{
"expression-type": "expression-set",
"operator": "AND",
"expressions": [
{
"expression-type": "fulltext",
"value": "test",
"fuzzy": false
}
]
},
{
"expression-type": "relative-date",
"name": "r_modify_date",
"value": -2,
"time-unit": "MONTH",

EDCPKRST220200-PRE-EN-01 Reference Guide 997

Appendix E. AQL

"operator": "GREATER_THAN",
"repeating": false
}
]
}

E.1.1 Fulltext expression

A fulltext expression is similar to the URL parameter q in that it follows the
Simple Search Language syntax. Moreover, fulltext expressions allow you to
perform a fuzzy search by using the fuzzy parameter, which takes a boolean value
and defaults to true. A fuzzy search is a process that returns values based on
approximate string value matching. In other words, the criteria used to perform a
fuzzy search does not have to match exactly to be relevant enough to return search
results.

In the following fuzzy search examples, the first row, where fuzzy search is set to
false, will match RESTful services, but not RESTFULL or RESTfol. The search
criteria must have an exact match to return a result.

The second row, where fuzzy is set to true, matches all of the above terms.

Example E-5: Expressions using the fuzzy search parameter

<!-- Fuzzy search set to false -->

<fulltext fuzzy="false">RESTful</fulltext>

<!-- Fuzzy search set to false -->

<fulltext fuzzy="true">RESTful</fulltext>

E.1.2 Property expression

A property expression defines property value constraints by using a variety of
logical operators.

Table E-1:

Option Description
name Property name
value Property value
operator Supports the following logical operators: EQUAL, NOT_EQUAL,
GREATER_THAN, LESS_THAN, GREATER_EQUAL, LESS_EQUAL,
BEGINS_WITH, CONTAINS, DOES_NOT_CONTAIN, ENDS_WITH,
IS_NULL, IS_NOT_NULL

998 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 AQL

Option Description
fuzzy Whether or not to enable fuzzy search for the following operators:
SEARCH_OP_DOES_NOT_CONTAIN, SEARCH_OP_CONTAINS,
SEARCH_OP_EQUAL

Default value: false

exact-match Whether or not to evaluate an EQUAL or NOT_EQUALS constraint.

When the constraint is evaluated, the system performs no stemming,

stop words removal, thesaurus search, or wildcard matching.

Default value: false

repeating Determines whether or not DFC should generate DQL instead of
xQuery when the type of a repeating property is neither DF_ID nor DF_
STRING.

Default value: false

case-sensitive Indicates whether the search operation is case sensitive. Default value:
false

The following property expression returns true when the object_name of an object
is rest.

Example E-6: Property expression in XML

<property name="object_name" operator="EQUAL" exact-match="true"
repeating="true" case-sensitive="true" fuzzy="false">rest
</property>

Example E-7: Property expression in JSON

{
"expression-type": "property",
"name": "object_name",
"operator": "EQUAL",
"value": "rest",
"exact-match": true,
"repeating": true,
"case-sensitive": true,
"fuzzy": false
}

EDCPKRST220200-PRE-EN-01 Reference Guide 999

Appendix E. AQL

E.1.3 Property list expression

A property expression defines property value constraints by using a list of discrete
values. The following table describes the details:

Table E-2:

Option Description
name Property name
operator Supports the following logical operators:
• IN: returns true if the value of the property is in the value list.
• NOT IN: returns true if the value of the property is not in the value
list.
values List of discrete property values
repeating Whether the property is repeating

The following expression returns true if the r_object_type is either dm_document

or dm_folder.

Example E-8: Property list expression in XML

<property-list name="r_object_type" operator="IN" repeating="false">
<values>
<value>dm_document</value>
<value>dm_folder</value>
</values>
</property-list>

Example E-9: Property list expression in JSON

{
"expression-type": "property-list",
"name": "r_object_type",
"operator": "IN",
"values": [
"dm_document",
"dm_folder"
],
"repeating": false
}

1000 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 AQL

E.1.4 Property range expression

A property expression defines property value constraints by using a value rang. The
following table describes the details:

Table E-3:

Option Description
name Property name
operator Supports the logical BETWEEN operator. Returns true when the value of
the property is in the range specified by from and to attributes.
from Starting value
to Ending value
repeating Whether the property is repeating

The following expression returns true if the r_content_size is smaller than or

equal to 1,000.

Example E-10: Property range expression in XML

<property-range name="r_content_size" operator="BETWEEN" repeating="false">
<from>0</from>
<to>10000</to>
</property-range>

Example E-11: Property range expression in JSON

{
"expression-type": "property-range",
"name": "r_content_size",
"operator": "BETWEEN",
"from": "0",
"to": "10000",
"repeating": false
}

EDCPKRST220200-PRE-EN-01 Reference Guide 1001

Appendix E. AQL

E.1.5 Relative date expression

A relative date expression defines constraints on date properties using a relative
date. A relative date shows the time difference to the current date, with a minus sign
(-) indicating a certain amount of time before the current date, and a plus sign,
which can be omitted, indicating a certain amount of time after the current date. The
following table describes the details:

Table E-4:

Option Description
name Time related property name, such as r_modify_date
time unit Supports these time units: MINUTE, DAY, MONTH, YEAR
value Number of the time unit
operator Supports these operators: EQUAL, GREATER_THAN, LESS_THAN,
GREATER_EQUAL, LESS_EQUAL

For example, the following expression returns true when r_modify_date is greater
than the current date minus 10 months:

Example E-12: Relative date expression in XML

<relative-date name="r_modify_date" operator="GREATER_THAN"

time-unit="MONTH">-10</relative-date>

Example E-13: Relative date expression in JSON

{
"expression-type": "relative-date",
"name": "r_modify_date",
"value": -10,
"time-unit": "MONTH",
"operator": "GREATER_THAN",
"repeating": false
}

1002 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 AQL

E.1.5.1 Expressions as templates

Expressions in AQL can also be used to define search templates. When the attribute
“template” is true, specific elements in the expressions are activated as variables.

The following table lists all AQL expressions that support variables:

Table E-5:

Expression type Variable Sample (variable predicates highlighted

in bold)
fulltext Fulltext search criterion <fulltext fuzzy="false"
template="true">key word</fulltext>

property Property value <property name="object_name"

operator="CONTAINS" exact-match="false"
repeating="false" case-sensitive="false"
Note: The search fuzzy="false" template="true">myobj</
operator cannot property>
be IS_NULL or
IS_NOT_NULL.
property list Value list <property-list name="r_object_type"
operator="IN" repeating="false"
template="true">
<values>
<value>dm_document</value>
<value>dm_folder</value>
</values>
</property-list>

relative date Relative value and time <relative-date name="r_modify_date" time-

unit="MONTH" operator="GREATER_THAN"
unit repeating="false" template="true">-3</
relative-date>

property range From and To values <property-range name="r_modify_date"

operator="BETWEEN" repeating="false"
template="true">
<from>2010-10-13T07:33:13.009+00:00</from>
<to>2014-11-11T01:35:17.089+00:00</to>
</property-range>

E.2 Facet in AQL

Using AQL, a facet definition becomes more powerful. You can define multiple
facets in one query document. These facets can also be nested. Furthermore, facet
grouping strategy and facet ordering can both be configured in AQL.

EDCPKRST220200-PRE-EN-01 Reference Guide 1003

Appendix E. AQL

E.2.1 Grouping strategy

A grouping strategy defines how to group the results or a facet search. Facet
definitions in AQL support the following grouping strategies:

• string
• range
• alpharange
• date

Example E-14: String grouping strategy in XML

<facet-definition id="id1" group-by="string">

<attributes>
<attribute>r_object_type</attribute>
</attributes>
</facet-definition>

Example E-15: String grouping strategy in JSON

{
"id": "id1",
"attributes": [
"r_object_type"
],
"group-by": "alpharange",
}

The string grouping strategy is commonly used when a string property is set as the
facet, for example, r_object_type. This grouping strategy has the following
options:

• nullValueFacet (optional): indicates whether or not to take null values into

account when computing the facet grouping, which defaults to false.
• keepDuplicateValues (optional): indicates whether or not to take duplicated
values for repeating properties into account when computing the facet grouping,
which defaults to false. This option works for xPlore 1.1 P03 and later versions.
• caseInsensitive (optional): indicates whether or not to take letter case into
account when computing the facet grouping, which defaults to false. This
option works for xPlore 1.1 P03 and later versions.

Example E-16: Range grouping strategy in XML

<facet-definition id="id1" group-by="range">

1004 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 AQL

<attributes>
<attribute>r_content_size</attribute>
</attributes>
<properties>
<property name="range">0:1000,1000:10000,10000:</property>
</properties>
<sort>FREQUENCY</sort>
</facet-definition>

Example E-17: Range grouping strategy in JSON

{
"id": "id1",
"attributes": [
"r_content_size"
],
"group-by": "range",
"sort": "FREQUENCY",
"properties": {
"range": "0:1000,1000:10000,10000:"
}
}

The range grouping strategy is commonly used when a numeric property is set as
the facet, for example, r_content_size. This grouping strategy has the following
option:

• range (required): Specifies a list of buckets for grouping. Each bucket is

separated by a comma (','). A bucket is composed of a lower and upper bounds
separated by a colon (':'). You can create open ended buckets by omitting one of
the bounds but keeping the comma separator. Overlapping buckets are not
supported and may result in inconsistent results.

Notes

• The lower-bound is inclusive while the upper-bound is exclusive.

• The boundaries are parsed as Double. Example: 0:10,10:100.89,100:

Example E-18: Alpharange grouping strategy in XML

<facet-definition id="id1" group-by="alpharange">

<attributes>
<attribute>r_object_name</attribute>
</attributes>
<properties>
<property name="range">a:m,n:r,s:z</property>
</properties>
<sort>FREQUENCY</sort>
</facet-definition>

EDCPKRST220200-PRE-EN-01 Reference Guide 1005

Appendix E. AQL

Example E-19: Alpharange grouping strategy in JSON

{
"id": "id1",
"attributes": [
"r_object_name"
],
"group-by": "alpharange",
"sort": "FREQUENCY",
"properties": {
"range": "a:m,n:r,s:z"
}
}

The alpharange grouping strategy is commonly used when a string property is set
as the facet, for example, r_object_name. This grouping strategy has the following
option:

range (required): specifies a list of buckets for grouping. Each bucket is separated by
comma (','). A bucket is composed of a lower and upper bounds separated by colon
(':'). You can create open ended buckets by omitting one of the bounds but keeping
the comma separator. Overlapping buckets are not supported and may result in
inconsistent results.

Notes

• This grouping strategy is case-insensitive.

• The boundaries are inclusive.
• The boundaries are parsed as characters. Example: a:m,n:r,s:z

Example E-20: Date grouping strategy in XML

<facet-definition id="id1" group-by="week">

<attributes>
<attribute>r_modify_date</attribute>
</attributes>
<sort>FREQUENCY</sort>
</facet-definition>

Example E-21: Date grouping strategy in JSON

{
"id": "id1",
"attributes": [
"r_modify_date"

1006 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01

 AQL

],
"group-by": "week",
"sort": "FREQUENCY"
}

The date grouping strategy has the following types:

• day: groups results by day

• week: groups results by week
• month: groups results by month
• quarter (since xPlore 1.3): groups results by quarter
• year: groups results by year
• relativeDate: a pre-defined grouping, which contains the following groups:
OLDER, LAST_YEAR, LAST_MONTH, LAST_WEEK, THIS_YEAR, THIS_WEEK,
YESTERDAY, TODAY

For more information on the options for this grouping strategy, see the Grouping
Strategies table on page 660.

E.2.2 Facet ordering

Facet ordering is configured in the sort element of a facet definition. The following
ordering policies are supported:

• FREQUENCY: sort by the result count in descending order.

• NONE: keeps the order returned by the facet handler.
• VALUE_ASCENDING: sort by the facet value ID in ascending order.
• VALUE_DESCENDING: sort by the facet value ID in descending order.

EDCPKRST220200-PRE-EN-01 Reference Guide 1007

Appendix F. Events Audited by Default
Some events are audited by default in Documentum Server. The following is a
listing of the events that are audited by default. In each point we list the event (or
events) and a short description:

• dm_audit and dm_unaudit

All executions of methods that register or unregister events for auditing.
• dm_signoff
All executions of a <IDfPersistentObject.signoff> method.
• dm_adddigsignature
All executions of an <addDigitalSignature> method. By default, audit trail entries
created for the <dm_adddigsignature> event are not signed by Documentum
Server. To sign those entries, register the event explicitly for auditing, then set
the argument to require signing.
• dm_addesignature and dm_addesignature_failed
All executions, successful or unsuccessful, of an <addESignature> method. The
audit trail entries for the <dm_addesignature> event are automatically signed by
Documentum Server.
• dm_purgeaudit
Removal of an audit trail entry from the repository. A <dm_purgeaudit> event is
generated whenever a destroy method is executed to remove an Audit Trail
entry from the repository, or a <PURGE_AUDIT> administration method is
executed. All <dm_purgeaudit> events are audited.
• User login failure
• dm_default_set
A default set of events for objects of type <dm_document> and its subtypes. This
event is registered against the docbase configuration object, and Documentum
Server audits the events in the set for <dm_document> type and its subtypes.
The following events are registered against the docbase configuration object:

– dm_archive

– dm_checkin
– dm_restore
– dm_assemble
– dm_checkout
– dm_save

– dm_bp_attach
– dm_destroy

EDCPKRST220200-PRE-EN-01 Reference Guide 1009

Appendix F. Events Audited by Default

– dm_setfile
– dm_bp_demote
– dm_freeze
– dm_signoff
– dm_bp_promote
– dm_link
– dm_unfreeze

– dm_bp_resume
– dm_lock
– dm_unlink
– dm_bp_suspend
– dm_mark

– dm_unlock
– dm_branch
– dm_prune

1010 OpenText™ Documentum™ REST Services EDCPKRST220200-PRE-EN-01