OpenText™ Documentum™ REST

Services

Development Guide

Use Documentum xCP REST Services to interact with

Documentum repositories.

EDCPKL230200-PGR-EN-01
OpenText™ Documentum™ REST Services
Development Guide
EDCPKL230200-PGR-EN-01
Rev.: 2023-Apr-04
This documentation has been created for OpenText™ Documentum™ REST Services CE 23.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 © 2023 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 ................................................................................... 65

2 General REST definitions ....................................................... 67

2.1 Common definition - HTTP headers .................................................. 67
2.2 Common definition - query parameters ............................................. 69
2.2.1 Property view .................................................................................. 74
2.2.1.1 Predefined view expression ............................................................. 74
2.2.1.2 Custom view expression .................................................................. 74
2.2.1.3 View expression syntax ................................................................... 75
2.3 Server configuration parameters ...................................................... 75
2.4 HTTP status codes .......................................................................... 77
2.5 Representation ............................................................................... 79
2.6 xCP common elements ................................................................... 79

3 Authentication ......................................................................... 83
3.1 Authentication with HTTP basic ........................................................ 83

4 Resources ................................................................................ 85
4.1 xCP advanced repository query instance .......................................... 85
4.1.1 URI template .................................................................................. 85
4.1.2 Link relation .................................................................................... 85
4.1.3 Operations ...................................................................................... 86
4.1.3.1 Perform a advanced repository query ............................................... 86
4.1.3.1.1 HTTP method ................................................................................. 86
4.1.3.1.2 Query parameters ........................................................................... 86
4.1.3.1.3 Request headers ............................................................................. 86
4.1.3.1.4 Request body ................................................................................. 87
4.1.3.1.5 Response headers .......................................................................... 87
4.1.3.1.6 Supported response media types ..................................................... 87
4.1.3.1.7 Response status ............................................................................. 87
4.1.3.1.8 Response body ............................................................................... 87
4.2 xCP advanced repository query single type ....................................... 89
4.2.1 URI template .................................................................................. 89
4.2.2 Link relation .................................................................................... 89
4.2.3 Operations ...................................................................................... 89
4.2.3.1 Get an advanced repository query type ............................................. 89
4.2.3.1.1 HTTP method ................................................................................. 90
4.2.3.1.2 Query parameters ........................................................................... 90
4.2.3.1.3 Request headers ............................................................................. 90
4.2.3.1.4 Request body ................................................................................. 90
4.2.3.1.5 Response headers .......................................................................... 90

EDCPKL230200-PGR-EN-01 Development Guide iii

Table of Contents

4.2.3.1.6 Supported response media types ..................................................... 90

4.2.3.1.7 Response status ............................................................................. 90
4.2.3.1.8 Response body ............................................................................... 91
4.3 xCP advanced repository query type collection ................................. 92
4.3.1 URI template .................................................................................. 92
4.3.2 Feed and EDAA support .................................................................. 92
4.3.3 Link relation .................................................................................... 93
4.3.4 Operations ...................................................................................... 93
4.3.4.1 Get a advanced repository query type collection ................................ 93
4.3.4.1.1 HTTP method ................................................................................. 93
4.3.4.1.2 Query parameters ........................................................................... 93
4.3.4.1.3 Request headers ............................................................................. 94
4.3.4.1.4 Request body ................................................................................. 94
4.3.4.1.5 Response headers .......................................................................... 94
4.3.4.1.6 Supported response media types ..................................................... 94
4.3.4.1.7 Response status ............................................................................. 94
4.3.4.1.8 Response body ............................................................................... 95
4.4 xCP alert query single instance ........................................................ 95
4.4.1 URI template .................................................................................. 95
4.4.2 Link relation .................................................................................... 95
4.4.3 Operations ...................................................................................... 95
4.4.3.1 Perform an alert query ..................................................................... 96
4.4.3.1.1 HTTP method ................................................................................. 96
4.4.3.1.2 Query parameters ........................................................................... 96
4.4.3.1.3 Request headers ............................................................................. 96
4.4.3.1.4 Request body ................................................................................. 96
4.4.3.1.5 Response headers .......................................................................... 97
4.4.3.1.6 Supported response media types ..................................................... 97
4.4.3.1.7 Response status ............................................................................. 97
4.4.3.1.8 Response body ............................................................................... 97
4.5 xCP alert query single type .............................................................. 99
4.5.1 URI template .................................................................................. 99
4.5.2 Link relation .................................................................................... 99
4.5.3 Operations ...................................................................................... 99
4.5.3.1 Get an alert query type .................................................................... 99
4.5.3.1.1 HTTP method ............................................................................... 100
4.5.3.1.2 Query parameters ......................................................................... 100
4.5.3.1.3 Request headers ........................................................................... 100
4.5.3.1.4 Request body ............................................................................... 100
4.5.3.1.5 Response headers ........................................................................ 100
4.5.3.1.6 Supported response media types ................................................... 100
4.5.3.1.7 Response status ........................................................................... 100

iv OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.5.3.1.8 Response body ............................................................................. 101

4.6 xCP alert query type collection ....................................................... 101
4.6.1 URI template ................................................................................ 101
4.6.2 Feed and EDAA support ................................................................ 101
4.6.3 Link relation .................................................................................. 102
4.6.4 Operations .................................................................................... 102
4.6.4.1 Get an alert query type collection ................................................... 102
4.6.4.1.1 HTTP method ............................................................................... 102
4.6.4.1.2 Query parameters ......................................................................... 102
4.6.4.1.3 Request headers ........................................................................... 103
4.6.4.1.4 Request body ............................................................................... 103
4.6.4.1.5 Response headers ........................................................................ 103
4.6.4.1.6 Supported response media types ................................................... 103
4.6.4.1.7 Response status ........................................................................... 103
4.6.4.1.8 Response body ............................................................................. 104
4.7 xCP alert single instance ............................................................... 104
4.7.1 URI template ................................................................................ 104
4.7.2 Link relation .................................................................................. 104
4.7.3 Operations .................................................................................... 105
4.7.3.1 Get an alert ................................................................................... 105
4.7.3.1.1 HTTP method ............................................................................... 105
4.7.3.1.2 Query parameters ......................................................................... 105
4.7.3.1.3 Request headers ........................................................................... 105
4.7.3.1.4 Request body ............................................................................... 105
4.7.3.1.5 Response headers ........................................................................ 106
4.7.3.1.6 Supported response media types ................................................... 106
4.7.3.1.7 Response status ........................................................................... 106
4.7.3.1.8 Response body ............................................................................. 106
4.7.3.2 Update alert status ........................................................................ 107
4.7.3.2.1 HTTP method ............................................................................... 107
4.7.3.2.2 Server accepted request media types ............................................. 107
4.7.3.2.3 Query parameters ......................................................................... 107
4.7.3.2.4 Request headers ........................................................................... 107
4.7.3.2.5 Request body ............................................................................... 107
4.7.3.2.6 Response headers ........................................................................ 108
4.7.3.2.7 Supported response media types ................................................... 108
4.7.3.2.8 Response status ........................................................................... 108
4.7.3.2.9 Response body ............................................................................. 108
4.8 xCP alert collection ....................................................................... 109
4.8.1 URI template ................................................................................ 109
4.8.2 Feed and EDAA support ................................................................ 109
4.8.3 Link relation .................................................................................. 110

EDCPKL230200-PGR-EN-01 Development Guide v

Table of Contents

4.8.4 Operations .................................................................................... 110

4.8.4.1 Get an alert collection .................................................................... 110
4.8.4.1.1 HTTP method ............................................................................... 110
4.8.4.1.2 Query parameters ......................................................................... 110
4.8.4.1.3 Request headers ........................................................................... 111
4.8.4.1.4 Request body ............................................................................... 111
4.8.4.1.5 Response headers ........................................................................ 111
4.8.4.1.6 Supported response media types ................................................... 111
4.8.4.1.7 Response status ........................................................................... 111
4.8.4.1.8 Response body ............................................................................. 112
4.9 xCP Alert Single Type ................................................................... 112
4.9.1 URI template ................................................................................ 112
4.9.2 Link relation .................................................................................. 112
4.9.3 Operations .................................................................................... 112
4.9.3.1 Get an Alert Type .......................................................................... 113
4.9.3.1.1 HTTP method ............................................................................... 113
4.9.3.1.2 Query parameters ......................................................................... 113
4.9.3.1.3 Request headers ........................................................................... 113
4.9.3.1.4 Request body ............................................................................... 113
4.9.3.1.5 Response headers ........................................................................ 113
4.9.3.1.6 Supported response media types ................................................... 113
4.9.3.1.7 Response status ........................................................................... 113
4.9.3.1.8 Response body ............................................................................. 114
4.10 xCP Alert Type collection ............................................................... 114
4.10.1 URI template ................................................................................ 114
4.10.2 Feed and EDAA support ................................................................ 114
4.10.3 Link relation .................................................................................. 115
4.10.4 Operations .................................................................................... 115
4.10.4.1 Get an Alert Type collection ........................................................... 115
4.10.4.1.1 HTTP method ............................................................................... 115
4.10.4.1.2 Query parameters ......................................................................... 115
4.10.4.1.3 Request headers ........................................................................... 116
4.10.4.1.4 Request body ............................................................................... 116
4.10.4.1.5 Response headers ........................................................................ 116
4.10.4.1.6 Supported response media types ................................................... 116
4.10.4.1.7 Response status ........................................................................... 116
4.10.4.1.8 Response body ............................................................................. 117
4.11 xCP annotation collection .............................................................. 117
4.11.1 URI template ................................................................................ 117
4.11.2 Feed and EDAA support ................................................................ 117
4.11.3 Link relation .................................................................................. 118
4.11.4 Operations .................................................................................... 118

vi OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.11.4.1 Get an annotation collection ........................................................... 118

4.11.4.1.1 HTTP method ............................................................................... 118
4.11.4.1.2 Query parameters ......................................................................... 119
4.11.4.1.3 Request headers ........................................................................... 119
4.11.4.1.4 Request body ............................................................................... 119
4.11.4.1.5 Response headers ........................................................................ 119
4.11.4.1.6 Supported response media types ................................................... 119
4.11.4.1.7 Response status ........................................................................... 119
4.11.4.1.8 Response body ............................................................................. 120
4.11.4.2 Get an annotation collection for a User ........................................... 120
4.11.4.2.1 HTTP method ............................................................................... 120
4.11.4.2.2 Query parameters ......................................................................... 121
4.11.4.2.3 Request headers ........................................................................... 121
4.11.4.2.4 Request body ............................................................................... 121
4.11.4.2.5 Response headers ........................................................................ 121
4.11.4.2.6 Supported response media types ................................................... 121
4.11.4.2.7 Response status ........................................................................... 121
4.11.4.2.8 Response body ............................................................................. 122
4.11.4.3 Create annotations ........................................................................ 122
4.11.4.3.1 HTTP method ............................................................................... 122
4.11.4.3.2 Server accepted request media types ............................................. 123
4.11.4.3.3 Query parameters ......................................................................... 123
4.11.4.3.4 Request headers ........................................................................... 123
4.11.4.3.5 Request body ............................................................................... 123
4.11.4.3.6 Response headers ........................................................................ 123
4.11.4.3.7 Supported response media types ................................................... 124
4.11.4.3.8 Response status ........................................................................... 124
4.11.4.3.9 Response body ............................................................................. 124
4.12 xCP application single instance ...................................................... 124
4.12.1 URI template ................................................................................ 124
4.12.2 Link relation .................................................................................. 124
4.12.3 Operations .................................................................................... 125
4.12.3.1 Get an application ......................................................................... 125
4.12.3.1.1 HTTP method ............................................................................... 125
4.12.3.1.2 Query parameters ......................................................................... 125
4.12.3.1.3 Request headers ........................................................................... 125
4.12.3.1.4 Request body ............................................................................... 125
4.12.3.1.5 Response headers ........................................................................ 126
4.12.3.1.6 Supported response media types ................................................... 126
4.12.3.1.7 Response status ........................................................................... 126
4.12.3.1.8 Response body ............................................................................. 126
4.13 xCP application type ...................................................................... 128

EDCPKL230200-PGR-EN-01 Development Guide vii

Table of Contents

4.13.1 URI template ................................................................................ 128

4.13.2 Link relation .................................................................................. 128
4.13.3 Operations .................................................................................... 128
4.13.3.1 Get an application type .................................................................. 128
4.13.3.1.1 HTTP method ............................................................................... 128
4.13.3.1.2 Query parameters ......................................................................... 129
4.13.3.1.3 Request headers ........................................................................... 129
4.13.3.1.4 Request body ............................................................................... 129
4.13.3.1.5 Response headers ........................................................................ 129
4.13.3.1.6 Supported response media types ................................................... 129
4.13.3.1.7 Response status ........................................................................... 129
4.13.3.1.8 Response body ............................................................................. 129
4.14 xCP application type collection ....................................................... 130
4.14.1 URI template ................................................................................ 130
4.14.2 Feed and EDAA support ................................................................ 130
4.14.3 Link relation .................................................................................. 131
4.14.4 Operations .................................................................................... 131
4.14.4.1 Get an Application Type collection .................................................. 131
4.14.4.1.1 HTTP method ............................................................................... 131
4.14.4.1.2 Query parameters ......................................................................... 131
4.14.4.1.3 Request headers ........................................................................... 132
4.14.4.1.4 Request body ............................................................................... 132
4.14.4.1.5 Response headers ........................................................................ 132
4.14.4.1.6 Supported response media types ................................................... 132
4.14.4.1.7 Response status ........................................................................... 132
4.14.4.1.8 Response body ............................................................................. 132
4.15 xCP application configuration single instance .................................. 133
4.15.1 URI template ................................................................................ 133
4.15.2 Link relation .................................................................................. 133
4.15.3 Operations .................................................................................... 133
4.15.3.1 Get an application configuration ..................................................... 134
4.15.3.1.1 HTTP method ............................................................................... 134
4.15.3.1.2 Query parameters ......................................................................... 134
4.15.3.1.3 Request headers ........................................................................... 134
4.15.3.1.4 Request body ............................................................................... 134
4.15.3.1.5 Response headers ........................................................................ 134
4.15.3.1.6 Supported response media types ................................................... 134
4.15.3.1.7 Response status ........................................................................... 135
4.15.3.1.8 Response body ............................................................................. 135
4.15.3.2 Update an application configuration ................................................ 135
4.15.3.2.1 HTTP method ............................................................................... 135
4.15.3.2.2 Server accepted request media types ............................................. 135

viii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.15.3.2.3 Query parameters ......................................................................... 136

4.15.3.2.4 Request headers ........................................................................... 136
4.15.3.2.5 Request body ............................................................................... 136
4.15.3.2.6 Response headers ........................................................................ 136
4.15.3.2.7 Supported response media types ................................................... 136
4.15.3.2.8 Response status ........................................................................... 137
4.15.3.2.9 Response body ............................................................................. 137
4.16 xCP application configuration collection .......................................... 137
4.16.1 URI template ................................................................................ 137
4.16.2 Feed and EDAA support ................................................................ 137
4.16.3 Link relation .................................................................................. 138
4.16.4 Operations .................................................................................... 139
4.16.4.1 Get an application configuration collection ...................................... 139
4.16.4.1.1 HTTP method ............................................................................... 139
4.16.4.1.2 Query parameters ......................................................................... 139
4.16.4.1.3 Request headers ........................................................................... 139
4.16.4.1.4 Request body ............................................................................... 140
4.16.4.1.5 Response headers ........................................................................ 140
4.16.4.1.6 Supported response media types ................................................... 140
4.16.4.1.7 Response status ........................................................................... 140
4.16.4.1.8 Response body ............................................................................. 140
4.17 xCP application configuration single type ........................................ 141
4.17.1 URI template ................................................................................ 141
4.17.2 Link relation .................................................................................. 141
4.17.3 Operations .................................................................................... 141
4.17.3.1 Get an application configuration type .............................................. 141
4.17.3.1.1 HTTP method ............................................................................... 142
4.17.3.1.2 Query parameters ......................................................................... 142
4.17.3.1.3 Request headers ........................................................................... 142
4.17.3.1.4 Request body ............................................................................... 142
4.17.3.1.5 Response headers ........................................................................ 142
4.17.3.1.6 Supported response media types ................................................... 142
4.17.3.1.7 Response status ........................................................................... 142
4.17.3.1.8 Response body ............................................................................. 143
4.18 xCP application configuration type collection ................................... 143
4.18.1 URI template ................................................................................ 143
4.18.2 Feed and EDAA support ................................................................ 143
4.18.3 Link relation .................................................................................. 144
4.18.4 Operations .................................................................................... 144
4.18.4.1 Get an application configuration type collection ............................... 144
4.18.4.1.1 HTTP method ............................................................................... 144
4.18.4.1.2 Query parameters ......................................................................... 144

EDCPKL230200-PGR-EN-01 Development Guide ix

Table of Contents

4.18.4.1.3 Request headers ........................................................................... 145

4.18.4.1.4 Request body ............................................................................... 145
4.18.4.1.5 Response headers ........................................................................ 145
4.18.4.1.6 Supported response media types ................................................... 145
4.18.4.1.7 Response status ........................................................................... 145
4.18.4.1.8 Response body ............................................................................. 146
4.19 xCP business object single instance ............................................... 146
4.19.1 URI template ................................................................................ 146
4.19.2 Link relation .................................................................................. 146
4.19.3 Operations .................................................................................... 147
4.19.3.1 Get a business object .................................................................... 147
4.19.3.1.1 HTTP method ............................................................................... 147
4.19.3.1.2 Query parameters ......................................................................... 147
4.19.3.1.3 Request headers ........................................................................... 147
4.19.3.1.4 Request body ............................................................................... 148
4.19.3.1.5 Response headers ........................................................................ 148
4.19.3.1.6 Supported response media types ................................................... 148
4.19.3.1.7 Response status ........................................................................... 148
4.19.3.1.8 Response body ............................................................................. 148
4.19.3.2 Update a business object ............................................................... 149
4.19.3.2.1 HTTP method ............................................................................... 149
4.19.3.2.2 Server accepted request media types ............................................. 149
4.19.3.2.3 Query parameters ......................................................................... 149
4.19.3.2.4 Request headers ........................................................................... 149
4.19.3.2.5 Request body ............................................................................... 149
4.19.3.2.6 Response headers ........................................................................ 150
4.19.3.2.7 Supported response media types ................................................... 150
4.19.3.2.8 Response status ........................................................................... 150
4.19.3.2.9 Response body ............................................................................. 150
4.19.3.3 Create a Business Object .............................................................. 151
4.19.3.3.1 HTTP method ............................................................................... 151
4.19.3.3.2 Server accepted request media types ............................................. 151
4.19.3.3.3 Query parameters ......................................................................... 151
4.19.3.3.4 Request headers ........................................................................... 151
4.19.3.3.5 Request body ............................................................................... 151
4.19.3.3.6 Response headers ........................................................................ 152
4.19.3.3.7 Supported response media types ................................................... 152
4.19.3.3.8 Response status ........................................................................... 152
4.19.3.3.9 Response body ............................................................................. 152
4.19.3.4 Delete a Business Object ............................................................... 153
4.19.3.4.1 HTTP method ............................................................................... 153
4.19.3.4.2 Query parameters ......................................................................... 153

x OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.19.3.4.3 Request headers ........................................................................... 153

4.19.3.4.4 Request body ............................................................................... 153
4.19.3.4.5 Response headers ........................................................................ 153
4.19.3.4.6 Response status ........................................................................... 153
4.19.3.4.7 Response body ............................................................................. 154
4.20 xCP Business Object collection ...................................................... 154
4.20.1 URI template ................................................................................ 154
4.20.2 Feed and EDAA support ................................................................ 154
4.20.3 Link relation .................................................................................. 155
4.20.4 Operations .................................................................................... 155
4.20.4.1 Get a business object collection ..................................................... 155
4.20.4.1.1 HTTP method ............................................................................... 155
4.20.4.1.2 Query parameters ......................................................................... 155
4.20.4.1.3 Request headers ........................................................................... 156
4.20.4.1.4 Request body ............................................................................... 156
4.20.4.1.5 Response headers ........................................................................ 156
4.20.4.1.6 Supported response media types ................................................... 156
4.20.4.1.7 Response status ........................................................................... 156
4.20.4.1.8 Response body ............................................................................. 157
4.21 xCP Business Object Single Type .................................................. 157
4.21.1 URI template ................................................................................ 157
4.21.2 Link relation .................................................................................. 157
4.21.3 Operations .................................................................................... 158
4.21.3.1 Get a business object type ............................................................. 158
4.21.3.1.1 HTTP method ............................................................................... 158
4.21.3.1.2 Query parameters ......................................................................... 158
4.21.3.1.3 Request headers ........................................................................... 158
4.21.3.1.4 Request body ............................................................................... 158
4.21.3.1.5 Response headers ........................................................................ 158
4.21.3.1.6 Supported response media types ................................................... 158
4.21.3.1.7 Response status ........................................................................... 159
4.21.3.1.8 Response body ............................................................................. 159
4.22 xCP Business Object type collection ............................................... 160
4.22.1 URI template ................................................................................ 160
4.22.2 Feed and EDAA support ................................................................ 160
4.22.3 Link relation .................................................................................. 161
4.22.4 Operations .................................................................................... 161
4.22.4.1 Get a Business Object type collection ............................................. 161
4.22.4.1.1 HTTP method ............................................................................... 161
4.22.4.1.2 Query parameters ......................................................................... 161
4.22.4.1.3 Request headers ........................................................................... 162
4.22.4.1.4 Request body ............................................................................... 162

EDCPKL230200-PGR-EN-01 Development Guide xi

Table of Contents

4.22.4.1.5 Response headers ........................................................................ 162

4.22.4.1.6 Supported response media types ................................................... 162
4.22.4.1.7 Response status ........................................................................... 162
4.22.4.1.8 Response body ............................................................................. 163
4.23 xCP Cabinet single instance .......................................................... 163
4.23.1 URI template ................................................................................ 163
4.23.2 Link relation .................................................................................. 163
4.23.3 Operations .................................................................................... 164
4.23.3.1 Get a Cabinet ............................................................................... 164
4.23.3.1.1 HTTP method ............................................................................... 164
4.23.3.1.2 Query parameters ......................................................................... 164
4.23.3.1.3 Request headers ........................................................................... 165
4.23.3.1.4 Request body ............................................................................... 165
4.23.3.1.5 Response headers ........................................................................ 165
4.23.3.1.6 Supported response media types ................................................... 165
4.23.3.1.7 Response status ........................................................................... 165
4.23.3.1.8 Response body ............................................................................. 166
4.23.3.2 Get objects in a Cabinet ................................................................ 166
4.23.3.2.1 HTTP method ............................................................................... 166
4.23.3.2.2 Query parameters ......................................................................... 166
4.23.3.2.3 Request headers ........................................................................... 166
4.23.3.2.4 Request body ............................................................................... 167
4.23.3.2.5 Response headers ........................................................................ 167
4.23.3.2.6 Supported response media types ................................................... 167
4.23.3.2.7 Response status ........................................................................... 167
4.23.3.2.8 Response body ............................................................................. 167
4.23.3.3 Create a Cabinet ........................................................................... 167
4.23.3.3.1 HTTP method ............................................................................... 168
4.23.3.3.2 Server accepted request media types ............................................. 168
4.23.3.3.3 Query parameters ......................................................................... 168
4.23.3.3.4 Request headers ........................................................................... 168
4.23.3.3.5 Request body ............................................................................... 168
4.23.3.3.6 Response headers ........................................................................ 169
4.23.3.3.7 Supported response media types ................................................... 169
4.23.3.3.8 Response status ........................................................................... 169
4.23.3.3.9 Response body ............................................................................. 169
4.23.3.4 Update a Cabinet .......................................................................... 170
4.23.3.4.1 HTTP method ............................................................................... 170
4.23.3.4.2 Server accepted request media types ............................................. 170
4.23.3.4.3 Query parameters ......................................................................... 170
4.23.3.4.4 Request headers ........................................................................... 170
4.23.3.4.5 Request body ............................................................................... 170

xii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.23.3.4.6 Response headers ........................................................................ 171

4.23.3.4.7 Supported response media types ................................................... 171
4.23.3.4.8 Response status ........................................................................... 171
4.23.3.4.9 Response body ............................................................................. 171
4.23.3.5 Delete a Cabinet ........................................................................... 172
4.23.3.5.1 HTTP method ............................................................................... 172
4.23.3.5.2 Query parameters ......................................................................... 172
4.23.3.5.3 Request headers ........................................................................... 172
4.23.3.5.4 Request body ............................................................................... 172
4.23.3.5.5 Response headers ........................................................................ 172
4.23.3.5.6 Response status ........................................................................... 172
4.23.3.5.7 Response body ............................................................................. 172
4.24 xCP Cabinet collection .................................................................. 173
4.24.1 URI template ................................................................................ 173
4.24.2 Feed and EDAA support ................................................................ 173
4.24.3 Link relation .................................................................................. 174
4.24.4 Operations .................................................................................... 174
4.24.4.1 Get a Cabinet collection ................................................................. 174
4.24.4.1.1 HTTP method ............................................................................... 174
4.24.4.1.2 Query parameters ......................................................................... 174
4.24.4.1.3 Request headers ........................................................................... 175
4.24.4.1.4 Request body ............................................................................... 175
4.24.4.1.5 Response headers ........................................................................ 175
4.24.4.1.6 Supported response media types ................................................... 175
4.24.4.1.7 Response status ........................................................................... 175
4.24.4.1.8 Response body ............................................................................. 176
4.25 xCP Cabinet Single Type ............................................................... 176
4.25.1 URI template ................................................................................ 176
4.25.2 Link relation .................................................................................. 176
4.25.3 Operations .................................................................................... 176
4.25.3.1 Get a Cabinet Type ....................................................................... 177
4.25.3.1.1 HTTP method ............................................................................... 177
4.25.3.1.2 Query parameters ......................................................................... 177
4.25.3.1.3 Request headers ........................................................................... 177
4.25.3.1.4 Request body ............................................................................... 177
4.25.3.1.5 Response headers ........................................................................ 177
4.25.3.1.6 Supported response media types ................................................... 177
4.25.3.1.7 Response status ........................................................................... 177
4.25.3.1.8 Response body ............................................................................. 178
4.26 xCP Cabinet Type collection .......................................................... 178
4.26.1 URI template ................................................................................ 178
4.26.2 Feed and EDAA support ................................................................ 178

EDCPKL230200-PGR-EN-01 Development Guide xiii

Table of Contents

4.26.3 Link relation .................................................................................. 179

4.26.4 Operations .................................................................................... 179
4.26.4.1 Get a Cabinet Type collection ........................................................ 179
4.26.4.1.1 HTTP method ............................................................................... 179
4.26.4.1.2 Query parameters ......................................................................... 179
4.26.4.1.3 Request headers ........................................................................... 180
4.26.4.1.4 Request body ............................................................................... 180
4.26.4.1.5 Response headers ........................................................................ 180
4.26.4.1.6 Supported response media types ................................................... 180
4.26.4.1.7 Response status ........................................................................... 180
4.26.4.1.8 Response body ............................................................................. 181
4.27 xCP Checklist single instance ........................................................ 181
4.27.1 URI template ................................................................................ 181
4.27.2 Link relation .................................................................................. 181
4.27.3 Operations .................................................................................... 182
4.27.3.1 Get a checklist .............................................................................. 182
4.27.3.1.1 HTTP method ............................................................................... 182
4.27.3.1.2 Query parameters ......................................................................... 182
4.27.3.1.3 Request headers ........................................................................... 182
4.27.3.1.4 Request body ............................................................................... 182
4.27.3.1.5 Response headers ........................................................................ 183
4.27.3.1.6 Supported response media types ................................................... 183
4.27.3.1.7 Response status ........................................................................... 183
4.27.3.1.8 Response body ............................................................................. 183
4.27.3.2 Update a Checklist ........................................................................ 183
4.27.3.2.1 HTTP method ............................................................................... 184
4.27.3.2.2 Server accepted request media types ............................................. 184
4.27.3.2.3 Query parameters ......................................................................... 184
4.27.3.2.4 Request headers ........................................................................... 184
4.27.3.2.5 Request body ............................................................................... 184
4.27.3.2.6 Response headers ........................................................................ 185
4.27.3.2.7 Supported response media types ................................................... 185
4.27.3.2.8 Response status ........................................................................... 185
4.27.3.2.9 Response body ............................................................................. 185
4.27.3.3 Create a Checklist ......................................................................... 186
4.27.3.3.1 HTTP method ............................................................................... 186
4.27.3.3.2 Server accepted request media types ............................................. 186
4.27.3.3.3 Query parameters ......................................................................... 186
4.27.3.3.4 Request headers ........................................................................... 186
4.27.3.3.5 Request body ............................................................................... 186
4.27.3.3.6 Response headers ........................................................................ 187
4.27.3.3.7 Supported response media types ................................................... 187

xiv OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.27.3.3.8 Response status ........................................................................... 187

4.27.3.3.9 Response body ............................................................................. 187
4.27.3.4 Delete a checklist .......................................................................... 188
4.27.3.4.1 HTTP method ............................................................................... 188
4.27.3.4.2 Query parameters ......................................................................... 188
4.27.3.4.3 Request headers ........................................................................... 188
4.27.3.4.4 Request body ............................................................................... 188
4.27.3.4.5 Response headers ........................................................................ 188
4.27.3.4.6 Response status ........................................................................... 188
4.27.3.4.7 Response body ............................................................................. 189
4.28 xCP Checklist Single Type ............................................................. 189
4.28.1 URI template ................................................................................ 189
4.28.2 Link relation .................................................................................. 189
4.28.3 Operations .................................................................................... 189
4.28.3.1 Get a Checklist Type ..................................................................... 189
4.28.3.1.1 HTTP method ............................................................................... 189
4.28.3.1.2 Query parameters ......................................................................... 190
4.28.3.1.3 Request headers ........................................................................... 190
4.28.3.1.4 Request body ............................................................................... 190
4.28.3.1.5 Response headers ........................................................................ 190
4.28.3.1.6 Supported response media types ................................................... 190
4.28.3.1.7 Response status ........................................................................... 190
4.28.3.1.8 Response body ............................................................................. 191
4.29 xCP Checklist Type collection ........................................................ 192
4.29.1 URI template ................................................................................ 192
4.29.2 Feed and EDAA support ................................................................ 192
4.29.3 Link relation .................................................................................. 193
4.29.4 Operations .................................................................................... 193
4.29.4.1 Get a Checklist Type collection ...................................................... 193
4.29.4.1.1 HTTP method ............................................................................... 193
4.29.4.1.2 Query parameters ......................................................................... 193
4.29.4.1.3 Request headers ........................................................................... 194
4.29.4.1.4 Request body ............................................................................... 194
4.29.4.1.5 Response headers ........................................................................ 194
4.29.4.1.6 Supported response media types ................................................... 194
4.29.4.1.7 Response status ........................................................................... 194
4.29.4.1.8 Response body ............................................................................. 195
4.30 xCP Comment single instance ....................................................... 195
4.30.1 URI template ................................................................................ 195
4.30.2 Link relation .................................................................................. 196
4.30.3 Operations .................................................................................... 196
4.30.3.1 Get a Comment ............................................................................ 196

EDCPKL230200-PGR-EN-01 Development Guide xv

Table of Contents

4.30.3.1.1 HTTP method ............................................................................... 196

4.30.3.1.2 Query parameters ......................................................................... 197
4.30.3.1.3 Request headers ........................................................................... 197
4.30.3.1.4 Request body ............................................................................... 197
4.30.3.1.5 Response headers ........................................................................ 197
4.30.3.1.6 Supported response media types ................................................... 197
4.30.3.1.7 Response status ........................................................................... 197
4.30.3.1.8 Response body ............................................................................. 198
4.30.3.2 Update a Comment ....................................................................... 198
4.30.3.2.1 HTTP method ............................................................................... 198
4.30.3.2.2 Server accepted request media types ............................................. 198
4.30.3.2.3 Query parameters ......................................................................... 198
4.30.3.2.4 Request headers ........................................................................... 198
4.30.3.2.5 Request body ............................................................................... 199
4.30.3.2.6 Response headers ........................................................................ 199
4.30.3.2.7 Supported response media types ................................................... 199
4.30.3.2.8 Response status ........................................................................... 199
4.30.3.2.9 Response body ............................................................................. 200
4.30.3.3 Create a Comment ........................................................................ 200
4.30.3.3.1 HTTP method ............................................................................... 200
4.30.3.3.2 Server accepted request media types ............................................. 200
4.30.3.3.3 Query parameters ......................................................................... 200
4.30.3.3.4 Request headers ........................................................................... 200
4.30.3.3.5 Request body ............................................................................... 201
4.30.3.3.6 Response headers ........................................................................ 201
4.30.3.3.7 Supported response media types ................................................... 201
4.30.3.3.8 Response status ........................................................................... 201
4.30.3.3.9 Response body ............................................................................. 202
4.30.3.4 Delete a Comment ........................................................................ 202
4.30.3.4.1 HTTP method ............................................................................... 202
4.30.3.4.2 Query parameters ......................................................................... 202
4.30.3.4.3 Request headers ........................................................................... 202
4.30.3.4.4 Request body ............................................................................... 202
4.30.3.4.5 Response headers ........................................................................ 203
4.30.3.4.6 Response status ........................................................................... 203
4.30.3.4.7 Response body ............................................................................. 203
4.31 xCP Comment collection ............................................................... 203
4.31.1 URI template ................................................................................ 203
4.31.2 Feed and EDAA support ................................................................ 204
4.31.3 Link relation .................................................................................. 205
4.31.4 Operations .................................................................................... 205
4.31.4.1 Get a Comment collection .............................................................. 205

xvi OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.31.4.1.1 HTTP method ............................................................................... 205

4.31.4.1.2 Query parameters ......................................................................... 205
4.31.4.1.3 Request headers ........................................................................... 206
4.31.4.1.4 Request body ............................................................................... 206
4.31.4.1.5 Response headers ........................................................................ 206
4.31.4.1.6 Supported response media types ................................................... 206
4.31.4.1.7 Response status ........................................................................... 206
4.31.4.1.8 Response body ............................................................................. 207
4.32 xCP Comment Single Type ............................................................ 207
4.32.1 URI template ................................................................................ 207
4.32.2 Link relation .................................................................................. 207
4.32.3 Operations .................................................................................... 207
4.32.3.1 Get a Comment Type .................................................................... 208
4.32.3.1.1 HTTP method ............................................................................... 208
4.32.3.1.2 Query parameters ......................................................................... 208
4.32.3.1.3 Request headers ........................................................................... 208
4.32.3.1.4 Request body ............................................................................... 208
4.32.3.1.5 Response headers ........................................................................ 208
4.32.3.1.6 Supported response media types ................................................... 208
4.32.3.1.7 Response status ........................................................................... 208
4.32.3.1.8 Response body ............................................................................. 209
4.33 xCP Comment Type collection ....................................................... 209
4.33.1 URI template ................................................................................ 209
4.33.2 Feed and EDAA support ................................................................ 209
4.33.3 Link relation .................................................................................. 210
4.33.4 Operations .................................................................................... 210
4.33.4.1 Get a Comment collection .............................................................. 210
4.33.4.1.1 HTTP method ............................................................................... 210
4.33.4.1.2 Query parameters ......................................................................... 210
4.33.4.1.3 Request headers ........................................................................... 211
4.33.4.1.4 Request body ............................................................................... 211
4.33.4.1.5 Response headers ........................................................................ 211
4.33.4.1.6 Supported response media types ................................................... 211
4.33.4.1.7 Response status ........................................................................... 211
4.33.4.1.8 Response body ............................................................................. 212
4.34 xCP Content single instance .......................................................... 212
4.34.1 URI template ................................................................................ 212
4.34.2 Link relation .................................................................................. 212
4.34.3 Operations .................................................................................... 213
4.34.3.1 Get a Content ............................................................................... 213
4.34.3.1.1 HTTP method ............................................................................... 213
4.34.3.1.2 Query parameters ......................................................................... 214

EDCPKL230200-PGR-EN-01 Development Guide xvii

Table of Contents

4.34.3.1.3 Request headers ........................................................................... 214

4.34.3.1.4 Request body ............................................................................... 215
4.34.3.1.5 Response headers ........................................................................ 215
4.34.3.1.6 Supported response media types ................................................... 215
4.34.3.1.7 Response status ........................................................................... 215
4.34.3.1.8 Response body ............................................................................. 215
4.34.3.2 Update a Content .......................................................................... 216
4.34.3.2.1 HTTP method ............................................................................... 216
4.34.3.2.2 Server accepted request media types ............................................. 216
4.34.3.2.3 Query parameters ......................................................................... 216
4.34.3.2.4 Request headers ........................................................................... 216
4.34.3.2.5 Request body ............................................................................... 216
4.34.3.2.6 Response headers ........................................................................ 217
4.34.3.2.7 Supported response media types ................................................... 217
4.34.3.2.8 Response status ........................................................................... 217
4.34.3.2.9 Response body ............................................................................. 217
4.34.3.3 Delete a Content ........................................................................... 218
4.34.3.3.1 HTTP method ............................................................................... 218
4.34.3.3.2 Query parameters ......................................................................... 218
4.34.3.3.3 Request headers ........................................................................... 218
4.34.3.3.4 Request body ............................................................................... 218
4.34.3.3.5 Response headers ........................................................................ 218
4.34.3.3.6 Response status ........................................................................... 218
4.34.3.3.7 Response body ............................................................................. 219
4.34.3.4 Check out a Content ...................................................................... 219
4.34.3.4.1 HTTP method ............................................................................... 219
4.34.3.4.2 Server accepted request media types ............................................. 219
4.34.3.4.3 Query parameters ......................................................................... 219
4.34.3.4.4 Request headers ........................................................................... 219
4.34.3.4.5 Request body ............................................................................... 219
4.34.3.4.6 Response headers ........................................................................ 220
4.34.3.4.7 Supported response media types ................................................... 220
4.34.3.4.8 Response status ........................................................................... 220
4.34.3.4.9 Response body ............................................................................. 220
4.34.3.5 Check in a Content ........................................................................ 221
4.34.3.5.1 HTTP method ............................................................................... 222
4.34.3.5.2 Server accepted request media types ............................................. 222
4.34.3.5.3 Query parameters ......................................................................... 222
4.34.3.5.4 Request headers ........................................................................... 222
4.34.3.5.5 Request body ............................................................................... 222
4.34.3.5.6 Response headers ........................................................................ 223
4.34.3.5.7 Supported response media types ................................................... 223

xviii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.34.3.5.8 Response status ........................................................................... 223

4.34.3.5.9 Response body ............................................................................. 223
4.35 xCP Content collection .................................................................. 224
4.35.1 URI template ................................................................................ 224
4.35.2 Feed and EDAA support ................................................................ 224
4.35.3 Link relation .................................................................................. 225
4.35.4 Operations .................................................................................... 225
4.35.4.1 Get a Content collection ................................................................ 225
4.35.4.1.1 HTTP method ............................................................................... 225
4.35.4.1.2 Query parameters ......................................................................... 225
4.35.4.1.3 Request headers ........................................................................... 226
4.35.4.1.4 Request body ............................................................................... 226
4.35.4.1.5 Response headers ........................................................................ 226
4.35.4.1.6 Supported response media types ................................................... 226
4.35.4.1.7 Response status ........................................................................... 226
4.35.4.1.8 Response body ............................................................................. 227
4.35.4.2 Create a Content ........................................................................... 227
4.35.4.2.1 HTTP method ............................................................................... 228
4.35.4.2.2 Server accepted request media types ............................................. 229
4.35.4.2.3 Query parameters ......................................................................... 229
4.35.4.2.4 Request headers ........................................................................... 229
4.35.4.2.5 Request body ............................................................................... 229
4.35.4.2.6 Response headers ........................................................................ 229
4.35.4.2.7 Supported response media types ................................................... 229
4.35.4.2.8 Response status ........................................................................... 230
4.35.4.2.9 Response body ............................................................................. 230
4.36 xCP Content Single Type ............................................................... 230
4.36.1 URI template ................................................................................ 230
4.36.2 Link relation .................................................................................. 230
4.36.3 Operations .................................................................................... 231
4.36.3.1 Get a Content Type ....................................................................... 231
4.36.3.1.1 HTTP method ............................................................................... 231
4.36.3.1.2 Query parameters ......................................................................... 231
4.36.3.1.3 Request headers ........................................................................... 231
4.36.3.1.4 Request body ............................................................................... 231
4.36.3.1.5 Response headers ........................................................................ 231
4.36.3.1.6 Supported response media types ................................................... 231
4.36.3.1.7 Response status ........................................................................... 232
4.36.3.1.8 Response body ............................................................................. 232
4.37 xCP Content Type collection .......................................................... 232
4.37.1 URI template ................................................................................ 232
4.37.2 Feed and EDAA support ................................................................ 232

EDCPKL230200-PGR-EN-01 Development Guide xix

Table of Contents

4.37.3 Link relation .................................................................................. 233

4.37.4 Operations .................................................................................... 233
4.37.4.1 Get a Content Type collection ........................................................ 233
4.37.4.1.1 HTTP method ............................................................................... 233
4.37.4.1.2 Query parameters ......................................................................... 233
4.37.4.1.3 Request headers ........................................................................... 234
4.37.4.1.4 Request body ............................................................................... 234
4.37.4.1.5 Response headers ........................................................................ 234
4.37.4.1.6 Supported response media types ................................................... 234
4.37.4.1.7 Response status ........................................................................... 234
4.37.4.1.8 Response body ............................................................................. 235
4.38 xCP Current User Instance ............................................................ 235
4.38.1 URI template ................................................................................ 235
4.38.2 Link relation .................................................................................. 235
4.38.3 Operations .................................................................................... 236
4.38.3.1 Get the Current User ..................................................................... 236
4.38.3.1.1 HTTP method ............................................................................... 236
4.38.3.1.2 Query parameters ......................................................................... 236
4.38.3.1.3 Request headers ........................................................................... 236
4.38.3.1.4 Request body ............................................................................... 237
4.38.3.1.5 Response headers ........................................................................ 237
4.38.3.1.6 Supported response media types ................................................... 237
4.38.3.1.7 Response status ........................................................................... 237
4.38.3.1.8 Response body ............................................................................. 237
4.39 xCP File Upload Resource ............................................................. 238
4.39.1 URI template ................................................................................ 238
4.39.2 Link relation .................................................................................. 238
4.39.3 Operations .................................................................................... 238
4.39.3.1 Upload a File ................................................................................ 238
4.39.3.1.1 HTTP method ............................................................................... 238
4.39.3.1.2 Query parameters ......................................................................... 238
4.39.3.1.3 Request headers ........................................................................... 238
4.39.3.1.4 Request body ............................................................................... 239
4.39.3.1.5 Response headers ........................................................................ 239
4.39.3.1.6 Supported response media types ................................................... 239
4.39.3.1.7 Response status ........................................................................... 239
4.39.3.1.8 Response body ............................................................................. 240
4.39.3.2 Location of the Uploaded File ......................................................... 241
4.39.3.3 Lifecycle of the Uploaded File ........................................................ 241
4.40 xCP Folder single instance ............................................................ 241
4.40.1 URI template ................................................................................ 241
4.40.2 Link relation .................................................................................. 241

xx OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.40.3 Operations .................................................................................... 242

4.40.3.1 Get a Folder ................................................................................. 242
4.40.3.1.1 HTTP method ............................................................................... 243
4.40.3.1.2 Query parameters ......................................................................... 243
4.40.3.1.3 Request headers ........................................................................... 243
4.40.3.1.4 Request body ............................................................................... 243
4.40.3.1.5 Response headers ........................................................................ 243
4.40.3.1.6 Supported response media types ................................................... 243
4.40.3.1.7 Response status ........................................................................... 244
4.40.3.1.8 Response body ............................................................................. 244
4.40.3.2 Update a Folder ............................................................................ 244
4.40.3.2.1 HTTP method ............................................................................... 244
4.40.3.2.2 Server accepted request media types ............................................. 244
4.40.3.2.3 Query parameters ......................................................................... 244
4.40.3.2.4 Request headers ........................................................................... 244
4.40.3.2.5 Request body ............................................................................... 245
4.40.3.2.6 Response headers ........................................................................ 245
4.40.3.2.7 Supported response media types ................................................... 245
4.40.3.2.8 Response status ........................................................................... 245
4.40.3.2.9 Response body ............................................................................. 246
4.40.3.3 Create a Folder ............................................................................. 246
4.40.3.3.1 HTTP method ............................................................................... 246
4.40.3.3.2 Server accepted request media types ............................................. 246
4.40.3.3.3 Query parameters ......................................................................... 246
4.40.3.3.4 Request headers ........................................................................... 246
4.40.3.3.5 Request body ............................................................................... 247
4.40.3.3.6 Response headers ........................................................................ 247
4.40.3.3.7 Supported response media types ................................................... 248
4.40.3.3.8 Response status ........................................................................... 248
4.40.3.3.9 Response body ............................................................................. 248
4.40.3.4 Copy a Document to a Folder ........................................................ 248
4.40.3.4.1 HTTP method ............................................................................... 248
4.40.3.4.2 Server accepted request media types ............................................. 249
4.40.3.4.3 Query parameters ......................................................................... 249
4.40.3.4.4 Request headers ........................................................................... 249
4.40.3.4.5 Request body ............................................................................... 249
4.40.3.4.6 Response headers ........................................................................ 249
4.40.3.4.7 Supported response media types ................................................... 250
4.40.3.4.8 Response status ........................................................................... 250
4.40.3.4.9 Response body ............................................................................. 250
4.40.3.5 Move a Document to a Folder ........................................................ 251
4.40.3.5.1 HTTP method ............................................................................... 251

EDCPKL230200-PGR-EN-01 Development Guide xxi

Table of Contents

4.40.3.5.2 Server accepted request media types ............................................. 251

4.40.3.5.3 Query parameters ......................................................................... 251
4.40.3.5.4 Request headers ........................................................................... 252
4.40.3.5.5 Request body ............................................................................... 252
4.40.3.5.6 Response headers ........................................................................ 252
4.40.3.5.7 Supported response media types ................................................... 252
4.40.3.5.8 Response status ........................................................................... 253
4.40.3.5.9 Response body ............................................................................. 253
4.40.3.6 Delete a Folder ............................................................................. 253
4.40.3.6.1 HTTP method ............................................................................... 253
4.40.3.6.2 Query parameters ......................................................................... 253
4.40.3.6.3 Request headers ........................................................................... 253
4.40.3.6.4 Request body ............................................................................... 254
4.40.3.6.5 Response headers ........................................................................ 254
4.40.3.6.6 Response status ........................................................................... 254
4.40.3.6.7 Response body ............................................................................. 254
4.41 xCP Folder Single Type ................................................................. 254
4.41.1 URI template ................................................................................ 254
4.41.2 Link relation .................................................................................. 254
4.41.3 Operations .................................................................................... 255
4.41.3.1 Get a Folder Type ......................................................................... 255
4.41.3.1.1 HTTP method ............................................................................... 255
4.41.3.1.2 Query parameters ......................................................................... 255
4.41.3.1.3 Request headers ........................................................................... 255
4.41.3.1.4 Request body ............................................................................... 255
4.41.3.1.5 Response headers ........................................................................ 255
4.41.3.1.6 Supported response media types ................................................... 256
4.41.3.1.7 Response status ........................................................................... 256
4.41.3.1.8 Response body ............................................................................. 256
4.42 xCP Folder Type collection ............................................................ 256
4.42.1 URI template ................................................................................ 256
4.42.2 Feed and EDAA support ................................................................ 256
4.42.3 Link relation .................................................................................. 257
4.42.4 Operations .................................................................................... 257
4.42.4.1 Get a Folder Type collection .......................................................... 257
4.42.4.1.1 HTTP method ............................................................................... 258
4.42.4.1.2 Query parameters ......................................................................... 258
4.42.4.1.3 Request headers ........................................................................... 258
4.42.4.1.4 Request body ............................................................................... 258
4.42.4.1.5 Response headers ........................................................................ 258
4.42.4.1.6 Supported response media types ................................................... 259
4.42.4.1.7 Response status ........................................................................... 259

xxii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.42.4.1.8 Response body ............................................................................. 259

4.43 xCP Case Node single instance ..................................................... 259
4.43.1 URI template ................................................................................ 259
4.43.2 Link relation .................................................................................. 260
4.43.3 Operations .................................................................................... 260
4.43.3.1 Get a case node ........................................................................... 261
4.43.3.1.1 HTTP method ............................................................................... 261
4.43.3.1.2 Query parameters ......................................................................... 261
4.43.3.1.3 Request headers ........................................................................... 261
4.43.3.1.4 Request body ............................................................................... 261
4.43.3.1.5 Response headers ........................................................................ 261
4.43.3.1.6 Supported response media types ................................................... 261
4.43.3.1.7 Response status ........................................................................... 262
4.43.3.1.8 Response body ............................................................................. 262
4.43.3.2 Update a case node ...................................................................... 262
4.43.3.2.1 HTTP method ............................................................................... 262
4.43.3.2.2 Server accepted request media types ............................................. 262
4.43.3.2.3 Query parameters ......................................................................... 262
4.43.3.2.4 Request headers ........................................................................... 262
4.43.3.2.5 Request body ............................................................................... 263
4.43.3.2.6 Response headers ........................................................................ 263
4.43.3.2.7 Supported response media types ................................................... 263
4.43.3.2.8 Response status ........................................................................... 263
4.43.3.2.9 Response body ............................................................................. 264
4.43.3.3 Create a case node ....................................................................... 264
4.43.3.3.1 HTTP method ............................................................................... 264
4.43.3.3.2 Server accepted request media types ............................................. 264
4.43.3.3.3 Query parameters ......................................................................... 264
4.43.3.3.4 Request headers ........................................................................... 264
4.43.3.3.5 Request body ............................................................................... 265
4.43.3.3.6 Response headers ........................................................................ 265
4.43.3.3.7 Supported response media types ................................................... 266
4.43.3.3.8 Response status ........................................................................... 266
4.43.3.3.9 Response body ............................................................................. 266
4.43.3.4 Copy a Document to a case node .................................................. 266
4.43.3.4.1 HTTP method ............................................................................... 267
4.43.3.4.2 Server accepted request media types ............................................. 267
4.43.3.4.3 Query parameters ......................................................................... 267
4.43.3.4.4 Request headers ........................................................................... 267
4.43.3.4.5 Request body ............................................................................... 267
4.43.3.4.6 Response headers ........................................................................ 267
4.43.3.4.7 Supported response media types ................................................... 268

EDCPKL230200-PGR-EN-01 Development Guide xxiii

Table of Contents

4.43.3.4.8 Response status ........................................................................... 268

4.43.3.4.9 Response body ............................................................................. 268
4.43.3.5 Move a case data node to a case node .......................................... 268
4.43.3.5.1 HTTP method ............................................................................... 268
4.43.3.5.2 Server accepted request media types ............................................. 269
4.43.3.5.3 Query parameters ......................................................................... 269
4.43.3.5.4 Request headers ........................................................................... 269
4.43.3.5.5 Request body ............................................................................... 269
4.43.3.5.6 Response headers ........................................................................ 269
4.43.3.5.7 Supported response media types ................................................... 270
4.43.3.5.8 Response status ........................................................................... 270
4.43.3.5.9 Response body ............................................................................. 270
4.43.3.6 Delete a case node ....................................................................... 270
4.43.3.6.1 HTTP method ............................................................................... 270
4.43.3.6.2 Query parameters ......................................................................... 271
4.43.3.6.3 Request headers ........................................................................... 271
4.43.3.6.4 Request body ............................................................................... 271
4.43.3.6.5 Response headers ........................................................................ 271
4.43.3.6.6 Response status ........................................................................... 271
4.43.3.6.7 Response body ............................................................................. 271
4.44 xCP Case Node Single Type .......................................................... 271
4.44.1 URI template ................................................................................ 272
4.44.2 Link relation .................................................................................. 272
4.44.3 Operations .................................................................................... 272
4.44.3.1 Get a Case Node Type .................................................................. 272
4.44.3.1.1 HTTP method ............................................................................... 272
4.44.3.1.2 Query parameters ......................................................................... 273
4.44.3.1.3 Request headers ........................................................................... 273
4.44.3.1.4 Request body ............................................................................... 273
4.44.3.1.5 Response headers ........................................................................ 273
4.44.3.1.6 Supported response media types ................................................... 273
4.44.3.1.7 Response status ........................................................................... 273
4.44.3.1.8 Response body ............................................................................. 274
4.45 xCP Case Node Type collection ..................................................... 274
4.45.1 URI template ................................................................................ 274
4.45.2 Feed and EDAA support ................................................................ 274
4.45.3 Link relation .................................................................................. 275
4.45.4 Operations .................................................................................... 275
4.45.4.1 Get a Case Node Type collection ................................................... 275
4.45.4.1.1 HTTP method ............................................................................... 275
4.45.4.1.2 Query parameters ......................................................................... 275
4.45.4.1.3 Request headers ........................................................................... 276

xxiv OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.45.4.1.4 Request body ............................................................................... 276

4.45.4.1.5 Response headers ........................................................................ 276
4.45.4.1.6 Supported response media types ................................................... 276
4.45.4.1.7 Response status ........................................................................... 276
4.45.4.1.8 Response body ............................................................................. 277
4.46 xCP Case Data Node single instance ............................................. 277
4.46.1 URI template ................................................................................ 277
4.46.2 Link relation .................................................................................. 277
4.46.3 Operations .................................................................................... 278
4.46.3.1 Get a case data node .................................................................... 278
4.46.3.1.1 HTTP method ............................................................................... 278
4.46.3.1.2 Query parameters ......................................................................... 278
4.46.3.1.3 Request headers ........................................................................... 279
4.46.3.1.4 Request body ............................................................................... 279
4.46.3.1.5 Response headers ........................................................................ 279
4.46.3.1.6 Supported response media types ................................................... 279
4.46.3.1.7 Response status ........................................................................... 279
4.46.3.1.8 Response body ............................................................................. 280
4.46.3.2 Update a case data node ............................................................... 280
4.46.3.2.1 HTTP method ............................................................................... 280
4.46.3.2.2 Server accepted request media types ............................................. 280
4.46.3.2.3 Query parameters ......................................................................... 280
4.46.3.2.4 Request headers ........................................................................... 280
4.46.3.2.5 Request body ............................................................................... 280
4.46.3.2.6 Response headers ........................................................................ 281
4.46.3.2.7 Supported response media types ................................................... 281
4.46.3.2.8 Response status ........................................................................... 281
4.46.3.2.9 Response body ............................................................................. 281
4.46.3.3 Create a case data node ............................................................... 282
4.46.3.3.1 HTTP method ............................................................................... 282
4.46.3.3.2 Server accepted request media types ............................................. 282
4.46.3.3.3 Query parameters ......................................................................... 282
4.46.3.3.4 Request headers ........................................................................... 282
4.46.3.3.5 Request body ............................................................................... 282
4.46.3.3.6 Response headers ........................................................................ 283
4.46.3.3.7 Supported response media types ................................................... 283
4.46.3.3.8 Response status ........................................................................... 283
4.46.3.3.9 Response body ............................................................................. 284
4.46.3.4 Copy a Document to a case data node ........................................... 284
4.46.3.4.1 HTTP method ............................................................................... 284
4.46.3.4.2 Server accepted request media types ............................................. 284
4.46.3.4.3 Query parameters ......................................................................... 284

EDCPKL230200-PGR-EN-01 Development Guide xxv

Table of Contents

4.46.3.4.4 Request headers ........................................................................... 284

4.46.3.4.5 Request body ............................................................................... 285
4.46.3.4.6 Response headers ........................................................................ 285
4.46.3.4.7 Supported response media types ................................................... 285
4.46.3.4.8 Response status ........................................................................... 285
4.46.3.4.9 Response body ............................................................................. 286
4.46.3.5 Move a case data node to another case data node .......................... 286
4.46.3.5.1 HTTP method ............................................................................... 286
4.46.3.5.2 Server accepted request media types ............................................. 286
4.46.3.5.3 Query parameters ......................................................................... 286
4.46.3.5.4 Request headers ........................................................................... 286
4.46.3.5.5 Request body ............................................................................... 287
4.46.3.5.6 Response headers ........................................................................ 287
4.46.3.5.7 Supported response media types ................................................... 287
4.46.3.5.8 Response status ........................................................................... 287
4.46.3.5.9 Response body ............................................................................. 288
4.46.3.6 Delete a case data node ................................................................ 288
4.46.3.6.1 HTTP method ............................................................................... 288
4.46.3.6.2 Query parameters ......................................................................... 288
4.46.3.6.3 Request headers ........................................................................... 288
4.46.3.6.4 Request body ............................................................................... 288
4.46.3.6.5 Response headers ........................................................................ 288
4.46.3.6.6 Response status ........................................................................... 288
4.46.3.6.7 Response body ............................................................................. 289
4.47 xCP Case Data Node Single Type .................................................. 289
4.47.1 URI template ................................................................................ 289
4.47.2 Link relation .................................................................................. 289
4.47.3 Operations .................................................................................... 289
4.47.3.1 Get a Case Data Node Type .......................................................... 290
4.47.3.1.1 HTTP method ............................................................................... 290
4.47.3.1.2 Query parameters ......................................................................... 290
4.47.3.1.3 Request headers ........................................................................... 290
4.47.3.1.4 Request body ............................................................................... 290
4.47.3.1.5 Response headers ........................................................................ 290
4.47.3.1.6 Supported response media types ................................................... 290
4.47.3.1.7 Response status ........................................................................... 290
4.47.3.1.8 Response body ............................................................................. 291
4.48 xCP Case Data Node Type collection ............................................. 291
4.48.1 URI template ................................................................................ 291
4.48.2 Feed and EDAA support ................................................................ 291
4.48.3 Link relation .................................................................................. 292
4.48.4 Operations .................................................................................... 292

xxvi OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.48.4.1 Get a Case Data Node Type collection ........................................... 292

4.48.4.1.1 HTTP method ............................................................................... 292
4.48.4.1.2 Query parameters ......................................................................... 292
4.48.4.1.3 Request headers ........................................................................... 293
4.48.4.1.4 Request body ............................................................................... 293
4.48.4.1.5 Response headers ........................................................................ 293
4.48.4.1.6 Supported response media types ................................................... 293
4.48.4.1.7 Response status ........................................................................... 293
4.48.4.1.8 Response body ............................................................................. 294
4.49 xCP Format single instance ........................................................... 294
4.49.1 URI template ................................................................................ 294
4.49.2 Link relation .................................................................................. 294
4.49.3 Operations .................................................................................... 295
4.49.3.1 Get a Format ................................................................................ 295
4.49.3.1.1 HTTP method ............................................................................... 295
4.49.3.1.2 Query parameters ......................................................................... 295
4.49.3.1.3 Request headers ........................................................................... 295
4.49.3.1.4 Request body ............................................................................... 295
4.49.3.1.5 Response headers ........................................................................ 295
4.49.3.1.6 Supported response media types ................................................... 296
4.49.3.1.7 Response status ........................................................................... 296
4.49.3.1.8 Response body ............................................................................. 296
4.50 xCP Format collection ................................................................... 296
4.50.1 URI template ................................................................................ 296
4.50.2 Feed and EDAA support ................................................................ 297
4.50.3 Link relation .................................................................................. 297
4.50.4 Operations .................................................................................... 298
4.50.4.1 Get a Format collection ................................................................. 298
4.50.4.1.1 HTTP method ............................................................................... 298
4.50.4.1.2 Query parameters ......................................................................... 298
4.50.4.1.3 Request headers ........................................................................... 298
4.50.4.1.4 Request body ............................................................................... 299
4.50.4.1.5 Response headers ........................................................................ 299
4.50.4.1.6 Supported response media types ................................................... 299
4.50.4.1.7 Response status ........................................................................... 299
4.50.4.1.8 Response body ............................................................................. 299
4.51 xCP Format Single Type ................................................................ 300
4.51.1 URI template ................................................................................ 300
4.51.2 Link relation .................................................................................. 300
4.51.3 Operations .................................................................................... 300
4.51.3.1 Get a Format Type ........................................................................ 300
4.51.3.1.1 HTTP method ............................................................................... 300

EDCPKL230200-PGR-EN-01 Development Guide xxvii

Table of Contents

4.51.3.1.2 Query parameters ......................................................................... 301

4.51.3.1.3 Request headers ........................................................................... 301
4.51.3.1.4 Request body ............................................................................... 301
4.51.3.1.5 Response headers ........................................................................ 301
4.51.3.1.6 Supported response media types ................................................... 301
4.51.3.1.7 Response status ........................................................................... 301
4.51.3.1.8 Response body ............................................................................. 302
4.52 xCP Format Type collection ........................................................... 302
4.52.1 URI template ................................................................................ 302
4.52.2 Feed and EDAA support ................................................................ 302
4.52.3 Link relation .................................................................................. 303
4.52.4 Operations .................................................................................... 303
4.52.4.1 Get a Format Type collection ......................................................... 303
4.52.4.1.1 HTTP method ............................................................................... 303
4.52.4.1.2 Query parameters ......................................................................... 303
4.52.4.1.3 Request headers ........................................................................... 304
4.52.4.1.4 Request body ............................................................................... 304
4.52.4.1.5 Response headers ........................................................................ 304
4.52.4.1.6 Supported response media types ................................................... 304
4.52.4.1.7 Response status ........................................................................... 304
4.52.4.1.8 Response body ............................................................................. 305
4.53 xCP Fragment single instance ....................................................... 305
4.53.1 URI template ................................................................................ 305
4.53.2 Link relation .................................................................................. 305
4.53.3 Operations .................................................................................... 306
4.53.3.1 Get a Fragment ............................................................................. 306
4.53.3.1.1 HTTP method ............................................................................... 306
4.53.3.1.2 Query parameters ......................................................................... 306
4.53.3.1.3 Request headers ........................................................................... 306
4.53.3.1.4 Request body ............................................................................... 307
4.53.3.1.5 Response headers ........................................................................ 307
4.53.3.1.6 Supported response media types ................................................... 307
4.53.3.1.7 Response status ........................................................................... 307
4.53.3.1.8 Response body ............................................................................. 307
4.53.3.2 Attach an Aspect to an Object ........................................................ 308
4.53.3.2.1 HTTP method ............................................................................... 308
4.53.3.2.2 Server accepted request media types ............................................. 308
4.53.3.2.3 Query parameters ......................................................................... 308
4.53.3.2.4 Request headers ........................................................................... 308
4.53.3.2.5 Request body ............................................................................... 309
4.53.3.2.6 Response headers ........................................................................ 309
4.53.3.2.7 Supported response media types ................................................... 310

xxviii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.53.3.2.8 Response status ........................................................................... 310

4.53.3.2.9 Response body ............................................................................. 310
4.54 xCP Fragment Single Type ............................................................ 310
4.54.1 URI template ................................................................................ 310
4.54.2 Link relation .................................................................................. 311
4.54.3 Operations .................................................................................... 311
4.54.3.1 Get a Fragment Type .................................................................... 311
4.54.3.1.1 HTTP method ............................................................................... 311
4.54.3.1.2 Query parameters ......................................................................... 311
4.54.3.1.3 Request headers ........................................................................... 311
4.54.3.1.4 Request body ............................................................................... 311
4.54.3.1.5 Response headers ........................................................................ 312
4.54.3.1.6 Supported response media types ................................................... 312
4.54.3.1.7 Response status ........................................................................... 312
4.54.3.1.8 Response body ............................................................................. 312
4.55 xCP Fragment Type collection ....................................................... 313
4.55.1 URI template ................................................................................ 313
4.55.2 Feed and EDAA support ................................................................ 313
4.55.3 Link relation .................................................................................. 314
4.55.4 Operations .................................................................................... 314
4.55.4.1 Get a Fragment Type collection ..................................................... 314
4.55.4.1.1 HTTP method ............................................................................... 314
4.55.4.1.2 Query parameters ......................................................................... 314
4.55.4.1.3 Request headers ........................................................................... 315
4.55.4.1.4 Request body ............................................................................... 315
4.55.4.1.5 Response headers ........................................................................ 315
4.55.4.1.6 Supported response media types ................................................... 315
4.55.4.1.7 Response status ........................................................................... 315
4.55.4.1.8 Response body ............................................................................. 316
4.56 xCP Full-Text Query single instance ............................................... 316
4.56.1 URI template ................................................................................ 316
4.56.2 Link relation .................................................................................. 316
4.56.3 Operations .................................................................................... 316
4.56.3.1 Perform a Full-Text Query ............................................................. 317
4.56.3.1.1 HTTP method ............................................................................... 317
4.56.3.1.2 Query parameters ......................................................................... 317
4.56.3.1.3 Request headers ........................................................................... 317
4.56.3.1.4 Request body ............................................................................... 318
4.56.3.1.5 Response headers ........................................................................ 318
4.56.3.1.6 Supported response media types ................................................... 318
4.56.3.1.7 Response status ........................................................................... 318
4.56.3.1.8 Response body ............................................................................. 318

EDCPKL230200-PGR-EN-01 Development Guide xxix

Table of Contents

4.57 xCP Full-Text Query Single Type ................................................... 328

4.57.1 URI template ................................................................................ 328
4.57.2 Link relation .................................................................................. 328
4.57.3 Operations .................................................................................... 329
4.57.3.1 Get a Full-Text Query Type ............................................................ 329
4.57.3.1.1 HTTP method ............................................................................... 329
4.57.3.1.2 Query parameters ......................................................................... 329
4.57.3.1.3 Request headers ........................................................................... 329
4.57.3.1.4 Request body ............................................................................... 329
4.57.3.1.5 Response headers ........................................................................ 329
4.57.3.1.6 Supported response media types ................................................... 330
4.57.3.1.7 Response status ........................................................................... 330
4.57.3.1.8 Response body ............................................................................. 330
4.58 xCP Full-Text Query Type collection ............................................... 331
4.58.1 URI template ................................................................................ 331
4.58.2 Feed and EDAA support ................................................................ 331
4.58.3 Link relation .................................................................................. 332
4.58.4 Operations .................................................................................... 332
4.58.4.1 Get a Full-Text Query Type collection ............................................. 332
4.58.4.1.1 HTTP method ............................................................................... 332
4.58.4.1.2 Query parameters ......................................................................... 332
4.58.4.1.3 Request headers ........................................................................... 333
4.58.4.1.4 Request body ............................................................................... 333
4.58.4.1.5 Response headers ........................................................................ 333
4.58.4.1.6 Supported response media types ................................................... 333
4.58.4.1.7 Response status ........................................................................... 333
4.58.4.1.8 Response body ............................................................................. 334
4.59 xCP Historical Query single instance .............................................. 334
4.59.1 URI template ................................................................................ 334
4.59.2 Link relation .................................................................................. 334
4.59.3 Operations .................................................................................... 335
4.59.3.1 Get a Historical Query ................................................................... 335
4.59.3.1.1 HTTP method ............................................................................... 335
4.59.3.1.2 Query parameters ......................................................................... 335
4.59.3.1.3 Request headers ........................................................................... 335
4.59.3.1.4 Request body ............................................................................... 335
4.59.3.1.5 Response headers ........................................................................ 335
4.59.3.1.6 Supported response media types ................................................... 336
4.59.3.1.7 Response status ........................................................................... 336
4.59.3.1.8 Response body ............................................................................. 336
4.60 xCP Historical Query collection ...................................................... 336
4.60.1 URI template ................................................................................ 336

xxx OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.60.2 Feed and EDAA support ................................................................ 336

4.60.3 Link relation .................................................................................. 337
4.60.4 Operations .................................................................................... 337
4.60.4.1 Get a Historical Query collection .................................................... 338
4.60.4.1.1 HTTP method ............................................................................... 338
4.60.4.1.2 Query parameters ......................................................................... 338
4.60.4.1.3 Request headers ........................................................................... 339
4.60.4.1.4 Request body ............................................................................... 340
4.60.4.1.5 Response headers ........................................................................ 340
4.60.4.1.6 Supported response media types ................................................... 340
4.60.4.1.7 Response status ........................................................................... 340
4.60.4.1.8 Response body ............................................................................. 340
4.61 xCP Historical Query Single Type .................................................. 341
4.61.1 URI template ................................................................................ 341
4.61.2 Link relation .................................................................................. 341
4.61.3 Operations .................................................................................... 341
4.61.3.1 Get a Historical Query Type ........................................................... 341
4.61.3.1.1 HTTP method ............................................................................... 342
4.61.3.1.2 Query parameters ......................................................................... 342
4.61.3.1.3 Request headers ........................................................................... 342
4.61.3.1.4 Request body ............................................................................... 342
4.61.3.1.5 Response headers ........................................................................ 342
4.61.3.1.6 Supported response media types ................................................... 342
4.61.3.1.7 Response status ........................................................................... 342
4.61.3.1.8 Response body ............................................................................. 343
4.62 xCP Historical Query Type collection .............................................. 343
4.62.1 URI template ................................................................................ 343
4.62.2 Feed and EDAA support ................................................................ 343
4.62.3 Link relation .................................................................................. 344
4.62.4 Operations .................................................................................... 344
4.62.4.1 Get a Historical Query Type collection ............................................ 344
4.62.4.1.1 HTTP method ............................................................................... 344
4.62.4.1.2 Query parameters ......................................................................... 344
4.62.4.1.3 Request headers ........................................................................... 345
4.62.4.1.4 Request body ............................................................................... 345
4.62.4.1.5 Response headers ........................................................................ 345
4.62.4.1.6 Supported response media types ................................................... 345
4.62.4.1.7 Response status ........................................................................... 345
4.62.4.1.8 Response body ............................................................................. 346
4.63 xCP Home Document .................................................................... 346
4.63.1 URI template ................................................................................ 346
4.63.2 Resources .................................................................................... 346

EDCPKL230200-PGR-EN-01 Development Guide xxxi

Table of Contents

4.63.3 Operations .................................................................................... 347

4.63.3.1 Get the Home Document ............................................................... 347
4.63.3.1.1 HTTP method ............................................................................... 347
4.63.3.1.2 Query parameters ......................................................................... 348
4.63.3.1.3 Request headers ........................................................................... 348
4.63.3.1.4 Request body ............................................................................... 348
4.63.3.1.5 Response headers ........................................................................ 348
4.63.3.1.6 Supported response media types ................................................... 348
4.63.3.1.7 Response status ........................................................................... 348
4.63.3.1.8 Response body ............................................................................. 349
4.64 xCP Member single instance .......................................................... 355
4.64.1 URI template ................................................................................ 355
4.64.2 Link relation .................................................................................. 355
4.64.3 Operations .................................................................................... 356
4.64.3.1 Get a Member ............................................................................... 356
4.64.3.1.1 HTTP method ............................................................................... 356
4.64.3.1.2 Query parameters ......................................................................... 356
4.64.3.1.3 Request headers ........................................................................... 356
4.64.3.1.4 Request body ............................................................................... 356
4.64.3.1.5 Response headers ........................................................................ 357
4.64.3.1.6 Supported response media types ................................................... 357
4.64.3.1.7 Response status ........................................................................... 357
4.64.3.1.8 Response body ............................................................................. 357
4.64.3.2 Add a Member .............................................................................. 358
4.64.3.2.1 HTTP method ............................................................................... 358
4.64.3.2.2 Server accepted request media types ............................................. 358
4.64.3.2.3 Query parameters ......................................................................... 358
4.64.3.2.4 Request headers ........................................................................... 358
4.64.3.2.5 Request body ............................................................................... 359
4.64.3.2.6 Response headers ........................................................................ 359
4.64.3.2.7 Supported response media types ................................................... 359
4.64.3.2.8 Response status ........................................................................... 359
4.64.3.2.9 Response body ............................................................................. 360
4.64.3.3 Remove a Member ........................................................................ 360
4.64.3.3.1 HTTP method ............................................................................... 360
4.64.3.3.2 Query parameters ......................................................................... 360
4.64.3.3.3 Request headers ........................................................................... 360
4.64.3.3.4 Request body ............................................................................... 361
4.64.3.3.5 Response headers ........................................................................ 361
4.64.3.3.6 Response status ........................................................................... 361
4.64.3.3.7 Response body ............................................................................. 361
4.65 xCP Member collection .................................................................. 361

xxxii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.65.1 URI template ................................................................................ 361

4.65.2 Feed and EDAA support ................................................................ 362
4.65.3 Link relation .................................................................................. 362
4.65.4 Operations .................................................................................... 363
4.65.4.1 Get a Member collection ................................................................ 363
4.65.4.1.1 HTTP method ............................................................................... 363
4.65.4.1.2 Query parameters ......................................................................... 363
4.65.4.1.3 Request headers ........................................................................... 364
4.65.4.1.4 Request body ............................................................................... 364
4.65.4.1.5 Response headers ........................................................................ 364
4.65.4.1.6 Supported response media types ................................................... 364
4.65.4.1.7 Response status ........................................................................... 364
4.65.4.1.8 Response body ............................................................................. 365
4.65.4.2 Get a Member collection of a Role or Group ................................... 365
4.65.4.2.1 HTTP method ............................................................................... 365
4.65.4.2.2 Query parameters ......................................................................... 365
4.65.4.2.3 Request headers ........................................................................... 366
4.65.4.2.4 Request body ............................................................................... 366
4.65.4.2.5 Response headers ........................................................................ 366
4.65.4.2.6 Supported response media types ................................................... 366
4.65.4.2.7 Response status ........................................................................... 366
4.65.4.2.8 Response body ............................................................................. 367
4.65.4.3 Get a Potential Member collection of a Role or Group ...................... 367
4.65.4.3.1 HTTP method ............................................................................... 367
4.65.4.3.2 Query parameters ......................................................................... 367
4.65.4.3.3 Request headers ........................................................................... 368
4.65.4.3.4 Request body ............................................................................... 368
4.65.4.3.5 Response headers ........................................................................ 368
4.65.4.3.6 Supported response media types ................................................... 368
4.65.4.3.7 Response status ........................................................................... 368
4.65.4.3.8 Response body ............................................................................. 369
4.66 xCP Member Single Type .............................................................. 369
4.66.1 URI template ................................................................................ 369
4.66.2 Link relation .................................................................................. 369
4.66.3 Operations .................................................................................... 369
4.66.3.1 Get a Member Type ...................................................................... 370
4.66.3.1.1 HTTP method ............................................................................... 370
4.66.3.1.2 Query parameters ......................................................................... 370
4.66.3.1.3 Request headers ........................................................................... 370
4.66.3.1.4 Request body ............................................................................... 370
4.66.3.1.5 Response headers ........................................................................ 370
4.66.3.1.6 Supported response media types ................................................... 370

EDCPKL230200-PGR-EN-01 Development Guide xxxiii

Table of Contents

4.66.3.1.7 Response status ........................................................................... 370

4.66.3.1.8 Response body ............................................................................. 371
4.67 xCP Member Type collection ......................................................... 371
4.67.1 URI template ................................................................................ 371
4.67.2 Feed and EDAA support ................................................................ 371
4.67.3 Link relation .................................................................................. 372
4.67.4 Operations .................................................................................... 372
4.67.4.1 Get a Member Type collection ....................................................... 372
4.67.4.1.1 HTTP method ............................................................................... 372
4.67.4.1.2 Query parameters ......................................................................... 372
4.67.4.1.3 Request headers ........................................................................... 373
4.67.4.1.4 Request body ............................................................................... 373
4.67.4.1.5 Response headers ........................................................................ 373
4.67.4.1.6 Supported response media types ................................................... 373
4.67.4.1.7 Response status ........................................................................... 373
4.67.4.1.8 Response body ............................................................................. 374
4.68 xCP Network Location single instance ............................................ 374
4.68.1 URI template ................................................................................ 374
4.68.2 Link relation .................................................................................. 374
4.68.3 Operations .................................................................................... 374
4.68.3.1 Get a Network Location ................................................................. 375
4.68.3.1.1 HTTP method ............................................................................... 375
4.68.3.1.2 Query parameters ......................................................................... 375
4.68.3.1.3 Request headers ........................................................................... 375
4.68.3.1.4 Request body ............................................................................... 375
4.68.3.1.5 Response headers ........................................................................ 375
4.68.3.1.6 Supported response media types ................................................... 375
4.68.3.1.7 Response status ........................................................................... 376
4.68.3.1.8 Response body ............................................................................. 376
4.69 xCP Network Location collection .................................................... 376
4.69.1 URI template ................................................................................ 376
4.69.2 Feed and EDAA support ................................................................ 376
4.69.3 Link relation .................................................................................. 377
4.69.4 Operations .................................................................................... 377
4.69.4.1 Get a Network Location collection .................................................. 378
4.69.4.1.1 HTTP method ............................................................................... 378
4.69.4.1.2 Query parameters ......................................................................... 378
4.69.4.1.3 Request headers ........................................................................... 378
4.69.4.1.4 Request body ............................................................................... 378
4.69.4.1.5 Response headers ........................................................................ 378
4.69.4.1.6 Supported response media types ................................................... 379
4.69.4.1.7 Response status ........................................................................... 379

xxxiv OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.69.4.1.8 Response body ............................................................................. 379

4.70 xCP Network Location Single Type ................................................ 379
4.70.1 URI template ................................................................................ 379
4.70.2 Link relation .................................................................................. 380
4.70.3 Operations .................................................................................... 380
4.70.3.1 Get a Network Location Type ......................................................... 380
4.70.3.1.1 HTTP method ............................................................................... 380
4.70.3.1.2 Query parameters ......................................................................... 380
4.70.3.1.3 Request headers ........................................................................... 380
4.70.3.1.4 Request body ............................................................................... 381
4.70.3.1.5 Response headers ........................................................................ 381
4.70.3.1.6 Supported response media types ................................................... 381
4.70.3.1.7 Response status ........................................................................... 381
4.70.3.1.8 Response body ............................................................................. 381
4.71 xCP Network Location Type collection ............................................ 381
4.71.1 URI template ................................................................................ 382
4.71.2 Feed and EDAA support ................................................................ 382
4.71.3 Link relation .................................................................................. 382
4.71.4 Operations .................................................................................... 383
4.71.4.1 Get a Network Location Type collection .......................................... 383
4.71.4.1.1 HTTP method ............................................................................... 383
4.71.4.1.2 Query parameters ......................................................................... 383
4.71.4.1.3 Request headers ........................................................................... 383
4.71.4.1.4 Request body ............................................................................... 384
4.71.4.1.5 Response headers ........................................................................ 384
4.71.4.1.6 Supported response media types ................................................... 384
4.71.4.1.7 Response status ........................................................................... 384
4.71.4.1.8 Response body ............................................................................. 384
4.72 xCP Picklist Single Type ................................................................ 385
4.72.1 URI template ................................................................................ 385
4.72.2 Link relation .................................................................................. 385
4.72.3 Operations .................................................................................... 385
4.72.3.1 Get a Picklist ................................................................................ 385
4.72.3.1.1 HTTP method ............................................................................... 385
4.72.3.1.2 Query parameters ......................................................................... 385
4.72.3.1.3 Request headers ........................................................................... 386
4.72.3.1.4 Request body ............................................................................... 386
4.72.3.1.5 Response headers ........................................................................ 386
4.72.3.1.6 Supported response media types ................................................... 386
4.72.3.1.7 Response status ........................................................................... 386
4.72.3.1.8 Response body ............................................................................. 387
4.73 xCP Picklist Type collection ........................................................... 387

EDCPKL230200-PGR-EN-01 Development Guide xxxv

Table of Contents

4.73.1 URI template ................................................................................ 388

4.73.2 Feed and EDAA support ................................................................ 388
4.73.3 Link relation .................................................................................. 388
4.73.4 Operations .................................................................................... 389
4.73.4.1 Get a Picklist Type collection ......................................................... 389
4.73.4.1.1 HTTP method ............................................................................... 389
4.73.4.1.2 Query parameters ......................................................................... 389
4.73.4.1.3 Request headers ........................................................................... 389
4.73.4.1.4 Request body ............................................................................... 390
4.73.4.1.5 Response headers ........................................................................ 390
4.73.4.1.6 Supported response media types ................................................... 390
4.73.4.1.7 Response status ........................................................................... 390
4.73.4.1.8 Response body ............................................................................. 390
4.74 xCP Process single instance .......................................................... 391
4.74.1 URI template ................................................................................ 391
4.74.2 Link relation .................................................................................. 391
4.74.3 Operations .................................................................................... 392
4.74.3.1 Get a Process ............................................................................... 392
4.74.3.1.1 HTTP method ............................................................................... 392
4.74.3.1.2 Query parameters ......................................................................... 392
4.74.3.1.3 Request headers ........................................................................... 392
4.74.3.1.4 Request body ............................................................................... 392
4.74.3.1.5 Response headers ........................................................................ 392
4.74.3.1.6 Supported response media types ................................................... 393
4.74.3.1.7 Response status ........................................................................... 393
4.74.3.1.8 Response body ............................................................................. 393
4.74.3.2 Update the status of a Process ...................................................... 393
4.74.3.2.1 HTTP method ............................................................................... 394
4.74.3.2.2 Server accepted request media types ............................................. 394
4.74.3.2.3 Query parameters ......................................................................... 394
4.74.3.2.4 Request headers ........................................................................... 394
4.74.3.2.5 Request body ............................................................................... 394
4.74.3.2.6 Response headers ........................................................................ 394
4.74.3.2.7 Supported response media types ................................................... 395
4.74.3.2.8 Response status ........................................................................... 395
4.74.3.2.9 Response body ............................................................................. 395
4.75 xCP Process collection .................................................................. 395
4.75.1 URI template ................................................................................ 395
4.75.2 Feed and EDAA support ................................................................ 396
4.75.3 Link relation .................................................................................. 396
4.75.4 Operations .................................................................................... 397
4.75.4.1 Get a Process collection ................................................................ 397

xxxvi OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.75.4.1.1 HTTP method ............................................................................... 397

4.75.4.1.2 Query parameters ......................................................................... 397
4.75.4.1.3 Request headers ........................................................................... 397
4.75.4.1.4 Request body ............................................................................... 398
4.75.4.1.5 Response headers ........................................................................ 398
4.75.4.1.6 Supported response media types ................................................... 398
4.75.4.1.7 Response status ........................................................................... 398
4.75.4.1.8 Response body ............................................................................. 398
4.75.4.2 Create a Process .......................................................................... 399
4.75.4.2.1 HTTP method ............................................................................... 399
4.75.4.2.2 Server accepted request media types ............................................. 399
4.75.4.2.3 Query parameters ......................................................................... 399
4.75.4.2.4 Request headers ........................................................................... 399
4.75.4.2.5 Request body ............................................................................... 399
4.75.4.2.6 Response headers ........................................................................ 401
4.75.4.2.7 Supported response media types ................................................... 401
4.75.4.2.8 Response status ........................................................................... 401
4.75.4.2.9 Response body ............................................................................. 401
4.76 xCP Process Single Type .............................................................. 402
4.76.1 URI template ................................................................................ 402
4.76.2 Link relation .................................................................................. 402
4.76.3 Operations .................................................................................... 402
4.76.3.1 Get a Process Type ...................................................................... 402
4.76.3.1.1 HTTP method ............................................................................... 402
4.76.3.1.2 Query parameters ......................................................................... 403
4.76.3.1.3 Request headers ........................................................................... 403
4.76.3.1.4 Request body ............................................................................... 403
4.76.3.1.5 Response headers ........................................................................ 403
4.76.3.1.6 Supported response media types ................................................... 403
4.76.3.1.7 Response status ........................................................................... 403
4.76.3.1.8 Response body ............................................................................. 404
4.77 xCP Process Type collection .......................................................... 404
4.77.1 URI template ................................................................................ 404
4.77.2 Feed and EDAA support ................................................................ 404
4.77.3 Link relation .................................................................................. 405
4.77.4 Operations .................................................................................... 405
4.77.4.1 Get a Process Type collection ........................................................ 405
4.77.4.1.1 HTTP method ............................................................................... 405
4.77.4.1.2 Query parameters ......................................................................... 405
4.77.4.1.3 Request headers ........................................................................... 406
4.77.4.1.4 Request body ............................................................................... 406
4.77.4.1.5 Response headers ........................................................................ 406

EDCPKL230200-PGR-EN-01 Development Guide xxxvii

Table of Contents

4.77.4.1.6 Supported response media types ................................................... 406

4.77.4.1.7 Response status ........................................................................... 406
4.77.4.1.8 Response body ............................................................................. 407
4.78 xCP product information single instance ......................................... 407
4.78.1 URI template ................................................................................ 407
4.78.2 Link relation .................................................................................. 407
4.78.3 Operations .................................................................................... 407
4.78.3.1 Get product information ................................................................. 408
4.78.3.1.1 HTTP method ............................................................................... 408
4.78.3.1.2 Query parameters ......................................................................... 408
4.78.3.1.3 Request headers ........................................................................... 408
4.78.3.1.4 Request body ............................................................................... 408
4.78.3.1.5 Response headers ........................................................................ 408
4.78.3.1.6 Supported response media types ................................................... 408
4.78.3.1.7 Response status ........................................................................... 409
4.78.3.1.8 Response body ............................................................................. 409
4.79 xCP product information type ......................................................... 409
4.79.1 URI template ................................................................................ 409
4.79.2 Link relation .................................................................................. 409
4.79.3 Operations .................................................................................... 410
4.79.3.1 Get a Product Information Type ..................................................... 410
4.79.3.1.1 HTTP method ............................................................................... 410
4.79.3.1.2 Query parameters ......................................................................... 410
4.79.3.1.3 Request headers ........................................................................... 410
4.79.3.1.4 Request body ............................................................................... 410
4.79.3.1.5 Response headers ........................................................................ 410
4.79.3.1.6 Supported response media types ................................................... 410
4.79.3.1.7 Response status ........................................................................... 411
4.79.3.1.8 Response body ............................................................................. 411
4.80 xCP product information type collection .......................................... 411
4.80.1 URI template ................................................................................ 411
4.80.2 Feed and EDAA support ................................................................ 411
4.80.3 Link relation .................................................................................. 412
4.80.4 Operations .................................................................................... 412
4.80.4.1 Get a Product Information Type collection ....................................... 412
4.80.4.1.1 HTTP method ............................................................................... 412
4.80.4.1.2 Query parameters ......................................................................... 413
4.80.4.1.3 Request headers ........................................................................... 413
4.80.4.1.4 Request body ............................................................................... 413
4.80.4.1.5 Response headers ........................................................................ 413
4.80.4.1.6 Supported response media types ................................................... 413
4.80.4.1.7 Response status ........................................................................... 414

xxxviii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.80.4.1.8 Response body ............................................................................. 414

4.81 xCP Project single instance ........................................................... 414
4.81.1 URI template ................................................................................ 414
4.81.2 Link relation .................................................................................. 415
4.81.3 Operations .................................................................................... 415
4.81.3.1 Get a Project ................................................................................ 415
4.81.3.1.1 HTTP method ............................................................................... 415
4.81.3.1.2 Query parameters ......................................................................... 415
4.81.3.1.3 Request headers ........................................................................... 415
4.81.3.1.4 Request body ............................................................................... 416
4.81.3.1.5 Response headers ........................................................................ 416
4.81.3.1.6 Supported response media types ................................................... 416
4.81.3.1.7 Response status ........................................................................... 416
4.81.3.1.8 Response body ............................................................................. 416
4.82 xCP Project collection .................................................................... 417
4.82.1 URI template ................................................................................ 417
4.82.2 Feed and EDAA support ................................................................ 417
4.82.3 Link relation .................................................................................. 418
4.82.4 Operations .................................................................................... 418
4.82.4.1 Get a Project collection .................................................................. 418
4.82.4.1.1 HTTP method ............................................................................... 418
4.82.4.1.2 Query parameters ......................................................................... 418
4.82.4.1.3 Request headers ........................................................................... 419
4.82.4.1.4 Request body ............................................................................... 419
4.82.4.1.5 Response headers ........................................................................ 419
4.82.4.1.6 Supported response media types ................................................... 419
4.82.4.1.7 Response status ........................................................................... 419
4.82.4.1.8 Response body ............................................................................. 420
4.83 xCP project single type .................................................................. 420
4.83.1 URI template ................................................................................ 420
4.83.2 Link relation .................................................................................. 420
4.83.3 Operations .................................................................................... 420
4.83.3.1 Get a Project type ......................................................................... 421
4.83.3.1.1 HTTP method ............................................................................... 421
4.83.3.1.2 Query parameters ......................................................................... 421
4.83.3.1.3 Request headers ........................................................................... 421
4.83.3.1.4 Request body ............................................................................... 421
4.83.3.1.5 Response headers ........................................................................ 421
4.83.3.1.6 Supported response media types ................................................... 421
4.83.3.1.7 Response status ........................................................................... 421
4.83.3.1.8 Response body ............................................................................. 422
4.84 xCP Project Type collection ........................................................... 422

EDCPKL230200-PGR-EN-01 Development Guide xxxix

Table of Contents

4.84.1 URI template ................................................................................ 422

4.84.2 Feed and EDAA support ................................................................ 422
4.84.3 Link relation .................................................................................. 423
4.84.4 Operations .................................................................................... 423
4.84.4.1 Get a Project Type collection ......................................................... 423
4.84.4.1.1 HTTP method ............................................................................... 423
4.84.4.1.2 Query parameters ......................................................................... 423
4.84.4.1.3 Request headers ........................................................................... 424
4.84.4.1.4 Request body ............................................................................... 424
4.84.4.1.5 Response headers ........................................................................ 424
4.84.4.1.6 Supported response media types ................................................... 424
4.84.4.1.7 Response status ........................................................................... 424
4.84.4.1.8 Response body ............................................................................. 425
4.85 xCP Queue List single instance ...................................................... 425
4.85.1 URI template ................................................................................ 425
4.85.2 Link relation .................................................................................. 425
4.85.3 Operations .................................................................................... 425
4.85.3.1 Get a queue list ............................................................................. 426
4.85.3.1.1 HTTP method ............................................................................... 426
4.85.3.1.2 Query parameters ......................................................................... 426
4.85.3.1.3 Request headers ........................................................................... 426
4.85.3.1.4 Request body ............................................................................... 426
4.85.3.1.5 Response headers ........................................................................ 426
4.85.3.1.6 Supported response media types ................................................... 427
4.85.3.1.7 Response status ........................................................................... 427
4.85.3.1.8 Response body ............................................................................. 427
4.86 xCP Real-Time query single instance ............................................. 429
4.86.1 URI template ................................................................................ 429
4.86.2 Link relation .................................................................................. 429
4.86.3 Operations .................................................................................... 429
4.86.3.1 Perform a Real-Time query ............................................................ 429
4.86.3.1.1 HTTP method ............................................................................... 429
4.86.3.1.2 Query parameters ......................................................................... 430
4.86.3.1.3 Request headers ........................................................................... 430
4.86.3.1.4 Request body ............................................................................... 430
4.86.3.1.5 Response headers ........................................................................ 430
4.86.3.1.6 Supported response media types ................................................... 431
4.86.3.1.7 Response status ........................................................................... 431
4.86.3.1.8 Response body ............................................................................. 431
4.87 xCP Real-Time query single type ................................................... 433
4.87.1 URI template ................................................................................ 433
4.87.2 Link relation .................................................................................. 433

xl OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.87.3 Operations .................................................................................... 433

4.87.3.1 Get a Real-Time query type ........................................................... 434
4.87.3.1.1 HTTP method ............................................................................... 434
4.87.3.1.2 Query parameters ......................................................................... 434
4.87.3.1.3 Request headers ........................................................................... 434
4.87.3.1.4 Request body ............................................................................... 434
4.87.3.1.5 Response headers ........................................................................ 434
4.87.3.1.6 Supported response media types ................................................... 434
4.87.3.1.7 Response status ........................................................................... 434
4.87.3.1.8 Response body ............................................................................. 435
4.88 xCP Real-Time query type collection .............................................. 435
4.88.1 URI template ................................................................................ 435
4.88.2 Feed and EDAA support ................................................................ 435
4.88.3 Link relation .................................................................................. 436
4.88.4 Operations .................................................................................... 436
4.88.4.1 Get a Real-Time query type collection ............................................ 436
4.88.4.1.1 HTTP method ............................................................................... 437
4.88.4.1.2 Query parameters ......................................................................... 437
4.88.4.1.3 Request headers ........................................................................... 437
4.88.4.1.4 Request body ............................................................................... 437
4.88.4.1.5 Response headers ........................................................................ 437
4.88.4.1.6 Supported response media types ................................................... 438
4.88.4.1.7 Response status ........................................................................... 438
4.88.4.1.8 Response body ............................................................................. 438
4.89 xCP relationship single instance ..................................................... 438
4.89.1 URI template ................................................................................ 439
4.89.2 Link relation .................................................................................. 439
4.89.3 Operations .................................................................................... 439
4.89.3.1 Get a Relationship ......................................................................... 440
4.89.3.1.1 HTTP method ............................................................................... 440
4.89.3.1.2 Query parameters ......................................................................... 440
4.89.3.1.3 Request headers ........................................................................... 440
4.89.3.1.4 Request body ............................................................................... 440
4.89.3.1.5 Response headers ........................................................................ 440
4.89.3.1.6 Supported response media types ................................................... 440
4.89.3.1.7 Response status ........................................................................... 441
4.89.3.1.8 Response body ............................................................................. 441
4.89.3.2 Update a Relationship ................................................................... 441
4.89.3.2.1 HTTP method ............................................................................... 441
4.89.3.2.2 Server accepted request media types ............................................. 441
4.89.3.2.3 Query parameters ......................................................................... 441
4.89.3.2.4 Request headers ........................................................................... 441

EDCPKL230200-PGR-EN-01 Development Guide xli

Table of Contents

4.89.3.2.5 Request body ............................................................................... 442

4.89.3.2.6 Response headers ........................................................................ 442
4.89.3.2.7 Supported response media types ................................................... 442
4.89.3.2.8 Response status ........................................................................... 442
4.89.3.2.9 Response body ............................................................................. 443
4.89.3.3 Create a relationship ..................................................................... 443
4.89.3.3.1 HTTP method ............................................................................... 443
4.89.3.3.2 Server accepted request media types ............................................. 443
4.89.3.3.3 Query parameters ......................................................................... 443
4.89.3.3.4 Request headers ........................................................................... 443
4.89.3.3.5 Request body ............................................................................... 444
4.89.3.3.6 Response headers ........................................................................ 445
4.89.3.3.7 Supported response media types ................................................... 445
4.89.3.3.8 Response status ........................................................................... 445
4.89.3.3.9 Response body ............................................................................. 445
4.89.3.4 Delete a Relationship .................................................................... 446
4.89.3.4.1 HTTP method ............................................................................... 446
4.89.3.4.2 Query parameters ......................................................................... 446
4.89.3.4.3 Request headers ........................................................................... 446
4.89.3.4.4 Request body ............................................................................... 446
4.89.3.4.5 Response headers ........................................................................ 446
4.89.3.4.6 Response status ........................................................................... 446
4.89.3.4.7 Response body ............................................................................. 446
4.90 xCP Relationship collection ............................................................ 447
4.90.1 URI template ................................................................................ 447
4.90.2 Feed and EDAA support ................................................................ 447
4.90.3 Link relation .................................................................................. 448
4.90.4 Operations .................................................................................... 448
4.90.4.1 Get a Relationship collection .......................................................... 448
4.90.4.1.1 HTTP method ............................................................................... 448
4.90.4.1.2 Query parameters ......................................................................... 448
4.90.4.1.3 Request headers ........................................................................... 449
4.90.4.1.4 Request body ............................................................................... 449
4.90.4.1.5 Response headers ........................................................................ 449
4.90.4.1.6 Supported response media types ................................................... 449
4.90.4.1.7 Response status ........................................................................... 449
4.90.4.1.8 Response body ............................................................................. 450
4.91 xCP Relationship Single Type ........................................................ 450
4.91.1 URI template ................................................................................ 450
4.91.2 Link relation .................................................................................. 450
4.91.3 Operations .................................................................................... 450
4.91.3.1 Get a Relationship Type ................................................................ 451

xlii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.91.3.1.1 HTTP method ............................................................................... 451

4.91.3.1.2 Query parameters ......................................................................... 451
4.91.3.1.3 Request headers ........................................................................... 451
4.91.3.1.4 Request body ............................................................................... 451
4.91.3.1.5 Response headers ........................................................................ 451
4.91.3.1.6 Supported response media types ................................................... 451
4.91.3.1.7 Response status ........................................................................... 451
4.91.3.1.8 Response body ............................................................................. 452
4.92 xCP Relationship Type collection ................................................... 452
4.92.1 URI template ................................................................................ 452
4.92.2 Feed and EDAA support ................................................................ 452
4.92.3 Link relation .................................................................................. 453
4.92.4 Operations .................................................................................... 453
4.92.4.1 Get a Relationship type collection .................................................. 453
4.92.4.1.1 HTTP method ............................................................................... 453
4.92.4.1.2 Query parameters ......................................................................... 453
4.92.4.1.3 Request headers ........................................................................... 454
4.92.4.1.4 Request body ............................................................................... 454
4.92.4.1.5 Response headers ........................................................................ 454
4.92.4.1.6 Supported response media types ................................................... 454
4.92.4.1.7 Response status ........................................................................... 454
4.92.4.1.8 Response body ............................................................................. 455
4.93 xCP Rendition collection ................................................................ 455
4.93.1 URI template ................................................................................ 455
4.93.2 Feed and EDAA support ................................................................ 455
4.93.3 Link relation .................................................................................. 456
4.93.4 Operations .................................................................................... 456
4.93.4.1 Get renditions ............................................................................... 456
4.93.4.1.1 HTTP method ............................................................................... 456
4.93.4.1.2 Query parameters ......................................................................... 457
4.93.4.1.3 Request headers ........................................................................... 458
4.93.4.1.4 Request body ............................................................................... 458
4.93.4.1.5 Response headers ........................................................................ 458
4.93.4.1.6 Supported response media types ................................................... 459
4.93.4.1.7 Response status ........................................................................... 459
4.93.4.1.8 Response body ............................................................................. 459
4.94 xCP repository single instance ....................................................... 461
4.94.1 URI template ................................................................................ 462
4.94.2 Link relation .................................................................................. 462
4.94.3 Operations .................................................................................... 463
4.94.3.1 Get a repository ............................................................................ 463
4.94.3.1.1 HTTP method ............................................................................... 463

EDCPKL230200-PGR-EN-01 Development Guide xliii

Table of Contents

4.94.3.1.2 Query parameters ......................................................................... 463

4.94.3.1.3 Request headers ........................................................................... 463
4.94.3.1.4 Request body ............................................................................... 463
4.94.3.1.5 Response headers ........................................................................ 463
4.94.3.1.6 Supported response media types ................................................... 464
4.94.3.1.7 Response status ........................................................................... 464
4.94.3.1.8 Response body ............................................................................. 464
4.95 xCP repository single type ............................................................. 464
4.95.1 URI template ................................................................................ 464
4.95.2 Link relation .................................................................................. 465
4.95.3 Operations .................................................................................... 465
4.95.3.1 Get a repository type ..................................................................... 466
4.95.3.1.1 HTTP method ............................................................................... 466
4.95.3.1.2 Query parameters ......................................................................... 466
4.95.3.1.3 Request headers ........................................................................... 466
4.95.3.1.4 Request body ............................................................................... 466
4.95.3.1.5 Response headers ........................................................................ 466
4.95.3.1.6 Supported response media types ................................................... 466
4.95.3.1.7 Response status ........................................................................... 466
4.95.3.1.8 Response body ............................................................................. 467
4.96 xCP repository type collection ........................................................ 467
4.96.1 URI template ................................................................................ 467
4.96.2 Feed and EDAA support ................................................................ 467
4.96.3 Link relation .................................................................................. 468
4.96.4 Operations .................................................................................... 468
4.96.4.1 Get a repository type collection ...................................................... 468
4.96.4.1.1 HTTP method ............................................................................... 468
4.96.4.1.2 Query parameters ......................................................................... 468
4.96.4.1.3 Request headers ........................................................................... 469
4.96.4.1.4 Request body ............................................................................... 469
4.96.4.1.5 Response headers ........................................................................ 469
4.96.4.1.6 Supported response media types ................................................... 469
4.96.4.1.7 Response status ........................................................................... 469
4.96.4.1.8 Response body ............................................................................. 470
4.97 xCP stateless process single instance ............................................ 470
4.97.1 URI template ................................................................................ 470
4.97.2 Link relation .................................................................................. 470
4.97.3 Operations .................................................................................... 470
4.97.3.1 Create a stateless process ............................................................ 470
4.97.3.1.1 HTTP method ............................................................................... 471
4.97.3.1.2 Server accepted request media types ............................................. 471
4.97.3.1.3 Query parameters ......................................................................... 471

xliv OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.97.3.1.4 Request headers ........................................................................... 471

4.97.3.1.5 Request body ............................................................................... 471
4.97.3.1.6 Response headers ........................................................................ 472
4.97.3.1.7 Supported response media types ................................................... 472
4.97.3.1.8 Response status ........................................................................... 472
4.97.3.1.9 Response body ............................................................................. 472
4.98 xCP stateless process single type .................................................. 473
4.99 xCP task single instance ................................................................ 473
4.99.1 URI template ................................................................................ 473
4.99.2 Link relation .................................................................................. 474
4.99.3 Operations .................................................................................... 475
4.99.3.1 Get a task ..................................................................................... 476
4.99.3.1.1 HTTP method ............................................................................... 476
4.99.3.1.2 Query parameters ......................................................................... 476
4.99.3.1.3 Request headers ........................................................................... 476
4.99.3.1.4 Request body ............................................................................... 476
4.99.3.1.5 Response headers ........................................................................ 476
4.99.3.1.6 Supported response media types ................................................... 476
4.99.3.1.7 Response status ........................................................................... 477
4.99.3.1.8 Response body ............................................................................. 477
4.99.3.2 Get the status of a Task ................................................................. 477
4.99.3.2.1 HTTP method ............................................................................... 477
4.99.3.2.2 Query parameters ......................................................................... 477
4.99.3.2.3 Request headers ........................................................................... 478
4.99.3.2.4 Request body ............................................................................... 478
4.99.3.2.5 Response headers ........................................................................ 478
4.99.3.2.6 Supported response media types ................................................... 478
4.99.3.2.7 Response status ........................................................................... 478
4.99.3.2.8 Response body ............................................................................. 479
4.99.3.3 Update the status of a Task ........................................................... 479
4.99.3.3.1 HTTP method ............................................................................... 479
4.99.3.3.2 Server accepted request media types ............................................. 479
4.99.3.3.3 Query parameters ......................................................................... 479
4.99.3.3.4 Request headers ........................................................................... 479
4.99.3.3.5 Request body ............................................................................... 480
4.99.3.3.6 Response headers ........................................................................ 480
4.99.3.3.7 Supported response media types ................................................... 480
4.99.3.3.8 Response status ........................................................................... 480
4.99.3.3.9 Response body ............................................................................. 481
4.99.3.4 Acquire a Task .............................................................................. 481
4.99.3.4.1 HTTP method ............................................................................... 481
4.99.3.4.2 Server accepted request media types ............................................. 481

EDCPKL230200-PGR-EN-01 Development Guide xlv

Table of Contents

4.99.3.4.3 Query parameters ......................................................................... 481

4.99.3.4.4 Request headers ........................................................................... 481
4.99.3.4.5 Request body ............................................................................... 481
4.99.3.4.6 Response headers ........................................................................ 482
4.99.3.4.7 Supported response media types ................................................... 482
4.99.3.4.8 Response status ........................................................................... 482
4.99.3.4.9 Response body ............................................................................. 482
4.99.3.5 Update a Task .............................................................................. 482
4.99.3.5.1 HTTP method ............................................................................... 483
4.99.3.5.2 Server accepted request media types ............................................. 483
4.99.3.5.3 Query parameters ......................................................................... 483
4.99.3.5.4 Request headers ........................................................................... 483
4.99.3.5.5 Request body ............................................................................... 483
4.99.3.5.6 Response headers ........................................................................ 484
4.99.3.5.7 Supported response media types ................................................... 484
4.99.3.5.8 Response status ........................................................................... 484
4.99.3.5.9 Response body ............................................................................. 484
4.99.3.6 Complete a Task ........................................................................... 484
4.99.3.6.1 HTTP method ............................................................................... 485
4.99.3.6.2 Server accepted request media types ............................................. 485
4.99.3.6.3 Query parameters ......................................................................... 485
4.99.3.6.4 Request headers ........................................................................... 485
4.99.3.6.5 Request body ............................................................................... 485
4.99.3.6.6 Response headers ........................................................................ 486
4.99.3.6.7 Supported response media types ................................................... 486
4.99.3.6.8 Response status ........................................................................... 486
4.99.3.6.9 Response body ............................................................................. 487
4.99.3.7 Repeat a Task .............................................................................. 487
4.99.3.7.1 HTTP method ............................................................................... 487
4.99.3.7.2 Server accepted request media types ............................................. 487
4.99.3.7.3 Query parameters ......................................................................... 487
4.99.3.7.4 Request headers ........................................................................... 487
4.99.3.7.5 Request body ............................................................................... 487
4.99.3.7.6 Response headers ........................................................................ 488
4.99.3.7.7 Supported response media types ................................................... 488
4.99.3.7.8 Response status ........................................................................... 488
4.99.3.7.9 Response body ............................................................................. 488
4.100 xCP Task collection ....................................................................... 488
4.100.1 URI template ................................................................................ 489
4.100.2 Feed and EDAA support ................................................................ 489
4.100.3 Link relation .................................................................................. 490
4.100.4 Operations .................................................................................... 490

xlvi OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.100.4.1 Get a Task collection ..................................................................... 490

4.100.4.1. HTTP method ............................................................................... 490
1
4.100.4.1. Query parameters ......................................................................... 490
2
4.100.4.1. Request headers ........................................................................... 491
3
4.100.4.1. Request body ............................................................................... 491
4
4.100.4.1. Response headers ........................................................................ 491
5
4.100.4.1. Supported response media types ................................................... 491
6
4.100.4.1. Response status ........................................................................... 491
7
4.100.4.1. Response body ............................................................................. 492
8
4.101 xCP Task single type ..................................................................... 492
4.101.1 URI template ................................................................................ 492
4.101.2 Link relation .................................................................................. 492
4.101.3 Operations .................................................................................... 492
4.101.3.1 Get a Task Type ........................................................................... 493
4.101.3.1. HTTP method ............................................................................... 493
1
4.101.3.1. Query parameters ......................................................................... 493
2
4.101.3.1. Request headers ........................................................................... 493
3
4.101.3.1. Request body ............................................................................... 493
4
4.101.3.1. Response headers ........................................................................ 493
5
4.101.3.1. Supported response media types ................................................... 493
6
4.101.3.1. Response status ........................................................................... 493
7
4.101.3.1. Response body ............................................................................. 494
8
4.102 xCP Task type collection ............................................................... 494
4.102.1 URI template ................................................................................ 494
4.102.2 Feed and EDAA support ................................................................ 494
4.102.3 Link relation .................................................................................. 495
4.102.4 Operations .................................................................................... 495
4.102.4.1 Get a Task Type collection ............................................................ 495

EDCPKL230200-PGR-EN-01 Development Guide xlvii

Table of Contents

4.102.4.1. HTTP method ............................................................................... 495

1
4.102.4.1. Query parameters ......................................................................... 495
2
4.102.4.1. Request headers ........................................................................... 496
3
4.102.4.1. Request body ............................................................................... 496
4
4.102.4.1. Response headers ........................................................................ 496
5
4.102.4.1. Supported response media types ................................................... 496
6
4.102.4.1. Response status ........................................................................... 496
7
4.102.4.1. Response body ............................................................................. 497
8
4.103 xCP Task-list query single instance ................................................ 497
4.103.1 URI template ................................................................................ 497
4.103.2 Link relation .................................................................................. 497
4.103.3 Operations .................................................................................... 497
4.103.3.1 Perform a Tasklist query ................................................................ 498
4.103.3.1. HTTP method ............................................................................... 498
1
4.103.3.1. Query parameters ......................................................................... 498
2
4.103.3.1. Request headers ........................................................................... 498
3
4.103.3.1. Request body ............................................................................... 498
4
4.103.3.1. Response headers ........................................................................ 499
5
4.103.3.1. Supported response media types ................................................... 499
6
4.103.3.1. Response status ........................................................................... 499
7
4.103.3.1. Response body ............................................................................. 499
8
4.104 xCP Tasklist query single type ....................................................... 502
4.104.1 URI template ................................................................................ 502
4.104.2 Link relation .................................................................................. 502
4.104.3 Operations .................................................................................... 502
4.104.3.1 Get a Tasklist query type ............................................................... 502
4.104.3.1. HTTP method ............................................................................... 503
1
4.104.3.1. Query parameters ......................................................................... 503
2

xlviii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.104.3.1. Request headers ........................................................................... 503

3
4.104.3.1. Request body ............................................................................... 503
4
4.104.3.1. Response headers ........................................................................ 503
5
4.104.3.1. Supported response media types ................................................... 503
6
4.104.3.1. Response status ........................................................................... 503
7
4.104.3.1. Response body ............................................................................. 504
8
4.105 xCP Tasklist query type collection .................................................. 505
4.105.1 URI template ................................................................................ 505
4.105.2 Feed and EDAA support ................................................................ 505
4.105.3 Link relation .................................................................................. 506
4.105.4 Operations .................................................................................... 506
4.105.4.1 Get a Tasklist query type collection ................................................ 506
4.105.4.1. HTTP method ............................................................................... 506
1
4.105.4.1. Query parameters ......................................................................... 506
2
4.105.4.1. Request headers ........................................................................... 507
3
4.105.4.1. Request body ............................................................................... 507
4
4.105.4.1. Response headers ........................................................................ 507
5
4.105.4.1. Supported response media types ................................................... 507
6
4.105.4.1. Response status ........................................................................... 507
7
4.105.4.1. Response body ............................................................................. 508
8
4.106 xCP Template Single instance ....................................................... 508
4.106.1 URI template ................................................................................ 508
4.106.2 Link relation .................................................................................. 508
4.106.3 Operations .................................................................................... 509
4.106.3.1 Get a Template ............................................................................. 509
4.106.3.1. HTTP method ............................................................................... 509
1
4.106.3.1. Query parameters ......................................................................... 509
2
4.106.3.1. Request headers ........................................................................... 509
3

EDCPKL230200-PGR-EN-01 Development Guide xlix

Table of Contents

4.106.3.1. Request body ............................................................................... 509

4
4.106.3.1. Response headers ........................................................................ 509
5
4.106.3.1. Supported response media types ................................................... 510
6
4.106.3.1. Response status ........................................................................... 510
7
4.106.3.1. Response body ............................................................................. 510
8
4.107 xCP Template collection ................................................................ 510
4.107.1 URI template ................................................................................ 510
4.107.2 Feed and EDAA support ................................................................ 511
4.107.3 Link relation .................................................................................. 511
4.107.4 Operations .................................................................................... 512
4.107.4.1 Get a Template collection .............................................................. 512
4.107.4.1. HTTP method ............................................................................... 512
1
4.107.4.1. Query parameters ......................................................................... 512
2
4.107.4.1. Request headers ........................................................................... 512
3
4.107.4.1. Request body ............................................................................... 513
4
4.107.4.1. Response headers ........................................................................ 513
5
4.107.4.1. Supported response media types ................................................... 513
6
4.107.4.1. Response status ........................................................................... 513
7
4.107.4.1. Response body ............................................................................. 513
8
4.108 xCP template single type ............................................................... 514
4.108.1 URI template ................................................................................ 514
4.108.2 Link relation .................................................................................. 514
4.108.3 Operations .................................................................................... 514
4.108.3.1 Get a template type ....................................................................... 514
4.108.3.1. HTTP method ............................................................................... 515
1
4.108.3.1. Query parameters ......................................................................... 515
2
4.108.3.1. Request headers ........................................................................... 515
3
4.108.3.1. Request body ............................................................................... 515
4

l OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.108.3.1. Response headers ........................................................................ 515

5
4.108.3.1. Supported response media types ................................................... 515
6
4.108.3.1. Response status ........................................................................... 515
7
4.108.3.1. Response body ............................................................................. 516
8
4.109 xCP Template Type collection ........................................................ 516
4.109.1 URI template ................................................................................ 516
4.109.2 Feed and EDAA support ................................................................ 516
4.109.3 Link relation .................................................................................. 517
4.109.4 Operations .................................................................................... 517
4.109.4.1 Get a template type collection ........................................................ 517
4.109.4.1. HTTP method ............................................................................... 517
1
4.109.4.1. Query parameters ......................................................................... 517
2
4.109.4.1. Request headers ........................................................................... 518
3
4.109.4.1. Request body ............................................................................... 518
4
4.109.4.1. Response headers ........................................................................ 518
5
4.109.4.1. Supported response media types ................................................... 518
6
4.109.4.1. Response status ........................................................................... 518
7
4.109.4.1. Response body ............................................................................. 519
8
4.110 xCP user preference single instance .............................................. 519
4.110.1 URI template ................................................................................ 519
4.110.2 Link relation .................................................................................. 519
4.110.3 Operations .................................................................................... 519
4.110.3.1 Get user preferences ..................................................................... 520
4.110.3.1. HTTP method ............................................................................... 520
1
4.110.3.1. Query parameters ......................................................................... 520
2
4.110.3.1. Request headers ........................................................................... 520
3
4.110.3.1. Request body ............................................................................... 520
4
4.110.3.1. Response headers ........................................................................ 520
5

EDCPKL230200-PGR-EN-01 Development Guide li

Table of Contents

4.110.3.1. Supported response media types ................................................... 520

6
4.110.3.1. Response status ........................................................................... 521
7
4.110.3.1. Response body ............................................................................. 521
8
4.110.3.2 Update user preferences ............................................................... 521
4.110.3.2. HTTP method ............................................................................... 521
1
4.110.3.2. Server accepted request media types ............................................. 521
2
4.110.3.2. Query parameters ......................................................................... 521
3
4.110.3.2. Request headers ........................................................................... 522
4
4.110.3.2. Request body ............................................................................... 522
5
4.110.3.2. Response headers ........................................................................ 522
6
4.110.3.2. Supported response media types ................................................... 522
7
4.110.3.2. Response status ........................................................................... 523
8
4.110.3.2. Response body ............................................................................. 523
9
4.111 xCP user preferences single type ................................................... 523
4.111.1 URI template ................................................................................ 523
4.111.2 Link relation .................................................................................. 523
4.111.3 Operations .................................................................................... 524
4.111.3.1 Get a user preferences type ........................................................... 524
4.111.3.1. HTTP method ............................................................................... 524
1
4.111.3.1. Query parameters ......................................................................... 524
2
4.111.3.1. Request headers ........................................................................... 524
3
4.111.3.1. Request body ............................................................................... 524
4
4.111.3.1. Response headers ........................................................................ 525
5
4.111.3.1. Supported response media types ................................................... 525
6
4.111.3.1. Response status ........................................................................... 525
7
4.111.3.1. Response body ............................................................................. 525
8

lii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.112 xCP user preferences type collection .............................................. 525

4.112.1 URI template ................................................................................ 526
4.112.2 Feed and EDAA support ................................................................ 526
4.112.3 Link relation .................................................................................. 526
4.112.4 Operations .................................................................................... 527
4.112.4.1 Get a user preferences type collection ............................................ 527
4.112.4.1. HTTP method ............................................................................... 527
1
4.112.4.1. Query parameters ......................................................................... 527
2
4.112.4.1. Request headers ........................................................................... 527
3
4.112.4.1. Request body ............................................................................... 528
4
4.112.4.1. Response headers ........................................................................ 528
5
4.112.4.1. Supported response media types ................................................... 528
6
4.112.4.1. Response status ........................................................................... 528
7
4.112.4.1. Response body ............................................................................. 528
8
4.113 xCP view single instance ............................................................... 529
4.113.1 URI template ................................................................................ 529
4.113.2 Link relation .................................................................................. 529
4.113.3 Operations .................................................................................... 529
4.113.3.1 Get a view .................................................................................... 529
4.113.3.1. HTTP method ............................................................................... 529
1
4.113.3.1. Query parameters ......................................................................... 529
2
4.113.3.1. Request headers ........................................................................... 530
3
4.113.3.1. Request body ............................................................................... 530
4
4.113.3.1. Response headers ........................................................................ 530
5
4.113.3.1. Supported response media types ................................................... 531
6
4.113.3.1. Response status ........................................................................... 531
7
4.113.3.1. Response body ............................................................................. 531
8
4.113.4 Formats ........................................................................................ 532
4.114 xCP viewer single instance ............................................................ 533

EDCPKL230200-PGR-EN-01 Development Guide liii

Table of Contents

4.114.1 URI template ................................................................................ 534

4.114.2 Link relation .................................................................................. 534
4.114.3 Operations .................................................................................... 534
4.114.3.1 Get a viewer ................................................................................. 534
4.114.3.1. HTTP method ............................................................................... 534
1
4.114.3.1. Query parameters ......................................................................... 534
2
4.114.3.1. Request headers ........................................................................... 534
3
4.114.3.1. Request body ............................................................................... 535
4
4.114.3.1. Response headers ........................................................................ 535
5
4.114.3.1. Supported response media types ................................................... 535
6
4.114.3.1. Response status ........................................................................... 535
7
4.114.3.1. Response body ............................................................................. 535
8
4.115 xCP Viewer collection .................................................................... 538
4.115.1 URI template ................................................................................ 538
4.115.2 Feed and EDAA support ................................................................ 539
4.115.3 Link relation .................................................................................. 539
4.115.4 Operations .................................................................................... 540
4.115.4.1 Get a viewer collection .................................................................. 540
4.115.4.1. HTTP method ............................................................................... 540
1
4.115.4.1. Query parameters ......................................................................... 540
2
4.115.4.1. Request headers ........................................................................... 540
3
4.115.4.1. Request body ............................................................................... 540
4
4.115.4.1. Response headers ........................................................................ 540
5
4.115.4.1. Supported response media types ................................................... 540
6
4.115.4.1. Response status ........................................................................... 541
7
4.115.4.1. Response body ............................................................................. 541
8
4.116 xCP raw content ........................................................................... 542
4.116.1 URI template ................................................................................ 542
4.116.2 Operations .................................................................................... 543

liv OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.116.2.1 Get a Binary Stream ...................................................................... 543

4.116.2.1. HTTP method ............................................................................... 543
1
4.116.2.1. Query parameters ......................................................................... 543
2
4.116.2.1. Request headers ........................................................................... 544
3
4.116.2.1. Request body ............................................................................... 544
4
4.116.2.1. Response headers ........................................................................ 544
5
4.116.2.1. Supported response media types ................................................... 544
6
4.116.2.1. Response status ........................................................................... 544
7
4.116.2.1. Response body ............................................................................. 544
8
4.116.2.2 Upload a Binary Stream ................................................................. 545
4.116.2.2. HTTP method ............................................................................... 545
1
4.116.2.2. Server accepted request media types ............................................. 545
2
4.116.2.2. Query parameters ......................................................................... 545
3
4.116.2.2. Request headers ........................................................................... 546
4
4.116.2.2. Request body ............................................................................... 546
5
4.116.2.2. Response headers ........................................................................ 546
6
4.116.2.2. Supported response media types ................................................... 546
7
4.116.2.2. Response status ........................................................................... 546
8
4.116.2.2. Response body ............................................................................. 547
9
4.117 xCP LightWeight Business Object single instance ........................... 547
4.117.1 URI template ................................................................................ 547
4.117.2 Link relation .................................................................................. 547
4.117.3 Operations .................................................................................... 548
4.117.3.1 Get a Lightweight Business Object ................................................. 548
4.117.3.1. HTTP method ............................................................................... 548
1
4.117.3.1. Query parameters ......................................................................... 548
2

EDCPKL230200-PGR-EN-01 Development Guide lv

Table of Contents

4.117.3.1. Request headers ........................................................................... 549

3
4.117.3.1. Request body ............................................................................... 549
4
4.117.3.1. Response headers ........................................................................ 549
5
4.117.3.1. Supported response media types ................................................... 549
6
4.117.3.1. Response status ........................................................................... 549
7
4.117.3.1. Response body ............................................................................. 550
8
4.117.3.2 Update a Lightweight Business Object ............................................ 550
4.117.3.2. HTTP method ............................................................................... 550
1
4.117.3.2. Server accepted request media types ............................................. 550
2
4.117.3.2. Query parameters ......................................................................... 550
3
4.117.3.2. Request headers ........................................................................... 550
4
4.117.3.2. Request body ............................................................................... 550
5
4.117.3.2. Response headers ........................................................................ 551
6
4.117.3.2. Supported response media types ................................................... 551
7
4.117.3.2. Response status ........................................................................... 551
8
4.117.3.2. Response body ............................................................................. 551
9
4.117.3.3 Delete a Lightweight Business Object ............................................. 552
4.117.3.3. HTTP method ............................................................................... 552
1
4.117.3.3. Query parameters ......................................................................... 552
2
4.117.3.3. Request headers ........................................................................... 552
3
4.117.3.3. Request body ............................................................................... 552
4
4.117.3.3. Response headers ........................................................................ 552
5
4.117.3.3. Response status ........................................................................... 552
6
4.117.3.3. Response body ............................................................................. 552
7

lvi OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.117.3.4 Reparent a Lightweight Business Object ......................................... 553

4.117.3.4. HTTP method ............................................................................... 553
1
4.117.3.4. Server accepted request media types ............................................. 553
2
4.117.3.4. Query parameters ......................................................................... 553
3
4.117.3.4. Request headers ........................................................................... 553
4
4.117.3.4. Request body ............................................................................... 553
5
4.117.3.4. Response headers ........................................................................ 554
6
4.117.3.4. Supported response media types ................................................... 554
7
4.117.3.4. Response status ........................................................................... 554
8
4.117.3.4. Response body ............................................................................. 554
9
4.118 xCP Lightweight Business Object collection .................................... 555
4.118.1 URI template ................................................................................ 555
4.118.2 Feed and EDAA support ................................................................ 555
4.118.3 Link relation .................................................................................. 556
4.118.4 Operations .................................................................................... 556
4.118.4.1 Get a Lightweight Business Object collection .................................. 556
4.118.4.1. HTTP method ............................................................................... 556
1
4.118.4.1. Query parameters ......................................................................... 556
2
4.118.4.1. Request headers ........................................................................... 557
3
4.118.4.1. Request body ............................................................................... 557
4
4.118.4.1. Response headers ........................................................................ 557
5
4.118.4.1. Supported response media types ................................................... 557
6
4.118.4.1. Response status ........................................................................... 557
7
4.118.4.1. Response body ............................................................................. 558
8
4.119 xCP Lightweight Business Object single type .................................. 558
4.119.1 URI template ................................................................................ 558
4.119.2 Link relation .................................................................................. 558
4.119.3 Operations .................................................................................... 558

EDCPKL230200-PGR-EN-01 Development Guide lvii

Table of Contents

4.119.3.1 Get a Lightweight Business Object type .......................................... 559

4.119.3.1. HTTP method ............................................................................... 559
1
4.119.3.1. Query parameters ......................................................................... 559
2
4.119.3.1. Request headers ........................................................................... 559
3
4.119.3.1. Request body ............................................................................... 559
4
4.119.3.1. Response headers ........................................................................ 559
5
4.119.3.1. Supported response media types ................................................... 559
6
4.119.3.1. Response status ........................................................................... 560
7
4.119.3.1. Response body ............................................................................. 560
8
4.120 xCP Lightweight Business Object Type collection ............................ 561
4.120.1 URI template ................................................................................ 561
4.120.2 Feed and EDAA support ................................................................ 561
4.120.3 Link relation .................................................................................. 562
4.120.4 Operations .................................................................................... 562
4.120.4.1 Get a Lightweight Business Object type collection ........................... 563
4.120.4.1. HTTP method ............................................................................... 563
1
4.120.4.1. Query parameters ......................................................................... 563
2
4.120.4.1. Request headers ........................................................................... 563
3
4.120.4.1. Request body ............................................................................... 563
4
4.120.4.1. Response headers ........................................................................ 563
5
4.120.4.1. Supported response media types ................................................... 564
6
4.120.4.1. Response status ........................................................................... 564
7
4.120.4.1. Response body ............................................................................. 564
8
4.121 xCP Lightweight Content single instance ........................................ 564
4.121.1 URI template ................................................................................ 565
4.121.2 Link relation .................................................................................. 565
4.121.3 Operations .................................................................................... 566
4.121.3.1 Get a Lightweight Content ............................................................. 566

lviii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.121.3.1. HTTP method ............................................................................... 567

1
4.121.3.1. Query parameters ......................................................................... 567
2
4.121.3.1. Request headers ........................................................................... 567
3
4.121.3.1. Request body ............................................................................... 568
4
4.121.3.1. Response headers ........................................................................ 568
5
4.121.3.1. Supported response media types ................................................... 568
6
4.121.3.1. Response status ........................................................................... 568
7
4.121.3.1. Response body ............................................................................. 568
8
4.121.3.2 Update a Lightweight Content ........................................................ 569
4.121.3.2. HTTP method ............................................................................... 569
1
4.121.3.2. Server accepted request media types ............................................. 569
2
4.121.3.2. Query parameters ......................................................................... 569
3
4.121.3.2. Request headers ........................................................................... 569
4
4.121.3.2. Request body ............................................................................... 569
5
4.121.3.2. Response headers ........................................................................ 570
6
4.121.3.2. Supported response media types ................................................... 570
7
4.121.3.2. Response status ........................................................................... 570
8
4.121.3.2. Response body ............................................................................. 570
9
4.121.3.3 Delete a Lightweight Content ......................................................... 571
4.121.3.3. HTTP method ............................................................................... 571
1
4.121.3.3. Query parameters ......................................................................... 571
2
4.121.3.3. Request headers ........................................................................... 571
3
4.121.3.3. Request body ............................................................................... 571
4
4.121.3.3. Response headers ........................................................................ 571
5

EDCPKL230200-PGR-EN-01 Development Guide lix

Table of Contents

4.121.3.3. Response status ........................................................................... 571

6
4.121.3.3. Response body ............................................................................. 572
7
4.121.3.4 Check out a Lightweight Content .................................................... 572
4.121.3.4. HTTP method ............................................................................... 572
1
4.121.3.4. Server accepted request media types ............................................. 572
2
4.121.3.4. Query parameters ......................................................................... 572
3
4.121.3.4. Request headers ........................................................................... 572
4
4.121.3.4. Request body ............................................................................... 572
5
4.121.3.4. Response headers ........................................................................ 573
6
4.121.3.4. Supported response media types ................................................... 573
7
4.121.3.4. Response status ........................................................................... 573
8
4.121.3.4. Response body ............................................................................. 573
9
4.121.3.5 Check in a Lightweight Content ...................................................... 574
4.121.3.5. HTTP method ............................................................................... 574
1
4.121.3.5. Server accepted request media types ............................................. 574
2
4.121.3.5. Query parameters ......................................................................... 575
3
4.121.3.5. Request headers ........................................................................... 575
4
4.121.3.5. Request body ............................................................................... 575
5
4.121.3.5. Response headers ........................................................................ 576
6
4.121.3.5. Supported response media types ................................................... 576
7
4.121.3.5. Response status ........................................................................... 576
8
4.121.3.5. Response body ............................................................................. 577
9
4.122 xCP Lightweight Content collection ................................................ 577
4.122.1 URI template ................................................................................ 577
4.122.2 Feed and EDAA support ................................................................ 577
4.122.3 Link relation .................................................................................. 578

lx OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.122.4 Operations .................................................................................... 578

4.122.4.1 Get a Lightweight Content collection ............................................... 578
4.122.4.1. HTTP method ............................................................................... 578
1
4.122.4.1. Query parameters ......................................................................... 578
2
4.122.4.1. Request headers ........................................................................... 579
3
4.122.4.1. Request body ............................................................................... 579
4
4.122.4.1. Response headers ........................................................................ 579
5
4.122.4.1. Supported response media types ................................................... 579
6
4.122.4.1. Response status ........................................................................... 579
7
4.122.4.1. Response body ............................................................................. 580
8
4.123 xCP lightweight content single type ................................................ 580
4.123.1 URI template ................................................................................ 580
4.123.2 Link relation .................................................................................. 580
4.123.3 Operations .................................................................................... 580
4.123.3.1 Get a Content Type ....................................................................... 581
4.123.3.1. HTTP method ............................................................................... 581
1
4.123.3.1. Query parameters ......................................................................... 581
2
4.123.3.1. Request headers ........................................................................... 581
3
4.123.3.1. Request body ............................................................................... 581
4
4.123.3.1. Response headers ........................................................................ 581
5
4.123.3.1. Supported response media types ................................................... 581
6
4.123.3.1. Response status ........................................................................... 581
7
4.123.3.1. Response body ............................................................................. 582
8
4.124 xCP Lightweight Content Type collection ........................................ 582
4.124.1 URI template ................................................................................ 582
4.124.2 Feed and EDAA support ................................................................ 582
4.124.3 Link relation .................................................................................. 583
4.124.4 Operations .................................................................................... 583
4.124.4.1 Get a Lightweight Content Type collection ...................................... 583

EDCPKL230200-PGR-EN-01 Development Guide lxi

Table of Contents

4.124.4.1. HTTP method ............................................................................... 583

1
4.124.4.1. Query parameters ......................................................................... 583
2
4.124.4.1. Request headers ........................................................................... 584
3
4.124.4.1. Request body ............................................................................... 584
4
4.124.4.1. Response headers ........................................................................ 584
5
4.124.4.1. Supported response media types ................................................... 584
6
4.124.4.1. Response status ........................................................................... 584
7
4.124.4.1. Response body ............................................................................. 585
8
4.125 xCP LightWeight materialization resource ....................................... 585
4.125.1 URI template ................................................................................ 585
4.125.2 Link relation .................................................................................. 585
4.125.3 Operations .................................................................................... 586
4.125.3.1 Materialize the lightweight object .................................................... 586
4.125.3.1. HTTP method ............................................................................... 586
1
4.125.3.1. Server accepted request media types ............................................. 587
2
4.125.3.1. Query parameters ......................................................................... 587
3
4.125.3.1. Request headers ........................................................................... 587
4
4.125.3.1. Request body ............................................................................... 587
5
4.125.3.1. Response headers ........................................................................ 587
6
4.125.3.1. Supported response media types ................................................... 587
7
4.125.3.1. Response status ........................................................................... 588
8
4.125.3.1. Response body ............................................................................. 588
9
4.125.3.2 Delete a Lightweight materialization resource ................................. 588
4.125.3.2. HTTP method ............................................................................... 588
1
4.125.3.2. Query parameters ......................................................................... 588
2
4.125.3.2. Request headers ........................................................................... 589
3

lxii OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 Table of Contents

4.125.3.2. Request body ............................................................................... 589

4
4.125.3.2. Response headers ........................................................................ 589
5
4.125.3.2. Response status ........................................................................... 589
6
4.125.3.2. Response body ............................................................................. 589
7
4.126 xCP Shared Parent single instance ................................................ 589
4.126.1 URI template ................................................................................ 589
4.126.2 Link relation .................................................................................. 590
4.126.3 Operations .................................................................................... 590
4.126.4 Get a collection of Lightweight Objects on a shared parent .............. 590
4.126.4.1 HTTP method ............................................................................... 590
4.126.4.2 Query parameters ......................................................................... 591
4.126.4.3 Request headers ........................................................................... 591
4.126.4.4 Request body ............................................................................... 591
4.126.4.5 Response headers ........................................................................ 591
4.126.4.6 Supported response media types ................................................... 591
4.126.4.7 Response status ........................................................................... 591
4.126.4.8 Response body ............................................................................. 592
4.126.5 Creates a lightweight object that shares a specific shared object ...... 592
4.126.5.1 HTTP method ............................................................................... 592
4.126.5.2 Server accepted request media types ............................................. 592
4.126.5.3 Query parameters ......................................................................... 593
4.126.5.4 Request headers ........................................................................... 593
4.126.5.5 Request body ............................................................................... 593
4.126.5.6 Response headers ........................................................................ 593
4.126.5.7 Supported response media types ................................................... 593
4.126.5.8 Response status ........................................................................... 594
4.126.5.9 Response body ............................................................................. 594
4.126.6 Creates a lightweight object that shares a specific shared content .... 594
4.126.6.1 HTTP method ............................................................................... 594
4.126.6.2 Query parameters ......................................................................... 594
4.126.6.3 Request headers ........................................................................... 594
4.126.6.4 Request body ............................................................................... 595
4.126.6.5 Response headers ........................................................................ 595
4.126.6.6 Supported response media types ................................................... 595
4.126.6.7 Response status ........................................................................... 595
4.126.6.8 Response body ............................................................................. 596
4.127 xCP sShared parent collection ....................................................... 597
4.127.1 URI template ................................................................................ 597
4.127.2 Link relation .................................................................................. 597

EDCPKL230200-PGR-EN-01 Development Guide lxiii

Table of Contents

4.127.3 Operations .................................................................................... 597

4.127.3.1 Get a shared parent collection ....................................................... 597
4.127.3.1. HTTP method ............................................................................... 597
1
4.127.3.1. Query parameters ......................................................................... 597
2
4.127.3.1. Request headers ........................................................................... 598
3
4.127.3.1. Request body ............................................................................... 598
4
4.127.3.1. Response headers ........................................................................ 598
5
4.127.3.1. Supported response media types ................................................... 598
6
4.127.3.1. Response status ........................................................................... 598
7
4.127.3.1. Response body ............................................................................. 599
8
4.128 Viewer provider profile ................................................................... 599

lxiv OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

Chapter 1
Overview

OpenText Documentum xCelerated Composition Platform (xCP) REST Services is a

set of RESTful web service interfaces that enable you to assemble various pre-built
software components and services to create and manage solutions, with a high
degree of flexibility.

EDCPKL230200-PGR-EN-01 Development Guide 65

Chapter 2
General REST definitions

2.1 Common definition - HTTP headers

Documentum REST Services supports the following common HTTP headers:

HTTP header Name Description In Request or Value Range

Response?
Authorization Authorization header Request HTTP basic
for authentication authentication header
with the credential
part encoded, for
example:

Authorization:
Basic
QWxhZGRpbjpvcGVu
IHNlc2FtZQ==

Or, Kerberos
authentication header
with the credential
part encoded, for
example:

Authorization:
Negotiate
YIIZG1hZG1pbjpwY
XNzd29yZ.
Accept Acceptable media Request • application/
type for the response vnd.emc.xcp+xml
• application/
vnd.emc.xcp+json
• application/xml
• application/json
Content-Type MIME type of the Request/Response • application/
request body or vnd.emc.xcp+xml
response body • application/
vnd.emc.xcp+json
• application/xml
• application/json

EDCPKL230200-PGR-EN-01 Development Guide 67

Chapter 2 General REST definitions

HTTP header Name Description In Request or Value Range

Response?
Content-Length Size of the entity- Request/Response Non-negative
body, in decimal number
number of OCTETs,
sent to the recipient
Location URI of the newly- Response URI
created resource
Set-Cookie Sets an HTTP cookie Response Once the user is
Response authenticated,
x-csrf-token

cookie is sent in the

response header.
x-csrf-token Client (for example, Request Browsers and clients
Javascript) needs to must send
add this header for
x-csrf-token
POST calls to
safeguard against cookie value in the
any CSRF Request header or as
vulnerability. parameter for any
post operation to
safeguard against
any CSRF
vulnerability.

Example:
var xhr = new
XMLHttpRequest();
xhr.setRequestHeader(
'x-csrf-token',
Ext.util.Cookies.get(
'x-csrf-token'));

WWW-Authenticate Indicates the Response Used by HTTP basic

authentication authentication and
scheme that should HTTP Kerberos
be used to access the negotiate
requested entity. authentication Set-
Cookie.

68 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 2.2. Common definition - query parameters

2.2 Common definition - query parameters

xCP REST Services supports the following common query parameters:

Note: For a specific resource, it may not support all the following query
parameters. For detailed information about what query parameters a resource
supports, see the Query parameters section of that resource.

Query Description Data Type Value Range Default

parameter
Name
inline Determines boolean • true - return false
whether to show the object
content (the instance and Note:
object instance) embed the Although
in an atom entry object the default
or EDAA entry instance into value is
for a collection. the entry's false, we
content still
element. recommen
• false - do d that you
not return try setting
object this
instance. parameter
to true in
your
developme
nt
environme
nt to get
the entire
content of
resources
and
explore the
complete
data
structure.
In your
production
environme
nt, you can
set this
parameter
to false
for better
performan
ce.

EDCPKL230200-PGR-EN-01 Development Guide 69

Chapter 2 General REST definitions

Query Description Data Type Value Range Default

parameter
Name
items-per-page Specifies the integer Any integer no 100
number of items less than 1
to be rendered
on one page.
page Specifies the integer Any integer no 1
page number of less than 1
the page to
return.

If you set
items-per-
page to 200, and
page to 2, the
operation
returns items 201
- 400.
view Specifies the string See “Property :default
object properties view”
to retrieve. on page 74.

This parameter
works only
when inline is
set to true.

For more
information, see
“Property view”
on page 74.
include-total Determines boolean • true - return false
whether to the total
return the total number of
number of objects.
objects. For • false - do
paged feeds, not return
objects in all the total
pages are number of
counted. objects.

70 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 2.2. Common definition - query parameters

Query Description Data Type Value Range Default

parameter
Name
sort Specifies a set of string This parameter NA
the sort consists of
specifications in multiple sort
a returned specifications,
collection. separated by
comma ( , ).

Each sort
specification
consists of a
property (any
non-repeating
property) by
which to sort the
results and its
sort order (DESC
or ASC),
separated by the
whitespace
character ( ).

The sort order is

optional. if not
specified, the
default sort
order is ASC.

If any property
with an invalid
name is
specified, an
error is thrown.

Example:

sort=r_
modify_date
desc,object-
id asc,title
links Determines boolean • true - return true
whether to link relations.
return link • false - do
relations in the not return
object link relations.
representation.

This parameter
works only
when inline is
set to true.

EDCPKL230200-PGR-EN-01 Development Guide 71

Chapter 2 General REST definitions

Query Description Data Type Value Range Default

parameter
Name
recursive Determines boolean • true - return false
whether to all indirect
return all children
indirect children recursively
recursively when a
when a request request tries
tries to get the to get the
children of an children of
object. an object.
• false - Only
return direct
children
when a
request tries
to get the
children of
an object.

72 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 2.2. Common definition - query parameters

Query Description Data Type Value Range Default

parameter
Name
permissions This query boolean • For collection false
parameter is objects–This
used by all the parameter,
collections. when true,
Permission returns
based links and permission-
Permission info based links
is provided only and basic &
when this query extended
parameter value permissions
is set to true. for the
collection
objects.
• For single
object—This
parameter is
not
applicable.
The response
would
always
return
permission-
based links
and basic &
extended
permissions
for an object.

Refer to the
Example 2-1,
“Sample in
XML”
on page 73
section for an
example.

Example 2-1: Sample in XML

<dm:permission>
<dm:basic-permission>RELATE</dm:basic-permission>
<dm:extended-permissions>
<dm:item>
EXECUTE_PROC
</dm:item>
<dm:item>
CHANGE_LOCATION
</dm:item>
</dm:extended-permissions>
</dm:permission>

EDCPKL230200-PGR-EN-01 Development Guide 73

Chapter 2 General REST definitions

Example 2-2: Sample in JSON

"permission": {
"basic-permission":"RELATE",
"extended-permissions":["EXECUTE_PROC","CHANGE_LOCATION"]

2.2.1 Property view

You can use the property view to specify the object properties to retrieve in an
operation. This can be done by creating a view expression in the view query
parameter. A view expression can either be a predefined view expression or a
custom view expression that contains a list of property names.

2.2.1.1 Predefined view expression

Documentum REST Services supports the following predefined view expressions:

View expression Description

:all Returns all properties of the requested object
to the client.

If you use this view expression, the

performance may degrade when a request
tries to retrieve a collection resource.
:default Returns the default set of properties of the
requested object to the client. This is the
default value if there is no value specified for
the view query parameter.

2.2.1.2 Custom view expression

A custom view expression contains a list of property names of the properties that
you want to retrieve separated by commas (,).

A property name must observe the following rules:

• The maximum allowed length is 27 characters.

• The first character must be a letter. The remaining characters can be letters,
digits, or underscores.
• The name cannot contain spaces or punctuation.
• The name cannot be any of the words reserved by the underlying RDBMS.

Note: Property names are not case sensitive.

If a property name violating any of the rules is specified in the expression, the view
expression is considered as invalid and rejected. In this case, the server returns the
HTTP 400 Bad Request status.

74 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 2.3. Server configuration parameters

2.2.1.3 View expression syntax

The syntax of a view expression is defined with the following EBNF:
view-expression = predefined-view | properties-list ;
predefined-view = leading-separator, predefined-view-name ;
leading-separator = ":" ;
predefined-view-name = "default" | "all" | "none" ;
properties-list = property-name, { "," property-name } ;
property-name = character, 26 * [ character ] ;
character = letter | digit | underscore ;
letter = "a" .. "z" | "A" .. "Z" ;
digit = "0" .. "9" ;
underscore = "_" ;

Example 2-3: Predefined view example

view=:all

This example sets the view parameter to the predefined view expression:all,
meaning that all properties of the requested object are returned.

Example 2-4: Custom view example

view=object_name,r_object-type

This example sets the view parameter to the custom view expression object_
name,r_object-type, meaning that only the object_name and r_object-
type properties of the requested object are returned.

2.3 Server configuration parameters

Documentum REST Services supports the following server configuration
parameters:

Parameter name Description

inline=false Displays the inline representation of
resources in the collection.
show-created-resource-in-response=true The newly created resource representation
that the system includes in the response
body. The default value is true.
all-versions=false This parameter is used to delete a content
object. all-versions=true deletes all the
versions of the content. all-versions=false
deletes the version of the content for which
the object Id is passed.
default-view-type=default Specifies the default value for the view. The
section “Property view” on page 74 provides
more details.

EDCPKL230200-PGR-EN-01 Development Guide 75

Chapter 2 General REST definitions

Parameter name Description

check-readonly-properties=false The system checks if the incoming message
contains read-only properties and if yes,
displays an error. The default value is false.
business-objects-output-mandatory- Output mandatory properties.
properties=r_object_id, r_creator_name,
r_creation_date, r_modifier, r_modify_date
relationships-output-mandatory-
properties=r_object_id,parent_id,child_id
contents-output-mandatory-
properties=r_object_id,owner_name,title,a_c
ontent_type,authors,keywords
folders-output-mandatory-
properties=r_object_id,title,subject,r_folder_p
ath
cabinets-output-mandatory-
properties=r_object_id,title,subject,r_folder_p
ath
templates-output-mandatory-
properties=a_content_type,description,dos_e
xtension,r_object_type,r_object_id,object_na
me,a_is_signed
use-defaults=false xCP URI Parameters
data-validation=true
time-dimension=DAILY
calculation-step=2
relative-last-time=100
data-sanitization=true
feed-author=OpenText Documentum Other configurations
content-staging-location= If these parameters are not set, the file is
uploaded to the Java temporary folder,
context-path=
which can be specified by using the java.
io.tmpdir system parameter.
allow-text-sanitizer-policies= Security configurations
FORMATTING,STYLES,
LINKS,IMAGES
types-resources-caching-age=31536000 The caching period in seconds for all the rest
resources accessed with /types/** and /
service/** URL. The default value is one year.
report-dfc-ticket-timeout=600 This parameter is used in Crystal Reports.
The duration for which docbase
authentication ticket is valid. The default
value is 10 minutes.

76 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 2.4. HTTP status codes

Parameter name Description

file-maxInMemorySize=10240 The maximum size allowed before files are
written to the disk. The files with size less
than this value are stored in the memory;
else stored in the disk directly.
file-maxUploadSize=10240 The maximum file size that can be uploaded.
permissions=false This parameter is being used by all the
collections. Permission based links and
Permission info is provided only when this
query parameter value is set to true. When
no value provided in the query parameter,
then this configuration is used.
csrf-protection-enabled This parameter is configurable so that CSRF
protection can be disabled for testing
purposes or for an intranet application where
vulnerability is of less concern. By default it
is enabled.
update_event_ignore_unmodified_attr=true true—The Update event is triggered only
when the attribute used in condition is
updated and the condition is met.

false—The Update event is triggered even if

the attribute used in condition is not updated
and the condition is met.

Configure the following parameters in the rest-api-runtime.properties file to

perform the following:

• To display number of items per page:

rest.paging.default.size

• To set the maximum page size:

rest.paging.max.size

The value of default size is limited by the maximum page size value.

2.4 HTTP status codes

Documentum REST Services supports the following HTTP status codes:

Status code 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.

EDCPKL230200-PGR-EN-01 Development Guide 77

Chapter 2 General REST definitions

Status code Description

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 has fulfilled the request but does
not need to return an entity-body.
304 Not Modified The server responds with this status code if
the client has performed a conditional GET
request and access is allowed, but the
document has not been modified.
400 Bad Request The request could not be understood by the
server due to malformed syntax, missing or
invalid information (such as a validation
error on an input field, or a missing required
value). 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 has recognized your credentials,
but you do not possess the authorization to
perform this request, and the request should
not be repeated.
404 Not Found The request specifies a URI of a resource that
does not exist.
405 Method Not Allowed The HTTP verb specified in the request
(DELETE, GET, HEAD, POST, PUT) is not
allowed for the resource identified by the
request URI.
406 Not Acceptable The resource identified by this request URI is
not capable of generating a representation
corresponding to one of the media types in
the Accept header of the request.
409 Conflict The 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).

78 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 2.5. Representation

Status code Description

415 Unsupported Media Type The server is refusing to service the request
because the entity of the request is in a
format not supported by the requested
resource for the requested method.
500 Internal Server Error The server encountered an unexpected
condition which prevented it from fulfilling
the request.

2.5 Representation
xCP REST Services supports two representation formats, JSON and XML.

JSON is the primary format for resource representation. collection-based resources

are presented as EDAA, which is a JSON representation of an Atom feed. For more
information about EDAA, see the Platform REST Services Data Access API.

XML is the other format for resource representation in xCP REST Services. Like the
JSON format, collection-based resources are presented as feeds, defined by Atom.
For more information about Atom, see RFC42870.

2.6 xCP common elements

This section describes the common elements that can appear in type definitions.

Events

A type definition may have multiple events associated with it. Every event can be
used either for reporting or for triggering processes.

If an event triggers a process, the process element appears in the type definition,
pointing to a process type. When this event is triggered, a process of the pointed
type is created.

Example 2-5: Sample in XML

<events>
<event label="bo_all_attributes_created" trigger="CREATED">
<description/>
</event>
<event label="bo_all_attributes_updated" trigger="UPDATED">
<description>Event occurs on updated BO</description>
</event>
<event label="bo_all_attributes_created_start_process"
trigger="CREATE" condition="session.login='testuser'">
<description/>
<process mode="statefull">URI of the Process Type</process>
</event>
</events>

EDCPKL230200-PGR-EN-01 Development Guide 79

Chapter 2 General REST definitions

Example 2-6: Sample in JSON

"events": [{
"label": "bo_all_attributes_created",
"trigger": "CREATED",
"description": ""
},
{
"label": "bo_all_attributes_updated",
"trigger": "UPDATED",
"description": "Event occurs on updated BO"
},
{
"label": "bo_all_attributes_created_start_process",
"trigger": "CREATED",
"description": "",
"condition": "session.login='testuser'"
"process":{
"mode":"statefull",
"href":"URI of the Process Type"
}
}]

Relationships

If the relationships section appears in a type definition, instances of that type can
participate in a relationship of a specified type as the source, target, or both
according to the settings in the section.

In the following example, instances of the type can participate in relationships of the
ut200_bo_rel_1way_hasm type as the source and participate in relationships of the
ut200_bo_rel_2way_121 type as the target.

Example 2-7: Sample in XML

<relationships>
<source rel="http://names.emc.com/documentum/linkrel/source"
name="ut200_bo_rel_1way_hasm"
type="http://localhost:8080/xcp-rest/types/relationships/
ut200_bo_rel_1way_hasm"/>
<target rel="http://names.emc.com/documentum/linkrel/target"
name="ut200_bo_rel_2way_121"
type="http://localhost:8080/xcp-rest/types/relationships/
ut200_bo_rel_2way_121"/>
</relationships>

Example 2-8: Sample in JSON

"relationships": {
"source": [{
"rel": "http://names.emc.com/documentum/linkrel/source",
"name": "ut200_bo_rel_1way__has1",
"type": "http://localhost:8080/xcp-rest/types/relationships/
ut200_bo_rel_1way_hasm"
}],
"target": [{
"rel": "http://names.emc.com/documentum/linkrel/target",
"name": "ut200_bo_rel_2way_121",

80 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 2.6. xCP common elements

"type": "http://localhost:8080/xcp-rest/types/relationships/
ut200_bo_rel_2way_121"
}]
}

Fragments

If the fragments section appears in a type definition, instances of that type can have
certain types of fragments (aspects) attached according to the settings in the section.

In the following example, instances of this type can have fragments of the utapp21_
aspect_all_attrs type attached.

Example 2-9: Sample in XML

<fragments>
<type href="${contextPath}types/fragments/utapp21_aspect_all_attrs"/>
</fragments>

Example 2-10: Sample in JSON

"fragments" : [ {
"href" : "${contextPath}types/fragments/utapp21_aspect_all_attrs"
} ],

Correspondingly, if a runtime instance has fragments attached, an extra properties

section appears where xsi:type specifies the fragment type:
<dm:properties xsi:type="ut200_architect_aspect-properties">
<dm:education>today</dm:education>
<dm:years_of_experience>today</dm:years_of_experience>
</dm:properties>

Picklists

If a property with valueAssist appears in a type definition, instances of that type

can have picklists of the type defined in valueAssist.

Example 2-11: Sample in XML

<property
name="highest_degree"
label="Highest Degree Achieved"
type="string" length="16"
valueAssist="http://localhost:8080/xcp-rest/picklists/ut200_highest_degree"/>

Example 2-12: Sample in JSON

{
"label": "Highest Degree Achieved",

EDCPKL230200-PGR-EN-01 Development Guide 81

Chapter 2 General REST definitions

"name": "highest_degree",
"type": "string",
"length": "16",
"valueAssist": "http://localhost:8080/xcp-rest/picklists/ut200_highest_degree"
}

82 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

Chapter 3
Authentication

xCP REST Services supports HTTP basic authentication.

3.1 Authentication with HTTP basic

xCP REST Services implements HTTP Basic authentication, which passes both
usernames and passwords to the REST server.

Note: We strongly recommend that you use HTTPS when using HTTP Basic
authentication, which requires a secure connection because the Basic
authentication transmits the user name and password in BASE64 encoded
plain text.

When using HTTP Basic authentication, a request has to carry the username/
password pair in the Authorization header with the following pattern:
Authorization: Basic BASE64{${username}:${password}}

Example 3-1: Username/password pair for dmadmin/password

GET /${resource-url} HTTP/1.1
Authorization: Basic ZG1hZG1pbjpwYXNzd29yZA==

If the authentication fails, the REST server responds with the HTTP 401
Unauthorized status code.

EDCPKL230200-PGR-EN-01 Development Guide 83

Chapter 4
Resources

4.1 xCP advanced repository query instance

An instance of Advanced Repository Query represents a Advanced repository query
configured in xCP Designer. This resource enables you to perform a query on objects
in a repository.

4.1.1 URI template

/dql-queries/query_name

query_name Name of the Advanced repository query

4.1.2 Link relation

The following table lists link relation(s) for a Advanced Repository Query resource.

Link relation Description Resource reference

self This Advanced Repository “xCP advanced repository
Query instance query instance” on page 85
type Type definition of this “xCP advanced repository
resource query single type”
on page 89

Following conditions must be met for link generations:

• Add these attributes in the select query:

r_object_id, r_object_type.

Based on the r_object_type, the links get generated. For links to work, Alias
should not be given for these two attributes.
• The returned type value from r_object_type should be modeled in xCP Designer.
For example, if r_object_type returns customer, ensure that this model already
exists in xCP Designer.

EDCPKL230200-PGR-EN-01 Development Guide 85

Chapter 4 Resources

4.1.3 Operations
Advanced Repository Query resource supports the following HTTP method.

Method Description
GET Retrieve the results of a Advanced
Repository query.

4.1.3.1 Perform a advanced repository query

Perform a Advanced Repository query on objects in a repository.

4.1.3.1.1 HTTP method

GET

4.1.3.1.2 Query parameters

This operation supports the following common query parameters:

• inline
• items-per-page
• page
• sort
• links (combined with inline)
• input_<input_name>, where the <input_name> is the input parameter configured
in xCP Designer.

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.1.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

86 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.1. xCP advanced repository query instance

4.1.3.1.4 Request body

None.

4.1.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.1.3.1.6 Supported response media types

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

4.1.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.1.3.1.8 Response body

XML or JSON representation of the query results. The results are presented using
Atom Feed in XML representation or using EDAA collection in JSON representation.
By default, this operation only returns basic properties of each result. You can get a
single instance by accessing the src link in the corresponding entry. To obtain a full
representation of each result, set the inline parameter to true.

Example 4-1: Query results in EDAA collection

For example, the Request URL: /dql-queries/query_name?inline=true

&permissions=true &items-per-page=1
{
"id": "dql-queries/utapp21_dqlcustomers",
"title": "utapp21_dqlcustomers",
"updated": "2016-04-27T10:03:48.259Z",
"author": "OpenText Documentum",
"items-per-page": 2,
"links": [{
"rel": "self",

EDCPKL230200-PGR-EN-01 Development Guide 87

Chapter 4 Resources

"href": "dql-queries/utapp21_dqlcustomers"
}, {
"rel": "next",
"href": "dql-queries/utapp21_dqlcustomers?items-per-page=2&page=2"
}],
"entries": [{
"id": "dql-queries/utapp21_dqlcustomers/1155688358",
"title": "utapp21_dqlcustomers-0801e240801a3091",
"updated": "2016-04-27T10:03:48.260Z",
"summary": "utapp21_dqlcustomers-0801e240801a3091",
"content": {
"name": "dql-query",
"type": "utapp21_dqlcustomers",
"definition": "http://127.0.0.1:8180/xcp-rest/types/
dql-queries/
utapp21_dqlcustomers",
"properties": {
"r_object_type": "utapp21_customers",
"r_object_id": "0801e240801a3091",
"new_string": "single-string-attribute"
},
"permission": {
"basic-permission": "DELETE",
"extended-permissions": ["EXECUTE_PROC", "CHANGE_LOCATION",
"CHANGE_STATE", "CHANGE_PERMIT",
"CHANGE_OWNER"]
},
"links": [{
"rel": "type",
"href": "types/business-objects/utapp21_customers"
}, {
"rel": "http://identifiers.emc.com/linkrel/instances",
"href": "business-objects/utapp21_customers"
}, {
"rel": "edit",
"href": "business-objects/utapp21_customers/0801e240801a3091"
}, {
"rel": "self",
"href": "business-objects/utapp21_customers/0801e240801a3091"
}, {
"rel": "http://identifiers.emc.com/linkrel/add-comment",
"href": "business-objects/utapp21_customers/0801e240801a3091/comments"
}, {
"rel": "http://identifiers.emc.com/linkrel/comments",
"href": "business-objects/utapp21_customers/0801e240801a3091/comments"
}, {
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "business-objects/utapp21_customers/0801e240801a3091"
}],
"content-type": "application/vnd.emc.xcp+json"
}
} }]
}

88 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.2. xCP advanced repository query single type

4.2 xCP advanced repository query single type

A single instance of advanced repository query type represents the type definition of
a Advanced Repository query that is configured in xCP Designer.

4.2.1 URI template

/types/dql-queries/query-type

query-type Type of the Advanced repository query

4.2.2 Link relation

The following table lists general link relations for a Advanced repository query Type
resource.

Link relation Description Resource reference

self Type definition of a “xCP advanced repository
Advanced repository query query single type”
on page 89
instances [1] Advanced Repository Query “xCP advanced repository
instance query instance” on page 85
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.2.3 Operations
An advanced repository query type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of a Advanced
repository query

4.2.3.1 Get an advanced repository query type

Retrieve the type definition of a Advanced repository query.

EDCPKL230200-PGR-EN-01 Development Guide 89

Chapter 4 Resources

4.2.3.1.1 HTTP method

GET

4.2.3.1.2 Query parameters

None.

4.2.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.2.3.1.4 Request body

None.

4.2.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.2.3.1.6 Supported response media types

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

4.2.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

90 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.2. xCP advanced repository query single type

4.2.3.1.8 Response body

XML or JSON representation of the type definition of a Advanced Repository query.

The Type definition mainly contains the following elements:

Element Description
properties Specifies a set of properties that are
displayed in the output table in xCP.
expression-set Specifies a set of condition constraints for
input filter.
sort Specifies sort settings.
options Specifies which version of the result to
return. Valid values are:
• resultLimit: Only returns the latest
version of a result

Example 4-2: Query results in EDAA collection

{
"name": "dql-query-type",
"type": "utapp21_dqluserinput",
"label": "utapp21_dqluserinput",
"data-type": "types/dql-queries/utapp21_dqluserinput",
"description": "Description for utapp21_dqluserinput",
"dql-text": "select user_name from dm_user where user_name = $param1$
"properties": [{
"name": "user_name",
"output-name": "user_name",
"type": "string",
"sortable": "false"
}],
"expression-set": {
"properties": [{
"input-name": "input_param1",
"input-type": "form-input",
"name": "param1",
"type": "string",
"repeating": "false"
}]
"links": [{
"rel": "self",
"href": "types/dql-queries/utapp21_dqluserinput"
}, {
"rel": "http://identifiers.emc.com/linkrel/instances",
"href": "dql-queries/utapp21_dqluserinput"
}],
"options": [{
"resultLimit": "100"
}]
}

EDCPKL230200-PGR-EN-01 Development Guide 91

Chapter 4 Resources

4.3 xCP advanced repository query type collection

The Advanced repository query type collection represents a collection of type
definitions for Advanced repository query instances.

4.3.1 URI template

/types/dql-queries

4.3.2 Feed and EDAA support

A collection of advanced repository query type instances conforms to Atom Feed in
XML representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/dql-queries/
Title Name of Feed DQLQueries
Updated Value of the updated 2016-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/dql-queries/
and name of the type sample_query
Title Query name sample_query
Summary Summary of the query A sample query
Updated Last update time of the 2015-01-25T18:51:39.469Z
instance that this entry points
to

92 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.3. xCP advanced repository query type collection

4.3.3 Link relation

The following table lists link relation(s) for a Advanced repository query type
collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP advanced repository
for Advanced Repository query type collection”
Query instances on page 92

4.3.4 Operations
Advanced repository query type collection resource supports the following HTTP
method.

Method Description
GET Retrieve a collection of type definitions for
Advanced Repository Query instances

4.3.4.1 Get a advanced repository query type collection

Retrieve a collection of type definitions for Advanced Repository query instances.

4.3.4.1.1 HTTP method

GET

4.3.4.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links
• inline
• items-per-page
• page

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 93

Chapter 4 Resources

4.3.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.3.4.1.4 Request body

None.

4.3.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.3.4.1.6 Supported response media types

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

4.3.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

94 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.4. xCP alert query single instance

4.3.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Advanced

repository query instances.

• Each instance may contain all or a set of properties of the type definitions for
Advanced Repository Query instances, depending on the setting of the query
parameter view.
• Pagination is supported.

4.4 xCP alert query single instance

A single instance of Alert Query represents an Alert Query defined in xCP Designer.
This resource enables you to perform a query on metadata of Alert instances in a
repository.

4.4.1 URI template

/alert-queries/query_name

query_name Name of the alert query

4.4.2 Link relation

The following table lists link relation(s) for an Alert Query resource.

Link relation Description Resource reference

self This Alert Query instance “xCP alert query single
instance” on page 95

4.4.3 Operations
An Alert Query resource supports the following HTTP method.

Method Description
GET Retrieve the results of an alert query

EDCPKL230200-PGR-EN-01 Development Guide 95

Chapter 4 Resources

4.4.3.1 Perform an alert query

Retrieve the results of an alert query.

4.4.3.1.1 HTTP method

GET

4.4.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links
• inline
• items-per-page
• page
• include-total
• sort
An Alert Query resource does not support sort on multiple attributes, meaning
that you can specify at most one attribute as the sort criterion when performing a
query.

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.4.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.4.3.1.4 Request body

None.

96 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.4. xCP alert query single instance

4.4.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.4.3.1.6 Supported response media types

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

4.4.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.4.3.1.8 Response body

XML or JSON representation of the query results. The results are presented using
Atom Feed in XML representation or using EDAA collection in JSON representation.
By default, this operation only returns basic properties of each result. You can get a
single instance by accessing the src link in the corresponding entry. To obtain a full
representation of each result, set the inline parameter to true.

Example 4-3: Query results in atom feed

<feed>
<id>alert-queries/utapp21_loanalertquery</id>
<title type="text">utapp21_loanalertquery</title>
<updated>2014-01-23T09:30:13.858Z</updated>
<link href="alert-queries/utapp21_loanalertquery" rel="self" />
<author>
<name>OpenText Documentum</name>
</author>
<entry>
<id>alert-queries/utapp21_loanalertquery/972255271</id>
<title type="text">utapp21_loanalertquery-0</title>
<updated>2014-01-23T09:30:13.858Z</updated>
<link href="alert-queries/utapp21_loanalertquery/972255271" rel="edit" />
<summary type="text">utapp21_loanalertquery-0</summary>
<content type="application/vnd.emc.xcp+xml"
src="alert-queries/utapp21_loanalertquery/972255271" />
</entry>

EDCPKL230200-PGR-EN-01 Development Guide 97

Chapter 4 Resources

<entry>
<id>alert-queries/utapp21_loanalertquery/1592705241</id>
<title type="text">utapp21_loanalertquery-0</title>
<updated>2014-01-23T09:30:13.859Z</updated>
<link href="alert-queries/utapp21_loanalertquery/1592705241" rel="edit" />
<summary type="text">utapp21_loanalertquery-0</summary>
<content type="application/vnd.emc.xcp+xml"
src="alert-queries/utapp21_loanalertquery/1592705241" />
</entry>
<entry>
<id>alert-queries/utapp21_loanalertquery/194042900</id>
<title type="text">utapp21_loanalertquery-0</title>
<updated>2014-01-23T09:30:13.859Z</updated>
<link href="alert-queries/utapp21_loanalertquery/194042900" rel="edit" />
<summary type="text">utapp21_loanalertquery-0</summary>
<content type="application/vnd.emc.xcp+xml"
src="alert-queries/utapp21_loanalertquery/194042900" />
</entry>
</feed>

Example 4-4: Query results in EDAA collection

{
id: "alert-queries/utapp21_loanalertquery"
title: "utapp21_loanalertquery"
updated: "2014-01-23T17:26:07.107+08:00"
author: "OpenText Documentum"
links:
{
rel: "self"
href: "alert-queries/utapp21_loanalertquery"
}

entries:
{
id: "alert-queries/utapp21_loanalertquery/456959915"
title: "utapp21_loanalertquery-0"
updated: "2014-01-23T17:26:07.107+08:00"
summary: "utapp21_loanalertquery-0"
content: {
src: "alert-queries/utapp21_loanalertquery/456959915"
content-type: "application/vnd.emc.xcp+json"
}
}
{
id: "alert-queries/utapp21_loanalertquery/343615540"
title: "utapp21_loanalertquery-0"
updated: "2014-01-23T17:26:07.107+08:00"
summary: "utapp21_loanalertquery-0"
content: {
src: "alert-queries/utapp21_loanalertquery/343615540"
content-type: "application/vnd.emc.xcp+json"
}
}
{
id: "alert-queries/utapp21_loanalertquery/1509423337"
title: "utapp21_loanalertquery-0"
updated: "2014-01-23T17:26:07.107+08:00"
summary: "utapp21_loanalertquery-0"
content: {
src: "alert-queries/utapp21_loanalertquery/1509423337"
content-type: "application/vnd.emc.xcp+json"
}
}
}

98 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.5. xCP alert query single type

4.5 xCP alert query single type

A single instance of Alert Query Type represents the type definition of an alert
query that is configured in xCP Designer.

4.5.1 URI template

/types/alert-queries/query-type

query-type Type of the alert query

4.5.2 Link relation

The following table lists general link relation for an Alert Query Type resource.

Link relation Description Resource reference

self Type definition of Alert “xCP alert query single type”
Query instances on page 99
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.5.3 Operations
An Alert Query Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Alert Query
instances

4.5.3.1 Get an alert query type

Retrieve the type definition of Alert Query instances of a certain type.

EDCPKL230200-PGR-EN-01 Development Guide 99

Chapter 4 Resources

4.5.3.1.1 HTTP method

GET

4.5.3.1.2 Query parameters

None.

4.5.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.5.3.1.4 Request body

None.

4.5.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.5.3.1.6 Supported response media types

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

4.5.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

100 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.6. xCP alert query type collection

4.5.3.1.8 Response body

XML or JSON representation of the type definition of Alert Query instances.

4.6 xCP alert query type collection

An Alert Query Type collection represents a collection of type definitions for Alert
Query instances.

4.6.1 URI template

/types/alert-queries

4.6.2 Feed and EDAA support

A collection of Alert Query Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/alert-queries
Title Name of Feed Alert Queries
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/alert-queries/base-
and name of the type alert-query
Title Title of the alert query base-alert-query
Summary Summary of the alert query Base Alert Query
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 101

Chapter 4 Resources

4.6.3 Link relation

The following table lists link relation(s) for an Alert Query Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP alert query type
for Alert Query instances collection” on page 101

4.6.4 Operations
An Alert Query Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Alert Query instances

4.6.4.1 Get an alert query type collection

Retrieve a collection of type definitions for Alert Query instances.

4.6.4.1.1 HTTP method

GET

4.6.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

102 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.6. xCP alert query type collection

4.6.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.6.4.1.4 Request body

None.

4.6.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.6.4.1.6 Supported response media types

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

4.6.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 103

Chapter 4 Resources

4.6.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Alert Query

instances.

• Each instance may contain all or a set of properties of the type definitions for
Alert Query instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.7 xCP alert single instance

A single instance of Alert represents an alert in the system. An alert is triggered
when the trigger condition is met.

4.7.1 URI template

/alerts/alert-type/alert-id

alert-type Type of the alert

alert-id ID of the alert

4.7.2 Link relation

The following table lists general link relations for an Alert resource.

Link relation Description Resource reference

type Type definition of this “xCP Alert Single Type”
resource on page 112
status [1] Status of the Alert instance Not applicable
self This Alert instance “xCP alert single instance”
on page 104
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

104 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.7. xCP alert single instance

4.7.3 Operations
An Alert resource supports the following HTTP methods.

Method Description
GET Retrieve an Alert resource
PUT Update the status of an Alert resource

4.7.3.1 Get an alert

Retrieve an Alert resource.

4.7.3.1.1 HTTP method

GET

4.7.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.7.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.7.3.1.4 Request body

None.

EDCPKL230200-PGR-EN-01 Development Guide 105

Chapter 4 Resources

4.7.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.7.3.1.6 Supported response media types

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

4.7.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.7.3.1.8 Response body

XML or JSON representation of the Alert resource.

• The type link relation points to the type definition of the Alert resource, through
which you can retrieve an “xCP Alert Single Type” on page 112.
• The status link relation indicates the status of the Alert resource, through which
you can update the status by using a PUT request.
• Null values are presented as an empty string (“”).

106 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.7. xCP alert single instance

4.7.3.2 Update alert status

Update the status of an Alert resource.

4.7.3.2.1 HTTP method

To update the status of an Alert resource, send a PUT request to the status link
relation of the Alert in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/alerts/<alert-type>/<alert-id>/status

4.7.3.2.2 Server accepted request media types

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

4.7.3.2.3 Query parameters

None.

4.7.3.2.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.7.3.2.5 Request body

XML or JSON representation of the status of the Alert resource. The following
statuses are supported:

Status XML Representation JSON Representation

NEW <?xml version="1.0" {"NEW":{}}
encoding="UTF-8"?>
<dm:new xmlns:dm="http://
identifiers.emc.com/vocab/
xcp"/>

ACKNOWLEDGED <?xml version="1.0" {"ACKNOWLEDGED":{}}

encoding="UTF-8"?>
<dm:acknowledged
xmlns:dm="http://
identifiers.emc.com/vocab/
xcp"/>

CLOSED <?xml version="1.0" {"CLOSED":{}}

encoding="UTF-8"?>
<dm:closed xmlns:dm="http://
identifiers.emc.com/vocab/
xcp"/>

EDCPKL230200-PGR-EN-01 Development Guide 107

Chapter 4 Resources

4.7.3.2.6 Response headers

• Location

• Content-Length

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.7.3.2.7 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.documentum+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.7.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.7.3.2.9 Response body

XML or JSON representation of the updated Alert resource:

• The type link relation points to the type definition of the Alert resource, through
which you can retrieve a “xCP Alert Single Type” on page 112.

• The status link relation indicates the updated status of the Alert resource.

• Null values are presented as an empty string (“”).

108 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.8. xCP alert collection

4.8 xCP alert collection

An Alert collection represents a collection of Alert instances.

4.8.1 URI template

/alerts/alert-type

alert-type Type of the alert

4.8.2 Feed and EDAA support

A collection of Alert instances conforms to Atom Feed in XML representation and
EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
Alert/xcp-base-alert
Title Alert title Base Alert
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ Alert/xcp-base-alert/
uri>/<entry_id> 18765432199812ce
Title Entry title Entry title
Summary Entry summary Entry summary
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 109

Chapter 4 Resources

4.8.3 Link relation

The following table lists link relation(s) for an Alert collection resource.

Link relation Description Resource reference

self This collection resource “xCP alert collection”
on page 109
first, last, previous, next Pagination links “xCP alert collection”
on page 109

4.8.4 Operations
An Alert collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Alert instances.

4.8.4.1 Get an alert collection

Retrieve a collection of Alert instances of a certain type.

4.8.4.1.1 HTTP method

GET

4.8.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total
• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

110 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.8. xCP alert collection

4.8.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.8.4.1.4 Request body

None.

4.8.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.8.4.1.6 Supported response media types

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

4.8.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 111

Chapter 4 Resources

4.8.4.1.8 Response body

XML or JSON representation of a collection of Alert instances.

• Each instance may contain all or a set of properties of the Alert instance,
depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.9 xCP Alert Single Type

A single instance of Alert Type represents the type definition of Alert instances. An
Alert Type resource is configured based on a Historical Query resource and exposes
one or more columns of the historical query.

4.9.1 URI template

/types/alert-type

alert-type Type of the alert

4.9.2 Link relation

The following table lists general link relations for an Alert Type resource.

Link relation Description Resource reference

self Type definition of Alert “xCP Alert Single Type”
instances on page 112
instances [1] collection of the Alert “xCP alert collection”
instances on page 109
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.9.3 Operations
An Alert Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Alert instances

112 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.9. xCP Alert Single Type

4.9.3.1 Get an Alert Type

Retrieve the type definition of Alert instances.

4.9.3.1.1 HTTP method

GET

4.9.3.1.2 Query parameters

None.

4.9.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.9.3.1.4 Request body

None.

4.9.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.9.3.1.6 Supported response media types

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

4.9.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 113

Chapter 4 Resources

4.9.3.1.8 Response body

XML or JSON representation of the type definition of Alert instances. The

instances link relation points to a collection of Alert instances, through which you
can retrieve an “xCP alert collection” on page 109.

4.10 xCP Alert Type collection

An Alert Type collection represents a collection of type definitions for Alert
instances.

4.10.1 URI template

/types/alerts

4.10.2 Feed and EDAA support

A collection of Alert Type instances conforms to Atom Feed in XML representation
and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/alerts
Title Name of Feed Alerts
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/alerts/xcp-base-alert
and name of the type
Title Alert title xcp-base-alert
Summary Alert summary Base Alert
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

114 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.10. xCP Alert Type collection

4.10.3 Link relation

The following table lists link relation(s) for an Alert Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Alert Type collection”
for Alert instances on page 114

4.10.4 Operations
An Alert Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Alert instances

4.10.4.1 Get an Alert Type collection

Retrieve a collection of type definitions for Alert instances.

4.10.4.1.1 HTTP method

GET

4.10.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 115

Chapter 4 Resources

4.10.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.10.4.1.4 Request body

None.

4.10.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.10.4.1.6 Supported response media types

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

4.10.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

116 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.11. xCP annotation collection

4.10.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Alert instances.

• Each instance may contain all or a set of properties of the type definitions for
Alert instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.11 xCP annotation collection

An Annotation collection resource handles annotation requests for the viewer
framework in xCP REST services. Annotations are markups displayed on documents
and images. They can be represented in various shapes, sizes, and colors.

Note: xCP REST services does not use a type definition to model annotation
instances. Therefore, annotations are passed within the body of a request or
response in a model that a viewer provider can understand and consume.
“Viewer provider profile” on page 599 provides detailed information about
viewer providers.

4.11.1 URI template

viewers/viewer-provider/contents/content-type/content-id/view/
annotations

viewer-provider Name of the viewer provider

content-type Content type of the Content instance to
which annotations are attached
content-id Object ID of the Content instance to which
annotations are attached

4.11.2 Feed and EDAA support

An Annotation collection resource does not support Atom Feed or EDAA.

EDCPKL230200-PGR-EN-01 Development Guide 117

Chapter 4 Resources

4.11.3 Link relation

This resource does not have any link relations.

4.11.4 Operations
An Annotation collection resource supports the following HTTP methods.

Method Description
GET Retrieve all annotations on a Content
instance
GET Retrieve annotations created by a specific
user on a Content instance
POST Create annotations on a Content instance

4.11.4.1 Get an annotation collection

Retrieve all annotations on a Content instance.

4.11.4.1.1 HTTP method

GET

To retrieve all annotations on a Content instance:

1. Get the view link of a Content instance in the following pattern:

/contents/content-type/content-id/
view?contentType=content-format&ann=true&man=true

2. Get the annotations on the Content instance in the following pattern:

viewers/viewer-provider/contents/content-type/
content-id/view/annotations

Note: The viewer provider must support the content format of the annotations.
The section “Formats” on page 532 provides more information about content
formats.

118 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.11. xCP annotation collection

4.11.4.1.2 Query parameters

This operation does not support any query parameters.

4.11.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.11.4.1.4 Request body

None.

4.11.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.11.4.1.6 Supported response media types

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

4.11.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 119

Chapter 4 Resources

4.11.4.1.8 Response body

JSON representation of an Annotation collection. This collection contains all

annotations attached to a Content instance.

Example 4-5: Annotations in JSON using the content viewer provider

[{
pageNumber: 1,
pageHeight: 590,
commentId: 0901e24080010590,
pageWidth: 416,
commentColor: "red",
commentContent: "hello world",
commentTitle: "hello world",
xPos: 46,
yPos: 85,
creatorName: "tester"
},{
pageNumber: 2,
pageHeight: 590,
commentId: 0900492d80088c20,
pageWidth: 416,
commentColor: "red",
commentContent: "hello world 2",
commentTitle: "hello world 2",
xPos: 65,
yPos: 185,
creatorName: "dmadmin"
}]

4.11.4.2 Get an annotation collection for a User

Retrieve annotations created by a specific user on a Content instance.

4.11.4.2.1 HTTP method

GET

To retrieve annotations created by a specific user on a Content instance:

1. Get the view link of a Content instance in the following pattern:

/contents/content-type/content-id/
view?contentType=content-format&ann=true&man=true

2. Get the annotations for the user by appending the username to the URI in the
following pattern:
viewers/viewer-provider/contents/content-type/
content-id/view/annotations/username

For example, the following request gets the annotations that testuser creates on
the Content instance with the object ID 0901e2408001dec5:
/ContentViewer/contents/dm_document/
0901e2408001dec5/view/annotations/testuser

120 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.11. xCP annotation collection

Note: The viewer provider must support the content format of the annotations.
The section “Formats” on page 532 provides more information about content
formats.

4.11.4.2.2 Query parameters

This operation does not support any query parameters.

4.11.4.2.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.11.4.2.4 Request body

None.

4.11.4.2.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.11.4.2.6 Supported response media types

• application/atom+xml

• application/vnd.emc.xcp+json
• application/json (For compatible viewing)

4.11.4.2.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 121

Chapter 4 Resources

4.11.4.2.8 Response body

JSON representation of an Annotation collection created by a specific user.

Example 4-6: Annotations in JSON using the content viewer provider

[{
pageNumber: 1,
pageHeight: 590,
commentId: 0900492d80088c20,
pageWidth: 416,
commentColor: "red",
commentContent: "hello world",
commentTitle: "hello world",
xPos: 46,
yPos: 85,
creatorName: "tester"
},{
pageNumber: 2,
pageHeight: 590,
commentId: 0900492d80088c20,
pageWidth: 416,
commentColor: "red",
commentContent: "hello world 2",
commentTitle: "hello world 2",
xPos: 65,
yPos: 185,
creatorName: "tester"
}]

4.11.4.3 Create annotations

Create annotations on a Content instance.

4.11.4.3.1 HTTP method

POST

To Create annotations on a Content instance:

1. Get the view link of a Content instance in the following pattern:

/contents/content-type/content-id/
view?contentType=content-format&ann=true&man=true

2. Post the annotation payload (see “Request body” on page 123) to the Content
instance in the following pattern:
viewers/viewer-provider/contents/content-type/
content-id/view/annotations

122 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.11. xCP annotation collection

4.11.4.3.2 Server accepted request media types

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

4.11.4.3.3 Query parameters

None.

4.11.4.3.4 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.11.4.3.5 Request body

A form that represents an Annotation instance where the form name is set to
commentData and the form data describes the annotation content in JSON that
resembles the following:

Example 4-7: Annotation Content using the Content Viewer provider

{
pageNumber: 5,
pageHeight: 590,
pageWidth: 416,
commentColor: "red",
commentContent: "this is a comment",
commentTitle: "comment title",
xPos: 46,
yPos: 85,
creatorName: "dmadmin"
}

Note: You can create only one Annotation instance at a time.

4.11.4.3.6 Response headers

Location

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 123

Chapter 4 Resources

4.11.4.3.7 Supported response media types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/json (For compatible viewing)

4.11.4.3.8 Response status

201 - Content uploaded successfully

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.11.4.3.9 Response body

JSON representation of an Annotation collection.

4.12 xCP application single instance

A single instance of Application represents an xCP application. This resource
contains properties of the xCP application, and references to the related projects.

4.12.1 URI template

/application

4.12.2 Link relation

The following table lists general link relations for an Application resource.

Link relation Description Resource reference

self This application instance “xCP application single
instance” on page 124
type Type definition of this “xCP application type”
resource on page 128
projects [1] collection of all projects in the “xCP Project collection”
application on page 417
roles [1] collection of all roles defined “xCP Member collection”
in this application on page 361

124 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.12. xCP application single instance

Link relation Description Resource reference

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.12.3 Operations
An Application resource supports the following HTTP method.

Method Description
GET Retrieve an Application resource

4.12.3.1 Get an application

Retrieve the information about an xCP application.

4.12.3.1.1 HTTP method

GET

4.12.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

For more details about the query parameters, see “Common definition - query
parameters” on page 69.

4.12.3.1.3 Request headers

• Accept
• Authorization

4.12.3.1.4 Request body

None.

EDCPKL230200-PGR-EN-01 Development Guide 125

Chapter 4 Resources

4.12.3.1.5 Response headers

Content-Type

4.12.3.1.6 Supported response media types

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

4.12.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.12.3.1.8 Response body

XML or JSON representation of the Application resource.

• The type link relation points to the type definition of the Application resource,
through which you can retrieve an “xCP application type” on page 128.
• The projects link relation points to the collection of all project defined in the
Application resource.
• The roles link relation points to the collection of all roles defined in the
Application resource.
• The application-configurations link relation points to a collection of
application configuration instances in the Application resource.
• Null values are presented as an empty string (“”).

Example 4-8: Sample in XML

<?xml version="1.0" encoding="UTF-8" ?>
<dm:project xsi:type="xcp_project"
dm:definition="http://127.0.0.1:8000/xCP21UTApp/types/projects/xcp_project">
<dm:properties xsi:type="xcp_project-properties">
<dm:label>xCP21UTApp</dm:label>
<dm:version>1.0.0</dm:version>
<dm:name>xCP21UTApp</dm:name>
<dm:type>application</dm:type>
<dm:namespace>utapp21</dm:namespace>
</dm:properties>

126 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.12. xCP application single instance

<dm:links>
<dm:link rel="type" href="types/projects/xcp_project" />
<dm:link rel="http://identifiers.emc.com/linkrel/application-configurations"
href="application-configurations/xcp_application_configuration" />
<dm:link rel="http://identifiers.emc.com/linkrel/roles"
href="members/xcp_member?current-application" />
<dm:link rel="self" href="application" />
<dm:link rel="http://identifiers.emc.com/linkrel/projects"
href="projects/xcp_project" />
</dm:links>
</dm:project>

Example 4-9: Sample in JSON

{
name: "project"
type: "xcp_project"
definition: "http://127.0.0.1:8000/xCP21UTApp/types/projects/xcp_project"
properties:
{
label: "xCP21UTApp"
version: "1.0.0"
name: "xCP21UTApp"
type: "application"
namespace: "utapp21"
}
links:
{
rel: "type"
href: "types/projects/xcp_project"
}
{
rel: "http://identifiers.emc.com/linkrel/application-configurations"
href: "application-configurations/xcp_application_configuration"
}
{
rel: "http://identifiers.emc.com/linkrel/roles"
href: "members/xcp_member?current-application"
}
{
rel: "self"
href: "application"
}
{
rel: "http://identifiers.emc.com/linkrel/projects"
href: "projects/xcp_project"
}
}

EDCPKL230200-PGR-EN-01 Development Guide 127

Chapter 4 Resources

4.13 xCP application type

A single instance of Application Type represents the type definition of Application
instances.

4.13.1 URI template

/types/projects/xcp_project

4.13.2 Link relation

The following table lists general link relations for an Application Type resource.

Link relation Description Resource reference

self Type definition of an “xCP application type”
Application instance on page 128
instances [1] collection of the project “xCP application
instances configuration collection”
on page 137
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.13.3 Operations
An Application Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Application
instances

4.13.3.1 Get an application type

Retrieve the type definition of Application instances.

4.13.3.1.1 HTTP method

GET

128 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.13. xCP application type

4.13.3.1.2 Query parameters

None.

4.13.3.1.3 Request headers

• Accept
• Authorization

4.13.3.1.4 Request body

None.

4.13.3.1.5 Response headers

Content-Type

4.13.3.1.6 Supported response media types

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

4.13.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.13.3.1.8 Response body

XML or JSON representation of the type definition of Application instances.

EDCPKL230200-PGR-EN-01 Development Guide 129

Chapter 4 Resources

4.14 xCP application type collection

An Application Type collection represents a collection of type definitions for
Application instances.

4.14.1 URI template

/types/projects

4.14.2 Feed and EDAA support

A collection of Application Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/projects/
Title Projects Projects
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed projects/xcp_application/
and name of the type
Title Project Project
Summary Project Project
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

130 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.14. xCP application type collection

4.14.3 Link relation

The following table lists link relation(s) for an Application Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP application type
for Application instances collection” on page 130

4.14.4 Operations
An Application Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Application instances

4.14.4.1 Get an Application Type collection

Retrieve a collection of type definitions for Application instances.

4.14.4.1.1 HTTP method

GET

4.14.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

For more details about the query parameters, see “Common definition - query
parameters” on page 69.

EDCPKL230200-PGR-EN-01 Development Guide 131

Chapter 4 Resources

4.14.4.1.3 Request headers

• Accept

• Authorization

4.14.4.1.4 Request body

None.

4.14.4.1.5 Response headers

Content-Type

4.14.4.1.6 Supported response media types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.14.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.14.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Application

instances.

• Each instance may contain all or a set of properties of Application Type

instances, depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

132 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.15. xCP application configuration single instance

4.15 xCP application configuration single instance

A single instance of Application Configuration describes the parameters and
endpoints of an application. This resource can be extended to store additional
configuration information, if necessary.

4.15.1 URI template

/application-configurations/xcp_application_configuration/
application_configuration-id

application_configuration-id Object ID of the application configuration

4.15.2 Link relation

The following table lists general link relations for an Application Configuration
resource.

Link relation Description Resource reference

type Type definition of this “xCP application
resource configuration single type”
on page 141
instances [1] collection of the Application “xCP application
Configuration instances configuration collection”
on page 137
edit This Application “xCP application
Configuration instance configuration single
instance” on page 133
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.15.3 Operations
An Application Configuration resource supports the following HTTP methods.

Method Description
GET Retrieve an Application Configuration
resource
POST Update an Application Configuration
resource

EDCPKL230200-PGR-EN-01 Development Guide 133

Chapter 4 Resources

4.15.3.1 Get an application configuration

Retrieve the information about the application parameters and endpoints of an
Application Configuration resource, identified by the object ID.

4.15.3.1.1 HTTP method

GET

4.15.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.15.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.15.3.1.4 Request body

None.

4.15.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.15.3.1.6 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

134 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.15. xCP application configuration single instance

4.15.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.15.3.1.8 Response body

XML or JSON representation of the Application Configuration resource.

• The type link relation points to the type definition of the Application
Configuration resource, through which you can retrieve an “xCP application
configuration single type” on page 141.
• Null values are presented as an empty string (“”).

4.15.3.2 Update an application configuration

Update an Application Configuration instance.

4.15.3.2.1 HTTP method

POST

To update an Application Configuration instance, send a POST request to the edit

link relation of that instance in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/application-configurations/
<application-configuration-type>/<objectId>

4.15.3.2.2 Server accepted request media types

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

EDCPKL230200-PGR-EN-01 Development Guide 135

Chapter 4 Resources

4.15.3.2.3 Query parameters

None.

4.15.3.2.4 Request headers

• Accept

• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.15.3.2.5 Request body

XML or JSON representation of the Application Configuration instance.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
application configuration single type” on page 141), the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.

• To set an existing field to null, use one of the following patterns.

Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

4.15.3.2.6 Response headers

• Location
• Content-Length

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.15.3.2.7 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.documentum+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

136 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.16. xCP application configuration collection

4.15.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.15.3.2.9 Response body

XML or JSON representation of the updated Application Configuration instance:

• The type link relation points to the type definition of the Application
Configuration instance, through which you can retrieve an “xCP application
configuration single type” on page 141.
• Null values are presented as an empty string (“”).

4.16 xCP application configuration collection

An Application Configuration collection represents a collection of Application
Configuration instances.

4.16.1 URI template

/application-configurations/xcp_application_configuration

4.16.2 Feed and EDAA support

A collection of Application Configuration instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
application-configurations/
xcp_application_configuratio
n
Title Name of configuration type xcp_application_configuratio
n

EDCPKL230200-PGR-EN-01 Development Guide 137

Chapter 4 Resources

Feed property Feed value Example

Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties:

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ application-configurations/
uri>/<entry_id> xcp_application_configuratio
n/08001538800049ab
Title Name of the application xcp_application_configuratio
configuration type with the n-0
running number appended to
it
Summary Name of application xcp_application_configuratio
configuration type with n-0
running number appended to
it
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.16.3 Link relation

The following table lists link relation(s) for an Application Configuration collection
resource:

Link relation Description Resource reference

self This collection resource “xCP application
configuration collection”
on page 137
first, last, previous, next Pagination links “xCP application
configuration collection”
on page 137

138 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.16. xCP application configuration collection

4.16.4 Operations
An Application Configuration collection resource supports the following HTTP
method.

Method Description
GET Retrieve a collection of Application
Configuration instances.

4.16.4.1 Get an application configuration collection

Retrieve a collection of Application Configuration instances.

4.16.4.1.1 HTTP method

GET

4.16.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

• permissions

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.16.4.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 139

Chapter 4 Resources

4.16.4.1.4 Request body

None.

4.16.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.16.4.1.6 Supported response media types

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

4.16.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.16.4.1.8 Response body

XML or JSON representation of a collection of Application Configuration instances.

• Each instance may contain all or a set of properties of the Application

Configuration, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

140 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.17. xCP application configuration single type

4.17 xCP application configuration single type

A single instance of Application Configuration Type represents the type definition
of Application Configuration instances.

4.17.1 URI template

/types/application-configurations/xcp_application_configuration

4.17.2 Link relation

The following table lists general link relations for an Application Configuration
Type resource:

Link relation Description Resource reference

self Type definition of “xCP application
Application Configuration configuration single type”
instances on page 141
instances [1] collection of the Application “xCP application
Configuration instances configuration collection”
on page 137
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.17.3 Operations
An Application Configuration Type resource supports the following HTTP method:

Method Description
GET Retrieve the type definition of Application
Configuration instances

4.17.3.1 Get an application configuration type

Retrieve the type definition of Application Configuration instances.

EDCPKL230200-PGR-EN-01 Development Guide 141

Chapter 4 Resources

4.17.3.1.1 HTTP method

GET

4.17.3.1.2 Query parameters

None.

4.17.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.17.3.1.4 Request body

None.

4.17.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.17.3.1.6 Supported response media types

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

4.17.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

142 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.18. xCP application configuration type collection

4.17.3.1.8 Response body

XML or JSON representation of the type definition of Application Configuration

instances. The instances link relation points to a collection of Application
Configuration instances, through which you can retrieve an “xCP application
configuration collection” on page 137.

4.18 xCP application configuration type collection

An Application Configuration Type collection represents a collection of type
definitions for Application Configuration instances.

4.18.1 URI template

/types/application-configurations

4.18.2 Feed and EDAA support

A collection of Application Configuration Type instances conforms to Atom Feed in
XML representation and EDAA collection in JSON representation.

This collection resource contains the following properties:

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/application-
configurations/
Title Name of Feed Application Configurations
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties:

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed application-configurations/
and name of the type xcp_application_configuratio
n/
Title Application Configuration NA
Summary Application Configuration NA
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 143

Chapter 4 Resources

4.18.3 Link relation

The following table lists link relation(s) for an Application Configuration Type
resource:

Link relation Description Resource reference

self Collection of type definitions “xCP application
for Application configuration type
Configuration instances collection” on page 143

4.18.4 Operations
An Application Configuration Type collection resource supports the following
HTTP method:

Method Description
GET Retrieve a collection of type definitions for
Application Configuration instances

4.18.4.1 Get an application configuration type collection

Retrieve a collection of type definitions for Application Configuration instances.

4.18.4.1.1 HTTP method

GET

4.18.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page
• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

144 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.18. xCP application configuration type collection

4.18.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.18.4.1.4 Request body

None.

4.18.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.18.4.1.6 Supported response media types

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

4.18.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 145

Chapter 4 Resources

4.18.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Application

Configuration instances.

• Each instance may contain all or a set of properties of the Application

Configuration Type instance, depending on the setting of the query parameter
view.

• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.19 xCP business object single instance

A single instance of Business Object is a resource that describes a business object.

4.19.1 URI template

/business-objects/business-object-type/business_object-id

business-object-type Type of the Business Object resource

business_object-id Object ID of the Business Object resource

4.19.2 Link relation

The following table lists general link relations for a Business Object resource:

Link relation Description Resource reference

type Type definition of this “xCP Business Object Single
resource Type” on page 157
instances [1] collection of the Business “xCP Business Object
Object instances collection” on page 154
edit Edit this Business Object “xCP business object single
instance instance” on page 146
self This Business Object instance “xCP business object single
instance” on page 146
comments [1] Comments attached to this “xCP Comment collection”
Business Object instance on page 203
add-comment Add a comment to the “xCP business object single
Business Object instance instance” on page 146
delete [1] Delete this Business Object “xCP business object single
instance instance” on page 146
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

146 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.19. xCP business object single instance

4.19.3 Operations
A Business Object resource supports the following HTTP methods:

Method Description
GET Retrieve a Business Object resource
POST Create a Business Object resource
POST Update a business object resource
GET Retrieve comments from a Business Object
resource. See “xCP Comment single
instance” on page 195.
POST Add comments to a Business Object resource.
See “xCP Comment single instance”
on page 195.
DELETE Delete a Business Object resource

4.19.3.1 Get a business object

Retrieve a Business Object resource.

4.19.3.1.1 HTTP method

GET

4.19.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.19.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 147

Chapter 4 Resources

4.19.3.1.4 Request body

None.

4.19.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.19.3.1.6 Supported response media types

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

4.19.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.19.3.1.8 Response body

XML or JSON representation of the Business Object resource.

• The type link relation points to the type definition of the Business Object
resource, through which you can retrieve an “xCP Business Object Single Type”
on page 157.
• Null values are presented as an empty string (“”).

148 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.19. xCP business object single instance

4.19.3.2 Update a business object

Update a business object resource.

4.19.3.2.1 HTTP method

POST

To update a Business Object resource, send a POST request to the edit link relation
of that resource in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/business-objects/<business-object-type>/<objectId>

4.19.3.2.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.19.3.2.3 Query parameters

None.

4.19.3.2.4 Request headers

• Accept

• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.19.3.2.5 Request body

XML or JSON representation of the Business Object resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Business Object Single Type” on page 157), the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

EDCPKL230200-PGR-EN-01 Development Guide 149

Chapter 4 Resources

4.19.3.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.19.3.2.7 Supported response media types

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

4.19.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.19.3.2.9 Response body

XML or JSON representation of the updated Business Object resource:

• The type link relation points to the type definition of the Business Object
resource, through which you can retrieve a “xCP Business Object Single Type”
on page 157.
• Null values are presented as an empty string (“”).

150 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.19. xCP business object single instance

4.19.3.3 Create a Business Object

Create a Business Object resource.

4.19.3.3.1 HTTP method

POST

To create a Business Object resource of a certain type, send a POST request to the
collection of Business Object resources of that type in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/business-objects/<business-object-type>

4.19.3.3.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.19.3.3.3 Query parameters

None.

4.19.3.3.4 Request headers

• Accept

• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.19.3.3.5 Request body

XML or JSON representation of the Business Object resource.

• This operation creates a Business Object resource with all fields specified in the
request. However, if the request body contains a field that is not presented in the
corresponding DML type (“xCP Business Object Single Type” on page 157), the
field is ignored.

• Unspecified fields are set the default values in Documentum Server.

• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

EDCPKL230200-PGR-EN-01 Development Guide 151

Chapter 4 Resources

4.19.3.3.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.19.3.3.7 Supported response media types

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

4.19.3.3.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.19.3.3.9 Response body

XML or JSON representation of the Business Object resource:

• The type link relation points to the type definition of the Business Object
resource, through which you can retrieve a “xCP Business Object Single Type”
on page 157.
• Null values are presented as an empty string (“”).

152 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.19. xCP business object single instance

4.19.3.4 Delete a Business Object

Delete a Business Object resource.

4.19.3.4.1 HTTP method

DELETE

To delete a Business Object resource, send a DELETE request to the delete link
relation of the resource with the following pattern:
http://127.0.0.1:8080/<xcp-rest>/business-objects/<business-object-type>/<objectID>

4.19.3.4.2 Query parameters

None.

4.19.3.4.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.19.3.4.4 Request body

None.

4.19.3.4.5 Response headers

None.

4.19.3.4.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 153

Chapter 4 Resources

4.19.3.4.7 Response body

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

4.20 xCP Business Object collection

A Business Object collection represents a collection of Business Object instances of a
certain type.

4.20.1 URI template

/business-objects/business-object-type

business-object-type Type of the Business Object resources.

4.20.2 Feed and EDAA support

A collection of Business Object instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties:

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
business-objects/test-
business-type
Title Name of business object type test-business-type
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties:

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ business-objects/test-
uri>/<entry_id> business-type/
0800153880005b89
Title object_name of the entry Sample BusinessObject
Summary object_name of the entry Sample BusinessObject
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

154 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.20. xCP Business Object collection

4.20.3 Link relation

The following table lists link relation(s) for a Business Object collection resource:

Link relation Description Resource reference

self This collection resource “xCP Business Object
collection” on page 154
first, last, previous, next Pagination links “xCP Business Object
collection” on page 154

4.20.4 Operations
A Business Object collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Business Object
instances.

4.20.4.1 Get a business object collection

Retrieve a collection of Business Object instances of a certain type.

4.20.4.1.1 HTTP method

GET

4.20.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 155

Chapter 4 Resources

4.20.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.20.4.1.4 Request body

None.

4.20.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.20.4.1.6 Supported response media types

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

4.20.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

156 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.21. xCP Business Object Single Type

4.20.4.1.8 Response body

XML or JSON representation of a collection of Business Object instances.

• Each instance may contain all or a set of properties of the Business Object
instance, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.21 xCP Business Object Single Type

A single instance of Business Object Type represents the type definition of Business
Object instances.

4.21.1 URI template

/types/business-objects/business-object-type

business-object-type Type of the Business Object resources.

4.21.2 Link relation

The following table lists general link relations for a Business Object Type resource:

Link relation Description Resource reference

self Type definition of Business “xCP Business Object Single
Object instances Type” on page 157
instances [1] collection of the Business “xCP Business Object
Object instances collection” on page 154
defaults [1] Default values specified on a “xCP Business Object Single
Business Object type Type” on page 157
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

EDCPKL230200-PGR-EN-01 Development Guide 157

Chapter 4 Resources

4.21.3 Operations
A Business Object Type resource supports the following HTTP method:

Method Description
GET Retrieve the type definition of Business
Object instances

4.21.3.1 Get a business object type

Retrieve the type definition of Business Object instances of a certain type.

4.21.3.1.1 HTTP method

GET

4.21.3.1.2 Query parameters

None.

4.21.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.21.3.1.4 Request body

None.

4.21.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.21.3.1.6 Supported response media types

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

158 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.21. xCP Business Object Single Type

4.21.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.21.3.1.8 Response body

Response body in JSON

{
"name":"business-object-type",
"type":"utapp21_customerrecord",
"label":"CustomerRecord",
"parent":"types/business-objects/xcp_rootsharedbo",
"shareable":"true","properties":
[{
"name":"cust_name",
"label":"cust_name",
"type":"string",
"length":64
},{
"name":"cust_addr",
"label":"cust_addr",
"type":"string",
"length":64,
"repeating":true
},{
"name":"cust_phone",
"label":"cust_phone",
"type":"string",
"length":64
},{
"name":"cust_active",
"label":"cust_active",
"type":"boolean
"},{
"name":"cust_rating",
"label":"cust_rating",
"type":"float"
},{
"name":"cust_enrolldate",
"label":"cust_enrolldate",
"type":"datetime"
},{
"name":"cust_brokerage",
"label":"cust_brokerage",
"type":"integer"
}],

"links":
[{"rel":"self",
"href":"types/business-objects/utapp21_customerrecord"
},{
"rel":"http://identifiers.emc.com/linkrel/instances",
"href":"business-objects/utapp21_customerrecord"

EDCPKL230200-PGR-EN-01 Development Guide 159

Chapter 4 Resources

},{
"rel":"http://identifiers.emc.com/linkrel/defaults",
"href":"types/business-objects/utapp21_customerrecord/defaults"
},{
"rel":"type"
},{
"rel":"edit"
},{
"rel":"canonical"
},{
"rel":"http://identifiers.emc.com/linkrel/delete"
},{
"rel":"http://identifiers.emc.com/linkrel/relations"
},{
"rel":"http://identifiers.emc.com/linkrel/lightweight-objects"
},{
"rel":"http://identifiers.emc.com/linkrel/add-lightweight-objects"
}]}

4.22 xCP Business Object type collection

A Business Object instances Type collection represents a collection of type
definitions for Business Object instances.

4.22.1 URI template

/types/business-objects/

4.22.2 Feed and EDAA support

A collection of Business Object Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties:

Feed property Feed value Example

ID URI of the feed http://127.0.0.1:8080/xcp-rest/
types/business-objects/
Title Business Objects Business Objects
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties:

Feed property Feed value Example

ID URI of the entry, which http://127.0.0.1:8080/xcp-rest/
contains the URI of the feed types/business-objects/
and name of the type xcp_business_objects/
Title Label of the type that this test-business-object-type
entry points to

160 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.22. xCP Business Object type collection

Feed property Feed value Example

Summary Label of the type that this test-business-object-type
entry points to
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.22.3 Link relation

The following table lists link relation(s) for a Business Object Type collection
resource:

Link relation Description Resource reference

self Collection of type definitions “xCP Business Object type
for Business Object instances collection” on page 160

4.22.4 Operations
A Business Object Type collection resource supports the following HTTP method:

Method Description
GET Retrieve a collection of type definitions for
Business Object instances

4.22.4.1 Get a Business Object type collection

Retrieve a collection of type definitions for Business Object instances.

4.22.4.1.1 HTTP method

GET

4.22.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 161

Chapter 4 Resources

4.22.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.22.4.1.4 Request body

None.

4.22.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.22.4.1.6 Supported response media types

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

4.22.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

162 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.23. xCP Cabinet single instance

4.22.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Business Object

instances.

• Each instance may contain all or a set of properties of the type definitions for
Business Object instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.23 xCP Cabinet single instance

A single instance of Cabinet represents a cabinet in a repository. Cabinets are the
highest level of organization visible to users in a repository.

A Cabinet object extends from dm_folder. Any object that extends from dm_
sysobject are stored in cabinets. A cabinet cannot be placed inside another cabinet
or a folder. Super user privileges are required to create or remove a cabinet. Any
user who has the Write permission to a cabinet can modify the properties of the
cabinet.

4.23.1 URI template

/cabinets/cabinet-type/cabinet-id

cabinet-type Type of the cabinet

cabinet-id Object ID of the cabinet

4.23.2 Link relation

The following table lists general link relations for a Cabinet resource:

Link relation Description Resource reference

type Type definition of this “xCP Cabinet Single Type”
resource on page 176
instances [1] collection of the Cabinet “xCP Cabinet collection”
instances on page 173
self This Cabinet instance “xCP Cabinet single
instance” on page 163
objects [1] Objects located in this “xCP Folder Type collection”
Cabinet resource on page 256
add Add an instance of an object “xCP Cabinet single
inside this Cabinet instance instance” on page 163
add-comment Add a comment to the “xCP Cabinet single
Cabinet instance instance” on page 163

EDCPKL230200-PGR-EN-01 Development Guide 163

Chapter 4 Resources

Link relation Description Resource reference

self This instance “xCP Cabinet single
instance” on page 163
edit Edit this instance “xCP Cabinet single
instance” on page 163
delete Delete this instance “xCP Cabinet single
instance” on page 163
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.23.3 Operations
A Cabinet resource supports the following HTTP methods:

Method Description
GET Retrieve a Cabinet resource
GET Retrieve the objects in a Cabinet resource
POST Create a Cabinet resource
POST Update a Cabinet resource
DELETE Delete a Cabinet resource

4.23.3.1 Get a Cabinet

Retrieve a Cabinet resource.

4.23.3.1.1 HTTP method

GET

4.23.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

164 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.23. xCP Cabinet single instance

4.23.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.23.3.1.4 Request body

None.

4.23.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.23.3.1.6 Supported response media types

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

4.23.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 165

Chapter 4 Resources

4.23.3.1.8 Response body

XML or JSON representation of the Cabinet resource.

• The type link relation points to the type definition of the Cabinet resource,
through which you can retrieve an “xCP Cabinet Single Type” on page 176.
• Null values are presented as an empty string (“”).

4.23.3.2 Get objects in a Cabinet

Retrieve objects in a Cabinet resource.

4.23.3.2.1 HTTP method

GET

To get objects in a Cabinet resource, send a GET request to the object link relation
of the Cabinet resource in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/processes/<process-system-name>/<cabinet-id>/
objects

4.23.3.2.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.23.3.2.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

166 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.23. xCP Cabinet single instance

4.23.3.2.4 Request body

None.

4.23.3.2.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.23.3.2.6 Supported response media types

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

4.23.3.2.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.23.3.2.8 Response body

XML or JSON representation of a collection of objects in the Cabinet resource.

4.23.3.3 Create a Cabinet

Create a Cabinet resource.

EDCPKL230200-PGR-EN-01 Development Guide 167

Chapter 4 Resources

4.23.3.3.1 HTTP method

POST

4.23.3.3.2 Server accepted request media types

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

4.23.3.3.3 Query parameters

None.

4.23.3.3.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.23.3.3.5 Request body

XML or JSON representation of the Cabinet resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Cabinet Single Type” on page 176), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

Example 4-10: Request body in XML

<dm:cabinet name="emc_iig_cabinet">
<dm:properties>
<dm:single_attr_string>emc</dm:single_attr_string>
</dm:properties>
</dm:cabinet>

Example 4-11: Request body in JSON

{
"name": "cabinet",
"type": "emc_iig_cabinet",
"definition": "http://127.0.0.1:8080/xcp-rest/types/cabinets/emc_iig_cabinet",

168 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.23. xCP Cabinet single instance

"properties": {
"single_attr_string": "emc",
}
}

4.23.3.3.6 Response headers

• Location

• Content-Length

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.23.3.3.7 Supported response media types

• application/vnd.emc.xcp+xml

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

• application/json (For compatible viewing)

4.23.3.3.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

409 - Conflict

500 - Other unexpected server error

4.23.3.3.9 Response body

XML or JSON representation of the created Cabinet resource:

• The type link relation points to the type definition of the Cabinet resource,
through which you can retrieve a “xCP Cabinet Single Type” on page 176.

• Null values are presented as an empty string (“”).

EDCPKL230200-PGR-EN-01 Development Guide 169

Chapter 4 Resources

4.23.3.4 Update a Cabinet

Update the metadata of a Cabinet resource.

4.23.3.4.1 HTTP method

POST

4.23.3.4.2 Server accepted request media types

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

4.23.3.4.3 Query parameters

None.

4.23.3.4.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.23.3.4.5 Request body

XML or JSON representation of the Cabinet resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Cabinet Single Type” on page 176), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

170 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.23. xCP Cabinet single instance

4.23.3.4.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.23.3.4.7 Supported response media types

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

4.23.3.4.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.23.3.4.9 Response body

XML or JSON representation of the updated Cabinet resource:

• The type link relation points to the type definition of the Cabinet resource,
through which you can retrieve a “xCP Cabinet Single Type” on page 176.
• Null values are presented as an empty string (“”).

EDCPKL230200-PGR-EN-01 Development Guide 171

Chapter 4 Resources

4.23.3.5 Delete a Cabinet

Delete a Cabinet resource.

4.23.3.5.1 HTTP method

DELETE

4.23.3.5.2 Query parameters

None.

4.23.3.5.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.23.3.5.4 Request body

None.

4.23.3.5.5 Response headers

None.

4.23.3.5.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

4.23.3.5.7 Response body

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

172 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.24. xCP Cabinet collection

4.24 xCP Cabinet collection

A Cabinet collection represents a collection of Cabinet instances.

4.24.1 URI template

/cabinets/cabinet-type/

cabinet-type Type of the cabinet

4.24.2 Feed and EDAA support

A collection of Cabinet instances conforms to Atom Feed in XML representation and
EDAA collection in JSON representation.

This collection resource contains the following properties:

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
cabinets/dm_cabinet
Title Title of the collection dm_cabinet
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties:

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ cabinets/dm_cabinet/
uri>/<entry_id> 0c01e24080012a95
Title Entry title xcp_sample_cabinet
Summary Entry summary xCP Sample Cabinet
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 173

Chapter 4 Resources

4.24.3 Link relation

The following table lists link relation(s) for a Cabinet collection resource.

Link relation Description Resource reference

self This collection resource “xCP Cabinet collection”
on page 173
first, last, previous, next Pagination links “xCP Cabinet collection”
on page 173

4.24.4 Operations
A Cabinet collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Cabinet instances

4.24.4.1 Get a Cabinet collection

Retrieve a collection of Cabinet instances of a certain type.

4.24.4.1.1 HTTP method

GET

4.24.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total
• sort

• permissions

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

174 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.24. xCP Cabinet collection

4.24.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.24.4.1.4 Request body

None.

4.24.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.24.4.1.6 Supported response media types

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

4.24.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 175

Chapter 4 Resources

4.24.4.1.8 Response body

XML or JSON representation of a collection of Cabinet instances.

• Each instance may contain all or a set of properties of the Cabinet instance,
depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.25 xCP Cabinet Single Type

A single instance of Cabinet Type represents the type definition of Cabinet instances.

4.25.1 URI template

/types/cabinets/cabinet-type

cabinet-type Type of the cabinets

4.25.2 Link relation

The following table lists general link relations for a Cabinet Type resource.

Link relation Description Resource reference

self Type definition of Cabinet “xCP Cabinet Single Type”
instances on page 176
instances [1] collection of the Cabinet “xCP Cabinet collection”
instances on page 173
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.25.3 Operations
A Cabinet Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Cabinet
instances

176 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.25. xCP Cabinet Single Type

4.25.3.1 Get a Cabinet Type

Retrieve the type definition of Cabinet instances.

4.25.3.1.1 HTTP method

GET

4.25.3.1.2 Query parameters

None.

4.25.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.25.3.1.4 Request body

None.

4.25.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.25.3.1.6 Supported response media types

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

4.25.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 177

Chapter 4 Resources

4.25.3.1.8 Response body

XML or JSON representation of the type definition of Cabinet instances. The

instances link relation points to a collection of Cabinet instances, through which
you can retrieve an “xCP Cabinet collection” on page 173.

4.26 xCP Cabinet Type collection

A Cabinet Type collection represents a collection of type definitions for Cabinet
instances.

4.26.1 URI template

/types/cabinets

4.26.2 Feed and EDAA support

A collection of Cabinet Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/cabinets
Title Name of Feed Cabinets
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/cabinets/dm_cabinet
and name of the type
Title Title of the cabinet type dm_cabinet
Summary Summary of the cabinet type Base Cabinet
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

178 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.26. xCP Cabinet Type collection

4.26.3 Link relation

The following table lists link relation(s) for a Cabinet Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Cabinet Type
for Cabinet instances collection” on page 178

4.26.4 Operations
A Cabinet Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Cabinet instances

4.26.4.1 Get a Cabinet Type collection

Retrieve a collection of type definitions for Cabinet instances.

4.26.4.1.1 HTTP method

GET

4.26.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 179

Chapter 4 Resources

4.26.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.26.4.1.4 Request body

None.

4.26.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.26.4.1.6 Supported response media types

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

4.26.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

180 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.27. xCP Checklist single instance

4.26.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Cabinet instances.

• Each instance may contain all or a set of properties of the type definitions for
Cabinet instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.27 xCP Checklist single instance

A single instance of checklist is a resource that describes a checklist.

4.27.1 URI template

/casenodes/casenode-type/casenode-id/checklists/checklist-type/
checklist-id

casenode-type Type of the case node

casenode-id Object Id of the case node
Checklist-type Types of the checklist attached/associated
checklist-id Object-id of the checklist instance

4.27.2 Link relation

The following table lists general link relations for a checklist resource.

Link relation Description Resource reference

type Type definition of this “xCP Checklist Single Type”
resource on page 189
instances [1] collection of the case node “xCP Checklist Type
instances collection” on page 192
edit Edit this checklist instance “xCP Checklist single
instance” on page 181
self This checklist instance “xCP Checklist single
instance” on page 181
delete [1] Delete this checklist instance “xCP Checklist single
instance” on page 181
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

EDCPKL230200-PGR-EN-01 Development Guide 181

Chapter 4 Resources

4.27.3 Operations
A checklist resource supports the following HTTP methods.

Method Description
GET Retrieve a checklist resource
POST Create a checklist resource
POST Update a checklist resource
DELETE Delete a checklist resource

4.27.3.1 Get a checklist

Retrieve a checklist resource.

4.27.3.1.1 HTTP method

GET

4.27.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.27.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.27.3.1.4 Request body

None.

182 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.27. xCP Checklist single instance

4.27.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.27.3.1.6 Supported response media types

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

4.27.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.27.3.1.8 Response body

XML or JSON representation of the checklist resource.

• The type link relation points to the type definition of the checklist resource,
through which you can retrieve an “xCP Checklist Single Type” on page 189.
• Null values are presented as an empty string (“”).

4.27.3.2 Update a Checklist

Update a checklist resource.

EDCPKL230200-PGR-EN-01 Development Guide 183

Chapter 4 Resources

4.27.3.2.1 HTTP method

POST

To update a checklist resource, send a POST request to the edit link relation of that
resource in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/checklist/casenodes/<casenode-type>/<casenode-id>/
checklist/<checklist-type>/<checlist-id>

4.27.3.2.2 Server accepted request media types

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

4.27.3.2.3 Query parameters

None.

4.27.3.2.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.27.3.2.5 Request body

XML or JSON representation of the checklist resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Checklist Single Type” on page 189), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

184 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.27. xCP Checklist single instance

4.27.3.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.27.3.2.7 Supported response media types

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

4.27.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.27.3.2.9 Response body

XML or JSON representation of the updated checklist resource:

• The type link relation points to the type definition of the checklist resource,
through which you can retrieve a “xCP Checklist Single Type” on page 189.
• Null values are presented as an empty string (“”).

EDCPKL230200-PGR-EN-01 Development Guide 185

Chapter 4 Resources

4.27.3.3 Create a Checklist

Create a checklist resource.

4.27.3.3.1 HTTP method

POST

To create a checklist resource of a certain type, send a POST request to the collection
of checklist resources of that type in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/casenode/<casenode-type>/<casenode-id>/checklist/
<checklist-type>

4.27.3.3.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.27.3.3.3 Query parameters

None.

4.27.3.3.4 Request headers

• Accept

• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.27.3.3.5 Request body

XML or JSON representation of the checklist resource.

• This operation creates a checklist resource with all fields specified in the request.
However, if the request body contains a field that is not presented in the
corresponding DML type (“xCP Checklist Single Type” on page 189), the field is
ignored.

• Unspecified fields are set the default values in Documentum Server.

• To set an existing field to null, use one of the following patterns.

Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

186 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.27. xCP Checklist single instance

4.27.3.3.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.27.3.3.7 Supported response media types

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

4.27.3.3.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.27.3.3.9 Response body

XML or JSON representation of the checklist resource:

• The type link relation points to the type definition of the checklist resource,
through which you can retrieve a “xCP Checklist Single Type” on page 189.
• Null values are presented as an empty string (“”).

EDCPKL230200-PGR-EN-01 Development Guide 187

Chapter 4 Resources

4.27.3.4 Delete a checklist

Delete a checklist resource.

4.27.3.4.1 HTTP method

DELETE

To delete a checklist resource, send a DELETE request to the delete link relation of
the resource with the following pattern:
http://127.0.0.1:8080/<rest-app-name>/casenode/<casenode-type>/<casenode-id>/checklist/
<checklist-type/<checklist-id>

4.27.3.4.2 Query parameters

None.

4.27.3.4.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.27.3.4.4 Request body

None.

4.27.3.4.5 Response headers

None.

4.27.3.4.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

188 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.28. xCP Checklist Single Type

4.27.3.4.7 Response body

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

4.28 xCP Checklist Single Type

A single instance of checklist Type represents the type definition of checklist
instances.

4.28.1 URI template

/types/checklists/checklist-type

4.28.2 Link relation

The following table lists general link relations for a checklist Type resource.

Link relation Description Resource reference

self Type checklist instances “xCP Checklist Single Type”
on page 189

4.28.3 Operations
A checklist Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of checklist
instances.

4.28.3.1 Get a Checklist Type

Retrieve the type definition of checkllist instances of a certain type.

4.28.3.1.1 HTTP method

GET

EDCPKL230200-PGR-EN-01 Development Guide 189

Chapter 4 Resources

4.28.3.1.2 Query parameters

None.

4.28.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.28.3.1.4 Request body

None.

4.28.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.28.3.1.6 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.28.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

190 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.28. xCP Checklist Single Type

4.28.3.1.8 Response body

Response body in JSON

{
"name":"checklist-type",
"type":"utapp21_customerrecord",
"label":"CustomerRecord",
"parent":"types/checklist/xcp_rootsharedbo",
"shareable":"true","properties":
[{
"name":"cust_name",
"label":"cust_name",
"type":"string",
"length":64
},{
"name":"cust_addr",
"label":"cust_addr",
"type":"string",
"length":64,
"repeating":true
},{
"name":"cust_phone",
"label":"cust_phone",
"type":"string",
"length":64
},{
"name":"cust_active",
"label":"cust_active",
"type":"boolean
"},{
"name":"cust_rating",
"label":"cust_rating",
"type":"float"
},{
"name":"cust_enrolldate",
"label":"cust_enrolldate",
"type":"datetime"
},{
"name":"cust_brokerage",
"label":"cust_brokerage",
"type":"integer"
}],

"links":
[{"rel":"self",
"href":"types/checklist/utapp21_customerrecord"
},{
"rel":"http://identifiers.emc.com/linkrel/instances",
"href":"checklist/utapp21_customerrecord"
},{
"rel":"http://identifiers.emc.com/linkrel/defaults",
"href":"types/business-objects/utapp21_customerrecord/defaults"
},{
"rel":"type"
},{
"rel":"edit"
},{
"rel":"canonical"
},{
"rel":"http://identifiers.emc.com/linkrel/delete"
},{
"rel":"http://identifiers.emc.com/linkrel/relations"
},{
"rel":"http://identifiers.emc.com/linkrel/lightweight-objects"
},{
"rel":"http://identifiers.emc.com/linkrel/add-lightweight-objects"
}]}

EDCPKL230200-PGR-EN-01 Development Guide 191

Chapter 4 Resources

4.29 xCP Checklist Type collection

A checklist instances Type collection represents a collection of type definitions for
checklist instances.

4.29.1 URI template

/casenodes/casenode-type/casenode-id/checklists

4.29.2 Feed and EDAA support

A collection of checklist Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
casenodes/
w1_case1/0b00303980174d82/
checklists
Title Checklist w1_case1
Updated Value of the updated 2021-02-22T12:23:47.317Z
property of the last updated
entry in the feed
Author Opentext Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry that contains http://localhost:8080/xcp-rest/
the URI of the feed and name casenodes/
of the type w1_case1/0b00303980174d82/
checklists/
w1_ck1/0800303980174d8c
Title Label of the type that this Sample checklist
entry points to
Summary Label of the type that this Sample checklist
entry points to
Updated Last update time of the 2021-02-22T12:23:47.323Z
instance that this entry points
to

192 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.29. xCP Checklist Type collection

4.29.3 Link relation

The following table lists link relation(s) for a checklist Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Checklist Type
for checklist instances collection” on page 192

4.29.4 Operations
A checklist Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
checklist instances

4.29.4.1 Get a Checklist Type collection

Retrieve a collection of type definitions for checklist instances.

4.29.4.1.1 HTTP method

GET

4.29.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 193

Chapter 4 Resources

4.29.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.29.4.1.4 Request body

None.

4.29.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.29.4.1.6 Supported response media types

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

4.29.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

194 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.30. xCP Comment single instance

4.29.4.1.8 Response body

XML or JSON representation of a collection of type definitions for checklist

instances.

• Each instance may contain all or a set of properties of the type definitions for
checklist instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.30 xCP Comment single instance

A single instance of Comment represents a comment, which can be attached to
business objects, contents, or folders.

4.30.1 URI template

URI for a Comment resource that is attached to a Business Object resource:

/business-objects/business-object-type/business-object-id/comments/
comment-id

business-object-type Type of the business object that this comment

is attached to
business-object-id r_object-id of the business object that this
comment is attached to
comment-id r_object-id of the comment

URI for a Comment resource that is attached to a Content resource:

/contents/content-type/content-id/comments/comment-id

content-type Type of the content that this comment is

attached to
content-id r_object-id of the content that this
comment is attached to
comment-id r_object-id of the comment

URI for a Comment resource that is attached to a Folder resource:

/folders/folder-type/folder-id/comments/comment-id

folder-type Type of the folder that this comment is

attached to
folder-id r_object-id of the folder that this
comment is attached to

EDCPKL230200-PGR-EN-01 Development Guide 195

Chapter 4 Resources

comment-id r_object-id of the comment

4.30.2 Link relation

The following table lists general link relations for a Comment resource.

Link relation Description Resource reference

type Type definition of this “xCP Comment Single Type”
resource on page 207
self This Comment instance “xCP Comment single
instance” on page 195
edit Edit this Comment instance “xCP Comment single
instance” on page 195
delete [1] Delete this Comment “xCP Comment single
instance instance” on page 195
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.30.3 Operations
A Comment resource supports the following HTTP methods.

Method Description
GET Retrieve a Comment resource
POST Update a Comment resource
POST Create a Comment resource
DELETE Delete a Comment resource

4.30.3.1 Get a Comment

Retrieve a Comment resource.

4.30.3.1.1 HTTP method

GET

196 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.30. xCP Comment single instance

4.30.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.30.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.30.3.1.4 Request body

None.

4.30.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.30.3.1.6 Supported response media types

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

4.30.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 197

Chapter 4 Resources

4.30.3.1.8 Response body

XML or JSON representation of the Comment resource.

• The type link relation points to the type definition of the Comment resource,
through which you can retrieve an “xCP Comment Single Type” on page 207.

• Null values are presented as an empty string (“”).

4.30.3.2 Update a Comment

Update a Comment resource.

4.30.3.2.1 HTTP method

POST

To update a Comment resource, send a POST request to the edit link relation of the
resource in one of the following patterns:

• http://127.0.0.1:8080/<xcp-rest>/business-objects/<business-object-type>/<objectID>/
comments/<comment-objectID>

• http://127.0.0.1:8080/<xcp-rest>/contents/<content-type>/<objectID>/
comments/<comment-objectID>

• http://127.0.0.1:8080/<xcp-rest>/folders/<folder-type>/<objectID>/
comments/<comment-objectID>

4.30.3.2.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.30.3.2.3 Query parameters

None.

4.30.3.2.4 Request headers

• Accept
• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

198 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.30. xCP Comment single instance

4.30.3.2.5 Request body

XML or JSON representation of the Comment resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Comment Single Type” on page 207), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

4.30.3.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.30.3.2.7 Supported response media types

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

4.30.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 199

Chapter 4 Resources

4.30.3.2.9 Response body

XML or JSON representation of the updated Comment resource:

• The type link relation points to the type definition of the Comment resource,
through which you can retrieve a “xCP Comment Single Type” on page 207.

• Null values are presented as an empty string (“”).

4.30.3.3 Create a Comment

Create a Comment resource.

4.30.3.3.1 HTTP method

POST

To create a Comment resource, send a POST request to the collection of Comment

resources in one of the following patterns:

• http://127.0.0.1:8080/<xcp-rest>/business-objects/<business-object-type>/<objectID>/
comments

• http://127.0.0.1:8080/<xcp-rest>/contents/<content-type>/<objectID>/
comments

• http://127.0.0.1:8080/<xcp-rest>/folders/<folder-type>/<objectID>/
comments

4.30.3.3.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.30.3.3.3 Query parameters

None.

4.30.3.3.4 Request headers

• Accept
• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

200 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.30. xCP Comment single instance

4.30.3.3.5 Request body

XML or JSON representation of the Comment resource.

• This operation creates a Comment resource with all fields specified in the
request. However, if the request body contains a field that is not presented in the
corresponding DML type (“xCP Comment Single Type” on page 207), the field is
ignored.
• Unspecified fields are set the default values in Documentum Server.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

4.30.3.3.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.30.3.3.7 Supported response media types

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

4.30.3.3.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 201

Chapter 4 Resources

4.30.3.3.9 Response body

XML or JSON representation of the Comment resource:

• The type link relation points to the type definition of the Comment resource,
through which you can retrieve a “xCP Comment Single Type” on page 207.
• Null values are presented as an empty string (“”).

4.30.3.4 Delete a Comment

Delete a Comment resource.

4.30.3.4.1 HTTP method

DELETE

To delete a Comment resource, send a DELETE request to the delete link relation of
the resource with one of the following patterns:

• http://127.0.0.1:8080/<xcp-rest>/business-objects/<business-object-type>/<objectID>/
comments/<comment-objectID>

• http://127.0.0.1:8080/<xcp-rest>/contents/<content-type>/<objectID>/
comments/<comment-objectID>

• http://127.0.0.1:8080/<xcp-rest>/folders/<folder-type>/<objectID>/
comments/<comment-objectID>

4.30.3.4.2 Query parameters

None.

4.30.3.4.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.30.3.4.4 Request body

None.

202 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.31. xCP Comment collection

4.30.3.4.5 Response headers

None.

4.30.3.4.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

4.30.3.4.7 Response body

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

4.31 xCP Comment collection

A Comment collection represents a collection of comments instances, which can be
attached to business objects, contents, or folders.

4.31.1 URI template

URI for a Comment collection that is attached to a Business Object resource:

/business-objects/business-object-type/business-object-id/comments

business-object-type Type of the business object that this comment

is attached to
business-object-id r_object-id of the business object that this
comment is attached to

URI for a Comment collection that is attached to a Content resource:

/contents/content-type/content-id/comments

content-type Type of the content that this comment is

attached to
content-id r_object-id of the content that this
comment is attached to

URI for a Comment collection that is attached to a Folder resource:

/folders/folder-type/folder-id/comments

EDCPKL230200-PGR-EN-01 Development Guide 203

Chapter 4 Resources

folder-type Type of the folder that this comment is

attached to
folder-id r_object-id of the folder that this
comment is attached to

4.31.2 Feed and EDAA support

A collection of Comment instances conforms to Atom Feed in XML representation
and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
business-objects/
ut200_bo_all_attribute/
0800153880008be0/comments
Title Name of the comment type xcp_comments
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties:

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ business-objects/
uri>/<entry_id> ut200_bo_all_attribute/
0800153880008be0/
comments/1268153880005be2
Title object_name of the entry Sample Comment
Summary object_name of the entry Sample Comment
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

204 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.31. xCP Comment collection

4.31.3 Link relation

The following table lists link relation(s) for a Comment collection resource:

Link relation Description Resource reference

self This collection resource “xCP Comment collection”
on page 203
first, last, previous, next Pagination links “xCP Comment collection”
on page 203

4.31.4 Operations
A Comment collection resource supports the following HTTP method:

Method Description
GET Retrieve a collection of Comment instances.

4.31.4.1 Get a Comment collection

Retrieve a collection of Comment instances.

4.31.4.1.1 HTTP method

GET

4.31.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total
• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 205

Chapter 4 Resources

4.31.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.31.4.1.4 Request body

None.

4.31.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.31.4.1.6 Supported response media types

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

4.31.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

206 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.32. xCP Comment Single Type

4.31.4.1.8 Response body

XML or JSON representation of a collection of Comment instances.

• Each instance may contain all or a set of properties of the Comment instance,
depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.32 xCP Comment Single Type

A single instance of Comment Type represents the type definition of Comment
instances.

4.32.1 URI template

/types/comments/comment-type

comment-type Type of the Comment resources.

4.32.2 Link relation

The following table lists general link relations for a Comment Type resource:

Link relation Description Resource reference

self Type definition of Comment “xCP Comment Single Type”
instances on page 207
instances [1] collection of the Comment “xCP Comment collection”
instances on page 203
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.32.3 Operations
A Comment Type resource supports the following HTTP method:

Method Description
GET Retrieve the type definition of Comment
instances

EDCPKL230200-PGR-EN-01 Development Guide 207

Chapter 4 Resources

4.32.3.1 Get a Comment Type

Retrieve the type definition of Comment instances

4.32.3.1.1 HTTP method

GET

4.32.3.1.2 Query parameters

None.

4.32.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.32.3.1.4 Request body

None.

4.32.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.32.3.1.6 Supported response media types

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

4.32.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

208 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.33. xCP Comment Type collection

4.32.3.1.8 Response body

XML or JSON representation of the type definition of Comment instances. The

instances link relation points to a collection of Comment instances, through which
you can retrieve an “xCP Comment collection” on page 203.

4.33 xCP Comment Type collection

A Comment Type collection represents a collection of type definitions for Comment
instances.

4.33.1 URI template

/types/comments

4.33.2 Feed and EDAA support

A collection of Comment Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties:

Feed property Feed value Example

ID URI of the feed http://127.0.0.1:8080/xcp-rest/
types/comments
Title Comments Comments
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties:

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/comments/
and name of the type xcp_comments
Title Name of the comment type xcp_comments
Summary comments comments
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 209

Chapter 4 Resources

4.33.3 Link relation

The following table lists link relation(s) for a Comment Type collection resource:

Link relation Description Resource reference

self Collection of type definitions “xCP Comment Type
for Comment instances collection” on page 209

4.33.4 Operations
A Comment Type collection resource supports the following HTTP method:

Method Description
GET Retrieve a collection of type definitions for
Comment instances

4.33.4.1 Get a Comment collection

Retrieve a collection of type definitions for Comment instances.

4.33.4.1.1 HTTP method

GET

4.33.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

210 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.33. xCP Comment Type collection

4.33.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.33.4.1.4 Request body

None.

4.33.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.33.4.1.6 Supported response media types

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

4.33.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 211

Chapter 4 Resources

4.33.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Comment

instances.

• Each instance may contain all or a set of properties of the type definitions for
Comment instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.34 xCP Content single instance

A single instance of Content is a resource that describes a content. A Content
resource is an instance of a subtype of dm_document.

4.34.1 URI template

/contents/content-type/content-id

content-type Type of the content

content-id r_object-id of the content

4.34.2 Link relation

The following table lists general link relations for a Content resource:

Link relation Description Resource reference

type Type definition of this “xCP Content Single Type”
resource on page 230
instances [1] collection of the Content “xCP Content collection”
instances on page 224
self This Content instance “xCP Content single
instance” on page 212
edit Edit this Content instance “xCP Content single
instance” on page 212
delete [1] Delete this Content instance “xCP Content single
instance” on page 212
checkout [1] Check out this Content “xCP Content single
instance instance” on page 212
comments [1] Comments attached to this “xCP Comment collection”
Content instance on page 203
add-comment Add a comment to this “xCP Content single
Content instance instance” on page 212

212 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.34. xCP Content single instance

Link relation Description Resource reference

download-media [1] Link to the content binary “xCP raw content”
stream for download on page 542
checkin-next-major [1] Check in this Content “xCP Content Single Type”
instance as the next major on page 230
version
checkin-current-version [1] Check in this Content “xCP Content Single Type”
instance as the current on page 230
version
checkin-next-minor [1] Check in this Content “xCP Content Single Type”
instance as the next minor on page 230
version
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.34.3 Operations
A Content resource supports the following HTTP methods:

Method Description
GET Retrieve a Content resource
POST Update a Content resource
DELETE Delete a Content resource
POST Check out a Content resource
POST Check in a Content resource
POST Import a new version to a Content resource

4.34.3.1 Get a Content

Retrieve the current version of a Content resource.

4.34.3.1.1 HTTP method

GET

EDCPKL230200-PGR-EN-01 Development Guide 213

Chapter 4 Resources

4.34.3.1.2 Query parameters

The following query parameter is specific to this operation:

parameter Description Data Type Default

recursive Specifies whether or boolean false
not to list all the
following version
policy-related link
relations in the
response body
regardless of the
content state:
• checkin-next-
major
• checkin-current-
version
• checkin-next-
minor
• checkout

For example, when

this parameter is set
to true, the
checkout link
relation appears even
when the Content
resource is checked
out.

Additionally, this operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.34.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

214 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.34. xCP Content single instance

4.34.3.1.4 Request body

None.

4.34.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.34.3.1.6 Supported response media types

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

4.34.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.34.3.1.8 Response body

XML or JSON representation of the Content resource.

• The type link relation points to the type definition of the Content resource,
through which you can retrieve an “xCP Content Single Type” on page 230.
• Null values are presented as an empty string (“”).

EDCPKL230200-PGR-EN-01 Development Guide 215

Chapter 4 Resources

4.34.3.2 Update a Content

Update the current version of a Content resource.

4.34.3.2.1 HTTP method

POST

To update the current version of a Content resource, send a POST request to the
edit link relation of the resource with the following pattern:
http://127.0.0.1:8080/<rest-app-name>/contents/<content-type>/<objectID>

4.34.3.2.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.34.3.2.3 Query parameters

None.

4.34.3.2.4 Request headers

• Accept

• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.34.3.2.5 Request body

XML or JSON representation of the Content resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Content Single Type” on page 230), the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

216 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.34. xCP Content single instance

4.34.3.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.34.3.2.7 Supported response media types

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

4.34.3.2.8 Response status

201 - Content updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.34.3.2.9 Response body

XML or JSON representation of the updated Content resource:

• The type link relation points to the type definition of the Content resource,
through which you can retrieve a “xCP Content Single Type” on page 230.
• Null values are presented as an empty string (“”).

EDCPKL230200-PGR-EN-01 Development Guide 217

Chapter 4 Resources

4.34.3.3 Delete a Content

Delete a Content resource.

4.34.3.3.1 HTTP method

DELETE

To delete a Content resource, send a DELETE request to the delete link relation of
the resource with the following pattern:
http://127.0.0.1:8080/<rest-app-name>/contents/<content-type>/<objectID>

4.34.3.3.2 Query parameters

None.

4.34.3.3.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.34.3.3.4 Request body

None.

4.34.3.3.5 Response headers

None.

4.34.3.3.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

218 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.34. xCP Content single instance

4.34.3.3.7 Response body

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

4.34.3.4 Check out a Content

Check out a Content resource.

4.34.3.4.1 HTTP method

POST

To check out a Content resource, send a POST request to the checkout link relation
of the resource with the following pattern:
http://127.0.0.1:8080/<rest-app-name>/contents/<content-type>/<objectID>/lock

4.34.3.4.2 Server accepted request media types

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

4.34.3.4.3 Query parameters

None.

4.34.3.4.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.34.3.4.5 Request body

XML or JSON representation of the Content resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Content Single Type” on page 230), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

EDCPKL230200-PGR-EN-01 Development Guide 219

Chapter 4 Resources

4.34.3.4.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.34.3.4.7 Supported response media types

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

4.34.3.4.8 Response status

201 - Content checked out successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.34.3.4.9 Response body

XML or JSON representation of the updated Content resource:

• The type link relation points to the type definition of the Content resource,
through which you can retrieve a “xCP Content Single Type” on page 230.
• Null values are presented as an empty string (“”).

220 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.34. xCP Content single instance

4.34.3.5 Check in a Content

Check in a Content resource or import a new version to a Content resource.

This operation contains the following steps:

1. Upload a content by posting an “xCP File Upload Resource” on page 238.

When a content instance is successfully uploaded, the REST server returns the
201 Created status code. Additionally, the return message contains the Location
header which indicates the URI of the file uploaded.
2. Send a POST request specifying the metadata of the content to one of the
checkin link relations of the resource with the following pattern:
http://127.0.0.1:8080/<rest-app-name>/contents/<content-type>/<objectID>/<check-in-
option>

<check-in-option> can be one of the followings:

• checkin-current-version
• checkin-next-major
• checkin-next-minor

Notes

• The request body must contain a reference to the content you uploaded by
using the “xCP File Upload Resource” on page 238 resource. To do this,
specify the full or relative URI of the uploaded content in source.

Example 4-12: XML Sample

<?xml version="1.0" encoding="UTF-8"?>
<content xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ut200_content_with_attrs">
<properties>
<r_version_label>CURRENT<r_version_label>
</properties>
<source>http://127.0.0.1:8080/xcp-rest/files/
d6e9ac3a-72a9-4262-ba30-398f4f701ac6</source>
</content>

Example 4-13: JSON Sample

{
"properties":
{ "r_version_label": [ "CURRENT" ] }
,
"source":"/files/680884ca-c104-4513-afde-aedc686ff3c3"
}

• To import a new version to a Content resource, append ?retain-lock=true

to the URL of the request. By doing this, the Content remains locked
(checked out), and a new version is imported to the Content resource.

EDCPKL230200-PGR-EN-01 Development Guide 221

Chapter 4 Resources

4.34.3.5.1 HTTP method

POST

4.34.3.5.2 Server accepted request media types

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

4.34.3.5.3 Query parameters

The following query parameter is specific to this operation:

Parameter Description Data Type Default

retain-lock Specifies whether or boolean false
not to retain the lock
on the Content
resource in a checkin
operation.

If you set this

parameter to true,
the Content resource
remains locked
(checked out), and a
new version is
imported to the
Content resource.

4.34.3.5.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.34.3.5.5 Request body

The request body contains a reference to the file you uploaded by using the “xCP
File Upload Resource” on page 238 resource and the metadata of the Content
resource.

222 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.34. xCP Content single instance

4.34.3.5.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.34.3.5.7 Supported response media types

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

4.34.3.5.8 Response status

201 - Content checked in successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.34.3.5.9 Response body

XML or JSON representation of the Content resource that you check in:

• The type link relation points to the type definition of the Content resource,
through which you can retrieve a “xCP Content Single Type” on page 230.
• Null values are presented as an empty string (“”).

EDCPKL230200-PGR-EN-01 Development Guide 223

Chapter 4 Resources

4.35 xCP Content collection

A Content collection represents a collection of Content instances.

4.35.1 URI template

/contents/content-type

content-type Type of the content

4.35.2 Feed and EDAA support

A collection of Content instances conforms to Atom Feed in XML representation and
EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
contents/test-content
Title Name of content type test content type
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ contents/test-content/
uri>/<entry_id> 186923apt7
Title Content name testContent.txt
Summary Content name testContent.txt
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

224 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.35. xCP Content collection

4.35.3 Link relation

The following table lists link relation(s) for a Content collection resource.

Link relation Description Resource reference

self This collection resource “xCP Content collection”
on page 224
first, last, previous, next Pagination links “xCP Content collection”
on page 224

4.35.4 Operations
A Content collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Content instances.
POST Create a Content instance.

4.35.4.1 Get a Content collection

Retrieve a collection of Content instances.

4.35.4.1.1 HTTP method

GET

4.35.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 225

Chapter 4 Resources

4.35.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.35.4.1.4 Request body

None.

4.35.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.35.4.1.6 Supported response media types

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

4.35.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

226 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.35. xCP Content collection

4.35.4.1.8 Response body

XML or JSON representation of a collection of Content instances.

• Each instance may contain all or a set of properties of the Content instance,
depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.35.4.2 Create a Content

You can create a Content resource from scratch or from a Template resource in your
home cabinet or in a folder.

Create a Content from scratch

To create a Content resource of a certain type from scratch, follow these steps:

1. Upload a content by posting an “xCP File Upload Resource” on page 238.

When a content instance is successfully uploaded, the REST server returns the
201 Created status code. Additionally, the return contains the Location header
which indicates the URI of the file uploaded.
2. Send a POST request specifying the metadata of the content to a collection of
Content resources of that type in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/contents/<content-type>

Notes

• The request body must contain a reference to the content you uploaded by
using the “xCP File Upload Resource” on page 238 resource. To do this,
specify the full or relative URI of the uploaded content in source.

Example 4-14: XML Sample

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

<content xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ut200_content_with_attrs">
<properties>
<r_version_label>CURRENT<r_version_label>
</properties>
<source>http://127.0.0.1:8080/xcp-rest/files/
d6e9ac3a-72a9-4262-ba30-398f4f701ac6</source>
</content>

Example 4-15: JSON Sample

{
"properties": {
"source":"/files/680884ca-c104-4513-afde-aedc686ff3c3"

EDCPKL230200-PGR-EN-01 Development Guide 227

Chapter 4 Resources

}
}

• Alternatively, you can create the Content resource under a specified folder
by sending the POST request to the objects link relation of the Folder
resource in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/folders/<folder-type>/<foder-id>/objects

Create a Content from template

To create a Content resource from a Template resource, send a POST request

specifying the metadata of the content to either your home document or the objects
link relation of a Folder resource. The request body must contain a reference to the
corresponding “xCP Template Single instance” on page 508 resource. To do this,
specify the full or relative URI of the Template resource in source.

Example 4-16: XML Sample

<?xml version="1.0" encoding="UTF-8"?>
<content xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ut200_content_with_attrs">
<properties>
<r_version_label>CURRENT<r_version_label>
</properties>
<source>http://127.0.0.1:8080/xcp-rest/files/
d6e9ac3a-72a9-4262-ba30-398f4f701ac6</source>
</content>

Example 4-17: JSON Sample

{
"properties":
{ "r_version_label": [ "CURRENT" ] }
,
"source":"/files/680884ca-c104-4513-afde-aedc686ff3c3"
}

4.35.4.2.1 HTTP method

POST

228 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.35. xCP Content collection

4.35.4.2.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.35.4.2.3 Query parameters

None.

4.35.4.2.4 Request headers

• Accept

• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.35.4.2.5 Request body

The request body contains the following:

• A reference to the file you uploaded by using the “xCP File Upload Resource”
on page 238 resource or a reference to a Template resource (“xCP Template
Single instance” on page 508)

• The metadata of the Content resource

4.35.4.2.6 Response headers

• Location
• Content-Length

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.35.4.2.7 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.documentum+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

EDCPKL230200-PGR-EN-01 Development Guide 229

Chapter 4 Resources

4.35.4.2.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.35.4.2.9 Response body

XML or JSON representation of the Content resource:

• The type link relation points to the type definition of the Content resource,
through which you can retrieve a “xCP Content Single Type” on page 230.
• Null values are presented as an empty string (“”).

4.36 xCP Content Single Type

A single instance of Content Type represents the type definition of Content
instances.

4.36.1 URI template

/types/contents/content-type

content-type Type of the Content

4.36.2 Link relation

The following table lists general link relations for a Content Type resource.

Link relation Description Resource reference

self Type definition of Content “xCP Content Single Type”
instances on page 230
instances [1] collection of the Content “xCP Content collection”
instances on page 224
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

230 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.36. xCP Content Single Type

4.36.3 Operations
A Content Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Content
instances

4.36.3.1 Get a Content Type

Retrieve the type definition of Content instances.

4.36.3.1.1 HTTP method

GET

4.36.3.1.2 Query parameters

None.

4.36.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.36.3.1.4 Request body

None.

4.36.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.36.3.1.6 Supported response media types

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

EDCPKL230200-PGR-EN-01 Development Guide 231

Chapter 4 Resources

4.36.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.36.3.1.8 Response body

XML or JSON representation of the type definition of Content instances. The

instances link relation points to a collection of Content instances, through which
you can retrieve an “xCP Content collection” on page 224.

4.37 xCP Content Type collection

A Content Type collection represents a collection of type definitions for Content
instances.

4.37.1 URI template

/types/contents

4.37.2 Feed and EDAA support

A collection of Content Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/contents
Title Name of Feed Contents
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

232 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.37. xCP Content Type collection

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/contents/
and name of the type testContentType
Title Content type testContentType
Summary Content Summary test content type
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.37.3 Link relation

The following table lists link relation(s) for a Content Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Content Type
for Content instances collection” on page 232

4.37.4 Operations
A Content Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Content instances

4.37.4.1 Get a Content Type collection

Retrieve a collection of type definitions for Content instances.

4.37.4.1.1 HTTP method

GET

4.37.4.1.2 Query parameters

This operation supports the following common query parameters:

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

EDCPKL230200-PGR-EN-01 Development Guide 233

Chapter 4 Resources

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.37.4.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.37.4.1.4 Request body

None.

4.37.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.37.4.1.6 Supported response media types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.37.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

234 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.38. xCP Current User Instance

4.37.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Content instances.

• Each instance may contain all or a set of properties of the type definitions for
Content instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.38 xCP Current User Instance

An instance of Current User is a resource that describes the current user together
with the authentication token in the request.

4.38.1 URI template

/currentuser

4.38.2 Link relation

The following table lists general link relations for a Current User resource.

Link relation Description Resource reference

type Type definition of this “xCP Member Single Type”
resource on page 369
preferences [1] Preferences of the current “xCP user preference single
user instance” on page 519
self This Current User instance “xCP Current User Instance”
on page 235
roles [1] Application roles to which “xCP Member collection”
this Current User instance on page 361
belongs
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

EDCPKL230200-PGR-EN-01 Development Guide 235

Chapter 4 Resources

4.38.3 Operations
A Current User resource supports the following HTTP method.

Method Description
GET Retrieve a Current User resource.
GET Retrieve preferences from a Current User
resource. See “xCP user preference single
instance” on page 519.
GET Retrieve application roles to which a current
user belongs. See “xCP Member collection”
on page 361.

4.38.3.1 Get the Current User

Retrieve the metadata, type definition, and preferences of the current user.

4.38.3.1.1 HTTP method

GET

4.38.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.38.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

236 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.38. xCP Current User Instance

4.38.3.1.4 Request body

None.

4.38.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.38.3.1.6 Supported response media types

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

4.38.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.38.3.1.8 Response body

XML or JSON representation of the Current User resource.

• The type link relation points to the type definition of the Current User resource,
through which you can retrieve an “xCP Member Single Type” on page 369.
• Null values are presented as an empty string (“”).

EDCPKL230200-PGR-EN-01 Development Guide 237

Chapter 4 Resources

4.39 xCP File Upload Resource

A File Upload resource enables a client to upload a file to a temporary folder and
obtain the URI of the newly-uploaded file. This resource is used in the content
creation operation (“Create a Content” on page 227).

4.39.1 URI template

/files

4.39.2 Link relation

This resource does not contain any link relation.

4.39.3 Operations
A File Upload resource supports the following HTTP method.

Method Description
POST Upload a file to a temporary folder

4.39.3.1 Upload a File

Upload a file to a temporary folder.

4.39.3.1.1 HTTP method

POST

4.39.3.1.2 Query parameters

None.

4.39.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

238 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.39. xCP File Upload Resource

4.39.3.1.4 Request body

This operation requires a multipart request. The file content is included in the
request body.

Example 4-18: File Upload Request

http://127.0.0.1:8000/xCP-App/files
Content-Type: multipart/form-data; boundary=314159265358979
--314159265358979
Content-Disposition: form-data; name=metadata
Content-Type: application/vnd.emc.documentum+json
{"properties": {"object_name": "xcp-rest"}}
--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain
This is the content
--314159265358979--

Example 4-19: JSON Sample

var dataToAdd = {
"properties": {
"object_name":files[0].name
},
"source":"/files/680884ca-c104-4513-afde-aedc686ff3c3"
};

4.39.3.1.5 Response headers

• Location

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.39.3.1.6 Supported response media types

multipart/form-data

4.39.3.1.7 Response status

201 - Content uploaded successfully

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 239

Chapter 4 Resources

4.39.3.1.8 Response body

This operation returns the Location header which indicates the URI of the file
uploaded. For example:
/files/680884ca-c104-4513-afde-aedc686ff3c3

When a file is being uploaded:

• The file is renamed with the UUID (in the preceding example, 680884ca-
c104-4513-afde-aedc686ff3c3) to avoid collisions with other users that
upload files with the same name.
• A property file is created with the UUID as the file name (in the preceding
example, 680884ca-c104-4513-afde-aedc686ff3c3.properties). This
property file records the original file name and the user who uploads the content
file.

Note: The newly-uploaded file is only visible to the use who uploads it.

In addition to the Location header, this operation also returns a feed response, which
is designed for clients that are unable to read the headers. These clients can obtain
the location of the newly-uploaded file from the id property in entries.
{
"id": "files",
"title": "",
"updated": "2013-10-15T14:20:00.168-07:00",
"author": "OpenText Documentum",
"links": [{
"rel": "self",
"href": "files"
}],
"entries": [{
"id": "files/680884ca-c104-4513-afde-aedc686ff3c3",
"title": "dfc.properties",
"updated": "2013-10-15T14:20:00.168-07:00",
"summary": "dfc.properties",
"content": {
"src": "files/680884ca-c104-4513-afde-aedc686ff3c3",
"content-type": "application/vnd.emc.xcp+json"
},
"links": [{
"rel": "edit",
"href": "files/680884ca-c104-4513-afde-aedc686ff3c3"
}]
}]
}

240 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.40. xCP Folder single instance

4.39.3.2 Location of the Uploaded File

You can specify the location where xCP RESTful Services uploads files by using the
content-staging-location parameter in server-configuration.properties. If
this parameter is not set, the file is uploaded to the Java temporary folder, which can
be specified by using the java.io.tmpdir system parameter.

4.39.3.3 Lifecycle of the Uploaded File

The lifecycle of a temporary file depends on the status of the content creation
operation that utilizes the uploaded file.

• If the client application completes the content creation operation successfully,

xCP RESTful Services automatically deletes the uploaded file.
• If the client application terminates the content creation operation before
completion, the client application has to invoke an HTTP DELETE on the
temporary file resource to remove the uploaded file.
• If content creation operation is accidentally terminated, xCP RESTful Services
does not automatically delete the uploaded file. You must execute a cleanup
script to delete orphan files.

4.40 xCP Folder single instance

A single instance of Folder represents a folder, which is an instance of dm_folder or
one of its subtypes.

4.40.1 URI template

/folders/folder-type/folder-id

folder-type Type of the folder

folder-id Object ID of the folder

4.40.2 Link relation

The following table lists general link relations for a Folder resource.

Link relation Description Resource reference

type Type definition of this “xCP Folder Single Type”
resource on page 254
instances [1] collection of the Folder “xCP Folder Type collection”
instances on page 256
self This instance “xCP Folder single instance”
on page 241
edit Edit this instance “xCP Folder single instance”
on page 241

EDCPKL230200-PGR-EN-01 Development Guide 241

Chapter 4 Resources

Link relation Description Resource reference

delete [1] Delete this instance “xCP Folder single instance”
on page 241
comments [1] Comments attached to the “xCP Comment collection”
Folder instance on page 203
add Add an instance of an object “xCP Folder single instance”
inside this Folder instance on page 241
add-comment Add a comment to the Folder “xCP Folder single instance”
instance on page 241
objects [1] Objects in the Folder instance “xCP Content collection”
on page 224
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.40.3 Operations
A Folder resource supports the following HTTP methods.

Method Description
GET Retrieve a Folder resource
GET Retrieve the objects in a Folder resource
POST Update a Folder resource
POST Create a Folder resource
POST Copy a document to a Folder resource
POST Move a document to a Folder resource
DELETE Delete a Folder resource

4.40.3.1 Get a Folder

Retrieve the metadata of a Folder resource. Other information, such as the comments
attached to the folder and objects in the folder, is presented in the link relations.

242 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.40. xCP Folder single instance

4.40.3.1.1 HTTP method

GET

4.40.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.40.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.40.3.1.4 Request body

None.

4.40.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.40.3.1.6 Supported response media types

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

EDCPKL230200-PGR-EN-01 Development Guide 243

Chapter 4 Resources

4.40.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.40.3.1.8 Response body

XML or JSON representation of the Folder resource.

• The type link relation points to the type definition of the Folder resource,
through which you can retrieve an “xCP Folder Single Type” on page 254.
• Null values are presented as an empty string (“”).

4.40.3.2 Update a Folder

Update a Folder resource.

4.40.3.2.1 HTTP method

POST

4.40.3.2.2 Server accepted request media types

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

4.40.3.2.3 Query parameters

None.

4.40.3.2.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

244 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.40. xCP Folder single instance

4.40.3.2.5 Request body

XML or JSON representation of the Folder resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Folder Single Type” on page 254), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

4.40.3.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.40.3.2.7 Supported response media types

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

4.40.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 245

Chapter 4 Resources

4.40.3.2.9 Response body

XML or JSON representation of the updated Folder resource:

• The type link relation points to the type definition of the Folder resource,
through which you can retrieve a “xCP Folder Single Type” on page 254.
• Null values are presented as an empty string (“”).

4.40.3.3 Create a Folder

Create a Folder resource.

4.40.3.3.1 HTTP method

POST

To create a Folder resource of a certain type, send a POST request to the collection of
Folder resources of that type in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/folders/<folder-type>

4.40.3.3.2 Server accepted request media types

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

4.40.3.3.3 Query parameters

None.

4.40.3.3.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

246 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.40. xCP Folder single instance

4.40.3.3.5 Request body

XML or JSON representation of the Folder resource.

• The request body must contain the object_name of the folder. A minimal request
body resembles the following samples:

Example 4-20: Minimal Request body in XML

<?xml version="1.0" encoding="UTF-8"?>
<dm:folder xmlns:dm="http://identifiers.emc.com/vocab/xcp">
<dm:properties>
<dm:object_name>AAA</dm:object_name>
</dm:properties>
</dm:folder>

Example 4-21: Minimal Request body in JSON

{
"properties" : {
"object_name" : "BBB"
}
}

• If a folder with the same name exists in the same location, the request fails.
• This operation creates a Folder resource with all fields specified in the request.
However, if the request body contains a field that is not presented in the
corresponding DML type (“xCP Folder Single Type” on page 254), the field is
ignored.
• Unspecified fields are set the default values in Documentum Server.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

4.40.3.3.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 247

Chapter 4 Resources

4.40.3.3.7 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.documentum+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.40.3.3.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.40.3.3.9 Response body

XML or JSON representation of the Folder resource:

• The type link relation points to the type definition of the Folder resource,
through which you can retrieve a “xCP Folder Single Type” on page 254.

• Null values are presented as an empty string (“”).

4.40.3.4 Copy a Document to a Folder

Copy a document (a Content instance) to a folder by using the objects link relation.

4.40.3.4.1 HTTP method

POST

To copy a Content instance to a Folder instance, send a POST request to the objects
link relation of the Folder instance in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/folders/<folder-type>/<folder-type-id>/objects

248 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.40. xCP Folder single instance

4.40.3.4.2 Server accepted request media types

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

4.40.3.4.3 Query parameters

None.

4.40.3.4.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.40.3.4.5 Request body

A reference to the Content instance to copy.

{
"href":"/contents/<content-type>/<content-id>"
}

For example:
{
"href":"/contents/contents/dm_document/0900492d80012f02"
}

4.40.3.4.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 249

Chapter 4 Resources

4.40.3.4.7 Supported response media types

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

4.40.3.4.8 Response status

201 - Object copied successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.40.3.4.9 Response body

XML or JSON representation of the Folder resource. You can find the copied Content
instance by accessing the objects link relation of the Folder instance. The copied
Content instance (2901492f80012f44) is listed under the entries section as shown
in the following example.

Example 4-22: Objects in Folder

{
id: "folders/utapp21_proc_folder/0b00492d80012ee5/objects"
title: "utapp21_proc_folder"
updated: "2013-12-19T12:03:01.166+08:00"
author: "OpenText Documentum"
links:
{
rel: "self"
href: "folders/utapp21_proc_folder/0b00492d80012ee5/objects"
}

entries:
{
id: "contents/dm_document/2901492f80012f44"
title: "utapp21_folder_all_attrs-child-26950"
updated: "2014-02-07T12:28:06.000+08:00"
summary: "dm_bpm_XCPAutoTaskMgmt1"
content: {
src: "contents/dm_document/2901492f80012f44"
content-type: "application/vnd.emc.xcp+json"
}
links:
{
rel: "edit"

250 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.40. xCP Folder single instance

href: "contents/dm_document/2901492f80012f44"
}
}

{
id: "contents/dm_document/0900492d80012f02"
title: "12/19/2013 11:25:13 AM dm_bpm_XCPAutoTaskMgmt"
updated: "2013-12-19T12:02:43.000+08:00"
summary: "dm_bpm_XCPAutoTaskMgmt2"
content:
{
src: "contents/dm_document/0900492d80012f02"
content-type: "application/vnd.emc.xcp+json"
}
links:
{
rel: "edit"
href: "contents/dm_document/0900492d80012f02"
}
}
}

4.40.3.5 Move a Document to a Folder

Move a document (a Content instance) to a folder by using the objects link relation.

4.40.3.5.1 HTTP method

POST

To move a Content instance to a Folder instance, send a POST request to the

objects link relation of the Folder instance in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/folders/<folder-type>/<folder-id>/objects

4.40.3.5.2 Server accepted request media types

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

4.40.3.5.3 Query parameters

None.

EDCPKL230200-PGR-EN-01 Development Guide 251

Chapter 4 Resources

4.40.3.5.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.40.3.5.5 Request body

The request body contains the following elements:

• Reference to the original location of the Content instance

• Reference to the Content instance to move

{
"source":"/folders/<folder-type>/<folder-id>",
"href":"/contents/<content-type>/<content-id>"
}

4.40.3.5.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.40.3.5.7 Supported response media types

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

252 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.40. xCP Folder single instance

4.40.3.5.8 Response status

201 - Object moved successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.40.3.5.9 Response body

XML or JSON representation of the Folder resource. You can find the moved
Content instance by accessing the objects link relation of the Folder instance. The
moved Content instance is listed under the entries section as shown in the example
Example 4-22, “Objects in Folder” on page 250.

4.40.3.6 Delete a Folder

Delete a Folder resource.

4.40.3.6.1 HTTP method

DELETE

To delete a Folder resource, send a DELETE request to the delete link relation of
the resource with the following pattern:
http://127.0.0.1:8080/<xcp-rest-app>/folders/<folder-type>/<folder-id>

4.40.3.6.2 Query parameters

None.

4.40.3.6.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 253

Chapter 4 Resources

4.40.3.6.4 Request body

None.

4.40.3.6.5 Response headers

None.

4.40.3.6.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

4.40.3.6.7 Response body

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

4.41 xCP Folder Single Type

A single instance of Folder Type represents the type definition of Folder instances.

4.41.1 URI template

/types/folders/folder-type

folder-type Type of the folder

4.41.2 Link relation

The following table lists general link relations for a Folder Type resource.

Link relation Description Resource reference

type Type definition of Folder “xCP Folder Single Type”
instances on page 254
instances [1] collection of the Folder “xCP Folder Type collection”
instances on page 256
defaults [1] Defaults of the type “xCP Folder Single Type”
definition on page 254

254 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.41. xCP Folder Single Type

Link relation Description Resource reference

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.41.3 Operations
A Folder Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Folder
instances

4.41.3.1 Get a Folder Type

Retrieve the type definition of Folder instances.

4.41.3.1.1 HTTP method

GET

4.41.3.1.2 Query parameters

None.

4.41.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.41.3.1.4 Request body

None.

4.41.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 255

Chapter 4 Resources

4.41.3.1.6 Supported response media types

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

4.41.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.41.3.1.8 Response body

XML or JSON representation of the type definition of Folder instances. The

instances link relation points to a collection of Folder instances, through which you
can retrieve an “xCP Folder Type collection” on page 256.

4.42 xCP Folder Type collection

A Folder Type collection represents a collection of type definitions for Folder
instances.

4.42.1 URI template

/types/folders

4.42.2 Feed and EDAA support

A collection of Folder Type instances conforms to Atom Feed in XML representation
and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/folders
Title Folders Folders

256 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.42. xCP Folder Type collection

Feed property Feed value Example

Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed folders/test-folder-type
and name of the type
Title Folder type test-folder-type
Summary Summary folder-summary
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.42.3 Link relation

The following table lists link relation(s) for a Folder Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Folder Type collection”
for Folder instances on page 256

4.42.4 Operations
A Folder Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Folder instances

4.42.4.1 Get a Folder Type collection

Retrieve a collection of type definitions for Folder instances.

EDCPKL230200-PGR-EN-01 Development Guide 257

Chapter 4 Resources

4.42.4.1.1 HTTP method

GET

4.42.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.42.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.42.4.1.4 Request body

None.

4.42.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

258 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.43. xCP Case Node single instance

4.42.4.1.6 Supported response media types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.42.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.42.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Folder instances.

• Each instance may contain all or a set of properties of the type definitions for
Folder instances, depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.43 xCP Case Node single instance

A single instance of case node represents a case, which is an instance of sub type of
xcp_basecase

4.43.1 URI template

/casenodes/casenode-type/casenode-id

casenode-type Type of the case node

casenode-id Object Id of the case node

EDCPKL230200-PGR-EN-01 Development Guide 259

Chapter 4 Resources

4.43.2 Link relation

The following table lists general link relations for a case node resource.

Link relation Description Resource reference

type Type definition of this “xCP Case Node Single
resource Type” on page 271
instances [1] collection of the case node “xCP Case Node Type
instances collection” on page 274
self This instance “xCP Case Node single
instance” on page 259
edit Edit this instance “xCP Case Node single
instance” on page 259
delete [1] Delete this instance “xCP Case Node single
instance” on page 259
comments [1] Comments attached to the “xCP Comment collection”
case node instance on page 203
add Add an instance of an object “xCP Case Node single
inside this case node instance instance” on page 259
add-comment Add a comment to the case “xCP Case Node single
node instance instance” on page 259
objects [1] Objects in the case node “xCP Content collection”
instance on page 224
checklist[1] Checklists associated with “xCP Checklist Type
the case node instance collection” on page 192
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.opentext.com/linkrel/

4.43.3 Operations
A case node resource supports the following HTTP methods.

Method Description
GET Retrieve a case node resource
GET Retrieve the objects in a case node resource
POST Update a case node resource
POST Create a case node resource
POST Copy a document to a case node resource
POST Move a document to a case node resource
DELETE Delete a case node resource

260 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.43. xCP Case Node single instance

4.43.3.1 Get a case node

Retrieve the metadata of a case node resource. Other information, such as the
comments attached to the case node and objects in the case node, is presented in the
link relations.

4.43.3.1.1 HTTP method

GET

4.43.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.43.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.43.3.1.4 Request body

None.

4.43.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.43.3.1.6 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

EDCPKL230200-PGR-EN-01 Development Guide 261

Chapter 4 Resources

4.43.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.43.3.1.8 Response body

XML or JSON representation of the case node resource.

• The type link relation points to the type definition of the case node resource,
through which you can retrieve an “xCP Case Node Single Type” on page 271.
• Null values are presented as an empty string (“”).

4.43.3.2 Update a case node

Update a case node resource.

4.43.3.2.1 HTTP method

POST

4.43.3.2.2 Server accepted request media types

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

4.43.3.2.3 Query parameters

None.

4.43.3.2.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

262 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.43. xCP Case Node single instance

4.43.3.2.5 Request body

XML or JSON representation of the case node resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Case Node Single Type” on page 271), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

4.43.3.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.43.3.2.7 Supported response media types

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

4.43.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 263

Chapter 4 Resources

4.43.3.2.9 Response body

XML or JSON representation of the updated case node resource:

• The type link relation points to the type definition of the case node resource,
through which you can retrieve a “xCP Case Node Single Type” on page 271.
• Null values are presented as an empty string (“”).

4.43.3.3 Create a case node

Create a case node resource.

4.43.3.3.1 HTTP method

POST

To create a case node resource of a certain type, send a POST request to the
collection of case node resources of that type in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/casenodes/<casenode-type>

4.43.3.3.2 Server accepted request media types

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

4.43.3.3.3 Query parameters

None.

4.43.3.3.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

264 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.43. xCP Case Node single instance

4.43.3.3.5 Request body

XML or JSON representation of the case node resource.

• The request body must contain the object_name of the case node. A minimal
request body resembles the following samples:

Example 4-23: Minimal Request body in XML

<?xml version="1.0" encoding="UTF-8"?>
<dm:casenodes xmlns:dm="http://identifiers.emc.com/vocab/xcp">
<dm:properties>
<dm:object_name>AAA</dm:object_name>
</dm:properties>
</dm:casenodes>

Example 4-24: Minimal Request body in JSON

{
"properties" : {
"object_name" : "BBB"
}
}

• If a case node with the same name exists in the same location, the request fails.
• This operation creates a case node resource with all fields specified in the
request. However, if the request body contains a field that is not presented in the
corresponding DML type (“xCP Case Node Single Type” on page 271), the field
is ignored.
• Unspecified fields are set the default values in Documentum Server.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

4.43.3.3.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 265

Chapter 4 Resources

4.43.3.3.7 Supported response media types

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

4.43.3.3.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.43.3.3.9 Response body

XML or JSON representation of the case node resource:

• The type link relation points to the type definition of the case node resource,
through which you can retrieve a “xCP Case Node Single Type” on page 271.
• Null values are presented as an empty string (“”).

4.43.3.4 Copy a Document to a case node

Copy a document (a Content instance) to a case node by using the objects link
relation.

Note: A case node can only have case data node instances.

266 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.43. xCP Case Node single instance

4.43.3.4.1 HTTP method

POST

To copy a case data node instance to a case node instance, send a POST request to
the objects link relation of the case node instance in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/casenodes/<casenode-type>/<casenode-type-id>/
objects

4.43.3.4.2 Server accepted request media types

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

4.43.3.4.3 Query parameters

None.

4.43.3.4.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.43.3.4.5 Request body

A reference to the case data node instance to copy.

{
"href":"/casedatanodes/<casedatanode-type>/<casedatanode-id>"
}

For example:
{
"href":"/casedatanodes/loan_property/dm_document/0900492d80012f02"
}

4.43.3.4.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 267

Chapter 4 Resources

4.43.3.4.7 Supported response media types

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

4.43.3.4.8 Response status

201 - Object copied successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.43.3.4.9 Response body

XML or JSON representation of the case node resource. You can find the copied case
data node instance by accessing the objects link relation of the case node instance.
The copied case data node instance (2901492f80012f44) is listed under the entries
section.

4.43.3.5 Move a case data node to a case node

Move a case data node (a case data node instance) to a case node by using the
objects link relation.

4.43.3.5.1 HTTP method

POST

To move a case data node instance to a case node instance, send a POST request to
the objects link relation of the case node instance in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/casenodes/<casenode-type>/<casenode-id>/objects

268 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.43. xCP Case Node single instance

4.43.3.5.2 Server accepted request media types

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

4.43.3.5.3 Query parameters

None.

4.43.3.5.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.43.3.5.5 Request body

The request body contains the following elements:

• Reference to the original location of the case data node instance

• Reference to the case data node instance to move

{
"source":"/casenodes/<casenode-type>/<casenode-id>",
"href":"/casenodes/<casenode-type>/<casenode-id>"
}

4.43.3.5.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 269

Chapter 4 Resources

4.43.3.5.7 Supported response media types

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

4.43.3.5.8 Response status

201 - Object moved successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.43.3.5.9 Response body

XML or JSON representation of the case node resource. You can find the moved case
data node instance by accessing the objects link relation of the case node instance.
The moved case data node instance is listed under the entries section as shown in
the example Example 4-22, “Objects in Folder” on page 250.

4.43.3.6 Delete a case node

Delete a case node resource.

4.43.3.6.1 HTTP method

DELETE

To delete a case node resource, send a DELETE request to the delete link relation of
the resource with the following pattern:
http://127.0.0.1:8080/<xcp-rest-app>/casenodes/<casenode-type>/<casenode-id>

270 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.44. xCP Case Node Single Type

4.43.3.6.2 Query parameters

None.

4.43.3.6.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.43.3.6.4 Request body

None.

4.43.3.6.5 Response headers

None.

4.43.3.6.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

4.43.3.6.7 Response body

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

4.44 xCP Case Node Single Type

A single instance of case node type represents the type definition of case node
instances.

EDCPKL230200-PGR-EN-01 Development Guide 271

Chapter 4 Resources

4.44.1 URI template

/types/casenodes/casenode-type

casenode-type Type of the case node

4.44.2 Link relation

The following table lists general link relations for a case node Type resource.

Link relation Description Resource reference

type Type definition of case node “xCP Case Node Single
instances Type” on page 271
instances [1] collection of the case node “xCP Folder Type collection”
instances on page 256
defaults [1] Defaults of the type “xCP Case Node Single
definition Type” on page 271
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.44.3 Operations
A Case Node Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of case node
instances

4.44.3.1 Get a Case Node Type

Retrieve the type definition of case node instances.

4.44.3.1.1 HTTP method

GET

272 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.44. xCP Case Node Single Type

4.44.3.1.2 Query parameters

None.

4.44.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.44.3.1.4 Request body

None.

4.44.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.44.3.1.6 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.44.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 273

Chapter 4 Resources

4.44.3.1.8 Response body

XML or JSON representation of the type definition of case node instances. The
instances link relation points to a collection of case node instances, through which
you can retrieve an “xCP Case Node Type collection” on page 274.

4.45 xCP Case Node Type collection

A case node type collection represents a collection of type definitions for case node
instances.

4.45.1 URI template

/types/casenodes

4.45.2 Feed and EDAA support

A collection of case node type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/casenodes
Title Case Node Case Node
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed casenodes/test-casenode-type
and name of the type
Title case node type test-casenode-type
Summary Summary folder-summary
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

274 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.45. xCP Case Node Type collection

4.45.3 Link relation

The following table lists link relation(s) for a case node type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Case Node Type
for case node instances collection” on page 274

4.45.4 Operations
A Case Node Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
case node instances

4.45.4.1 Get a Case Node Type collection

Retrieve a collection of type definitions for case node instances.

4.45.4.1.1 HTTP method

GET

4.45.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 275

Chapter 4 Resources

4.45.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.45.4.1.4 Request body

None.

4.45.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.45.4.1.6 Supported response media types

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

4.45.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

276 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.46. xCP Case Data Node single instance

4.45.4.1.8 Response body

XML or JSON representation of a collection of type definitions for case node

instances.

• Each instance may contain all or a set of properties of the type definitions for case
node instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.46 xCP Case Data Node single instance

A single instance of Case data node represents a case data node, which is an instance
of dm_folder or its subtypes.

4.46.1 URI template

/casedatanodes/casedatanode-type/casedatanode-id

casedatanode-type Type of the case data node

casedatanode-id Object Id of the case data node

4.46.2 Link relation

The following table lists general link relations for a case data node resource.

Link relation Description Resource reference

type Type definition of this “xCP Case Data Node Single
resource Type” on page 289
instances [1] collection of the case data “xCP Folder Type collection”
node instances on page 256
self This instance “xCP Case Data Node Single
Type” on page 289
edit Edit this instance “xCP Case Data Node single
instance” on page 277
delete [1] Delete this instance “xCP Case Data Node single
instance” on page 277
comments [1] Comments attached to the “xCP Comment collection”
case data node instance on page 203
add Add an instance of an object “xCP Case Data Node single
inside this casedaa node instance” on page 277
instance
add-comment Add a comment to the case “xCP Case Data Node single
data node instance instance” on page 277

EDCPKL230200-PGR-EN-01 Development Guide 277

Chapter 4 Resources

Link relation Description Resource reference

objects [1] Objects in the case data node “xCP Content collection”
instance on page 224
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.46.3 Operations
A case data node resource supports the following HTTP methods.

Method Description
GET Retrieve a case data node resource
GET Retrieve the objects in a case data node
resource
POST Update a case data node resource
POST Create a case data node resource
POST Copy a document to a case data node
resource
POST Move a document to a case data node
resource
DELETE Delete a case data node resource

4.46.3.1 Get a case data node

Retrieve the metadata of a case data node resource. Other information, such as the
comments attached to the case data node and objects in the case data node, is
presented in the link relations.

4.46.3.1.1 HTTP method

GET

4.46.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

278 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.46. xCP Case Data Node single instance

4.46.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.46.3.1.4 Request body

None.

4.46.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.46.3.1.6 Supported response media types

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

4.46.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 279

Chapter 4 Resources

4.46.3.1.8 Response body

XML or JSON representation of the case data node resource.

• The type link relation points to the type definition of the case data node
resource, through which you can retrieve an “xCP Case Data Node Single Type”
on page 289.
• Null values are presented as an empty string (“”).

4.46.3.2 Update a case data node

Update a case data node resource.

4.46.3.2.1 HTTP method

POST

4.46.3.2.2 Server accepted request media types

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

4.46.3.2.3 Query parameters

None.

4.46.3.2.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.46.3.2.5 Request body

XML or JSON representation of the case data node resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Case Data Node Single Type” on page 289), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

280 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.46. xCP Case Data Node single instance

4.46.3.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.46.3.2.7 Supported response media types

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

4.46.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.46.3.2.9 Response body

XML or JSON representation of the updated case data node resource:

• The type link relation points to the type definition of the case data node
resource, through which you can retrieve a “xCP Case Data Node Single Type”
on page 289.
• Null values are presented as an empty string (“”).

EDCPKL230200-PGR-EN-01 Development Guide 281

Chapter 4 Resources

4.46.3.3 Create a case data node

Create a case data node resource.

4.46.3.3.1 HTTP method

POST

To create a case data node resource of a certain type, send a POST request to the
collection of case data node resources of that type in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/casedatanodes/<casedatanode-type>

4.46.3.3.2 Server accepted request media types

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

4.46.3.3.3 Query parameters

None.

4.46.3.3.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.46.3.3.5 Request body

XML or JSON representation of the case data node resource.

• The request body must contain the object_name of the case data node. A
minimal request body resembles the following samples:

Example 4-25: Minimal Request body in XML

<?xml version="1.0" encoding="UTF-8"?>
<dm:casedataenodes xmlns:dm="http://identifiers.emc.com/vocab/xcp">
<dm:properties>
<dm:object_name>AAA</dm:object_name>
</dm:properties>
</dm:casedatanodes>

Example 4-26: Minimal Request body in JSON

{
"properties" : {
"object_name" : "BBB"

282 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.46. xCP Case Data Node single instance

}
}

• If a case data node with the same name exists in the same location, the request
fails.
• This operation creates a case data node resource with all fields specified in the
request. However, if the request body contains a field that is not presented in the
corresponding DML type (“xCP Case Data Node Single Type” on page 289), the
field is ignored.
• Unspecified fields are set the default values in Documentum Server.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

4.46.3.3.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.46.3.3.7 Supported response media types

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

4.46.3.3.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 283

Chapter 4 Resources

4.46.3.3.9 Response body

XML or JSON representation of the case data node resource:

• The type link relation points to the type definition of the case data node
resource, through which you can retrieve a “xCP Case Data Node Single Type”
on page 289.
• Null values are presented as an empty string (“”).

4.46.3.4 Copy a Document to a case data node

Copy a document (a Content instance) to a case data node by using the objects link
relation.

Note: A case data node can only have case data node instances.

4.46.3.4.1 HTTP method

POST

To copy a case data node instance to a case data node instance, send a POST request
to the objects link relation of the case data node instance in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/casedatanodes/<casedatanode-type>/<casedatanode-
type-id>/objects

4.46.3.4.2 Server accepted request media types

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

4.46.3.4.3 Query parameters

None.

4.46.3.4.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

284 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.46. xCP Case Data Node single instance

4.46.3.4.5 Request body

A reference to the case data node instance to copy.

{
"href":"/casedatanodes/<casedatanode-type>/<casedatanode-id>"
}

For example:
{
"href":"/casedatanodes/loan_property/dm_document/0900492d80012f02"
}

4.46.3.4.6 Response headers

• Location

• Content-Length

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.46.3.4.7 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.documentum+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.46.3.4.8 Response status

201 - Object copied successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 285

Chapter 4 Resources

4.46.3.4.9 Response body

XML or JSON representation of the case data node resource. You can find the copied
case data node instance by accessing the objects link relation of the case data node
instance. The copied case data node instance (2901492f80012f44) is listed under the
entries section.

4.46.3.5 Move a case data node to another case data node

Move a case data node (a case data node instance) to another case data node by
using the objects link relation.

4.46.3.5.1 HTTP method

POST

To move a case data node instance to a case node instance, send a POST request to
the objects link relation of the case data node instance in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/casedatanodes/<casedatanode-type>/<casedatanode-
id>/objects

4.46.3.5.2 Server accepted request media types

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

4.46.3.5.3 Query parameters

None.

4.46.3.5.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

286 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.46. xCP Case Data Node single instance

4.46.3.5.5 Request body

The request body contains the following elements:

• Reference to the original location of the case data node instance

• Reference to the case data node instance to move

{
"source":"/casedatanodes/<casedatanode-type>/<casedatanode-id>",
"href":"/casedatanodes/<casedatanode-type>/<casedatanode-id>"
}

4.46.3.5.6 Response headers

• Location

• Content-Length

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.46.3.5.7 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.documentum+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.46.3.5.8 Response status

201 - Object moved successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 287

Chapter 4 Resources

4.46.3.5.9 Response body

XML or JSON representation of the case data node resource. You can find the moved
case data node instance by accessing the objects link relation of the case node
instance. The moved case data node instance is listed under the entries section as
shown in the example Example 4-22, “Objects in Folder” on page 250.

4.46.3.6 Delete a case data node

Delete a case data node resource.

4.46.3.6.1 HTTP method

DELETE

To delete a case data node resource, send a DELETE request to the delete link
relation of the resource with the following pattern:
http://127.0.0.1:8080/<xcp-rest-app>/casedatanodes/<casedatanode-type>/<casedatanode-id>

4.46.3.6.2 Query parameters

None.

4.46.3.6.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.46.3.6.4 Request body

None.

4.46.3.6.5 Response headers

None.

4.46.3.6.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

288 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.47. xCP Case Data Node Single Type

4.46.3.6.7 Response body

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

4.47 xCP Case Data Node Single Type

A single instance of case data node type represents the type definition of case data
node instances.

4.47.1 URI template

/types/casedatanodes/casedatanode-type

casedatanode-type Type of the case data node

4.47.2 Link relation

The following table lists general link relations for a case data node Type resource.

Link relation Description Resource reference

type Type definition of case data “xCP Case Data Node Single
node instances Type” on page 289
instances [1] collection of the case data
node instances
defaults [1] Defaults of the type “xCP Case Data Node Single
definition Type” on page 289
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.47.3 Operations
A Case Node Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of case node
instances

EDCPKL230200-PGR-EN-01 Development Guide 289

Chapter 4 Resources

4.47.3.1 Get a Case Data Node Type

Retrieve the type definition of case data node instances.

4.47.3.1.1 HTTP method

GET

4.47.3.1.2 Query parameters

None.

4.47.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.47.3.1.4 Request body

None.

4.47.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.47.3.1.6 Supported response media types

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

4.47.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

290 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.48. xCP Case Data Node Type collection

4.47.3.1.8 Response body

XML or JSON representation of the type definition of case data node instances. The
instances link relation points to a collection of case data node instances, through
which you can retrieve an “xCP Folder Type collection” on page 256.

4.48 xCP Case Data Node Type collection

A case data node type collection represents a collection of type definitions for case
data node instances.

4.48.1 URI template

/types/casedatanodes

4.48.2 Feed and EDAA support

A collection of case data node type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/casedatanodes
Title Case Data Node Case Data Node
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed casedatanodes/test-
and name of the type casedatanode-type
Title case data node type test-casedatanode-type
Summary Summary casedatanode-summary
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 291

Chapter 4 Resources

4.48.3 Link relation

The following table lists link relation(s) for a case data node type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Case Data Node Type
for case data node instances collection” on page 291

4.48.4 Operations
A Case Data Node Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
case data node instances

4.48.4.1 Get a Case Data Node Type collection

Retrieve a collection of type definitions for case data node instances.

4.48.4.1.1 HTTP method

GET

4.48.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

292 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.48. xCP Case Data Node Type collection

4.48.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.48.4.1.4 Request body

None.

4.48.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.48.4.1.6 Supported response media types

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

4.48.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 293

Chapter 4 Resources

4.48.4.1.8 Response body

XML or JSON representation of a collection of type definitions for case data node
instances.

• Each instance may contain all or a set of properties of the type definitions for case
data node instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.49 xCP Format single instance

A single instance of Format is a resource that defines the format of a file based on its
file extension.

4.49.1 URI template

/formats/format-type/format-id

format-type Type of the format

format-id Format ID

4.49.2 Link relation

The following table lists general link relations for a Format resource.

Link relation Description Resource reference

type Type definition of this “xCP Format Single Type”
resource on page 300
instances [1] collection of the Format “xCP Format collection”
instances on page 296
self This Format instance “xCP Format single instance”
on page 294
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

294 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.49. xCP Format single instance

4.49.3 Operations
A Format resource supports the following HTTP methods.

Method Description
GET Retrieve a Format resource

4.49.3.1 Get a Format

Retrieve a Format resource.

4.49.3.1.1 HTTP method

GET

4.49.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.49.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.49.3.1.4 Request body

None.

4.49.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 295

Chapter 4 Resources

4.49.3.1.6 Supported response media types

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

4.49.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.49.3.1.8 Response body

XML or JSON representation of the Format resource.

• The type link relation points to the type definition of the Format resource,
through which you can retrieve an “xCP Format Single Type” on page 300.
• Null values are presented as an empty string (“”).

4.50 xCP Format collection

A Format collection represents a collection of Format instances of a certain type.

4.50.1 URI template

/formats/format-type

format-type Type of the format

296 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.50. xCP Format collection

4.50.2 Feed and EDAA support

A collection of Format instances conforms to Atom Feed in XML representation and
EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
formats/xcp_format
Title formats formats
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ formats/xcp_format/
uri>/<entry_id> 275db83d80000102
Title name property of the format test-format
resource
Summary description property of This is a test format
the format resource
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.50.3 Link relation

The following table lists link relation(s) for a Format collection resource.

Link relation Description Resource reference

self This collection resource “xCP Format collection”
on page 296
first, last, previous, next Pagination links “xCP Format collection”
on page 296

EDCPKL230200-PGR-EN-01 Development Guide 297

Chapter 4 Resources

4.50.4 Operations
A Format collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Format instances.

4.50.4.1 Get a Format collection

Retrieve a collection of Format instances of a certain type.

4.50.4.1.1 HTTP method

GET

4.50.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.50.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

298 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.50. xCP Format collection

4.50.4.1.4 Request body

None.

4.50.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.50.4.1.6 Supported response media types

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

4.50.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.50.4.1.8 Response body

XML or JSON representation of a collection of Format instances.

• Each instance may contain all or a set of properties of the Format instance,
depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

EDCPKL230200-PGR-EN-01 Development Guide 299

Chapter 4 Resources

4.51 xCP Format Single Type

A single instance of Format Type represents the type definition of Format instances.

4.51.1 URI template

/types/format-type

format-type Type of the format

4.51.2 Link relation

The following table lists general link relations for a Format Type resource.

Link relation Description Resource reference

self Type definition of Format “xCP Format Single Type”
instances on page 300
instances [1] Collection of the Format “xCP Format collection”
instances on page 296
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.51.3 Operations
A Format Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Format
instances

4.51.3.1 Get a Format Type

Retrieve the type definition of Format instances.

4.51.3.1.1 HTTP method

GET

300 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.51. xCP Format Single Type

4.51.3.1.2 Query parameters

None.

4.51.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.51.3.1.4 Request body

None.

4.51.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.51.3.1.6 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.51.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 301

Chapter 4 Resources

4.51.3.1.8 Response body

XML or JSON representation of the type definition of Format instances. The

instances link relation points to a collection Format instances, through which you
can retrieve an “xCP Format collection” on page 296.

4.52 xCP Format Type collection

A Format Type collection represents a collection of type definitions for Format
instances.

4.52.1 URI template

/types/formats

4.52.2 Feed and EDAA support

A collection of Format Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/formats
Title Formats Formats
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/formats/test-format
and name of the type
Title Format type name test-format
Summary label property of the type test-xcp-format
instance
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

302 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.52. xCP Format Type collection

4.52.3 Link relation

The following table lists link relation(s) for a Format Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Format Type
for Format instances collection” on page 302

4.52.4 Operations
A Format Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Format instances

4.52.4.1 Get a Format Type collection

Retrieve a collection of type definitions for Format instances.

4.52.4.1.1 HTTP method

GET

4.52.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 303

Chapter 4 Resources

4.52.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.52.4.1.4 Request body

None.

4.52.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.52.4.1.6 Supported response media types

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

4.52.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

304 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.53. xCP Fragment single instance

4.52.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Format instances.

• Each instance may contain all or a set of properties of the type definitions for
Format instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.53 xCP Fragment single instance

A single instance of Fragment represents an aspect attached to a persistent object. In
xCP REST services, aspects are a mechanism for adding properties to a persistent
object without changing its type definition. For example, you can attach properties
to a business-object instance of a certain type without changing that type definition.

A persistent object can have more than one aspects attached.

In xCP Designer, you can specify the types of persistent objects to which fragments
of a certain type can be attached. In xCP REST services, this setting is indicated in
the eligibility section of the type definition for fragments. “xCP Fragment Single
Type” on page 310 provides more information about fragments type definition.

Similarly, a type definition of certain persistent objects (for example, business

objects, folders, and contents) also specifies the type of fragments applicable to the
corresponding instances in the fragments section. For detailed information, see
Fragments in “xCP common elements” on page 79.

4.53.1 URI template

persistent_object_path/fragments/fragment_type

persistent_object_path Path of the persistent object to which the

Fragment instance is attached
fragment_type Type of the Fragment

4.53.2 Link relation

The following table lists general link relations for a Fragment resource.

Link relation Description Resource reference

type Type definition of this “xCP Fragment Single Type”
instance on page 310
self This Fragment instance “xCP Fragment single
instance” on page 305

EDCPKL230200-PGR-EN-01 Development Guide 305

Chapter 4 Resources

4.53.3 Operations
A Fragment resource supports the following HTTP methods.

Method Description
GET Retrieve a Fragment instance
POST Attach an aspect (Fragment instance) to a
persistent object

4.53.3.1 Get a Fragment

Retrieve a Fragment instance attached to a persistent object.

4.53.3.1.1 HTTP method

GET

Example 4-27: Request Example

http://127.0.0.1:8000/xCPApp/business-objects/utapp21_bo_with_aspect/0800492d8001d71b/
fragments/utapp21_aspect_all_attrs

4.53.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.53.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

306 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.53. xCP Fragment single instance

4.53.3.1.4 Request body

None.

4.53.3.1.5 Response headers

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.53.3.1.6 Supported response media types

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

4.53.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.53.3.1.8 Response body

XML or JSON representation of the Fragment instance.

• The type link relation points to the type definition of the Fragment instance,
through which you can retrieve an “xCP Fragment Single Type” on page 310.
• Null values are presented as an empty string (“”).

Example 4-28: Sample Response in JSON

{
"name": "fragment",
"type": "utapp21_aspect_all_attrs",
"definition": "http://127.0.0.1:8000/oct18/types/fragments/
utapp21_aspect_all_attrs",
"properties": {
"new_string": "sample"
},
"links":
[
{"rel": "type",

EDCPKL230200-PGR-EN-01 Development Guide 307

Chapter 4 Resources

"href": "types/fragments/o18_aspect1"},
{"rel": "self",
"href": "types/fragments/o18_aspect1/defaults"}
]
}

4.53.3.2 Attach an Aspect to an Object

Attach an aspect (Fragment instance) to a persistent object.

4.53.3.2.1 HTTP method

POST

To attach an aspect (Fragment instance) to a persistent object, send a POST request

to the path of the persistent object to which you want to attach the Fragment
instance in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/<persistent_object_path>

For example:
http://127.0.0.1:8080/xcp-rest/business-objects/o18_bo1/0800492d8001d71b

Note: The type of the Fragment instance must be associated with the type of
persistent object. For more information about this association, see “xCP
Fragment Single Type” on page 310 and the subsection Fragments in “xCP
common elements” on page 79.

4.53.3.2.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.53.3.2.3 Query parameters

None.

4.53.3.2.4 Request headers

• Accept
• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

308 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.53. xCP Fragment single instance

4.53.3.2.5 Request body

XML or JSON representation of the persistent object with the aspect to attach
presented in the fragments section. In the following example, the fragment named
utapp21_aspect_all_attrs is attached to a business object of the type utapp21_
bo_with_aspect.

Example 4-29: Sample Request in JSON

{
"name": "business-object",
"type": "utapp21_bo_with_aspect",
"definition": "http://127.0.0.1:8080/xcp-rest/types/business-objects/
utapp21_bo_with_aspect",
"properties": {
"r_creation_date": "2013-07-17T08:47:02.000-07:00",
"r_object_type": "utapp21_bo_with_aspect",
"int_attr_single": 0,
"float_attr_single": 0,
"i_folder_id": [
"0c01f70180000105"
],
"r_object_id": "0801f7018003c9eb",
"r_creator_name": "dmadmin",
"r_modify_date": "2013-07-17T08:47:02.000-07:00",
"object_name": "f71c3b3f-3388-4a8d-81fb-5ece796ae57c",
"r_modifier": "dmadmin",
"boolean_attr_single": false
},
"fragments": {
"utapp21_aspect_all_attrs": {
"properties": {
"new_string": "sample aspect",
"new_integer": 10
}
}
}
}

4.53.3.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 309

Chapter 4 Resources

4.53.3.2.7 Supported response media types

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

4.53.3.2.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.53.3.2.9 Response body

XML or JSON representation of the persistent object with the newly-attached aspect
presented in the fragments section.

4.54 xCP Fragment Single Type

A single instance of Fragment (Aspect) Type represents the type definition of
Fragment instances. This resource defines the properties to attach to persistent
objects and the types of objects to which a certain type of Fragments can be attached.
For detailed information, see “Response body” on page 312.

4.54.1 URI template

/types/fragments/fragment-type

fragment-type Type of the fragment

310 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.54. xCP Fragment Single Type

4.54.2 Link relation

The following table lists general link relation for a Fragment Type resource.

Link relation Description Resource reference

self Type definition of Fragment “xCP Fragment Single Type”
instances on page 310

4.54.3 Operations
A Fragment Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Fragment
instances

4.54.3.1 Get a Fragment Type

Retrieve the type definition of Fragment instances.

4.54.3.1.1 HTTP method

GET

4.54.3.1.2 Query parameters

None.

4.54.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.54.3.1.4 Request body

None.

EDCPKL230200-PGR-EN-01 Development Guide 311

Chapter 4 Resources

4.54.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.54.3.1.6 Supported response media types

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

4.54.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.54.3.1.8 Response body

XML or JSON representation of the type definition of Fragment instances. Properties

to attach to persistent objects are defined in the properties section. Types of objects
to which this type of Fragments can be attached are defined in the eligibility
section. In the following example, fragments of the utapp21_aspect_all_attrs
type can be attached to business objects of the following types:

• utapp21_bo_with_aspect
• utapp21_content_with_aspect
• utapp21_folder_with_aspect

Example 4-30: Sample Response in XML

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<fragment-type label="aspect_all_attrs" name="aspect_all_attrs"
type="utapp21_aspect_all_attrs" xmlns="http://identifiers.emc.com/vocab/xcp">
<properties>
<property label="New String" length="64" name="new_string" type="string"/>
<property label="New Integer" name="new_integer" type="integer"/>
<property label="New Float" name="new_float" type="float"/>
<property label="New Boolean" name="new_boolean" type="boolean"/>
<property label="New Date-time" name="new_date_time" type="datetime"/>
<property label="New String Rep" length="64" name="new_string_rep"

312 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.55. xCP Fragment Type collection

repeating="true" type="string"/>
<property label="New Integer Rep" name="new_integer_rep" type="integer"/>
<property label="New Float Rep" name="new_float_rep" repeating="true"
type="float"/>
<property label="New Boolean Rep" name="new_boolean_rep" repeating="true"
type="boolean"/>
<property label="New Date-time Rep" name="new_date_time_rep" repeating="true"
type="datetime"/>
</properties>
<eligibility>
<type href="${contextPath}types/business-objects/utapp21_bo_with_aspect"/>
<type href="${contextPath}types/contents/utapp21_content_with_aspect"/>
<type href="${contextPath}types/folders/utapp21_folder_with_aspect"/>
</eligibility>
<links>
<link href="${contextPath}types/fragments/utapp21_aspect_all_attrs"
rel="self"/>
<link rel="type"/>
</links>
</fragment-type>

4.55 xCP Fragment Type collection

A Fragment Type collection is a resource that represents a collection of type
definitions for Fragment instances.

4.55.1 URI template

/types/fragments

4.55.2 Feed and EDAA support

A collection of Fragment Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/fragments
Title Name of Feed Fragments
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

EDCPKL230200-PGR-EN-01 Development Guide 313

Chapter 4 Resources

Feed property Feed value Example

ID URI of the entry, which is the http://localhost:8080/xcp-rest/
URI of the feed with the types/fragments/
name of the type appended. utapp21_aspect_all_attrs
Title Entry title utapp21_aspect_all_attrs
Summary Entry summary Utapp21 Aspect All Attrs
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.55.3 Link relation

The following table lists link relation(s) for a Fragment Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Fragment Type
for Fragment instances collection” on page 313

4.55.4 Operations
A Fragment Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Fragment instances

4.55.4.1 Get a Fragment Type collection

Retrieve a collection of type definitions for Fragment instances.

4.55.4.1.1 HTTP method

GET

4.55.4.1.2 Query parameters

This operation supports the following common query parameters:

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

314 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.55. xCP Fragment Type collection

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.55.4.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.55.4.1.4 Request body

None.

4.55.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.55.4.1.6 Supported response media types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.55.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 315

Chapter 4 Resources

4.55.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Fragment

instances.

• Each instance may contain all or a set of properties of the type definitions for
Fragment instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.56 xCP Full-Text Query single instance

A single instance of Full-Text Query Single represents a full-text query configured in
xCP Designer. This resource enables you to perform a full-text query in a repository
and navigate the results using facets.

4.56.1 URI template

/fulltext-queries/query_name

query_name Name of the full-text query

4.56.2 Link relation

The following table lists link relation(s) for a Full-Text Query resource.

Link relation Description Resource reference

self This Full-Text Query instance “xCP Full-Text Query single
instance” on page 316
type Type definition of this “xCP Full-Text Query Single
resource Type” on page 328

4.56.3 Operations
A Full-Text Query resource supports the following HTTP method.

Method Description
GET Retrieve the results of a full-text query

316 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.56. xCP Full-Text Query single instance

4.56.3.1 Perform a Full-Text Query

Perform a full-text query in a repository and navigate the results using facets.

4.56.3.1.1 HTTP method

GET

4.56.3.1.2 Query parameters

The following query parameter is specific to this operation:

Parameter Description Data Type Default

q Full-text expression string N/A

This operation supports the following common query parameters:

• view
• links
• inline
• items-per-page
• page
• include-total
• sort
A Full-Text Query resource does not support sort on multiple attributes,
meaning that you can specify at most one attribute as the sort criterion when
performing a query.

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.56.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 317

Chapter 4 Resources

4.56.3.1.4 Request body

None.

4.56.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.56.3.1.6 Supported response media types

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

4.56.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.56.3.1.8 Response body

XML or JSON representation of the query results. The results are presented using
Atom Feed in XML representation or using EDAA collection in JSON representation.
By default, this operation only returns basic properties of each result. You can get a
single instance by accessing the src link in the corresponding entry. To obtain a full
representation of each result, set the inline parameter to true.

Example 4-31: Query Results in Atom Feed

<feed
xmlns="http://www.w3.org/2005/Atom"
xmlns:dm="http://identifiers.emc.com/vocab/xcp">
<id>fulltext-queries/iigbook_book_ftq</id>
<title type="text">iigbook_book_ftq</title>
<updated>2014-01-23T09:09:45.405Z</updated>
<link href="fulltext-queries/iigbook_book_ftq" rel="self"/>
<author>
<name>OpenText Documentum</name>
</author>
<dm:page>1</dm:page>
<dm:items-per-page>10</dm:items-per-page>

318 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.56. xCP Full-Text Query single instance

<dm:facets>
<dm:facet name="publish_date">
<dm:value name="TODAY" count="0"/>
<dm:constraint>2014-01-23T00:00:00.000\+0000/2014-01-24T00:00:00.000\
+0000</dm:constraint>
<dm:value name="YESTERDAY" count="0"/>
<dm:constraint>2014-01-22T00:00:00.000\+0000/2014-01-23T00:00:00.000\
+0000</dm:constraint>
<dm:value name="THIS_WEEK" count="0"/>
<dm:constraint>2014-01-20T00:00:00.000\+0000/2014-01-27T00:00:00.000\
+0000</dm:constraint>
<dm:value name="THIS_MONTH" count="0"/>
<dm:constraint>2014-01-01T00:00:00.000\+0000/2014-02-01T00:00:00.000\
+0000</dm:constraint>
<dm:value name="LAST_MONTH" count="0"/>
<dm:constraint>2013-12-01T00:00:00.000\+0000/2014-01-01T00:00:00.000\
+0000</dm:constraint>
<dm:value name="THIS_YEAR" count="0"/>
<dm:constraint>2014-01-01T00:00:00.000\+0000/2015-01-01T00:00:00.000\
+0000</dm:constraint>
<dm:value name="LAST_YEAR" count="0"/>
<dm:constraint>2013-01-01T00:00:00.000\+0000/2014-01-01T00:00:00.000\
+0000</dm:constraint>
<dm:value name="OLDER" count="0"/>
<dm:constraint>/2013-01-01T00:00:00.000\+0000</dm:constraint>
</dm:facet>
<dm:facet name="created_on">
<dm:value name="TODAY" count="3"/>
<dm:constraint>2014-01-23T00:00:00.000\+0000/2014-01-24T00:00:00.000\
+0000</dm:constraint>
<dm:value name="YESTERDAY" count="0"/>
<dm:constraint>2014-01-22T00:00:00.000\+0000/2014-01-23T00:00:00.000\
+0000</dm:constraint>
<dm:value name="THIS_WEEK" count="3"/>
<dm:constraint>2014-01-20T00:00:00.000\+0000/2014-01-27T00:00:00.000\
+0000</dm:constraint>
<dm:value name="THIS_MONTH" count="3"/>
<dm:constraint>2014-01-01T00:00:00.000\+0000/2014-02-01T00:00:00.000\
+0000</dm:constraint>
<dm:value name="LAST_MONTH" count="0"/>
<dm:constraint>2013-12-01T00:00:00.000\+0000/2014-01-01T00:00:00.000\
+0000</dm:constraint>
<dm:value name="THIS_YEAR" count="3"/>
<dm:constraint>2014-01-01T00:00:00.000\+0000/2015-01-01T00:00:00.000\
+0000</dm:constraint>
<dm:value name="LAST_YEAR" count="0"/>
<dm:constraint>2013-01-01T00:00:00.000\+0000/2014-01-01T00:00:00.000\
+0000</dm:constraint>
<dm:value name="OLDER" count="0"/>
<dm:constraint>/2013-01-01T00:00:00.000\+0000</dm:constraint>
</dm:facet>
<dm:facet name="book_status">
<dm:value name="available" count="3"/>
<dm:constraint>available</dm:constraint>
</dm:facet>
<dm:facet name="averagerate">
<dm:value name="0" count="1"/>
<dm:constraint>0</dm:constraint>
<dm:value name="8.80000019073486" count="1"/>
<dm:constraint>8.80000019073486</dm:constraint>
<dm:value name="9.10000038146973" count="1"/>
<dm:constraint>9.10000038146973</dm:constraint>
</dm:facet>
<dm:facet name="book_authors">
<dm:value name="Bruce Eckel" count="1"/>
<dm:constraint>Bruce Eckel</dm:constraint>
<dm:value name="David Flanagan" count="1"/>
<dm:constraint>David Flanagan</dm:constraint>
<dm:value name="Lessing, Gotthold Ephraim; Heine, Heinrich;
Marlowe, Christopher" count="1"/>

EDCPKL230200-PGR-EN-01 Development Guide 319

Chapter 4 Resources

<dm:constraint>Lessing, Gotthold Ephraim; Heine, Heinrich;

Marlowe, Christopher</dm:constraint>
</dm:facet>
</dm:facets>
<entry>
<id>fulltext-queries/iigbook_book_ftq/701500403</id>
<title type="text">Doktor Faust</title>
<updated>2014-01-23T09:09:45.407Z</updated>
<link href="fulltext-queries/iigbook_book_ftq/701500403" rel="edit"/>
<summary type="text">Doktor Faust</summary>
<content type="application/vnd.emc.xcp+xml">
<dm:fulltext-query
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="iigbook_book_ftq"
dm:definition="http://localhost:8000/iigbooks/types/
fulltext-queries/iigbook_book_ftq">
<dm:properties xsi:type="iigbook_book_ftq-properties">
<dm:r_creation_date>2014-01-23T08:55:05.000Z
</dm:r_creation_date>
<dm:r_object_type>iigbook_book</dm:r_object_type>
<dm:summary>Doktor Faust Doktor Faust</dm:summary>
<dm:averagerate>0.0</dm:averagerate>
<dm:owner_name>xcp21H2wk2</dm:owner_name>
<dm:douban_id>10387592</dm:douban_id>
<dm:price>$ 38.14</dm:price>
<dm:book_authors>
<dm:item>Lessing, Gotthold Ephraim; Heine, Heinrich;
Marlowe, Christopher</dm:item>
</dm:book_authors>
<dm:id>0901e24080019b29</dm:id>
<dm:translator>
<dm:item/>
</dm:translator>
<dm:isbn13>9781148737188</dm:isbn13>
<dm:borrow_times>0</dm:borrow_times>
<dm:page>382</dm:page>
<dm:image_url>http://img3.douban.com/mpic/s8099754.jpg
</dm:image_url>
<dm:isbn10>1148737189</dm:isbn10>
<dm:book_status>available</dm:book_status>
<dm:object_name>Doktor Faust</dm:object_name>
<dm:authors>
<dm:item/>
</dm:authors>
</dm:properties>
<dm:links>
<dm:link rel="type" href="types/fulltext-queries/
iigbook_book_ftq"/>
<dm:link rel="http://identifiers.emc.com/linkrel/instances"
href="fulltext-queries/iigbook_book_ftq"/>
<dm:link rel="self" href="fulltext-queries/
iigbook_book_ftq/0901e24080019b29"/>
</dm:links>
</dm:fulltext-query>
</content>
</entry>
<entry>
<id>fulltext-queries/iigbook_book_ftq/1096269836</id>
<title type="text">Thinking in Java</title>
<updated>2014-01-23T09:09:45.421Z</updated>
<link href="fulltext-queries/iigbook_book_ftq/1096269836" rel="edit"/>
<summary type="text">Thinking in Java</summary>
<content type="application/vnd.emc.xcp+xml">
<dm:fulltext-query
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="iigbook_book_ftq"
dm:definition="http://localhost:8000/iigbooks/types/
fulltext-queries/iigbook_book_ftq">
<dm:properties xsi:type="iigbook_book_ftq-properties">
<dm:r_creation_date>2014-01-23T08:56:40.000Z</dm:r_creation_date>

320 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.56. xCP Full-Text Query single instance

<dm:r_object_type>iigbook_book</dm:r_object_type>
<dm:summary>Thinking in Java Thinking in Java</dm:summary>
<dm:averagerate>8.80000019073486</dm:averagerate>
<dm:owner_name>xcp21H2wk2</dm:owner_name>
<dm:douban_id>1474824</dm:douban_id>
<dm:price>USD 69.99</dm:price>
<dm:book_authors>
<dm:item>Bruce Eckel</dm:item>
</dm:book_authors>
<dm:id>0901e24080019b2b</dm:id>
<dm:translator>
<dm:item/>
</dm:translator>
<dm:isbn13>9780131872486</dm:isbn13>
<dm:borrow_times>0</dm:borrow_times>
<dm:page>1150</dm:page>
<dm:image_url>http://img5.douban.com/mpic
/s4243918.jpg</dm:image_url>
<dm:isbn10>0131872486</dm:isbn10>
<dm:book_status>available</dm:book_status>
<dm:object_name>Thinking in Java</dm:object_name>
<dm:authors>
<dm:item/>
</dm:authors>
</dm:properties>
<dm:links>
<dm:link rel="type" href="types/fulltext-queries/
iigbook_book_ftq"/>
<dm:link rel="http://identifiers.emc.com/linkrel/instances"
href="fulltext-queries/iigbook_book_ftq"/>
<dm:link rel="self" href="fulltext-queries/iigbook_book_ftq/
0901e24080019b2b"/>
</dm:links>
</dm:fulltext-query>
</content>
</entry>
<entry>
<id>fulltext-queries/iigbook_book_ftq/786395505</id>
<title type="text">JavaScript: The Definitive Guide, 5th Edition</title>
<updated>2014-01-23T09:09:45.426Z</updated>
<link href="fulltext-queries/iigbook_book_ftq/786395505" rel="edit"/>
<summary type="text">JavaScript: The Definitive Guide, 5th Edition</summary>
<content type="application/vnd.emc.xcp+xml">
<dm:fulltext-query
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="iigbook_book_ftq"
dm:definition="http://localhost:8000/iigbooks/types/fulltext-queries/
iigbook_book_ftq">
<dm:properties xsi:type="iigbook_book_ftq-properties">
<dm:r_creation_date>2014-01-23T08:57:00.000Z</dm:r_creation_date>
<dm:r_object_type>iigbook_book</dm:r_object_type>
<dm:summary>
JavaScript: The Definitive Guide, 5th Edition
</dm:summary>
<dm:averagerate>9.10000038146973</dm:averagerate>
<dm:owner_name>xcp21H2wk2</dm:owner_name>
<dm:douban_id>1775608</dm:douban_id>
<dm:price>USD 49.99</dm:price>
<dm:book_authors>
<dm:item>David Flanagan</dm:item>
</dm:book_authors>
<dm:id>0901e24080019b2d</dm:id>
<dm:translator>
<dm:item/>
</dm:translator>
<dm:isbn13>9780596101992</dm:isbn13>
<dm:borrow_times>0</dm:borrow_times>
<dm:page>1032</dm:page>
<dm:image_url>http://img5.douban.com/mpic/s4251169.jpg</dm:image_url>
<dm:isbn10>0596101996</dm:isbn10>

EDCPKL230200-PGR-EN-01 Development Guide 321

Chapter 4 Resources

<dm:book_status>available</dm:book_status>
<dm:object_name>
JavaScript: The Definitive Guide, 5th Edition
</dm:object_name>
<dm:authors>
<dm:item/>
</dm:authors>
</dm:properties>
<dm:links>
<dm:link rel="type" href="types/fulltext-queries/iigbook_book_ftq"/>
<dm:link rel="http://identifiers.emc.com/linkrel/instances"
href="fulltext-queries/iigbook_book_ftq"/>
<dm:link rel="self" href="fulltext-queries/
iigbook_book_ftq/0901e24080019b2d"/>
</dm:links>
</dm:fulltext-query>
</content>
</entry>
</feed>

Example 4-32: Query Results in EDAA collection

{
"id": "fulltext-queries/iigbook_book_ftq",
"title": "iigbook_book_ftq",
"updated": "2014-01-23T09:12:07.323Z",
"author": "OpenText Documentum",
"page": 1,
"items-per-page": 10,
"links": [
{
"rel": "self",
"href": "fulltext-queries/iigbook_book_ftq"
}
],
"entries": [
{
"id": "fulltext-queries/iigbook_book_ftq/1180400326",
"title": "Doktor Faust",
"updated": "2014-01-23T09:12:07.323Z",
"summary": "Doktor Faust",
"content": {
"name": "fulltext-query",
"type": "iigbook_book_ftq",
"definition": "http://localhost:8000/iigbooks/types/
fulltext-queries/iigbook_book_ftq",
"properties": {
"r_creation_date": "2014-01-23T08:55:05.000Z",
"r_object_type": "iigbook_book",
"summary": "Doktor Faust Doktor Faust",
"averagerate": 0,
"owner_name": "xcp21H2wk2",
"douban_id": "10387592",
"price": "$ 38.14",
"book_authors": [
"Lessing, Gotthold Ephraim; Heine,
Heinrich; Marlowe, Christopher"
],
"id": "0901e24080019b29",
"translator": [
""
],
"isbn13": "9781148737188",
"borrow_times": 0,
"page": 382,
"image_url": "http://img3.douban.com/mpic/s8099754.jpg",

322 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.56. xCP Full-Text Query single instance

"isbn10": "1148737189",
"book_status": "available",
"object_name": "Doktor Faust",
"authors": [
""
]
},
"links": [
{
"rel": "type",
"href": "types/contents/iigbook_book"
},
{
"rel": "version-history",
"href": "contents/iigbook_book/0901e24080019b29/versions"
},
{
"rel": "edit",
"href": "contents/iigbook_book/0901e24080019b29"
},
{
"rel": "self",
"href": "contents/iigbook_book/0901e24080019b29"
},
{
"rel": "http://identifiers.emc.com/linkrel/download-media",
"href": "contents/iigbook_book/0901e24080019b29/media"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "contents/iigbook_book/0901e24080019b29"
},
{
"rel": "http://identifiers.emc.com/linkrel/checkout",
"href": "contents/iigbook_book/0901e24080019b29/lock"
},
{
"rel": "http://identifiers.emc.com/linkrel/instances",
"href": "contents/iigbook_book"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "relationships/iigbook_book_ticket?
filter=source%3D0901e24080019b29",
"type": "types/relationships/iigbook_book_ticket"
},
{
"rel": "http://identifiers.emc.com/linkrel/comments",
"href": "contents/iigbook_book/0901e24080019b29/comments"
}
],
"content-type": "application/vnd.emc.xcp+json"
}
},
{
"id": "fulltext-queries/iigbook_book_ftq/426111233",
"title": "Thinking in Java",
"updated": "2014-01-23T09:12:07.335Z",
"summary": "Thinking in Java",
"content": {
"name": "fulltext-query",
"type": "iigbook_book_ftq",
"definition": "http://localhost:8000/iigbooks/types/
fulltext-queries/iigbook_book_ftq",
"properties": {
"r_creation_date": "2014-01-23T08:56:40.000Z",
"r_object_type": "iigbook_book",
"summary": "Thinking in Java Thinking in Java",
"averagerate": 8.80000019073486,
"owner_name": "xcp21H2wk2",

EDCPKL230200-PGR-EN-01 Development Guide 323

Chapter 4 Resources

"douban_id": "1474824",
"price": "USD 69.99",
"book_authors": [
"Bruce Eckel"
],
"id": "0901e24080019b2b",
"translator": [
""
],
"isbn13": "9780131872486",
"borrow_times": 0,
"page": 1150,
"image_url": "http://img5.douban.com/mpic/s4243918.jpg",
"isbn10": "0131872486",
"book_status": "available",
"object_name": "Thinking in Java",
"authors": [
""
]
},
"links": [
{
"rel": "type",
"href": "types/contents/iigbook_book"
},
{
"rel": "version-history",
"href": "contents/iigbook_book/0901e24080019b2b/versions"
},
{
"rel": "edit",
"href": "contents/iigbook_book/0901e24080019b2b"
},
{
"rel": "self",
"href": "contents/iigbook_book/0901e24080019b2b"
},
{
"rel": "http://identifiers.emc.com/linkrel/download-media",
"href": "contents/iigbook_book/0901e24080019b2b/media"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "contents/iigbook_book/0901e24080019b2b"
},
{
"rel": "http://identifiers.emc.com/linkrel/checkout",
"href": "contents/iigbook_book/0901e24080019b2b/lock"
},
{
"rel": "http://identifiers.emc.com/linkrel/instances",
"href": "contents/iigbook_book"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "relationships/iigbook_book_ticket?
filter=source%3D0901e24080019b2b",
"type": "types/relationships/iigbook_book_ticket"
},
{
"rel": "http://identifiers.emc.com/linkrel/comments",
"href": "contents/iigbook_book/0901e24080019b2b/comments"
}
],
"content-type": "application/vnd.emc.xcp+json"
}
},
{
"id": "fulltext-queries/iigbook_book_ftq/315523436",
"title": "JavaScript: The Definitive Guide, 5th Edition",

324 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.56. xCP Full-Text Query single instance

"updated": "2014-01-23T09:12:07.337Z",
"summary": "JavaScript: The Definitive Guide, 5th Edition",
"content": {
"name": "fulltext-query",
"type": "iigbook_book_ftq",
"definition": "http://localhost:8000/iigbooks/types/
fulltext-queries/iigbook_book_ftq",
"properties": {
"r_creation_date": "2014-01-23T08:57:00.000Z",
"r_object_type": "iigbook_book",
"summary": "JavaScript: The Definitive Guide, 5th Edition",
"averagerate": 9.10000038146973,
"owner_name": "xcp21H2wk2",
"douban_id": "1775608",
"price": "USD 49.99",
"book_authors": [
"David Flanagan"
],
"id": "0901e24080019b2d",
"translator": [
""
],
"isbn13": "9780596101992",
"borrow_times": 0,
"page": 1032,
"image_url": "http://img5.douban.com/mpic/s4251169.jpg",
"isbn10": "0596101996",
"book_status": "available",
"object_name": "JavaScript: The Definitive Guide, 5th Edition",
"authors": [
""
]
},
"links": [
{
"rel": "type",
"href": "types/contents/iigbook_book"
},
{
"rel": "version-history",
"href": "contents/iigbook_book/0901e24080019b2d/versions"
},
{
"rel": "edit",
"href": "contents/iigbook_book/0901e24080019b2d"
},
{
"rel": "self",
"href": "contents/iigbook_book/0901e24080019b2d"
},
{
"rel": "http://identifiers.emc.com/linkrel/download-media",
"href": "contents/iigbook_book/0901e24080019b2d/media"
},
{
"rel": "http://identifiers.emc.com/linkrel/delete",
"href": "contents/iigbook_book/0901e24080019b2d"
},
{
"rel": "http://identifiers.emc.com/linkrel/checkout",
"href": "contents/iigbook_book/0901e24080019b2d/lock"
},
{
"rel": "http://identifiers.emc.com/linkrel/instances",
"href": "contents/iigbook_book"
},
{
"rel": "http://identifiers.emc.com/linkrel/relations",
"href": "relationships/iigbook_book_ticket?
filter=source%3D0901e24080019b2d",

EDCPKL230200-PGR-EN-01 Development Guide 325

Chapter 4 Resources

"type": "types/relationships/iigbook_book_ticket"
},
{
"rel": "http://identifiers.emc.com/linkrel/comments",
"href": "contents/iigbook_book/0901e24080019b2d/comments"
}
],
"content-type": "application/vnd.emc.xcp+json"
}
}
],
"facets": [
{
"name": "publish_date",
"values": [
{
"name": "TODAY",
"count": 0,
"constraint": "2014-01-23T00:00:00.000\\
+0000/2014-01-24T00:00:00.000\\+0000"
},
{
"name": "YESTERDAY",
"count": 0,
"constraint": "2014-01-22T00:00:00.000\\
+0000/2014-01-23T00:00:00.000\\+0000"
},
{
"name": "THIS_WEEK",
"count": 0,
"constraint": "2014-01-20T00:00:00.000\\
+0000/2014-01-27T00:00:00.000\\+0000"
},
{
"name": "THIS_MONTH",
"count": 0,
"constraint": "2014-01-01T00:00:00.000\\
+0000/2014-02-01T00:00:00.000\\+0000"
},
{
"name": "LAST_MONTH",
"count": 0,
"constraint": "2013-12-01T00:00:00.000\\
+0000/2014-01-01T00:00:00.000\\+0000"
},
{
"name": "THIS_YEAR",
"count": 0,
"constraint": "2014-01-01T00:00:00.000\\
+0000/2015-01-01T00:00:00.000\\+0000"
},
{
"name": "LAST_YEAR",
"count": 0,
"constraint": "2013-01-01T00:00:00.000\\
+0000/2014-01-01T00:00:00.000\\+0000"
},
{
"name": "OLDER",
"count": 0,
"constraint": "/2013-01-01T00:00:00.000\\+0000"
}
]
},
{
"name": "created_on",
"values": [
{
"name": "TODAY",
"count": 3,

326 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.56. xCP Full-Text Query single instance

"constraint": "2014-01-23T00:00:00.000\\
+0000/2014-01-24T00:00:00.000\\+0000"
},
{
"name": "YESTERDAY",
"count": 0,
"constraint": "2014-01-22T00:00:00.000\\
+0000/2014-01-23T00:00:00.000\\+0000"
},
{
"name": "THIS_WEEK",
"count": 3,
"constraint": "2014-01-20T00:00:00.000\\
+0000/2014-01-27T00:00:00.000\\+0000"
},
{
"name": "THIS_MONTH",
"count": 3,
"constraint": "2014-01-01T00:00:00.000\\
+0000/2014-02-01T00:00:00.000\\+0000"
},
{
"name": "LAST_MONTH",
"count": 0,
"constraint": "2013-12-01T00:00:00.000\\
+0000/2014-01-01T00:00:00.000\\+0000"
},
{
"name": "THIS_YEAR",
"count": 3,
"constraint": "2014-01-01T00:00:00.000\\
+0000/2015-01-01T00:00:00.000\\+0000"
},
{
"name": "LAST_YEAR",
"count": 0,
"constraint": "2013-01-01T00:00:00.000\\
+0000/2014-01-01T00:00:00.000\\+0000"
},
{
"name": "OLDER",
"count": 0,
"constraint": "/2013-01-01T00:00:00.000\\+0000"
}
]
},
{
"name": "book_status",
"values": [
{
"name": "available",
"count": 3,
"constraint": "available"
}
]
},
{
"name": "averagerate",
"values": [
{
"name": "0",
"count": 1,
"constraint": "0"
},
{
"name": "8.80000019073486",
"count": 1,
"constraint": "8.80000019073486"
},
{

EDCPKL230200-PGR-EN-01 Development Guide 327

Chapter 4 Resources

"name": "9.10000038146973",
"count": 1,
"constraint": "9.10000038146973"
}
]
},
{
"name": "book_authors",
"values": [
{
"name": "Bruce Eckel",
"count": 1,
"constraint": "Bruce Eckel"
},
{
"name": "David Flanagan",
"count": 1,
"constraint": "David Flanagan"
},
{
"name": "Lessing, Gotthold Ephraim; Heine, Heinrich;
Marlowe, Christopher",
"count": 1,
"constraint": "Lessing, Gotthold Ephraim; Heine, Heinrich;
Marlowe, Christopher"
}
]
}
]
}

4.57 xCP Full-Text Query Single Type

A single instance of Full-Text Query Type represents the type definition of a full-text
query that is configured in xCP Designer.

4.57.1 URI template

/types/fulltext-queries/query-type

query-type Type of the full-text query

4.57.2 Link relation

The following table lists general link relations for a Full-Text Query Type resource.

Link relation Description Resource reference

self Type definition of a full-text “xCP Full-Text Query Single
query Type” on page 328
instances [1] Full-Text Query instance “xCP Full-Text Query single
instance” on page 316

328 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.57. xCP Full-Text Query Single Type

Link relation Description Resource reference

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.57.3 Operations
A Full-Text Query Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of a full-text
query

4.57.3.1 Get a Full-Text Query Type

Retrieve the type definition of a full-text query.

4.57.3.1.1 HTTP method

GET

4.57.3.1.2 Query parameters

None.

4.57.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.57.3.1.4 Request body

None.

4.57.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 329

Chapter 4 Resources

4.57.3.1.6 Supported response media types

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

4.57.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.57.3.1.8 Response body

XML or JSON representation of the type definition of a full-text query. The Type
definition mainly contains the following elements:

Element Description
properties Specifies a set of properties that are
displayed in the output table in xCP.
expression-set Specifies a set of condition constraints with
AND or OR operators.
facets Specifies facets of the query.
sort Specifies sort settings.
options Specifies which version of the result to
return. Valid values are:
• LATEST: Only returns the latest version
of a result
• All: Returns all versions of a result

330 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.58. xCP Full-Text Query Type collection

4.58 xCP Full-Text Query Type collection

A Full-Text Query Type collection represents a collection of type definitions for Full-
Text Query instances.

Note: By default, xCP search uses only the date attribute as an input value for
a Full Text Query (FTQ). You can enable the time element for xCP search using
the query_precision parameter. For more information about how to enable
the time element for xCP search, see Documentum xCP Designer Help.

4.58.1 URI template

/types/fulltext-queries

4.58.2 Feed and EDAA support

A collection of Full-Text Query Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/fulltext-queries/
Title Name of Feed Fulltext Queries
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/fulltext-queries/
and name of the type sample_query
Title Query name sample_query
Summary Summary of the query A sample query
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 331

Chapter 4 Resources

4.58.3 Link relation

The following table lists link relation(s) for a Full-Text Query Type collection
resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Full-Text Query Type
for Full-Text Query instances collection” on page 331

4.58.4 Operations
A Full-Text Query Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Full-Text Query instances

4.58.4.1 Get a Full-Text Query Type collection

Retrieve a collection of type definitions for Full-Text Query instances.

4.58.4.1.1 HTTP method

GET

4.58.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total
• sort

• permissions

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

332 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.58. xCP Full-Text Query Type collection

4.58.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.58.4.1.4 Request body

None.

4.58.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.58.4.1.6 Supported response media types

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

4.58.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 333

Chapter 4 Resources

4.58.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Full-Text Query

instances.

• Each instance may contain all or a set of properties of the type definitions for
Full-Text Query instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.59 xCP Historical Query single instance

A single instance of the Historical Query resource functions as a business activity
monitor (BAM) that captures data flows in the system of an external database,
performs various functions (SUM, COUNT, AVG, and etc.) on the information
captured, and then returns the results in a data set form. The result set can be shown
in internal reports or in external tools, such as Crystal reports.

4.59.1 URI template

historical-queries/historical-query-name/sequence_number

historical-query-name Type of the historical query

sequence_number Zero-based sequence number

4.59.2 Link relation

The following table lists general link relation for a Historical Query resource.

Link relation Description Resource reference

instances [1] collection of the Historical “xCP Historical Query
Query instances collection” on page 336
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

334 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.59. xCP Historical Query single instance

4.59.3 Operations
A Historical Query resource supports the following HTTP method.

Method Description
GET Retrieve a Historical Query resource

4.59.3.1 Get a Historical Query

Retrieve a Historical Query instance.

4.59.3.1.1 HTTP method

GET

4.59.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.59.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.59.3.1.4 Request body

None.

4.59.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 335

Chapter 4 Resources

4.59.3.1.6 Supported response media types

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

4.59.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.59.3.1.8 Response body

XML or JSON representation of the Historical Query resource.

Null values are presented as an empty string (“”).

4.60 xCP Historical Query collection

A Historical Query collection represents a collection of Historical Query instances.

4.60.1 URI template

historical-queries/historical-query-name

historical-query-name Type of the historical query

4.60.2 Feed and EDAA support

A collection of Historical Query instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://127.0.0.1:8080/xcp-rest/
historical-queries/
ut200_hq_bo_all_attribute

336 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.60. xCP Historical Query collection

Feed property Feed value Example

Title Historical Queries Historical Queries
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://127.0.0.1:8080/xcp-rest/
follows this pattern: <Feed_ historical-queries/
URI>/<sequence_ ut200_hq_bo_all_attribute/0
number>
Title Entry title Entry title
Summary Entry summary Entry summary
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.60.3 Link relation

The following table lists link relation(s) for a Historical Query collection resource.

Link relation Description Resource reference

self This collection resource “xCP Historical Query
collection” on page 336
first, last, previous, next Pagination links “xCP Historical Query
collection” on page 336

4.60.4 Operations
A Historical Query collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Historical Query
instances.

EDCPKL230200-PGR-EN-01 Development Guide 337

Chapter 4 Resources

4.60.4.1 Get a Historical Query collection

Retrieve a collection of Historical Query instances.

4.60.4.1.1 HTTP method

GET

4.60.4.1.2 Query parameters

The following query parameters are specific to this operation:

Name Description Data Type Value Range Default Value

time-dimension Controls the string HOURLY, DAILY
time granularity DAILY,
aspect for BAM WEEKLY,
reports. This QUARTERLY,
parameter and YEARLY
specifies the
aggregation
table from which
the request
retrieves data.
For example, if
you set this
parameter to
HOURLY, the
request retrieves
data from the
HOURLY
aggregation
table.

338 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.60. xCP Historical Query collection

Name Description Data Type Value Range Default Value

relative-last-time Specifies the integer =>1 1
relative period
of time to look
back for.

For example, the

following
combination
retrieves data of
the last two
hours from the
hourly
aggregation
table on which
step 1
calculation is
performed.
? calculation-
step=1&time-
dimension=
HOURLY&relative-
last-time=2

This operation also supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.60.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 339

Chapter 4 Resources

4.60.4.1.4 Request body

None.

4.60.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.60.4.1.6 Supported response media types

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

4.60.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.60.4.1.8 Response body

XML or JSON representation of a collection of Historical Query instances.

• Each instance may contain all or a set of properties of the Historical Query
instance, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

340 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.61. xCP Historical Query Single Type

4.61 xCP Historical Query Single Type

A single instance of Historical Query Type represents the type definition of
Historical Query instances.

4.61.1 URI template

/types/historical-queries/historical-query-type

historical-query-type Type of the historical query

4.61.2 Link relation

The following table lists general link relations for a Historical Query Type resource.

Link relation Description Resource reference

self Type definition of Historical “xCP Historical Query Single
Query instances Type” on page 341
instances [1] collection of the Historical “xCP Historical Query
Query instances collection” on page 336
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.61.3 Operations
A Historical Query Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Historical
Query instances

4.61.3.1 Get a Historical Query Type

Retrieve the type definition of Historical Query instances.

EDCPKL230200-PGR-EN-01 Development Guide 341

Chapter 4 Resources

4.61.3.1.1 HTTP method

GET

4.61.3.1.2 Query parameters

None.

4.61.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.61.3.1.4 Request body

None.

4.61.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.61.3.1.6 Supported response media types

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

4.61.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

342 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.62. xCP Historical Query Type collection

4.61.3.1.8 Response body

XML or JSON representation of the type definition of Historical Query instances.

The instances link relation points to a collection of Historical Query instances,
through which you can retrieve an “xCP Historical Query collection” on page 336.

4.62 xCP Historical Query Type collection

A Historical Query Type collection represents a collection of type definitions for
Historical Query instances.

4.62.1 URI template

/types/historical-queries

4.62.2 Feed and EDAA support

A collection of Historical Query Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://127.0.0.1:8080/xcp-rest/
types/historical-queries
Title Name of Feed historical-query type
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which /types/historical-queries/xcp-
contains the URI of the feed historical-query
and name of the type
Title Title xcp-historical-query
Summary Summary xcp-historical-query
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 343

Chapter 4 Resources

4.62.3 Link relation

The following table lists link relation(s) for a Historical Query Type collection
resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Historical Query Type
for Historical Query collection” on page 343
instances

4.62.4 Operations
A Historical Query Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Historical Query instances

4.62.4.1 Get a Historical Query Type collection

Retrieve a collection of type definitions for Historical Query instances.

4.62.4.1.1 HTTP method

GET

4.62.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page
• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

344 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.62. xCP Historical Query Type collection

4.62.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.62.4.1.4 Request body

None.

4.62.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.62.4.1.6 Supported response media types

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

4.62.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 345

Chapter 4 Resources

4.62.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Historical Query

instances.

• Each instance may contain all or a set of properties of the type definitions for
Historical Query instances, depending on the setting of the query parameter
view.

• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.63 xCP Home Document

Home Document is an entry point to the REST Server. This resource enables a client
application in the runtime environment to discover resources, media types, and
operations that the REST Server supports.

4.63.1 URI template

/service

4.63.2 Resources
The following table lists the resources that can be discovered in the xCP Home
Document resource.

Resource Description Resource reference

repositories [1] xCP repository “xCP repository single
instance” on page 461
application [1] Application instance “xCP application single
instance” on page 124
business-object-types [1] Type definitions of business “xCP Business Object Single
objects Type” on page 157
content-types [1] Type definitions of contents “xCP Content Single Type”
on page 230
folder-types [1] Type definitions of folders “xCP Folder Single Type”
on page 254
picklist-types [1] Type definitions of picklist “xCP Picklist Single Type”
on page 385
relationship-types [1] Type definitions of “xCP Relationship Single
relationships Type” on page 450
alert-types [1] Type definitions of alerts “xCP Alert Single Type”
on page 112

346 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.63. xCP Home Document

Resource Description Resource reference

processes [1] Type definitions of processes “xCP Process Single Type”
on page 402
fulltext-query [1] Type definitions of fulltext “xCP Full-Text Query Single
queries Type” on page 328
historical-query [1] Type definitions of historical “xCP Historical Query Single
queries Type” on page 341
realtime-query [1] Type definitions of realtime “xCP Real-Time query single
queries type” on page 433
alert-query [1] Type definitions of alert “xCP alert query single type”
queries on page 99
tasklist-query [1] Type definitions of tasklist “xCP Tasklist query single
queries type” on page 502
upload [1] File upload “xCP File Upload Resource”
on page 238
about Product information “xCP product information
single instance” on page 407
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.63.3 Operations
The Home Document resource supports the following HTTP method.

Method Description
GET Retrieve the Home Document resource

4.63.3.1 Get the Home Document

Retrieve the Home Document, which contains information about the resources,
media types, and operations that the REST Server supports.

4.63.3.1.1 HTTP method

GET

EDCPKL230200-PGR-EN-01 Development Guide 347

Chapter 4 Resources

4.63.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.63.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.63.3.1.4 Request body

None.

4.63.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.63.3.1.6 Supported response media types

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

4.63.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

348 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.63. xCP Home Document

4.63.3.1.8 Response body

XML or JSON representation of the Home Document resource.

Example 4-33: Home Document in JSON

{
"resources": {
"http://identifiers.emc.com/linkrel/repositories": {
"href": "repositories/xcp_repository",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json"
]
}
},
"http://identifiers.emc.com/linkrel/application": {
"href": "application",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json"]
}
},
"http://identifiers.emc.com/linkrel/business-object-types": {
"href": "types/business-objects",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"http://identifiers.emc.com/linkrel/content-types": {
"href": "types/contents",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"http://identifiers.emc.com/linkrel/folder-types": {
"href": "types/folders",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"http://identifiers.emc.com/linkrel/picklist-types": {
"href": "types/picklists",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",

EDCPKL230200-PGR-EN-01 Development Guide 349

Chapter 4 Resources

"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"http://identifiers.emc.com/linkrel/relationship-types": {
"href": "types/relationships",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"http://identifiers.emc.com/linkrel/alert-types": {
"href": "types/alerts",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"http://identifiers.emc.com/linkrel/processes": {
"href": "types/processes",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"http://identifiers.emc.com/linkrel/fulltext-query": {
"href": "types/fulltext-queries",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"http://identifiers.emc.com/linkrel/historical-query": {
"href": "types/historical-queries",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"http://identifiers.emc.com/linkrel/realtime-query": {
"href": "types/realtime-queries",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},

350 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.63. xCP Home Document

"http://identifiers.emc.com/linkrel/alert-query": {
"href": "types/alert-queries",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"http://identifiers.emc.com/linkrel/tasklist-query": {
"href": "types/tasklist-queries",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"about": {
"href": "products/xcp_product_info",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json"]
}
},
"http://identifiers.emc.com/linkrel/upload": {
"href": "files",
"hints": {
"allow": ["POST"],
"representations": ["multipart/form-data"]
}
},
"http://identifiers.emc.com/linkrel/tasks/next-task": {
"href": "tasks/next-task",
"hints": {
"allow": ["GET"],
"representations": ["application/xml",
"application/json",
"application/vnd.emc.xcp+xml",
"application/vnd.emc.xcp+json"]
}
}
}
}

Example 4-34: Home Document in XML

<resources xmlns="http://identifiers.emc.com/vocab/xcp">
<resource rel="http://identifiers.emc.com/linkrel/repositories">
<link href="repositories/xcp_repository" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
</representations>
</hints>

EDCPKL230200-PGR-EN-01 Development Guide 351

Chapter 4 Resources

</resource>
<resource rel="http://identifiers.emc.com/linkrel/application">
<link href="application" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/business-object-types">
<link href="types/business-objects" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/content-types">
<link href="types/contents" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/folder-types">
<link href="types/folders" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/picklist-types">
<link href="types/picklists" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/relationship-types">
<link href="types/relationships" />
<hints>
<allow>GET</allow>
<representations>

352 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.63. xCP Home Document

<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/alert-types">
<link href="types/alerts" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/processes">
<link href="types/processes" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/fulltext-query">
<link href="types/fulltext-queries" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/historical-query">
<link href="types/historical-queries" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/realtime-query">
<link href="types/realtime-queries" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>

EDCPKL230200-PGR-EN-01 Development Guide 353

Chapter 4 Resources

</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/alert-query">
<link href="types/alert-queries" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/tasklist-query">
<link href="types/tasklist-queries" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
<i>application/atom+xml</i>
</representations>
</hints>
</resource>
<resource rel="about">
<link href="products/xcp_product_info" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/upload">
<link href="files" />
<hints>
<allow>POST</allow>
<representations>
<i>multipart/form-data</i>
</representations>
</hints>
</resource>
<resource rel="http://identifiers.emc.com/linkrel/tasks/next-task">
<link href="tasks/next-task" />
<hints>
<allow>GET</allow>
<representations>
<i>application/xml</i>
<i>application/json</i>
<i>application/vnd.emc.xcp+xml</i>
<i>application/vnd.emc.xcp+json</i>
</representations>
</hints>
</resource>
</resources>

354 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.64. xCP Member single instance

4.64 xCP Member single instance

A single instance of Member represents one of the following objects:

• user
• group
• role

4.64.1 URI template

/members/xcp_member/member-id

member-id r_object-id of the Member resource

4.64.2 Link relation

The following table lists general link relations for a Member resource.

Link relation Description Resource reference

type Type definition of this “xCP Member Single Type”
resource on page 369
potentialmembers [1] collection of potential “xCP Member collection”
members of this Member. on page 361

This link relation only exists

in role and group members.
members [1] collection of the Member “xCP Member collection”
instances that belong to this on page 361
Member.

This link relation only exists

in role and group members.
self This Member instance “xCP Member single
instance” on page 355
preferences Preferences of the Member “xCP user preference single
instance” on page 519
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

EDCPKL230200-PGR-EN-01 Development Guide 355

Chapter 4 Resources

4.64.3 Operations
A Member resource supports the following HTTP methods.

Method Description
GET Retrieve a Member resource
POST Add a Member resource to a role or group
member
DELETE Remove a Member resource from a role or
group member

4.64.3.1 Get a Member

Retrieve a Member resource.

4.64.3.1.1 HTTP method

GET

4.64.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.64.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.64.3.1.4 Request body

None.

356 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.64. xCP Member single instance

4.64.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.64.3.1.6 Supported response media types

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

4.64.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.64.3.1.8 Response body

XML or JSON representation of the Member resource.

• The type link relation points to the type definition of the Member resource,
through which you can retrieve an “xCP Member Single Type” on page 369.
• Null values are presented as an empty string (“”).

{
name: "member"
type: "xcp_member"
definition: "http://localhost:8000/xcprestapp/
types/members/xcp_member"
properties: {
login_name: "dmadmin"
label: "dmadmin"
member_type: "user"
name: "dmadmin"
r_object_id: "1101e24080000102"
is_superuser: true
member_email: "[email protected]"
}
links:
{
rel: "type"
href: "types/members/xcp_member"
}

EDCPKL230200-PGR-EN-01 Development Guide 357

Chapter 4 Resources

{
rel: "self"
href: "members/xcp_member/1101e24080000102"
}
{
rel: "http://identifiers.emc.com/linkrel/preferences"
href: "preferences/xcp_preference"
}
}

4.64.3.2 Add a Member

Add an existing member to a role or group member.

4.64.3.2.1 HTTP method

POST

To add an existing member to a role or group member, send a POST request to the
members link relation of the role or group member.
http://127.0.0.1:8080/<rest-app-name>/members/xcp_member?member-of=<member-id>

4.64.3.2.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.64.3.2.3 Query parameters

The following query parameter is specific to this operation:

Parameter Description Data Type Default

member-of r_object-id of the integer NA
member resource to
which you add a
member

4.64.3.2.4 Request headers

• Accept

• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

358 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.64. xCP Member single instance

4.64.3.2.5 Request body

URI of the member that you want to add.

Example:
{"href":"http://127.0.0.1:8080/xcp-rest/members/xcp_member/1101f70180000159"}

4.64.3.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.64.3.2.7 Supported response media types

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

4.64.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 359

Chapter 4 Resources

4.64.3.2.9 Response body

XML or JSON representation of the updated Member resource:

• You can locate the newly-added member by accessing the members link relation
of the updated Member resource.
• The type link relation points to the type definition of the Member resource,
through which you can retrieve a “xCP Member Single Type” on page 369.
• Null values are presented as an empty string (“”).

4.64.3.3 Remove a Member

Remove a member from a role or group member.

4.64.3.3.1 HTTP method

DELETE

To remove a member from a role or group member, send a DELETE request to the
potentialmembers link relation of the role or group member with the following
pattern:
http://127.0.0.1:8080/<rest-app-name>/members/xcp_member?potential-member-of=<member-id>

4.64.3.3.2 Query parameters

The following query parameter is specific to this operation:

Parameter Description Data Type Default

potential-member-of r_object-id of the integer NA
member resource
from which you
remove a member

4.64.3.3.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

360 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.65. xCP Member collection

4.64.3.3.4 Request body

URI of the member that you want to remove.

Example:
{"href":"http://127.0.0.1:8080/xcp-rest/members/xcp_member/1101f70180000159"}

4.64.3.3.5 Response headers

None.

4.64.3.3.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

4.64.3.3.7 Response body

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

4.65 xCP Member collection

A Member collection represents a collection of Member instances.

4.65.1 URI template

/Members/member-type

member-type Type of the member

EDCPKL230200-PGR-EN-01 Development Guide 361

Chapter 4 Resources

4.65.2 Feed and EDAA support

A collection of Member instances conforms to Atom Feed in XML representation
and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
members/xcp_member
Title Members Members
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ members/xcp_member/
uri>/<entry_id> 1201f70180000900
Title user_name or group_name test-member
Summary user_name or group_name test-member
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.65.3 Link relation

The following table lists link relation(s) for a Member collection resource.

Link relation Description Resource reference

self This collection resource “xCP Member collection”
on page 361
first, last, previous, next Pagination links “xCP Member collection”
on page 361

362 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.65. xCP Member collection

4.65.4 Operations
A Member collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Member instances of
a certain type.
GET Retrieve a collection of members of a role or
group
GET Retrieve a collection of potential members of
a role or group

4.65.4.1 Get a Member collection

Retrieve a collection of Member instances of a certain type.

4.65.4.1.1 HTTP method

GET

4.65.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 363

Chapter 4 Resources

4.65.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.65.4.1.4 Request body

None.

4.65.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.65.4.1.6 Supported response media types

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

4.65.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

364 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.65. xCP Member collection

4.65.4.1.8 Response body

XML or JSON representation of a collection of Member instances.

• Each instance may contain all or a set of properties of the Member instance,
depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.65.4.2 Get a Member collection of a Role or Group

Retrieve a collection of Member instances under a role or group.

4.65.4.2.1 HTTP method

GET

To get the members of a role or group member, send a GET request to the members
link relation of the role or group member.
http://127.0.0.1:8080/<rest-app-name>/members/xcp_member?member-of=<member-id>

4.65.4.2.2 Query parameters

The following query parameter is specific to this operation:

Parameter Description Data Type Default

member-of r_object-id of the integer NA
member resource to
which the collection
of Member resources
belongs

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 365

Chapter 4 Resources

4.65.4.2.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.65.4.2.4 Request body

None.

4.65.4.2.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.65.4.2.6 Supported response media types

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

4.65.4.2.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

366 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.65. xCP Member collection

4.65.4.2.8 Response body

XML or JSON representation of a collection of Member instances.

• Each instance may contain all or a set of properties of the Member instance,
depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.65.4.3 Get a Potential Member collection of a Role or Group

Retrieve a collection of Potential Member instances under a role or group.

4.65.4.3.1 HTTP method

GET

To get the potential members of a role or group member, send a GET request to the
potentialmembers link relation of the role or group member.
http://127.0.0.1:8080/<rest-app-name>/members/xcp_member?potential-member-of=<member-id>

4.65.4.3.2 Query parameters

The following query parameter is specific to this operation:

Parameter Description Data Type Default

potential-member-of r_object-id of the integer NA
member resource to
which the collection
of Member resources
belongs

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 367

Chapter 4 Resources

4.65.4.3.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.65.4.3.4 Request body

None.

4.65.4.3.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.65.4.3.6 Supported response media types

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

4.65.4.3.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

368 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.66. xCP Member Single Type

4.65.4.3.8 Response body

XML or JSON representation of a collection of Member instances.

• Each instance may contain all or a set of properties of the Member instance,
depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.66 xCP Member Single Type

A single instance of Member Type represents the type definition of Member
instances.

4.66.1 URI template

/types/member-type

member-type Type of the Members

4.66.2 Link relation

The following table lists general link relations for a Member Type resource.

Link relation Description Resource reference

self Type definition of Member “xCP Member Single Type”
instances on page 369
instances [1] collection of the Member “xCP Member collection”
instances on page 361
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.66.3 Operations
A Member Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Member
instances

EDCPKL230200-PGR-EN-01 Development Guide 369

Chapter 4 Resources

4.66.3.1 Get a Member Type

Retrieve the type definition of Member instances.

4.66.3.1.1 HTTP method

GET

4.66.3.1.2 Query parameters

None.

4.66.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.66.3.1.4 Request body

None.

4.66.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.66.3.1.6 Supported response media types

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

4.66.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

370 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.67. xCP Member Type collection

4.66.3.1.8 Response body

XML or JSON representation of the type definition of Member instances. The

instances link relation points to a collection of Member instances, through which
you can retrieve an “xCP Member collection” on page 361.

4.67 xCP Member Type collection

A Member Type collection represents a collection of type definitions for Member
instances.

4.67.1 URI template

/types/members

4.67.2 Feed and EDAA support

A collection of Member Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/members
Title Members Members
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/members/xcp_member
and name of the type
Title xcp_member xcp_member
Summary Label of the type Format Type
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 371

Chapter 4 Resources

4.67.3 Link relation

The following table lists link relation(s) for a Member Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Member Type
for Member instances collection” on page 371

4.67.4 Operations
A Member Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Member Type instances

4.67.4.1 Get a Member Type collection

Retrieve a collection of type definitions for Member Type instances.

4.67.4.1.1 HTTP method

GET

4.67.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

372 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.67. xCP Member Type collection

4.67.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.67.4.1.4 Request body

None.

4.67.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.67.4.1.6 Supported response media types

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

4.67.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 373

Chapter 4 Resources

4.67.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Member

instances.

• Each instance may contain all or a set of properties of the type definitions for
Member instances, depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.68 xCP Network Location single instance

A single instance of Network Location is a resource that records information about
the network locations of hosts.

4.68.1 URI template

/network-locations/networklocation-type/r_object-id

networklocation-type Type of the network location

r_object-id Object ID of the network location

4.68.2 Link relation

The following table lists general link relations for a Network Location resource.

Link relation Description Resource reference

type Type definition of this “xCP Network Location
resource Single Type” on page 379
self This Network Location “xCP Network Location
instance single instance” on page 374

4.68.3 Operations
A Network Location resource supports the following HTTP method.

Method Description
GET Retrieve a Network Location resource

374 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.68. xCP Network Location single instance

4.68.3.1 Get a Network Location

Retrieve a Network Location resource.

4.68.3.1.1 HTTP method

GET

4.68.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.68.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.68.3.1.4 Request body

None.

4.68.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.68.3.1.6 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

EDCPKL230200-PGR-EN-01 Development Guide 375

Chapter 4 Resources

4.68.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.68.3.1.8 Response body

XML or JSON representation of the Network Location resource.

• The type link relation points to the type definition of the Network Location
resource, through which you can retrieve an “xCP Network Location Single
Type” on page 379.
• Null values are presented as an empty string (“”).

4.69 xCP Network Location collection

A Network Location collection represents a collection of Network Location
instances.

4.69.1 URI template

/network-locations/networklocation-type

networklocation-type Type of the network location

4.69.2 Feed and EDAA support

A collection of Network Location instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
network-locations/
xcp_network_location
Title Network Location xcp_network_location

376 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.69. xCP Network Location collection

Feed property Feed value Example

Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ network-locations/
uri>/<entry_id> xcp_network_location/
0800492d8000d7fa
Title Entry title host1_network_location
Summary Entry summary host1 network location
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.69.3 Link relation

The following table lists link relation(s) for a Network Location collection resource.

Link relation Description Resource reference

self This collection resource “xCP Network Location
collection” on page 376
first, last, previous, next Pagination links “xCP Network Location
collection” on page 376

4.69.4 Operations
A Network Location collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Network Location
instances.

EDCPKL230200-PGR-EN-01 Development Guide 377

Chapter 4 Resources

4.69.4.1 Get a Network Location collection

Retrieve a collection of Network Location instances of a certain type.

4.69.4.1.1 HTTP method

GET

4.69.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.69.4.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.69.4.1.4 Request body

None.

4.69.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

378 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.70. xCP Network Location Single Type

4.69.4.1.6 Supported response media types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.69.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.69.4.1.8 Response body

XML or JSON representation of a collection of Network Location instances.

• Each instance may contain all or a set of properties of the Network Location
instance, depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.70 xCP Network Location Single Type

A single instance of Network Location Type represents the type definition of
Network Location instances.

4.70.1 URI template

/types/network-locations/networklocation-type

networklocation-type Type of the network location

EDCPKL230200-PGR-EN-01 Development Guide 379

Chapter 4 Resources

4.70.2 Link relation

The following table lists general link relations for a Network Location Type
resource.

Link relation Description Resource reference

self Type definition of Network “xCP Network Location
Location instances Single Type” on page 379
instances [1] collection of the Network “xCP Network Location
Location instances collection” on page 376
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.70.3 Operations
A Network Location Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Network
Location instances

4.70.3.1 Get a Network Location Type

Retrieve the type definition of Network Location instances.

4.70.3.1.1 HTTP method

GET

4.70.3.1.2 Query parameters

None.

4.70.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

380 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.71. xCP Network Location Type collection

4.70.3.1.4 Request body

None.

4.70.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.70.3.1.6 Supported response media types

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

4.70.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.70.3.1.8 Response body

XML or JSON representation of the type definition of Network Location instances.

The instances link relation points to a collection of Network Location instances,
through which you can retrieve an “xCP Network Location collection” on page 376.

4.71 xCP Network Location Type collection

A Network Location Type collection represents a collection of type definitions for
Network Location instances.

EDCPKL230200-PGR-EN-01 Development Guide 381

Chapter 4 Resources

4.71.1 URI template

/types/network-locations

4.71.2 Feed and EDAA support

A collection of Network Location Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/network-locations
Title Name of Feed Network Locations
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/network-locations/xcp-
and name of the type network-location
Title Name of the network xcp-network-location
location type
Summary Summary xCP Network locations
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.71.3 Link relation

The following table lists link relation(s) for a Network Location Type collection
resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Network Location Type
for Network Location collection” on page 381
instances

382 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.71. xCP Network Location Type collection

4.71.4 Operations
A Network Location Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Network Location instances

4.71.4.1 Get a Network Location Type collection

Retrieve a collection of type definitions for Network Location instances.

4.71.4.1.1 HTTP method

GET

4.71.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.71.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 383

Chapter 4 Resources

4.71.4.1.4 Request body

None.

4.71.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.71.4.1.6 Supported response media types

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

4.71.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.71.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Network Location

instances.

• Each instance may contain all or a set of properties of the type definitions for
Network Location instances, depending on the setting of the query parameter
view.

• The returned collection contains only those entries that you have access to.
• Pagination is supported.

384 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.72. xCP Picklist Single Type

4.72 xCP Picklist Single Type

A single instance of the Picklist Type resource is a static list that contains one or
more key/value pairs representing the type definition of a value.

4.72.1 URI template

/types/picklists/picklist-type

picklist-type Type of the picklist

4.72.2 Link relation

The following table lists link relation(s) for a Picklist Type resource.

Link relation Description Resource reference

self This Picklist Type resource “xCP Picklist Single Type”
on page 385

4.72.3 Operations
A Picklist Type resource supports the following HTTP method.

Method Description
GET Retrieve a Picklist Type resource

4.72.3.1 Get a Picklist

Retrieve a Picklist Type resource, which describes the type definition of a certain
value.

4.72.3.1.1 HTTP method

GET

4.72.3.1.2 Query parameters

None.

EDCPKL230200-PGR-EN-01 Development Guide 385

Chapter 4 Resources

4.72.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.72.3.1.4 Request body

None.

4.72.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.72.3.1.6 Supported response media types

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

4.72.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

386 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.73. xCP Picklist Type collection

4.72.3.1.8 Response body

XML or JSON representation of the Picklist Type resource.

Example 4-35: Response in XML

<?xml version="1.0" encoding="UTF-8"?>
<?xml-stylesheet type="text/xsl" href="dml-to-html-converter.xslt"
?>
<picklist xsi:type="ut200_cities" label="Cities"
xmlns="http://identifiers.emc.com/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<description>Picklist Cities with entries of type String</description>
<entry label="Boston" value="Value 0" type="string" length="64"/>
<entry label="Pleasonton" value="Value 1" type="string"
length="64"/>
<entry label="NY" value="Value 2" type="string" length="64"/>
</picklist>

Example 4-36: Response in JSON

{
"name" : "picklist",
"type" : "ut200_cities",
"label" : "Cities",
"entries" : [ {
"label" : "Boston",
"value" : "Value 0",
"type" : "string",
"length" : 64
}, {
"label" : "Pleasonton",
"value" : "Value 1",
"type" : "string",
"length" : 64
}, {
"label" : "NY",
"value" : "Value 2",
"type" : "string",
"length" : 64
} ]
}

4.73 xCP Picklist Type collection

A Picklist Type collection represents a collection of Picklist type definitions.

EDCPKL230200-PGR-EN-01 Development Guide 387

Chapter 4 Resources

4.73.1 URI template

/types/picklists

4.73.2 Feed and EDAA support

A collection of Picklist Type resources conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/picklists
Title Picklists Picklists
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/picklists/
and name of the type xcp_wq_view_filter
Title Type of the picklist xcp_wq_view_filter
Summary Summary Workqueue View Filter
Picklist
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.73.3 Link relation

The following table lists link relation(s) for a Picklist Type collection resource.

Link relation Description Resource reference

self collection of Picklist type “xCP Picklist Type
definitions collection” on page 387

388 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.73. xCP Picklist Type collection

4.73.4 Operations
A Picklist Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Picklist type
definitions

4.73.4.1 Get a Picklist Type collection

Retrieve a collection of Picklist type definitions.

4.73.4.1.1 HTTP method

GET

4.73.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.73.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 389

Chapter 4 Resources

4.73.4.1.4 Request body

None.

4.73.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.73.4.1.6 Supported response media types

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

4.73.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.73.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Picklist type

definitions.

• Each instance may contain all or a set of properties of Picklist instances,

depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

390 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.74. xCP Process single instance

4.74 xCP Process single instance

A single instance of Process represents a process of the dm_workflow object type.
This resource describes the metadata, packages, and variables of a process instance.

4.74.1 URI template

/processes/process-system-name/object-id

process-system-name System name of the process

object-id Object ID of the process

4.74.2 Link relation

The following table lists general link relations for a Process resource.

Link relation Description Resource reference

type Type definition of this “xCP Process Single Type”
resource on page 402
instances [1] collection of the Process “xCP Process collection”
instances on page 395
self This Process instance “xCP Process single instance”
on page 391
tasks Tasks belong to this Process “xCP Task collection”
instance on page 488
attachments Business objects involved in “xCP Business Object
this Process instance collection” on page 154
terminate Terminate this Process /processes/
instance process-system-name/
object-id/status
resume Resume this Process instance. /processes/
process-system-name/
object-id/status
halt Halt this Process instance. /processes/
process-system-name/
object-id/status
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

EDCPKL230200-PGR-EN-01 Development Guide 391

Chapter 4 Resources

4.74.3 Operations
A Process resource supports the following HTTP methods.

Method Description
GET Retrieve a Process resource
PUT Update the status of a Process resource

4.74.3.1 Get a Process

Retrieve the metadata, packages, and variables of a Process resource.

4.74.3.1.1 HTTP method

GET

4.74.3.1.2 Query parameters

This operation does not support any query parameters.

4.74.3.1.3 Request headers

• Accept
• Content-Type
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.74.3.1.4 Request body

None.

4.74.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

392 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.74. xCP Process single instance

4.74.3.1.6 Supported response media types

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

4.74.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.74.3.1.8 Response body

XML or JSON representation of the Process resource.

• The type link relation points to the type definition of the Process resource,
through which you can retrieve an “xCP Process Single Type” on page 402.
• Null values are presented as an empty string (“”).

4.74.3.2 Update the status of a Process

Update the status a Process resource. You can update the status of a Process resource
to one of the followings:

• halt
• terminate
• resume

EDCPKL230200-PGR-EN-01 Development Guide 393

Chapter 4 Resources

4.74.3.2.1 HTTP method

PUT

To update the status of a Process resource, send a PUT request to the status link
relation of the Process resource in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/processes/<process-system-name>/<object-id>/status

4.74.3.2.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.74.3.2.3 Query parameters

None.

4.74.3.2.4 Request headers

• Accept

• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.74.3.2.5 Request body

XML or JSON representation of the status of the Process resource.

Example 4-37: Resume a halted process

<resume>
<user-name>testUser</user-name>
</resume>

4.74.3.2.6 Response headers

• Location
• Content-Length

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

394 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.75. xCP Process collection

4.74.3.2.7 Supported response media types

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

4.74.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.74.3.2.9 Response body

The response does not contain any data.

4.75 xCP Process collection

A Process collection represents a collection of Process instances of a specific process.

4.75.1 URI template

/processes/process-system-name

process-system-name System name of the process

EDCPKL230200-PGR-EN-01 Development Guide 395

Chapter 4 Resources

4.75.2 Feed and EDAA support

A collection of Process instances conforms to Atom Feed in XML representation and
EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
processes/xcp-process
Title Process system name xcp-process
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ processes/xcp-process/
uri>/<entry_id> 4d01e24080030611
Title Entry title xcp-process
Summary Entry summary xcp process
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.75.3 Link relation

The following table lists link relation(s) for a Process collection resource.

Link relation Description Resource reference

self This collection resource “xCP Process collection”
on page 395
first, last, previous, next Pagination links “xCP Process collection”
on page 395

396 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.75. xCP Process collection

4.75.4 Operations
A Process collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Process instances.
POST Create of a Process instance.

4.75.4.1 Get a Process collection

Retrieve a collection of Process instances of a certain type.

4.75.4.1.1 HTTP method

GET

4.75.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.75.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 397

Chapter 4 Resources

4.75.4.1.4 Request body

None.

4.75.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.75.4.1.6 Supported response media types

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

4.75.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.75.4.1.8 Response body

XML or JSON representation of a collection of Process instances.

• Each instance may contain all or a set of properties of the Process instance,
depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

398 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.75. xCP Process collection

4.75.4.2 Create a Process

Create a Process instance of a certain process. You can create a Process instance with
a reference to an existing business object. Alternatively, you can add an inline
business object when creating a Process resource.

4.75.4.2.1 HTTP method

POST

To create a Process instance of a certain process, send a POST request to the

collection of Process instances of that process in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/processes/<process-system-name>

4.75.4.2.2 Server accepted request media types

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

4.75.4.2.3 Query parameters

None.

4.75.4.2.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.75.4.2.5 Request body

XML or JSON representation of the Process resource.

• If the corresponding DML type (“xCP Process Single Type” on page 402)
specifies mandatory packages of certain types, the newly-created Process
resource must contain packages of the specified types.
• You can create a Process resource with a reference to an existing business object.
Alternatively, you can add an inline business object when creating a Process
resource.
• This operation creates a Process resource with all fields specified in the request.
However, if the request body contains a field that is not presented in the
corresponding DML type (“xCP Process Single Type” on page 402), the field is
ignored.
• Unspecified fields are set the default values in Documentum Server.

EDCPKL230200-PGR-EN-01 Development Guide 399

Chapter 4 Resources

• To set an existing field to null, use one of the following patterns.

Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

Example 4-38: Create a process with a reference to an existing business

object
<?xml version="1.0" encoding="UTF-8"?>
<dm:process xmlns:dm="http://identifiers.emc.com/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="rpa_rest_proc_bo_pack_m">
<dm:data>
<dm:packages>
<dm:package dm:name="package0">
<dm:business-object xsi:type="rpa_proc_loan"
href="http://127.0.0.1:8080/xcp-rest/business-objects/
rpa_proc_loan/0800075180011dc6" />
</dm:package>
</dm:packages>
</dm:data>
</dm:process>

Example 4-39: Create a process with inline business objects

<process name="utapp21_rest_proc_bo_and_vriables">
<!-- business data of the process -->
<data>
<packages>
<package name="package0">
<business-object name="utapp21_bo_all_attrs">
<attributes>
<object_name>Dimka New Test</object_name>
<str_attr_single>AA12345</str_attr_single>
<int_attr_single>0</int_attr_single>
<float_attr_single>0</float_attr_single>
<boolean_attr_single>false</boolean_attr_single>
<name>Dimka New Test Name</name>
</attributes>
</business-object>
</package>
</packages>
<variables>
<variable name="interest">34</variable>
<variable name="approvers">
<item>AA12345</item>
<item>AA12345</item>
</variable>
</variables>
<attachments>
<attachment href="http://127.0.0.1:8080/rest-server/types/business-objects/
oct15_customer/080015388001e658"/>
</attachments>
</data>
</process>

400 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.75. xCP Process collection

4.75.4.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.75.4.2.7 Supported response media types

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

4.75.4.2.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.75.4.2.9 Response body

XML or JSON representation of the Process resource:

• The type link relation points to the type definition of the Process resource,
through which you can retrieve a “xCP Process Single Type” on page 402.
• Null values are presented as an empty string (“”).

EDCPKL230200-PGR-EN-01 Development Guide 401

Chapter 4 Resources

4.76 xCP Process Single Type

A single instance of Process Type represents the type definition of Process instances.

4.76.1 URI template

/types/processes/process-system-name

process-system-name System name of the process resource

4.76.2 Link relation

The following table lists general link relations for a Process Type resource.

Link relation Description Resource reference

self Type definition of Process “xCP Process Single Type”
instances on page 402
instances [1] collection of the Process “xCP Process collection”
instances on page 395
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.76.3 Operations
A Process Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of the process

4.76.3.1 Get a Process Type

Retrieve the type definition of the process.

4.76.3.1.1 HTTP method

GET

402 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.76. xCP Process Single Type

4.76.3.1.2 Query parameters

None.

4.76.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.76.3.1.4 Request body

None.

4.76.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.76.3.1.6 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.76.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 403

Chapter 4 Resources

4.76.3.1.8 Response body

XML or JSON representation of the type definition of Process instances. The

instances link relation points to a collection of Process instances, through which
you can retrieve an “xCP Process collection” on page 395.

4.77 xCP Process Type collection

A Process Type collection represents a collection of type definitions for processes.

4.77.1 URI template

/types/processes

4.77.2 Feed and EDAA support

A collection of Process Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/processes
Title Name of Feed Processes
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/processes/xcp-process
and name of the type
Title Process type xcp-process
Summary Process type summary xcp process
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

404 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.77. xCP Process Type collection

4.77.3 Link relation

The following table lists link relation(s) for a Process Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Process Type
for Process instances collection” on page 404

4.77.4 Operations
A Process Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
processes

4.77.4.1 Get a Process Type collection

Retrieve a collection of type definitions for processes.

4.77.4.1.1 HTTP method

GET

4.77.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 405

Chapter 4 Resources

4.77.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.77.4.1.4 Request body

None.

4.77.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.77.4.1.6 Supported response media types

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

4.77.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

406 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.78. xCP product information single instance

4.77.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Process instances.

• Each instance may contain all or a set of properties of the type definitions for
Process instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.78 xCP product information single instance

A Product Information resource provides general information about the product,
including the product name, major version, minor version, and so on.

4.78.1 URI template

/product-info

4.78.2 Link relation

The following table lists general link relations for a product information resource.

Link relation Description Resource reference

type Type definition of this “xCP product information
resource type” on page 409
about This Product Information “xCP product information
instance single instance” on page 407
self This Product Information “xCP product information
instance single instance” on page 407

4.78.3 Operations
A Product Information resource supports the following HTTP method.

Method Description
GET Retrieve a Product Information resource

EDCPKL230200-PGR-EN-01 Development Guide 407

Chapter 4 Resources

4.78.3.1 Get product information

Retrieve general information about the product, including the product name, major
version, minor version, and so on.

4.78.3.1.1 HTTP method

GET

4.78.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.78.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.78.3.1.4 Request body

None.

4.78.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.78.3.1.6 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

408 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.79. xCP product information type

4.78.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.78.3.1.8 Response body

XML or JSON representation of the Product Information resource.

• The type link relation points to the type definition of the Product Information
resource, through which you can retrieve an “xCP product information type”
on page 409.
• Null values are presented as an empty string (“”).

4.79 xCP product information type

A Product Information Type represents the type definition of the Product
Information instance.

4.79.1 URI template

/types/products/xcp_product_info

4.79.2 Link relation

The following table lists general link relations for a Product Information Type
resource.

Link relation Description Resource reference

self Type definition of the “xCP product information
Product Information instance type” on page 409
about Product Information instance “xCP product information
single instance” on page 407

EDCPKL230200-PGR-EN-01 Development Guide 409

Chapter 4 Resources

4.79.3 Operations
A Product Information Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of the Product
Information instance

4.79.3.1 Get a Product Information Type

Retrieve the type definition of the Product Information instance.

4.79.3.1.1 HTTP method

GET

4.79.3.1.2 Query parameters

None.

4.79.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.79.3.1.4 Request body

None.

4.79.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.79.3.1.6 Supported response media types

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

410 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.80. xCP product information type collection

4.79.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.79.3.1.8 Response body

XML or JSON representation of the type definition of the Product Information

instance. The about link relation points to the Product Information instance ,
through which you can retrieve an “xCP product information single instance”
on page 407.

4.80 xCP product information type collection

A Product Information Type collection represents a collection of type definitions for
the Product Information instance.

4.80.1 URI template

/types/products

4.80.2 Feed and EDAA support

A collection of Product Information Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/products
Title Name of Feed Products
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

EDCPKL230200-PGR-EN-01 Development Guide 411

Chapter 4 Resources

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/products/
and name of the type xcp_product_info
Title Type name xcp_product_info
Summary Summary Application Product Info
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.80.3 Link relation

The following table lists link relation(s) for a Product Information Type collection
resource.

Link relation Description Resource reference

self Collection of type definitions “xCP product information
for the Product Information type collection” on page 411

4.80.4 Operations
A Product Information Type collection resource supports the following HTTP
method.

Method Description
GET Retrieve a collection of type definitions for
the Product Information instance

4.80.4.1 Get a Product Information Type collection

Retrieve a collection of type definitions for the Product Information instance.

4.80.4.1.1 HTTP method

GET

412 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.80. xCP product information type collection

4.80.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page
• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.80.4.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.80.4.1.4 Request body

None.

4.80.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.80.4.1.6 Supported response media types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

EDCPKL230200-PGR-EN-01 Development Guide 413

Chapter 4 Resources

4.80.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.80.4.1.8 Response body

XML or JSON representation of a collection of type definitions for the Product

Information instance.

• Each instance may contain all or a set of properties of the type definitions for the
Product Information instance, depending on the setting of the query parameter
view.

• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.81 xCP Project single instance

A single instance of Project represents a standalone unit that is reusable and can be
included in more than one xCP applications. A Project resource contains other
artifacts such as business objects, contents, relationships. These artifacts can be
passed around xCP applications.

In xCP REST Services, only projects that are a part of an xCP application is
accessible. All projects are instances of xcp-project. For more information, see
“xCP project single type” on page 420.

4.81.1 URI template

/projects/xcp_project/project_name

project_name Name of the project

414 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.81. xCP Project single instance

4.81.2 Link relation

The following table lists general link relations for a Project resource.

Link relation Description Resource reference

type Type definition of this “xCP project single type”
resource on page 420
self This Project instance “xCP Project single instance”
on page 414

4.81.3 Operations
A Project resource supports the following HTTP method.

Method Description
GET Retrieve a Project resource

4.81.3.1 Get a Project

Retrieve a Project resource.

4.81.3.1.1 HTTP method

GET

4.81.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.81.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 415

Chapter 4 Resources

4.81.3.1.4 Request body

None.

4.81.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.81.3.1.6 Supported response media types

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

4.81.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.81.3.1.8 Response body

XML or JSON representation of a Project resource.

• The type link relation points to the type definition of the Project resource,
through which you can retrieve an “xCP project single type” on page 420.
• Null values are presented as an empty string (“”).

416 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.82. xCP Project collection

4.82 xCP Project collection

A Project collection represents a collection of Project instances of the xcp_project
type. For more information about xcp_project, see “xCP project single type”
on page 420.

4.82.1 URI template

/projects/xcp_project

4.82.2 Feed and EDAA support

A collection of Project instances conforms to Atom Feed in XML representation and
EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
projects
Title xcp-projects xcp-projects
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ projects/sample-project
uri>/<entry_id>
Title Entry title sample-project
Summary Entry summary Sample Project
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 417

Chapter 4 Resources

4.82.3 Link relation

The following table lists link relation(s) for a Project collection resource.

Link relation Description Resource reference

self This collection resource “xCP Project collection”
on page 417
first, last, previous, next Pagination links “xCP Project collection”
on page 417

4.82.4 Operations
A Project collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Project instances.

4.82.4.1 Get a Project collection

Retrieve a collection of Project instances of the xcp_project type. For more
information about xcp_project, see “xCP project single type” on page 420.

4.82.4.1.1 HTTP method

GET

4.82.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page
• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

418 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.82. xCP Project collection

4.82.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.82.4.1.4 Request body

None.

4.82.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.82.4.1.6 Supported response media types

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

4.82.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 419

Chapter 4 Resources

4.82.4.1.8 Response body

XML or JSON representation of a collection of Project instances.

• Each instance may contain all or a set of properties of the Project instance,
depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.83 xCP project single type

A single instance of Project Type represents the type definition of Project instances.

4.83.1 URI template

types/projects/xcp_project

Only one project type (xcp_project) exists.

4.83.2 Link relation

The following table lists general link relations for a Project Type resource.

Link relation Description Resource reference

self Type definition of Project “xCP project single type”
instances on page 420
instances [1] collection of the Project “xCP Project collection”
instances on page 417
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.83.3 Operations
A Project Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Project
instances

420 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.83. xCP project single type

4.83.3.1 Get a Project type

Retrieve the type definition of xCP projects.

4.83.3.1.1 HTTP method

GET

4.83.3.1.2 Query parameters

None.

4.83.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.83.3.1.4 Request body

None.

4.83.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.83.3.1.6 Supported response media types

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

4.83.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 421

Chapter 4 Resources

4.83.3.1.8 Response body

XML or JSON representation of the type definition of Project instances. The

instances link relation points to a collection of Project instances, through which
you can retrieve an “xCP Project collection” on page 417.

4.84 xCP Project Type collection

A Project Type collection represents a collection of type definitions for Project
instances. Currently, only one type definition (xcp_project) for projects exists.
Therefore, this collection resource only contains one entry.

4.84.1 URI template

/types/projects

4.84.2 Feed and EDAA support

A collection of Project Type instances conforms to Atom Feed in XML representation
and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/projects
Title Name of Feed Projects
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/projects/xcp-project
and name of the type
Title xcp_project xcp_project
Summary Project Project
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

422 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.84. xCP Project Type collection

4.84.3 Link relation

The following table lists link relation(s) for a Project Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Project Type collection”
for Project instances on page 422

4.84.4 Operations
A Project Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Project instances

4.84.4.1 Get a Project Type collection

Retrieve a collection of type definitions for Project instances. Currently, only one
type definition (xcp_project) for projects exists. Therefore, this collection resource
only contains one entry.

4.84.4.1.1 HTTP method

GET

4.84.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total
• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 423

Chapter 4 Resources

4.84.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.84.4.1.4 Request body

None.

4.84.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.84.4.1.6 Supported response media types

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

4.84.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

424 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.85. xCP Queue List single instance

4.84.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Project instances.

• Each instance may contain all or a set of properties of the type definitions for
Project instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.85 xCP Queue List single instance

A single instance of Queue List returns a list of queues belonging to the current user
from a set of queues identified in a tasklist query.

4.85.1 URI template

queues/xcp_queue?filter=tasklist-query-type='tasklist-query-name'&
currentuser=true

tasklist-query-name Name of the task list query

4.85.2 Link relation

The following table lists general link relation for a Queue List resource.

Link relation Description Resource reference

self This Queue List instance “xCP Queue List single
instance” on page 425

4.85.3 Operations
A Queue List resource supports the following HTTP method.

Method Description
GET Retrieve a Queue List resource

EDCPKL230200-PGR-EN-01 Development Guide 425

Chapter 4 Resources

4.85.3.1 Get a queue list

Retrieve a queue list instance of the current user.

4.85.3.1.1 HTTP method

GET

4.85.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.85.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.85.3.1.4 Request body

None.

4.85.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

426 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.85. xCP Queue List single instance

4.85.3.1.6 Supported response media types

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

4.85.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.85.3.1.8 Response body

XML or JSON representation of the Queue List resource.

Example 4-40: Response in JSON

{
"id": "queues/xcp_queue",
"title": "xcp_queue",
"updated": "2013-12-09T20:53:13.992-08:00",
"author": "OpenText Documentum",
"page": 1,
"items-per-page": 3,
"links": [{
"rel": "self",
"href": "queues/xcp_queue"
}],
"entries": [{
"id": "queues/xcp_queue/null",
"title": "country",
"updated": "2013-12-09T20:53:13.992-08:00",
"summary": "country",
"content": {
"src": "queues/xcp_queue/null",
"content-type": "application/vnd.emc.xcp+json"
},
"links": [{
"rel": "edit",
"href": "queues/xcp_queue/null"
}]
}, {
"id": "queues/xcp_queue/null",
"title": "region",
"updated": "2013-12-09T20:53:13.992-08:00",
"summary": "region",
"content": {
"src": "queues/xcp_queue/null",
"content-type": "application/vnd.emc.xcp+json"

EDCPKL230200-PGR-EN-01 Development Guide 427

Chapter 4 Resources

},
"links": [{
"rel": "edit",
"href": "queues/xcp_queue/null"
}]
}, {
"id": "queues/xcp_queue/null",
"title": "state",
"updated": "2013-12-09T20:53:13.992-08:00",
"summary": "state",
"content": {
"src": "queues/xcp_queue/null",
"content-type": "application/vnd.emc.xcp+json"
},
"links": [{
"rel": "edit",
"href": "queues/xcp_queue/null"
}]
}]
}

Example 4-41: Response in XML

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:dm="http://identifiers.emc.com/vocab/xcp">
<id>queues/xcp_queue</id>
<title type="text">xcp_queue</title>
<updated>2013-12-10T05:22:08.532Z</updated>
<link href="queues/xcp_queue" rel="self"/>
<author>
<name>OpenText Documentum</name>
</author>
<dm:page>1</dm:page>
<dm:items-per-page>3</dm:items-per-page>
<entry>
<id>queues/xcp_queue/null</id>
<title type="text">country</title>
<updated>2013-12-10T05:22:08.539Z</updated>
<link href="queues/xcp_queue/null" rel="edit"/>
<summary type="text">country</summary>
<content type="application/vnd.emc.xcp+xml"
src="queues/xcp_queue/null"/>
</entry>
<entry>
<id>queues/xcp_queue/null</id>
<title type="text">region</title>
<updated>2013-12-10T05:22:08.545Z</updated>
<link href="queues/xcp_queue/null" rel="edit"/>
<summary type="text">region</summary>
<content type="application/vnd.emc.xcp+xml"
src="queues/xcp_queue/null"/>
</entry>
<entry>
<id>queues/xcp_queue/null</id>
<title type="text">state</title>
<updated>2013-12-10T05:22:08.546Z</updated>
<link href="queues/xcp_queue/null" rel="edit"/>
<summary type="text">state</summary>
<content type="application/vnd.emc.xcp+xml"
src="queues/xcp_queue/null"/>
</entry>
</feed>

428 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.86. xCP Real-Time query single instance

4.86 xCP Real-Time query single instance

A single instance of Real-Time query single represents a real-time query configured
in xCP Designer. This resource enables you to perform a query on metadata of
objects in a repository.

4.86.1 URI template

/realtime-queries/query_name

query_name Name of the real-time query

4.86.2 Link relation

The following table lists link relation(s) for a Real-Time Query resource.

Link relation Description Resource reference

self This Real-Time Query “xCP Real-Time query single
instance instance” on page 429
type Type definition of this “xCP Real-Time query single
resource type” on page 433

4.86.3 Operations
A Real-Time Query resource supports the following HTTP method.

Method Description
GET Retrieve the results of a real-time query

4.86.3.1 Perform a Real-Time query

Perform a real-time query on metadata of objects in a repository.

4.86.3.1.1 HTTP method

GET

EDCPKL230200-PGR-EN-01 Development Guide 429

Chapter 4 Resources

4.86.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links
• inline
• items-per-page
• page
• include-total
• sort
A Real-Time Query resource does not support sort on multiple attributes,
meaning that you can specify at most one attribute as the sort criterion when
performing a query.

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.86.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.86.3.1.4 Request body

None.

4.86.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

430 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.86. xCP Real-Time query single instance

4.86.3.1.6 Supported response media types

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

4.86.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.86.3.1.8 Response body

XML or JSON representation of the query results. The results are presented using
Atom Feed in XML representation or using EDAA collection in JSON representation.
By default, this operation only returns basic properties of each result. You can get a
single instance by accessing the src link in the corresponding entry. To obtain a full
representation of each result, set the inline parameter to true.

Example 4-42: Query Results in Atom Feed

<feed>
<id>realtime-queries/xcp_folder_rt_query</id>
<title type="text">xcp_folder_rt_query</title>
<updated>2014-01-23T09:48:28.025Z</updated>
<link href="realtime-queries/xcp_folder_rt_query" rel="self" />
<author>
<name>OpenText Documentum</name>
</author>
<entry>
<id>realtime-queries/xcp_folder_rt_query/1864803513</id>
<title type="text">topic_0b01e2408002786f</title>
<updated>2014-01-23T09:37:51.000Z</updated>
<link href="realtime-queries/xcp_folder_rt_query/1864803513" rel="edit" />
<summary type="text">topic_0b01e2408002786f</summary>
<content type="application/vnd.emc.xcp+xml"
src="realtime-queries/xcp_folder_rt_query/1864803513" />
</entry>
<entry>
<id>realtime-queries/xcp_folder_rt_query/863557884</id>
<title type="text">topic_0b01e24080027871</title>
<updated>2014-01-23T09:37:51.000Z</updated>
<link href="realtime-queries/xcp_folder_rt_query/863557884" rel="edit" />
<summary type="text">topic_0b01e24080027871</summary>
<content type="application/vnd.emc.xcp+xml"
src="realtime-queries/xcp_folder_rt_query/863557884" />
</entry>
<entry>

EDCPKL230200-PGR-EN-01 Development Guide 431

Chapter 4 Resources

<id>realtime-queries/xcp_folder_rt_query/1357774768</id>
<title type="text">utapp21_folder_all_attrs-child-40264</title>
<updated>2014-01-23T09:37:07.000Z</updated>
<link href="realtime-queries/xcp_folder_rt_query/1357774768" rel="edit" />
<summary type="text">utapp21_folder_all_attrs-child-40264</summary>
<content type="application/vnd.emc.xcp+xml"
src="realtime-queries/xcp_folder_rt_query/1357774768" />
</entry>
</feed>

Example 4-43: Query results in EDAA collection

{
id: "realtime-queries/xcp_folder_rt_query"
title: "xcp_folder_rt_query"
updated: "2014-01-23T17:43:08.442+08:00"
author: "OpenText Documentum"
links:
{
rel: "self"
href: "realtime-queries/xcp_folder_rt_query"
}
{
rel: "next"
href: "realtime-queries/xcp_folder_rt_query?items-per-page=100&page=2"
}
{
rel: "last"
href: "realtime-queries/xcp_folder_rt_query?items-per-page=100&page=0"
}

entries:
{
id: "realtime-queries/xcp_folder_rt_query/384200868"
title: "topic_0b01e2408002786f"
updated: "2014-01-23T17:37:51.000+08:00"
summary: "topic_0b01e2408002786f"
content: {
src: "realtime-queries/xcp_folder_rt_query/384200868"
content-type: "application/vnd.emc.xcp+json"
}
}
{
id: "realtime-queries/xcp_folder_rt_query/1297481037"
title: "topic_0b01e24080027871"
updated: "2014-01-23T17:37:51.000+08:00"
summary: "topic_0b01e24080027871"
content: {
src: "realtime-queries/xcp_folder_rt_query/1297481037"
content-type: "application/vnd.emc.xcp+json"
}
}
{
id: "realtime-queries/xcp_folder_rt_query/1114446477"
title: "utapp21_folder_all_attrs-child-40264"
updated: "2014-01-23T17:37:07.000+08:00"
summary: "utapp21_folder_all_attrs-child-40264"
content: {
src: "realtime-queries/xcp_folder_rt_query/1114446477"
content-type: "application/vnd.emc.xcp+json"
}
}
{
id: "realtime-queries/xcp_folder_rt_query/278070062"
title: "utapp21_folder_all_attrs-92076"
updated: "2014-01-23T17:37:07.000+08:00"

432 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.87. xCP Real-Time query single type

summary: "utapp21_folder_all_attrs-92076"
content: {
src: "realtime-queries/xcp_folder_rt_query/278070062"
content-type: "application/vnd.emc.xcp+json"
}
}
}

4.87 xCP Real-Time query single type

A single instance of Real-Time Query Type represents the type definition of a real-
time query that is configured in xCP Designer.

4.87.1 URI template

/types/realtime-queries/query-type

query-type Type of the real-time query

4.87.2 Link relation

The following table lists general link relations for a Real-Time Query Type resource.

Link relation Description Resource reference

self Type definition of a real-time “xCP Real-Time query single
query type” on page 433
instances [1] Real-Time Query instance “xCP Real-Time query single
instance” on page 429
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.87.3 Operations
A Real-Time Query Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of a real-time
query

EDCPKL230200-PGR-EN-01 Development Guide 433

Chapter 4 Resources

4.87.3.1 Get a Real-Time query type

Retrieve the type definition of a real-time query.

4.87.3.1.1 HTTP method

GET

4.87.3.1.2 Query parameters

None.

4.87.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.87.3.1.4 Request body

None.

4.87.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.87.3.1.6 Supported response media types

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

4.87.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

434 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.88. xCP Real-Time query type collection

4.87.3.1.8 Response body

XML or JSON representation of the type definition of a real-time query. The Type
definition mainly contains the following elements:

Elements Description
properties Specifies a set of properties that are
displayed in the output table in xCP.
expression-set Specifies a set of condition constraints with
AND or OR operators.
sort Specifies sort settings.
options Specifies which version of the result to
return. Valid values are:
• LATEST: Only returns the latest version
of a result
• All: Returns all versions of a result

4.88 xCP Real-Time query type collection

A Real-Time Query Type collection represents a collection of type definitions for
Real-Time Query instances.

Note: By default, xCP search uses only the date attribute as an input value for
a Real Time Query (RTQ). You can enable the time element for xCP search
using the query_precision parameter. For more information about how to
enable the time element for xCP search, see Documentum xCP Designer Help.

4.88.1 URI template

/types/realtime-queries

4.88.2 Feed and EDAA support

A collection of Real-Time Query Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/realtime-queries/
Title Name of Feed RealtimeQueries
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed

EDCPKL230200-PGR-EN-01 Development Guide 435

Chapter 4 Resources

Feed property Feed value Example

Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/realtime-queries/
and name of the type sample_query
Title Query name sample_query
Summary Summary of the query A sample query
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.88.3 Link relation

The following table lists link relation(s) for a Real-Time Query Type collection
resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Real-Time query type
for Real-Time Query collection” on page 435
instances

4.88.4 Operations
A Real-Time Query Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Real-Time Query instances

4.88.4.1 Get a Real-Time query type collection

Retrieve a collection of type definitions for Real-Time Query instances.

436 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.88. xCP Real-Time query type collection

4.88.4.1.1 HTTP method

GET

4.88.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.88.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.88.4.1.4 Request body

None.

4.88.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 437

Chapter 4 Resources

4.88.4.1.6 Supported response media types

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

4.88.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.88.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Real-Time Query

instances.

• Each instance may contain all or a set of properties of the type definitions for
Real-Time Query instances, depending on the setting of the query parameter
view.

• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.89 xCP relationship single instance

A single instance of Relationship defines the fact that two or more resources are
related to each other. For example, one Business Object resource can be related to
another Business Object resource.

438 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.89. xCP relationship single instance

4.89.1 URI template

/relationships/relationships-type/relationships-id

relationships-type Type of the relationship

relationships-id Object ID of the relationship

4.89.2 Link relation

The following table lists general link relations for a Relationship resource.

Link relation Description Resource reference

type Type definition of this “xCP Relationship Single
resource Type” on page 450
instances [1] collection of the Relationship “xCP Relationship collection”
instances on page 447
self This Relationship instance “xCP relationship single
instance” on page 438
source Source of the relationship Any resource that can be
related to other resources
target Target of the relationship Any resource that can be
related to other resources
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.89.3 Operations
A Relationship resource supports the following HTTP methods.

Method Description
GET Retrieve a Relationship resource
POST Update a Relationship resource
POST Create a relationship resource
DELETE Update a Relationship resource

EDCPKL230200-PGR-EN-01 Development Guide 439

Chapter 4 Resources

4.89.3.1 Get a Relationship

Retrieve a Relationship resource.

4.89.3.1.1 HTTP method

GET

4.89.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.89.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.89.3.1.4 Request body

None.

4.89.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.89.3.1.6 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

440 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.89. xCP relationship single instance

4.89.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.89.3.1.8 Response body

XML or JSON representation of the Relationship resource.

• The type link relation points to the type definition of the Relationship resource,
through which you can retrieve an “xCP Relationship Single Type” on page 450.
• Null values are presented as an empty string (“”).

4.89.3.2 Update a Relationship

Update a Relationship resource.

4.89.3.2.1 HTTP method

POST

4.89.3.2.2 Server accepted request media types

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

4.89.3.2.3 Query parameters

None.

4.89.3.2.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 441

Chapter 4 Resources

4.89.3.2.5 Request body

XML or JSON representation of the Relationship resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Relationship Single Type” on page 450), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

4.89.3.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.89.3.2.7 Supported response media types

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

4.89.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

442 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.89. xCP relationship single instance

4.89.3.2.9 Response body

XML or JSON representation of the updated Relationship resource:

• The type link relation points to the type definition of the Relationship resource,
through which you can retrieve a “xCP Relationship Single Type” on page 450.
• Null values are presented as an empty string (“”).

4.89.3.3 Create a relationship

Create a relationship resource of a certain type.

4.89.3.3.1 HTTP method

POST

To create a Relationship resource of a certain type, send a POST request to the

collection of Relationship resources of that type in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/relationships/<relationship-type>

4.89.3.3.2 Server accepted request media types

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

4.89.3.3.3 Query parameters

None.

4.89.3.3.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 443

Chapter 4 Resources

4.89.3.3.5 Request body

XML or JSON representation of the Relationship resource.

• This operation creates a Relationship resource with all fields specified in the
request. However, if the request body contains a field that is not presented in the
corresponding DML type (“xCP Relationship Single Type” on page 450), the field
is ignored.
• Unspecified fields are set the default values in Documentum Server.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

Example 4-44: Request body in XML

<?xml version="1.0" encoding="UTF-8"?>
<dm:relationship xmlns:dm="http://identifiers.emc.com/documentum"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ut200_bo_rel_2way_121"
dm:definition="http://127.0.0.1:8080/xcp-rest/types/relationships/
ut200_bo_rel_2way_121">
<dm:properties xsi:type="ut200_bo_rel_2way_121-properties">
<dm:r_object-id>3700153880000a04</dm:r_object-id>
<dm:int_attr_single>0</dm:int_attr_single>
<dm:source>0000000000000001</dm:source>
<dm:target>0000000000000002</dm:target>
</dm:properties>
</dm:relationship>

Example 4-45: Request body in JSON

{
"name": "relationship",
"type": "ut200_bo_rel_2way_121",
"definition": "http://127.0.0.1:8080/xcp-rest/types/relationships/
ut200_bo_rel_2way_121",
"properties": {
"r_object-id": "3700153880000a04",
"int_attr_single": 0,
"source": "0000000000000000",
"target": "0000000000000000"
}
}

444 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.89. xCP relationship single instance

4.89.3.3.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.89.3.3.7 Supported response media types

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

4.89.3.3.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.89.3.3.9 Response body

XML or JSON representation of the Relationship resource:

• The type link relation points to the type definition of the Relationship resource,
through which you can retrieve a “xCP Relationship Single Type” on page 450.
• Null values are presented as an empty string (“”).

EDCPKL230200-PGR-EN-01 Development Guide 445

Chapter 4 Resources

4.89.3.4 Delete a Relationship

Delete a Relationship resource.

4.89.3.4.1 HTTP method

DELETE

4.89.3.4.2 Query parameters

None.

4.89.3.4.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.89.3.4.4 Request body

None.

4.89.3.4.5 Response headers

None.

4.89.3.4.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

4.89.3.4.7 Response body

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

446 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.90. xCP Relationship collection

4.90 xCP Relationship collection

A Relationship collection represents a collection of Relationship instances.

4.90.1 URI template

/relationships

4.90.2 Feed and EDAA support

A collection of Relationship instances conforms to Atom Feed in XML representation
and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
relationships/sample-
relationship
Title Title of the relationships Sample Relationships
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ relationships/sample-
uri>/<entry_id> relationship/
080015388000cd5e
Title Entry title sample-relationship-a
Summary Entry summary A Sample Relationship
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 447

Chapter 4 Resources

4.90.3 Link relation

The following table lists link relation(s) for a Relationship collection resource.

Link relation Description Resource reference

self This collection resource “xCP Relationship collection”
on page 447
first, last, previous, next Pagination links “xCP Relationship collection”
on page 447

4.90.4 Operations
A Relationship collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Relationship
instances

4.90.4.1 Get a Relationship collection

Retrieve a collection of Relationship instances of a certain type.

4.90.4.1.1 HTTP method

GET

4.90.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

448 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.90. xCP Relationship collection

4.90.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.90.4.1.4 Request body

None.

4.90.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.90.4.1.6 Supported response media types

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

4.90.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 449

Chapter 4 Resources

4.90.4.1.8 Response body

XML or JSON representation of a collection of Relationship instances.

• Each instance may contain all or a set of properties of the Relationship instance,
depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.91 xCP Relationship Single Type

A single instance of Relationship Type represents the type definition of Relationship
instances.

4.91.1 URI template

/types/relationship-type

relationship-type Type of the relationship

4.91.2 Link relation

The following table lists general link relations for a Relationship Type resource.

Link relation Description Resource reference

self Type definition of “xCP Relationship Single
Relationship instances Type” on page 450
instances [1] collection of the Relationship “xCP Relationship collection”
instances on page 447
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.91.3 Operations
A Relationship Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Relationship
instances

450 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.91. xCP Relationship Single Type

4.91.3.1 Get a Relationship Type

Retrieve the type definition of Relationship instances.

4.91.3.1.1 HTTP method

GET

4.91.3.1.2 Query parameters

None.

4.91.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.91.3.1.4 Request body

None.

4.91.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.91.3.1.6 Supported response media types

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

4.91.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 451

Chapter 4 Resources

4.91.3.1.8 Response body

XML or JSON representation of the type definition of Relationship instances. The

instances link relation points to a collection of Relationship instances, through
which you can retrieve an “xCP Relationship collection” on page 447.

4.92 xCP Relationship Type collection

A Relationship Type collection represents a collection of type definitions for
Relationship instances.

4.92.1 URI template

/types/relationships

4.92.2 Feed and EDAA support

A collection of Relationship Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/relationships
Title Name of Feed Relationships
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/relationships/sample-
and name of the type relationship-type
Title Title of the relationship loan_proc_emp
Summary Summary of the relationship Proc Loan-Proc EMP
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

452 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.92. xCP Relationship Type collection

4.92.3 Link relation

The following table lists link relation(s) for a Relationship Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Relationship Type
for Relationship instances collection” on page 452

4.92.4 Operations
A Relationship Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Relationship instances

4.92.4.1 Get a Relationship type collection

Retrieve a collection of type definitions for Relationship instances.

4.92.4.1.1 HTTP method

GET

4.92.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 453

Chapter 4 Resources

4.92.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.92.4.1.4 Request body

None.

4.92.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.92.4.1.6 Supported response media types

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

4.92.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

454 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.93. xCP Rendition collection

4.92.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Relationship

instances.

• Each instance may contain all or a set of properties of the type definitions for
Relationship instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.93 xCP Rendition collection

A Rendition collection represents a collection of pages within a Content instance
considered as Document.

4.93.1 URI template

viewers/provider-Name/contents/content-type/content-id/view/
renditionsviewers/provider-Name/templates/template-type/template-id/
view/renditions

provider-Name Name of the viewer provider

content-type Type of the content
content-id Object ID of the content
template-type Type of the template
template-id Object ID of the template

4.93.2 Feed and EDAA support

A collection of Rendition instances conforms to Atom Feed in XML representation
and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
ContentViewer/xcp-rest/
contents/xcp-contents/
00000000001/view/renditions
Title Renditions Renditions
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

EDCPKL230200-PGR-EN-01 Development Guide 455

Chapter 4 Resources

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <Feed_ ContentViewer/contents/xcp-
URI>/<rendition_id> contents/00000000001/view/
renditions/1
Title Page number Page 1
Summary Page number Page 1
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.93.3 Link relation

The following table lists link relation(s) for a Rendition collection resource.

Link relation Description Resource reference

self This Rendition collection “xCP Rendition collection”
resource. on page 455

4.93.4 Operations
A Rendition collection resource supports the following HTTP method.

Method Description
GET Retrieve a Rendition collection resource

4.93.4.1 Get renditions

Retrieve renditions of a Content instance or a Template instance.

4.93.4.1.1 HTTP method

GET

456 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.93. xCP Rendition collection

4.93.4.1.2 Query parameters

The following query parameters are specific to this operation:

Parameter Description Type Required or Not

start Specifies the start integer Yes
page.

This parameter is not

supported on a
standalone REST
server.
limit Specifies the integer Yes
maximum number of
pages to return in the
result.

This parameter is not

supported on a
standalone REST
server.
totalPages Specifies the total integer No
number of pages in
the Content instance.
pages Specifies a list of string No
comma separated
page indexes of the
pages that are
extracted from the
Content instance.
Page indexes are 1
based. Page range
specifications (for
example, 1-4) are
supported.
format Specifies the content string No
format.
location Specifies the ACS or string No
BOCS server where
xCP REST services
retrieves the page
information.
isFullyRenderedDoc Indicates whether or boolean No
not the entire
document is
rendered.

EDCPKL230200-PGR-EN-01 Development Guide 457

Chapter 4 Resources

Parameter Description Type Required or Not

items-per-page Specifies the number integer Yes
of items to be
rendered on one
page.
page Specifies the page integer Yes
number of the page
to return. If you set
items-per-page to
200, and page to 2,
the operation returns
items 201 to 400.

Additionally, this operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.93.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.93.4.1.4 Request body

None.

4.93.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

458 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.93. xCP Rendition collection

4.93.4.1.6 Supported response media types

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

4.93.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

404 - Object not found

500 - Other unexpected server error

4.93.4.1.8 Response body

Atom Feed in XML representation or EDAA collection in JSON representation of the

Rendition collection resource. Each entry in the collection represents one page of the
Content instance. The pageContentUrl property points to the actual rendition
content for that page.

Example 4-46: Response in JSON

{
"id": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/view/
renditions",
"title": "Document Renditions",
"updated": "2014-02-14T14:43:52.565+08:00",
"author": "OpenText Documentum",
"total": 17,
"links": [
{
"rel": "self",
"href": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/
view/renditions"
},
{
"rel": "next",
"href": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/
view/renditions?items-per-page=10&page=2"
},
{
"rel": "last",
"href": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/
view/renditions?items-per-page=10&page=2"
}
],
"entries": [
{
"id": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/
view/renditions/1",

EDCPKL230200-PGR-EN-01 Development Guide 459

Chapter 4 Resources

"title": "Page: 1",

"updated": "2014-02-14T14:43:52.565+08:00",
"summary": "Page: 1",
"content": {
"name": "viewer",
"type": "xcp_viewer_page",
"definition": "http://10.37.3.201:8000/xCP21UTApp/types/viewers/
xcp_viewer_page",
"properties": {
"pageNumber": 1,
"pageContentUrl": "http://<content_server>:9080/ACS
/servlet/ACS?command=read&version=2.3&docbaseid=01e240
&basepath=C%3A%5CDocumentum%5Cdata%5Cxcp21H2wk2%5C
thumbnail_storage_01%5C0001e240
&filepath=80%5C00%5C14%5Ca2.jpg&objectid=0901e2408002b4c7
&cacheid=dAQEAgA%3D%3DohQAgA%3D%3D&format=jpeg_lres&pagenum=0
&pagemod=000000000&signature=pIlbnwYd%2BPOmMetr9l3n2yA8rL7Ecl
sYHneJ8lOFvehv9In3SyNIwx9260GqWHKBX0evUrE2myHd8Lw69sNeJZ094yy
7sZwT6KeY8Ar1n0q8bVG%2FNHaGRPHC9SqoxWEqUTGm6VJPrX1fkfYcK%2Bq3
kYwP905xkYelw0bK6Caj6cg%3D
&servername=<acs_server>&mode=1
&timestamp=1392360232&length=17894&mime_type=image%2Fjpeg
&parallel_streaming=true&expire_delta=360",
"pageType": 0
},
"links": [],
"content-type": "application/vnd.emc.xcp+json"
},
"links": [
{
"rel": "edit",
"href": "viewers/ContentViewer/contents/dm_document/
0901e2408002b4c7/view/renditions/1"
}
]
},
{
"id": "viewers/ContentViewer/contents/dm_document/
0901e2408002b4c7/view/renditions/2",
"title": "Page: 2",
"updated": "2014-02-14T14:43:52.566+08:00",
"summary": "Page: 2",
"content": {
"name": "viewer",
"type": "xcp_viewer_page",
"definition": "http://10.37.3.201:8000/xCP21UTApp/types/viewers/
xcp_viewer_page",
"properties": {
"pageNumber": 2,
"pageContentUrl": "http://<content_server>:9080/ACS/servlet/
ACS?command=read&version=2.3&docbaseid=01e240
&basepath=C%3A%5CDocumentum%5Cdata%5Cxcp21H2wk2%5C
thumbnail_storage_01%5C0001e240&filepath=80%5C00%5C14%5Ca3.jpg
&objectid=0901e2408002b4c7&cacheid=dAQEAgA%3D%3DoxQAgA%3D%3D
&format=jpeg_lres&pagenum=0&pagemod=000000001
&signature=rmBhpImwIMap5DmSWsu5q%2Fw0RfwCZRLPNJjgL9%2F%2FIxKz9G
pN%2BYpJbCnrXFT5yaTTaiWzHxhlh6N3WzEa2gwf602Ugf6M36W7cKn4EgxzdzU
oMilU5NPaaF2%2Fs9NsJMEkv7%2By18HPbVxyl3W8eEyqcFLIyyzdP31onUcyvjjQNCM
%3D
&servername=<acs_server>&mode=1&timestamp=1392360232
&length=17894&mime_type=image%2Fjpeg&parallel_streaming=true
&expire_delta=360",
"pageType": 0
},
"links": [],
"content-type": "application/vnd.emc.xcp+json"
},
"links": [
{
"rel": "edit",

460 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.94. xCP repository single instance

"href": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/
view/renditions/2"
}
]
},
...
{
"id": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/
view/renditions/10",
"title": "Page: 10",
"updated": "2014-02-14T14:43:52.572+08:00",
"summary": "Page: 10",
"content": {
"name": "viewer",
"type": "xcp_viewer_page",
"definition": "http://10.37.3.201:8000/xCP21UTApp/types/viewers/
xcp_viewer_page",
"properties": {
"pageNumber": 10,
"pageContentUrl": "http://<content_server>:9080/ACS/servlet/
ACS?command=read&version=2.3&docbaseid=C%3A%5CDocumentum%5Cdata%5Cx
cp21H2wk2%5Cthumbnail_storage_01%5C0001e240
&filepath=80%5C00%5C14%5Cab.jpg&objectid=0901e2408002b4c7
&cacheid=dAQEAgA%3D%3DqxQAgA%3D%3D&format=jpeg_lres&pagenum=0
&pagemod=000000009&signature=raz%2Bbe%2BPybJbDCKnk63UwqMIQovx
dxwUF8hCUaij1k%2B40MhYWd%2B3P03RwVFzwiEIr4YjL7LiV3UXEEn5x%2F8
CyTzJ4QVmIHFN28Gwzz0PWZkiazJ2fEleJ%2B1CucU70DaBUvpLFNnkbPY7Tl
44c0lxh3i8p22MXewOjO6QQ82xE5E%3D&servername=<acs_server>
&mode=1&timestamp=1392360232&length=17894&mime_type=image%2Fjpeg
&parallel_streaming=true&expire_delta=360",
"pageType": 0
},
"links": [],
"content-type": "application/vnd.emc.xcp+json"
},
"links": [
{
"rel": "edit",
"href": "viewers/ContentViewer/contents/dm_document/
0901e2408002b4c7/view/renditions/10"
}
]
}
]
}

4.94 xCP repository single instance

A single instance of Repository represents a repository in xCP. This resource exposes
several underlying resources such as cabinets and members through link relations.

EDCPKL230200-PGR-EN-01 Development Guide 461

Chapter 4 Resources

4.94.1 URI template

/repositories/xcp_repository

Only one instance of the xcp_repository type exists. Therefore, this instance does
not have a repository ID.

4.94.2 Link relation

The following table lists general link relations for a Repository resource.

Link relation Description Resource reference

type Type definition of this “xCP repository single type”
resource on page 464
current-user [1] Current user belongs to this “xCP Current User Instance”
repository on page 235
cabinets [1] Cabinets belong to this “xCP Cabinet collection”
repository on page 173
templates [1] Templates belong to this “xCP Template collection”
repository on page 510
members [1] Members belong to this “xCP Member collection”
repository on page 361
self This Repository instance “xCP repository single
instance” on page 461
formats [1] Formats belong to this “xCP Format collection”
repository on page 296
network-locations [1] Network locations belong to “xCP Network Location
this repository collection” on page 376
queues [1] Queues belong to this “xCP Queue List single
repository instance” on page 425
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

462 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.94. xCP repository single instance

4.94.3 Operations
A Repository resource supports the following HTTP method.

Method Description
GET Retrieve a repository

4.94.3.1 Get a repository

Retrieve the repository of the xcp_repository type.

4.94.3.1.1 HTTP method

GET

4.94.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.94.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.94.3.1.4 Request body

None.

4.94.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 463

Chapter 4 Resources

4.94.3.1.6 Supported response media types

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

4.94.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.94.3.1.8 Response body

XML or JSON representation of the Repository resource. This operation returns the
name of the repository. Underlying resources such as cabinets and members are
exposed through link relations.

4.95 xCP repository single type

A single instance of Repository Type is a resource that represents the type definition
of the xCP repository. This resource exposes several underlying resources of the
repository instance such as cabinets and members through link relations.

4.95.1 URI template

types/repositories/xcp_repository

Only one repository type (xcp_repository) exists.

464 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.95. xCP repository single type

4.95.2 Link relation

The following table lists general link relations for a Repository Type resource.

Link relation Description Resource reference

instances [1] Instance of the repository “xCP repository single
type instance” on page 461
current-user [1] Current user belongs to the “xCP Current User Instance”
xCP repository on page 235
cabinets [1] Cabinets belong to the xCP “xCP Cabinet collection”
repository on page 173
templates [1] Templates belong to the xCP “xCP Template collection”
repository on page 510
members [1] Members belong to the xCP “xCP Member collection”
repository on page 361
self This Repository Type “xCP repository single
instance instance” on page 461
formats [1] Formats belong to the xCP “xCP Format collection”
repository on page 296
network-locations [1] Network locations belong to “xCP Network Location
the xCP repository collection” on page 376
queues [1] Queues belong to the xCP “xCP Queue List single
repository instance” on page 425
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.95.3 Operations
A Repository Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of the xCP
repository

EDCPKL230200-PGR-EN-01 Development Guide 465

Chapter 4 Resources

4.95.3.1 Get a repository type

Retrieve the type definition of the xCP repository.

4.95.3.1.1 HTTP method

GET

4.95.3.1.2 Query parameters

None.

4.95.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.95.3.1.4 Request body

None.

4.95.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.95.3.1.6 Supported response media types

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

4.95.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

466 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.96. xCP repository type collection

4.95.3.1.8 Response body

XML or JSON representation of the type definition of the xCP repository. This
resource also exposes several underlying resources of the repository instance such as
cabinets and members through link relations.

4.96 xCP repository type collection

A Repository Type collection is a resource that represents a collection of type
definitions for Repository instances. Currently, only one type definition (xcp_
repository) for repositories exists. Therefore, this collection resource only contains
one entry.

4.96.1 URI template

types/repositories/

4.96.2 Feed and EDAA support

A collection of Repository Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/repositories
Title Name of Feed Repositories
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/repositories/
and name of the type xcp_repository
Title Repository type title xcp_repository
Summary Repository type summary Repository
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 467

Chapter 4 Resources

4.96.3 Link relation

The following table lists link relation(s) for a Repository Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP repository type
for Repository instances collection” on page 467

4.96.4 Operations
A Repository Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Repository instances

4.96.4.1 Get a repository type collection

Retrieve a collection of type definitions for repository instances. Currently, only one
type definition (xcp_repository) for repositories exists. Therefore, this collection
resource only contains one entry.

4.96.4.1.1 HTTP method

GET

4.96.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total
• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

468 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.96. xCP repository type collection

4.96.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.96.4.1.4 Request body

None.

4.96.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.96.4.1.6 Supported response media types

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

4.96.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 469

Chapter 4 Resources

4.96.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Repository

instances. Currently, only one type definition (xcp_repository) for repositories
exists. Therefore, this collection resource only contains one entry.

4.97 xCP stateless process single instance

A single instance of Stateless Process represents a process that runs synchronously
as a single transaction. The synchronous transaction commits only at the end of the
process. If an error occurs during the process, the entire process fails.

4.97.1 URI template

Not applicable.
Once a stateless process is started and executed by the system, the response contains
the representation of the instance after execution. However, the system does not
create an object ID for the instance, meaning that you are not able to obtain a
Stateless Process instance through a GET request.

4.97.2 Link relation

The following table lists general link relation for a Stateless Process resource.

Link relation Description Resource reference

type Type definition of this “xCP stateless process single
resource type” on page 473

4.97.3 Operations
A Stateless Process resource supports the following HTTP method.

Method Description
POST Create and execute a Stateless Process
instance

4.97.3.1 Create a stateless process

Create and execute a Stateless Process instance.

470 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.97. xCP stateless process single instance

4.97.3.1.1 HTTP method

POST

To create and execute a Stateless Process resource of a certain type, set the run-
stateless property to true in the payload and then send a POST request to the
collection of Process resources of that type in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/processes/<process-system-name>

4.97.3.1.2 Server accepted request media types

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

4.97.3.1.3 Query parameters

None.

4.97.3.1.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.97.3.1.5 Request body

XML or JSON representation of the Stateless Process instance.

• This operation creates and executes a Stateless Process instance with all fields
specified in the request. However, if the request body contains a field that is not
presented in the corresponding DML type (“xCP stateless process single type”
on page 473), the field is ignored.
• Unspecified fields are set the default values in Documentum Server.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

EDCPKL230200-PGR-EN-01 Development Guide 471

Chapter 4 Resources

4.97.3.1.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.97.3.1.7 Supported response media types

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

4.97.3.1.8 Response status

201 - Object created successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.97.3.1.9 Response body

XML or JSON representation of the Stateless Process resource:

• The type link relation points to the type definition of the Stateless Process
resource, through which you can retrieve a “xCP stateless process single type”
on page 473.
• Null values are presented as an empty string (“”).

472 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.98. xCP stateless process single type

4.98 xCP stateless process single type

A single instance of Stateless Process Type represents the type definition of Stateless
Process instances. The type definition of Stateless Process resources is identical to
that of Process resources. However, a Stateless Process resource is different from a
Process instance in the following aspects:

• A Stateless Process cannot contain any task.

• A Stateless Process runs synchronously.
• Once a Stateless Process instance is created and executed, the response contains
the representation of the instance.
• Some properties defined in a Process type are not supported in a Stateless
Process instance.
• A Stateless Process instance only contains the type link relation.
• A Stateless Process instance has the runnable-stateless property set to true.

“xCP Process Single Type” on page 402 provides more information about the type
definition.

4.99 xCP task single instance

A single instance of Task represents an execution unit contained in a process. This
resource defines data manipulated in a task, the activity performer, the transition
rules, and so on.

4.99.1 URI template

/processes/process-system-name/process-id/tasks/task-name/task-id

process-system-name System name of the process where this task

belongs
process-id Object ID of the process where this task
belongs
task-name Name of the task
task-id Object ID of the task

EDCPKL230200-PGR-EN-01 Development Guide 473

Chapter 4 Resources

4.99.2 Link relation

The following table lists general link relations for a Task resource.

Link relation Description Resource reference

type Type definition of this “xCP Task single type”
resource on page 492
instances [1] collection of the Task “xCP Task collection”
instances on page 488
edit Update this Task instance “xCP task single instance”
on page 473
up Process to which this Task “xCP Process single instance”
instance belongs on page 391
halt Halt this task /processes/
process-system-name/
process-id/tasks/
task-name/task-id/status
resume Resume this task /processes/
process-system-name/
process-id/tasks/
task-name/task-id/status
complete Complete this task /processes/
process-system-name/
process-id/tasks/
task-name/task-id/status
delegate Delegate this task /processes/
process-system-name/
process-id/tasks/
task-name/task-id/status
repeat Repeat this task /processes/
process-system-name/
process-id/tasks/
task-name/task-id/status
reject Reject this task /processes/
process-system-name/
process-id/tasks/
task-name/task-id/status
acquire Acquire this task /processes/
process-system-name/
process-id/tasks/
task-name/task-id/status
unhold Unhold this task /processes/
process-system-name/
process-id/tasks/
task-name/task-id/status

474 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.99. xCP task single instance

Link relation Description Resource reference

assign Assign this task /processes/
process-system-name/
process-id/tasks/
task-name/task-id/status
reassign Reassign this task /processes/
process-system-name/
process-id/tasks/
task-name/task-id/status
unassign Unassign this task /processes/
process-system-name/
process-id/tasks/
task-name/task-id/status
change-workqueue Move this task to another /processes/
workqueue process-system-name/
process-id/tasks/
task-name/task-id/status
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.99.3 Operations
A Task resource supports the following HTTP methods.

Method Description
GET Retrieve a Task resource
GET Retrieve the status of a Task resource
PUT Update the status of a Task resource
PUT Acquire a Task resource
PUT Update the data of a Task resource
PUT Hold or unhold a Task resource
PUT Complete the data of a Task resource
PUT Repeat the data of a Task resource

EDCPKL230200-PGR-EN-01 Development Guide 475

Chapter 4 Resources

4.99.3.1 Get a task

Retrieve a task resource.

4.99.3.1.1 HTTP method

GET

4.99.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.99.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.1.4 Request body

None.

4.99.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.1.6 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

476 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.99. xCP task single instance

4.99.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.99.3.1.8 Response body

XML or JSON representation of the Task resource.

• The type link relation points to the type definition of the Task resource, through
which you can retrieve an “xCP Task single type” on page 492.
• Null values are presented as an empty string (“”).

4.99.3.2 Get the status of a Task

Retrieve the status a Task resource.

4.99.3.2.1 HTTP method

GET

4.99.3.2.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 477

Chapter 4 Resources

4.99.3.2.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.2.4 Request body

None.

4.99.3.2.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.2.6 Supported response media types

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

4.99.3.2.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

478 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.99. xCP task single instance

4.99.3.2.8 Response body

XML or JSON representation of the status of the Task resource.

4.99.3.3 Update the status of a Task

Update the status a Task resource. You can update the status of a Task resource to
one of the followings:

• halt
• resume
• terminate

4.99.3.3.1 HTTP method

PUT

To update the status of a Task resource, send a PUT request to the status link
relation of the Task resource in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/processes/<process-system-name>/<process-id>/
<task-name>/<task-id>/status

4.99.3.3.2 Server accepted request media types

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

4.99.3.3.3 Query parameters

None.

4.99.3.3.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 479

Chapter 4 Resources

4.99.3.3.5 Request body

XML or JSON representation of the status of the Task resource.

Example 4-47: Halt a running process

{"halt":{}}

Example 4-48: Resume a halted process

{"resume":{}}

Example 4-49: Terminate a process

{"terminate":{}}

4.99.3.3.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.3.7 Supported response media types

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

4.99.3.3.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

480 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.99. xCP task single instance

500 - Other unexpected server error

4.99.3.3.9 Response body

The response does not contain any data.

4.99.3.4 Acquire a Task

Acquire the data of a task.

4.99.3.4.1 HTTP method

PUT

To acquire the data of a Task resource, send a PUT request to the status link relation
of the Task resource in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/processes/<process-system-name>/<process-id>/
<task-name>/<task-id>/status

4.99.3.4.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.99.3.4.3 Query parameters

None.

4.99.3.4.4 Request headers

• Accept

• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.4.5 Request body

Example 4-50: Acquire a process

{
"acquire":{}
}

EDCPKL230200-PGR-EN-01 Development Guide 481

Chapter 4 Resources

4.99.3.4.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.4.7 Supported response media types

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

4.99.3.4.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.99.3.4.9 Response body

The response does not contain any data.

4.99.3.5 Update a Task

Update the data of a task.

482 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.99. xCP task single instance

4.99.3.5.1 HTTP method

PUT

To update the data of a Task resource, send a PUT request to the status link relation
of the Task resource in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/processes/<process-system-name>/<router-id>/
<tasks>/<system-task-name>/<task-id>/status

4.99.3.5.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.99.3.5.3 Query parameters

None.

4.99.3.5.4 Request headers

• Accept

• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.5.5 Request body

XML or JSON representation of the updated data.

Example 4-51: Update a process

{
"edit":{
"data":{
"variables":{
"employee_location":"",
"student_location":"raichur"
"packages":{
"package0":{"properties":{"id":"0000000000000000"}},
"package1":{"href":"business-objects/nsoct11_student/
0800492d80009575","properties":{}}
},
"attachments":[]
}
}
}

EDCPKL230200-PGR-EN-01 Development Guide 483

Chapter 4 Resources

4.99.3.5.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.5.7 Supported response media types

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

4.99.3.5.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.99.3.5.9 Response body

The response does not contain any data.

4.99.3.6 Complete a Task

Complete the data of a task.

484 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.99. xCP task single instance

4.99.3.6.1 HTTP method

PUT

To complete the data of a Task resource, send a PUT request to the status link
relation of the Task resource in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/processes/<process-system-name>/<router-id>/
<tasks>/<system-task-name>/<task-id>/status

4.99.3.6.2 Server accepted request media types

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

4.99.3.6.3 Query parameters

None.

4.99.3.6.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.6.5 Request body

XML or JSON representation of the completed data.

Example 4-52: Complete a process

{
"complete":{
"data":{
"variables":{

"variable_0":"",

"variables_1":"somevalue"
"packages":{
"package0":{"properties":{"id":"0000000000000000"}},
"package1":{"href":"business-objects/nsoct11_student/
0800492d80009575","properties":{}
}
},
"attachments":[]
}
}
}

Alternatively, you can complete the data with sign-off information.

EDCPKL230200-PGR-EN-01 Development Guide 485

Chapter 4 Resources

Example 4-53: Complete a process with sing-off

{
"complete":{
"data":
{
"variables":{"var0":"000","var1":111},
"packages":{
"package0":{"properties":{"id":"0000000a"} }
},
"attachments":[]
},
"task-requirements":{
"sign-off-password":"<password>"
}
}
}

4.99.3.6.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.6.7 Supported response media types

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

4.99.3.6.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

486 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.99. xCP task single instance

4.99.3.6.9 Response body

The response does not contain any data.

4.99.3.7 Repeat a Task

Repeat the data of a task.

4.99.3.7.1 HTTP method

PUT

To update the data of a Task resource, send a PUT request to the status link relation
of the Task resource in the following pattern:
http://127.0.0.1:8080/<rest-app-name>/processes/<process-system-name>/<router-id>/
<tasks>/<system-task-name>/<task-id>/status

4.99.3.7.2 Server accepted request media types

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

4.99.3.7.3 Query parameters

None.

4.99.3.7.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.7.5 Request body

XML or JSON representation of the repeated data.

Example 4-54: Repeat a process

{"repeat":{"data":
{"variables":{"employee_location":"","student_location":"raichur"},
"packages":{"package0":{"properties":{"id":"0000000000000000"}},
"package1":{"href":"business-objects/nsoct11_student/
0800492d8000a2ec","properties":{}}},
"attachments":[]},
"task-requirements":
{"user-name":["<user-name>"]}
}
}

EDCPKL230200-PGR-EN-01 Development Guide 487

Chapter 4 Resources

4.99.3.7.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.99.3.7.7 Supported response media types

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

4.99.3.7.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.99.3.7.9 Response body

The response does not contain any data.

4.100 xCP Task collection

A Task collection represents a collection of Task instances.

488 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.100. xCP Task collection

4.100.1 URI template

/processes/process-system-name/router-id/tasks/

process-system-name System name of the process where this task

belongs
router-id Object ID of the process where this task
belongs
task-name Name of the task

4.100.2 Feed and EDAA support

A collection of Task instances conforms to Atom Feed in XML representation and
EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8000/
xCP21UTApp/processes/
process-system-name/
process-id/tasks/task-name
Title Task tile Sample tasks
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8000/
follows this pattern: <feed_ xCP21UTApp/processes/
uri>/<entry_id> process-system-name/
process-id/tasks/task-name/
task-id
Title Entry title Sample task
Summary Entry summary Sample task
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 489

Chapter 4 Resources

4.100.3 Link relation

The following table lists link relation(s) for a Task collection resource.

Link relation Description Resource reference

self This collection resource “xCP Task collection”
on page 488
first, last, previous, next Pagination links “xCP Task collection”
on page 488

4.100.4 Operations
A Task collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Task instances

4.100.4.1 Get a Task collection

Retrieve a collection of Task instances of a certain type.

4.100.4.1.1 HTTP method

GET

4.100.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total
• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

490 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.100. xCP Task collection

4.100.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.100.4.1.4 Request body

None.

4.100.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.100.4.1.6 Supported response media types

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

4.100.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 491

Chapter 4 Resources

4.100.4.1.8 Response body

XML or JSON representation of a collection of Task instances.

• Each instance may contain all or a set of properties of the Task instance,
depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.101 xCP Task single type

A single instance of Task Type represents the type definition of Task instances.

4.101.1 URI template

types/processes/process-system-name/tasks/task-name

process-system-name System name of the process to which the

tasks belong
task-name Name of the task

4.101.2 Link relation

The following table lists general link relations for a Task Type resource.

Link relation Description Resource reference

self Type definition of Task “xCP Task single type”
instances on page 492
instances [1] collection of the Task “xCP Task collection”
instances on page 488
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.101.3 Operations
A Task Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Task instances

492 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.101. xCP Task single type

4.101.3.1 Get a Task Type

Retrieve the type definition of Task instances.

4.101.3.1.1 HTTP method

GET

4.101.3.1.2 Query parameters

None.

4.101.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.101.3.1.4 Request body

None.

4.101.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.101.3.1.6 Supported response media types

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

4.101.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 493

Chapter 4 Resources

4.101.3.1.8 Response body

XML or JSON representation of the type definition of tasks. The instances link
relation points to a collection of Task instances, through which you can retrieve an
“xCP Task collection” on page 488.

4.102 xCP Task type collection

A Task type collection represents a collection of type definitions for Task instances
that belong to a certain process type.

4.102.1 URI template

types/processes/process-system-name/tasks

process-system-name System name of the process to which the

tasks belong

4.102.2 Feed and EDAA support

A collection of Task Type instances conforms to Atom Feed in XML representation
and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/xcp-process/tasks
Title Name of Feed xCP Tasks
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/xcp-process/tasks/
and name of the type sample-task
Title Task title sample-task
Summary Task summary Sample task
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

494 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.102. xCP Task type collection

4.102.3 Link relation

The following table lists link relation(s) for a Task Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Task type collection”
for Task instances on page 494

4.102.4 Operations
A Task Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Task instances

4.102.4.1 Get a Task Type collection

Retrieve a collection of type definitions for Task instances.

4.102.4.1.1 HTTP method

GET

4.102.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 495

Chapter 4 Resources

4.102.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.102.4.1.4 Request body

None.

4.102.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.102.4.1.6 Supported response media types

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

4.102.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

496 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.103. xCP Task-list query single instance

4.102.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Task instances.

• Each instance may contain all or a set of properties of the type definitions for
Task instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.103 xCP Task-list query single instance

A single instance of Task-list Query Single represents a task-list query configured in
xCP Designer. This resource enables you to perform a query on tasks assigned to a
work queue, the current user, or all users.

4.103.1 URI template

/tasklist-queries/query_name

query_name Name of the task list query

4.103.2 Link relation

The following table lists link relation(s) for a Tasklist Query resource.

Link relation Description Resource reference

self This Tasklist Query instance “xCP Task-list query single
instance” on page 497
type Type definition of this “xCP Tasklist query single
resource type” on page 502

4.103.3 Operations
A Tasklist resource supports the following HTTP method.

Method Description
GET Retrieve the results of a task list query

EDCPKL230200-PGR-EN-01 Development Guide 497

Chapter 4 Resources

4.103.3.1 Perform a Tasklist query

Perform a task list query on metadata of tasks assigned to a work queue, the current
user, or all users.

4.103.3.1.1 HTTP method

GET

4.103.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links
• inline
• items-per-page
• page
• include-total
• sort
A Tasklist Query resource does not support sort on multiple attributes, meaning
that you can specify at most one attribute as the sort criterion when performing a
query.

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.103.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.103.3.1.4 Request body

None.

498 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.103. xCP Task-list query single instance

4.103.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.103.3.1.6 Supported response media types

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

4.103.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.103.3.1.8 Response body

XML or JSON representation of the query results. The results are presented using
Atom Feed in XML representation or using EDAA collection in JSON representation.
By default, this operation only returns basic properties of each result. You can get a
single instance by accessing the src link in the corresponding entry. To obtain a full
representation of each result, set the inline parameter to true.

Example 4-55: Response in JSON when inline set to true

{
"id": "tasklist-queries/dec10_qtlq1",
"title": "dec10_qtlq1",
"updated": "2013-12-09T21:27:08.800-08:00",
"author": "OpenText Documentum",
"page": 1,
"items-per-page": 10,
"links": [{
"rel": "self",
"href": "tasklist-queries/dec10_qtlq1"
}],
"entries": [{
"id": "tasklist-queries/dec10_qtlq1/888622289",
"title": "dec10_qtlq1-0",
"updated": "2013-12-09T21:27:08.800-08:00",
"summary": "dec10_qtlq1-0",
"content": {

EDCPKL230200-PGR-EN-01 Development Guide 499

Chapter 4 Resources

"name": "tasklist-query",
"type": "dec10_qtlq1",
"definition": "http://localhost:8000/dec10/types/
tasklist-queries/dec10_qtlq1",
"properties": {
"task_priority": 21,
"workqueue_flag": 0,
...
"workqueue_name": "region",
"workqueue_priority": 21,
"task_subject": "Work queue task-1",
"task_performer_name": "region"
},
"links": [{
"rel": "type",
"href": "types/processes/dec10_myprocess/tasks/
dec10_work_queue_task_1"
}, {
"rel": "http://identifiers.emc.com/linkrel/attachments",
"href": "processes/dec10_myprocess/4d01e24080001d00/attachments"
}, {
"rel": "self",
"href": "processes/dec10_myprocess/4d01e24080001d00/tasks/
dec10_work_queue_task_1/1b01e24080097ab0"
}, ....
{
"rel": "http://identifiers.emc.com/linkrel/acquire",
"href": "processes/dec10_myprocess/4d01e24080001d00/tasks/
dec10_work_queue_task_1/1b01e24080097ab0/status"
}],
"content-type": "application/vnd.emc.xcp+json"
}
}, {
"id": "tasklist-queries/dec10_qtlq1/1988225431",
"title": "dec10_qtlq1-0",
"updated": "2013-12-09T21:27:08.802-08:00",
"summary": "dec10_qtlq1-0",
"content": {
"name": "tasklist-query",
"type": "dec10_qtlq1",
"definition": "http://localhost:8000/dec10/types/tasklist-queries/
dec10_qtlq1",
"properties": {
"task_priority": 21,
...
"task_performer_name": "region"
},
"links": [{
"href": "types/processes/dec10_myprocess/tasks/
dec10_work_queue_task_1"
}...
{
"rel": "http://identifiers.emc.com/linkrel/acquire",
"href": "processes/dec10_myprocess/4d01e24080001d01/tasks/
dec10_work_queue_task_1/1b01e24080097ac5/status"
}],
"content-type": "application/vnd.emc.xcp+json"
}
}]
}

Example 4-56: Response in XML when inline set to true

<feed xmlns="http://www.w3.org/2005/Atom"
xmlns:dm="http://identifiers.emc.com/vocab/xcp">
<id>tasklist-queries/dec10_qtlq1</id>

500 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.103. xCP Task-list query single instance

<title type="text">dec10_qtlq1</title>
<updated>2013-12-10T05:40:05.834Z</updated>
<link href="tasklist-queries/dec10_qtlq1" rel="self"/>
<author>
<name>OpenText Documentum</name>
</author>
<dm:page>1</dm:page>
<dm:items-per-page>10</dm:items-per-page>
<entry>
<id>tasklist-queries/dec10_qtlq1/917251435</id>
<title type="text">dec10_qtlq1-0</title>
<updated>2013-12-10T05:40:05.835Z</updated>
<link href="tasklist-queries/dec10_qtlq1/917251435" rel="edit"/>
<summary type="text">dec10_qtlq1-0</summary>
<content type="application/vnd.emc.xcp+xml">
<dm:tasklist-query xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dec10_qtlq1"
dm:definition=
"http://localhost:8000/dec10/types/tasklist-queries/dec10_qtlq1">
<dm:properties xsi:type="dec10_qtlq1-properties">
<dm:task_priority>21</dm:task_priority>
<dm:workqueue_flag>0</dm:workqueue_flag>
<dm:activity_system_name>dec10_myprocess_
work_queue_task_1</dm:activity_system_name>
...
<dm:task_performer_name>region</dm:task_performer_name>
</dm:properties>
<dm:links>
<dm:link rel="type" href="types/tasklist-queries/dec10_qtlq1"/>
<dm:link rel="http://identifiers.emc.com/linkrel/instances"
href="tasklist-queries/dec10_qtlq1"/>
<dm:link rel="self" href="types/tasklist-queries/dec10_qtlq1/
defaults"/>
</dm:links>
</dm:tasklist-query>
</content>
</entry>
<entry>
<id>tasklist-queries/dec10_qtlq1/1964143150</id>
<title type="text">dec10_qtlq1-0</title>
<updated>2013-12-10T05:40:05.986Z</updated>
<link href="tasklist-queries/dec10_qtlq1/1964143150" rel="edit"/>
<summary type="text">dec10_qtlq1-0</summary>
<content type="application/vnd.emc.xcp+xml">
<dm:tasklist-query xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="dec10_qtlq1"
dm:definition="http://localhost:8000/dec10/types/tasklist-queries/dec10_qtlq1">
<dm:properties xsi:type="dec10_qtlq1-properties">
<dm:task_priority>21</dm:task_priority>
...
</dm:properties>
<dm:links>
<dm:link rel="type" href="types/tasklist-queries/dec10_qtlq1"/>
<dm:link rel="http://identifiers.emc.com/linkrel/instances"
href="tasklist-queries/dec10_qtlq1"/>
<dm:link rel="self" href="types/tasklist-queries/dec10_qtlq1/
defaults"/>
</dm:links>
</dm:tasklist-query>
</content>
</entry>
</feed>

EDCPKL230200-PGR-EN-01 Development Guide 501

Chapter 4 Resources

4.104 xCP Tasklist query single type

A single instance of Tasklist Query Type is represents the type definition of a task
list query that is configured in xCP Designer.

4.104.1 URI template

/types/tasklist-queries/query-type

query-type Type of the task list query

4.104.2 Link relation

The following table lists general link relations for a Tasklist Query Type resource.

Link relation Description Resource reference

self Type definition of Tasklist “xCP Tasklist query single
Query instances type” on page 502
instances [1] Tasklist Query instance “xCP Task-list query single
instance” on page 497
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.104.3 Operations
A Tasklist Query Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of a task list
query

4.104.3.1 Get a Tasklist query type

Retrieve the type definition of a task list query.

502 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.104. xCP Tasklist query single type

4.104.3.1.1 HTTP method

GET

4.104.3.1.2 Query parameters

None.

4.104.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.104.3.1.4 Request body

None.

4.104.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.104.3.1.6 Supported response media types

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

4.104.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 503

Chapter 4 Resources

4.104.3.1.8 Response body

XML or JSON representation of the type definition of a task list query. The Type
definition mainly contains the following elements:

Element Description
processes Defines a list of processes to which the task
list is scoped. A task list can be scoped to all
processes or a subset of processes. The list of
processes also defines which packages and
process variables are available.
properties Specifies a set of properties that are
displayed in the output table in xCP.
expression-set Specifies a set of condition constraints with
AND or OR operators.
sort Specifies sort settings.
scope Defines the search scope. Valid values are:
• USER: Searches tasks assigned to the
current user
• ALL_USERS: Searches tasks assigned to
all users
• WORKQUEUE: Searches tasks assigned to a
work queue
workqueue-view-filter Defines the work queue view filter. Valid
values are:
• SHOW_ALL_TASKS: Shows all tasks in the
work queue
• SHOW_UNASSIGNED_TASKS: Shows
unassigned tasks in the work queue
• SHOW_PROCESSOR_ELIGIBLE_AND_
OWNED_TASKS: Shows the tasks that the
processor can work on and the tasks that
the processor owns in the work queue
• SHOW_PROCESSOR_ELIGIBLE_TASKS:
Shows the tasks that the processor can
work on in the work queue

504 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.105. xCP Tasklist query type collection

4.105 xCP Tasklist query type collection

A Tasklist Query Type collection represents a collection of type definitions for
Tasklist Query instances.

Note: By default, xCP search uses only the date attribute as an input value for
a Task List Query (TLQ). You can enable the time element for xCP search using
the query_precision parameter. For more information about how to enable
the time element for xCP search, see Documentum xCP Designer Help.

4.105.1 URI template

/types/tasklist-queries

4.105.2 Feed and EDAA support

A collection of Tasklist Query Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/tasklist-queries
Title Name of Feed Tasklist Queries
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/tasklist-queries/
and name of the type sample-query
Title Title of the query sample-tasklist-query
Summary Summary of the query Sample query
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 505

Chapter 4 Resources

4.105.3 Link relation

The following table lists link relation(s) for a Tasklist Query Type collection
resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Tasklist query type
for Tasklist Query instances collection” on page 505

4.105.4 Operations
A Tasklist Query Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Tasklist Query instances

4.105.4.1 Get a Tasklist query type collection

Retrieve a collection of type definitions for Tasklist Query instances.

4.105.4.1.1 HTTP method

GET

4.105.4.1.2 Query parameters

The following query parameter is specific to this operation:

Parameter Description Data Type

work-queuename Specifies the name of the string
workqueue to which tasks
are assigned. This parameter
is required when scope is
set to WORKQUEUE.

This operation supports the following common query parameters:

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

506 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.105. xCP Tasklist query type collection

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.105.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.105.4.1.4 Request body

None.

4.105.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.105.4.1.6 Supported response media types

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

4.105.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 507

Chapter 4 Resources

4.105.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Tasklist Query

instances.

• Each instance may contain all or a set of properties of the type definitions for
Tasklist Query instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.106 xCP Template Single instance

A single instance of Template represents a document (the Content resource) stored
in the Template cabinet. This resource also adds extra properties on top of a regular
document.

4.106.1 URI template

/templates/template-type/r_object-id

template-type Type of the template

r_object-id Object ID of the template

4.106.2 Link relation

The following table lists general link relations for a Template resource.

Link relation Description Resource reference

type Type definition of this “xCP template single type”
resource on page 514
view [1] Viewer configuration for the “xCP viewer single instance”
Template resource on page 533
self This Template instance “xCP Template Single
instance” on page 508
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

508 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.106. xCP Template Single instance

4.106.3 Operations
A Template resource supports the following HTTP methods.

Method Description
GET Retrieve a Template resource

4.106.3.1 Get a Template

Retrieve a Template resource.

4.106.3.1.1 HTTP method

GET

4.106.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.106.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.106.3.1.4 Request body

None.

4.106.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 509

Chapter 4 Resources

4.106.3.1.6 Supported response media types

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

4.106.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.106.3.1.8 Response body

XML or JSON representation of the Template resource.

• The type link relation points to the type definition of the Template resource,
through which you can retrieve an “xCP template single type” on page 514.
• Null values are presented as an empty string (“”).

4.107 xCP Template collection

A Template collection represents a collection of Template instances.

4.107.1 URI template

/templates/template-type

template-type Type of the template

510 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.107. xCP Template collection

4.107.2 Feed and EDAA support

A collection of Template instances conforms to Atom Feed in XML representation
and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
templates/xcp-template
Title Type of the template xcp-template
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ templates/xcp-template/
uri>/<entry_id> 0901e240800001da
Title Entry title PowerPoint Pre-3.0
Presentation
Summary Entry summary PowerPoint Pre-3.0
Presentation
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.107.3 Link relation

The following table lists link relation(s) for a Template collection resource.

Link relation Description Resource reference

self This collection resource “xCP Template collection”
on page 510
first, last, previous, next Pagination links “xCP Template collection”
on page 510

EDCPKL230200-PGR-EN-01 Development Guide 511

Chapter 4 Resources

4.107.4 Operations
A Template collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Template instances.

4.107.4.1 Get a Template collection

Retrieve a collection of Template instances of a certain type.

4.107.4.1.1 HTTP method

GET

4.107.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

• permissions

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.107.4.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

512 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.107. xCP Template collection

4.107.4.1.4 Request body

None.

4.107.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.107.4.1.6 Supported response media types

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

4.107.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.107.4.1.8 Response body

XML or JSON representation of a collection of Template instances.

• Each instance may contain all or a set of properties of the Template instance,
depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

EDCPKL230200-PGR-EN-01 Development Guide 513

Chapter 4 Resources

4.108 xCP template single type

A single instance of Template Type represents the type definition of Template
instances.

4.108.1 URI template

/types/templates/template-type

template-type Type of the template

4.108.2 Link relation

The following table lists general link relations for a Template Type resource.

Link relation Description Resource reference

self Type definition of Template “xCP template single type”
instances on page 514
instances [1] collection of the Template “xCP Template collection”
instances on page 510
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.108.3 Operations
A Template Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Template
instances

4.108.3.1 Get a template type

Retrieve the type definition of template instances.

514 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.108. xCP template single type

4.108.3.1.1 HTTP method

GET

4.108.3.1.2 Query parameters

None.

4.108.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.108.3.1.4 Request body

None.

4.108.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.108.3.1.6 Supported response media types

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

4.108.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 515

Chapter 4 Resources

4.108.3.1.8 Response body

XML or JSON representation of the type definition of Template instances. The

instances link relation points to a collection of Template instances, through which
you can retrieve an “xCP Template collection” on page 510.

4.109 xCP Template Type collection

A Template Type collection represents a collection of type definitions for Template
instances.

4.109.1 URI template

/types/templates

4.109.2 Feed and EDAA support

A collection of Template Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
types/templates/
Title Name of Feed Templates
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
contains the URI of the feed types/templates/xcp-
and name of the type templates
Title Type of the templates xCP template
Summary Summary xCP template
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

516 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.109. xCP Template Type collection

4.109.3 Link relation

The following table lists link relation(s) for a Template Type collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Template Type
for Template instances collection” on page 516

4.109.4 Operations
A Template Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Template instances

4.109.4.1 Get a template type collection

Retrieve a collection of type definitions for Template instances.

4.109.4.1.1 HTTP method

GET

4.109.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 517

Chapter 4 Resources

4.109.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.109.4.1.4 Request body

None.

4.109.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.109.4.1.6 Supported response media types

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

4.109.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

518 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.110. xCP user preference single instance

4.109.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Template

instances.

• Each instance may contain all or a set of properties of the type definitions for
Template instances, depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.110 xCP user preference single instance

A single instance of User Preferences is a resource that describes the preferences of
the current user.

4.110.1 URI template

/preferences

4.110.2 Link relation

The following table lists general link relations for a User Preferences resource.

Link relation Description Resource reference

type Type definition of this “xCP user preferences single
resource type” on page 523
currentuser [1] Owner of the preferences “xCP Current User Instance”
on page 235
self This User Preferences “xCP user preference single
instance instance” on page 519
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.110.3 Operations
A User Preferences resource supports the following HTTP methods.

Method Description
GET Retrieve a User Preferences resource
POST Update a User Preferences resource

EDCPKL230200-PGR-EN-01 Development Guide 519

Chapter 4 Resources

4.110.3.1 Get user preferences

Retrieve the User Preferences resource of the current user.

4.110.3.1.1 HTTP method

GET

4.110.3.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.110.3.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.110.3.1.4 Request body

None.

4.110.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.110.3.1.6 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

520 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.110. xCP user preference single instance

4.110.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.110.3.1.8 Response body

XML or JSON representation of the User Preferences resource.

• The type link relation points to the type definition of the User Preferences
resource, through which you can retrieve an “xCP user preferences single type”
on page 523.
• The currentuser link relation points to the owner of the User Preferences
resource, through which you can retrieve an “xCP Current User Instance”
on page 235.
• Null values are presented as an empty string (“”).

4.110.3.2 Update user preferences

Update the User Preferences resource of the current user.

4.110.3.2.1 HTTP method

POST

4.110.3.2.2 Server accepted request media types

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

4.110.3.2.3 Query parameters

None.

EDCPKL230200-PGR-EN-01 Development Guide 521

Chapter 4 Resources

4.110.3.2.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.110.3.2.5 Request body

XML or JSON representation of the User Preferences resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
user preferences single type” on page 523), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

4.110.3.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.110.3.2.7 Supported response media types

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

522 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.111. xCP user preferences single type

4.110.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.110.3.2.9 Response body

XML or JSON representation of the updated User Preferences resource:

• The type link relation points to the type definition of the User Preferences
resource, through which you can retrieve a “xCP user preferences single type”
on page 523.
• Null values are presented as an empty string (“”).

4.111 xCP user preferences single type

A single instance of User Preferences Type represents the type definition of the User
Preferences instance of the current user.

4.111.1 URI template

/types/preferences-type

preferences-type Type of the user preferences

4.111.2 Link relation

The following table lists general link relations for a User Preferences Type resource.

Link relation Description Resource reference

self Type definition of User “xCP user preferences single
Preferences instances type” on page 523
preferences [1] User preferences of the “xCP user preference single
current user instance” on page 519
current-user [1] Current user “xCP Current User Instance”
on page 235

EDCPKL230200-PGR-EN-01 Development Guide 523

Chapter 4 Resources

Link relation Description Resource reference

collection [1] collection of User Preferences “xCP user preferences type
Type resources collection” on page 525
[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be
prefixed with the following string:

http://identifiers.emc.com/linkrel/

4.111.3 Operations
A User Preferences Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of the User
Preferences instance

4.111.3.1 Get a user preferences type

Retrieve the type definition of the User Preferences instance of the current user.

4.111.3.1.1 HTTP method

GET

4.111.3.1.2 Query parameters

None.

4.111.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.111.3.1.4 Request body

None.

524 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.112. xCP user preferences type collection

4.111.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.111.3.1.6 Supported response media types

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

4.111.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.111.3.1.8 Response body

XML or JSON representation of the type definition of the User Preferences instance
of the current user. The preferences link relation points to the User Preferences
instance of the current user.

4.112 xCP user preferences type collection

A User Preferences Type collection represents a collection of type definitions for
User Preferences instances.

EDCPKL230200-PGR-EN-01 Development Guide 525

Chapter 4 Resources

4.112.1 URI template

/types/preferences

4.112.2 Feed and EDAA support

A collection of User Preferences Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost8:8080/xcp-
rest/types/preferences
Title Preferences Preferences
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost8:8080/xcp-
contains the URI of the feed rest/types/preferences/
and name of the type xcp_preference
Title User Preferences Type Test User Preferences
Summary Summary xCP User Preferences
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.112.3 Link relation

The following table lists link relation(s) for a User Preferences Type collection
resource.

Link relation Description Resource reference

self Collection of type definitions “xCP user preferences type
for User Preferences collection” on page 525
instances

526 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.112. xCP user preferences type collection

4.112.4 Operations
A User Preferences Type collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
User Preferences instances

4.112.4.1 Get a user preferences type collection

Retrieve a collection of type definitions for User Preferences instances.

4.112.4.1.1 HTTP method

GET

4.112.4.1.2 Query parameters

This operation supports the following common query parameters:

• view

• links

• inline

• items-per-page

• page

• include-total

• sort

• permissions

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.112.4.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 527

Chapter 4 Resources

4.112.4.1.4 Request body

None.

4.112.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.112.4.1.6 Supported response media types

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

4.112.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.112.4.1.8 Response body

XML or JSON representation of a collection of type definitions for User Preferences

instances.

• Each instance may contain all or a set of properties of the type definitions for
User Preferences instances, depending on the setting of the query parameter
view.

• The returned collection contains only those entries that you have access to.
• Pagination is supported.

528 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.113. xCP view single instance

4.113 xCP view single instance

A single instance of View represents a viewer control that contains information
about how a viewer control is rendered and information about the content to be
rendered.

4.113.1 URI template

/contents/content-type/content-id/view/templates/template-type/
template-id/view

contetn-type Type of the content

content-id ID of the content
template-type Type of the template
template-id ID of the template

4.113.2 Link relation

A View resource does not have any link relation.

4.113.3 Operations
A View resource supports the following HTTP method.

Method Description
GET Retrieve a View resource

4.113.3.1 Get a view

Retrieve the information about how Content or Template instances can be rendered.

4.113.3.1.1 HTTP method

GET

4.113.3.1.2 Query parameters

The following query parameters are specific to this operation:

Parameter Description Data Type

contentType Indicates the content format, string
such as PDF
ann Indicates whether or not the boolean
viewer control supports
annotations

EDCPKL230200-PGR-EN-01 Development Guide 529

Chapter 4 Resources

Parameter Description Data Type

man Indicates whether or not the boolean
viewer control supports
annotation modifications
prn Indicates whether or not the boolean
viewer control supports
printing
thm Indicates whether or not the boolean
viewer control supports
thumbnails

Additionally, this operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.113.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.113.3.1.4 Request body

None.

4.113.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

530 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.113. xCP view single instance

4.113.3.1.6 Supported response media types

• application/vnd.emc.xcp+json
• application/json (For compatible viewing)

4.113.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

404 - Object not found

500 - Other unexpected server error

4.113.3.1.8 Response body

JSON representation of the View resource.

Example 4-57:
{
"objectUri": "templates/xcp_template/0900492d800001f8",
"objectId": "0900492d800001f8",
"provider": "ContentViewer",
"objectName": "Blank PDF Document",
"providerType": "div",
"format": "pdf",
"versionLabel": "1.0,CURRENT",
"automationLibrary": "",
"pageCount": -1,
"allowThumbnail": false,
"allowPageModify": false,
"displayAnnotations": false,
"allowAnnotate": false,
"supportUrlFallback": false,
"optionalData": "",
"userAnnotationUrl": "",
"allAnnotationsUrl": "",
"documentUploadUrl": "",
"annotationUploadUrl": "",
"printAuditUrl": "",
"exportAuditUrl": "",
"viewerAutomationUrl": "",
"pageDeletionUrl": "",
"pageReorderUrl": "",
"pageInsertionUrl": "",
"pageExtractionUrl": "",
"parameterList": [{
"name": "documentInfo",
"value": "{\"objectId\":\"0900492d800001f8\",\"objectName\":\"Blank PDF Document
\",
\"pageCount\":-1,\"assetClass\":\"Document\",\"documentPages\":null,
\"rendering\":false,\"rendered\":false}"
},

EDCPKL230200-PGR-EN-01 Development Guide 531

Chapter 4 Resources

{
"name": "searchInfoUrl",
"value": "null,{$objectUri}/searchinfo"
},
{
"name": "language",
"value": "en_US"
},
{
"name": "isCommentingAllowed",
"value": "false"
},
{
"name": "eventhandler",
"value": "DocumentViewerEventHandler"
},
{
"name": "documentPagesServiceUrl",
"value": "/viewers/ContentViewer/{$objectUri}/view/renditions"
},
{
"name": "documentPagesChunkSize",
"value": "3"
},
{
"name": "docURL",
"value": "/xcp-rest/templates/xcp_template/0900492d800001f8/stream?
provider=ContentViewer"
},
{
"name": "searchUrl",
"value": "{$objectUri}/search"
},
{
"name": "isServerSideSearch",
"value": "false"
}]
}

4.113.4 Formats
The viewer framework supports many formats for content display. The list of
formats can be found in <app_name>/WEB-INF/classes/com/emc/xcp/config/
web/applicationContext-ivf.xml.

The applicationContext-ivf.xml file also lists the viewer provider used to render
the content of a specific format. By modifying the key-value entries in this file, you
can configure the mapping between formats and viewer providers for an xCP
application.

Note: This configuration is available in xCP Designer UI. It is also a part of the
application deployment.

Example 4-58: Sample applicationContext-ivf.xml

<?xml version="1.0" ?>
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.springframework.org/schema/beans"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd

532 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.114. xCP viewer single instance

http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.0.xsd
http://www.springframework.org/schema/aop
http://www.springframework.org/schema/aop/spring-aop-3.0.xsd">
<bean class="com.emc.xcp.ivf.runtime.Format2ViewerMapping">
<property name="formatMapping">
<map>
<entry key="pdf" value="ContentViewer"></entry>
<entry key="tiff" value="ContentViewer"></entry>
<entry key="jpeg" value="ContentViewer"></entry>
<entry key="gif" value="ContentViewer"></entry>
<entry key="png" value="ContentViewer"></entry>
<entry key="bmp" value="ContentViewer"></entry>
<entry key="msw8" value="ContentViewer"></entry>
<entry key="msw12" value="ContentViewer"></entry>
<entry key="msw14" value="ContentViewer"></entry>
<entry key="ppt8" value="ContentViewer"></entry>
<entry key="ppt12" value="ContentViewer"></entry>
<entry key="ppt14" value="ContentViewer"></entry>
<entry key="excel8book" value="ContentViewer"></entry>
<entry key="excel12book" value="ContentViewer"></entry>
<entry key="excel14book" value="ContentViewer"></entry>
<entry key="msg" value="ContentViewer"></entry>
<entry key="mpeg-4v" value="VideoViewer"></entry>
<entry key="ogg" value="VideoViewer"></entry>
<entry key="webm" value="VideoViewer"></entry>
<entry key="3gp" value="VideoViewer"></entry>
<entry key="3g2" value="VideoViewer"></entry>
<entry key="asf" value="VideoViewer"></entry>
<entry key="avi" value="VideoViewer"></entry>
<entry key="flv" value="VideoViewer"></entry>
<entry key="f4v" value="VideoViewer"></entry>
<entry key="mpeg" value="VideoViewer"></entry>
<entry key="m4v" value="VideoViewer"></entry>
<entry key="quicktime" value="VideoViewer"></entry>
<entry key="wmv" value="VideoViewer"></entry>
</map>
</property>
</bean>
</beans>

4.114 xCP viewer single instance

A single instance of Viewer represents a viewer provider profile. This profile
describes the following aspects of a viewer provider:

• Viewer Capabilities
• Feature Enablement
• Supported Formats
• Environment Settings
• Viewer Control

For more information about viewer provider profiles, see “Viewer provider profile”
on page 599.

EDCPKL230200-PGR-EN-01 Development Guide 533

Chapter 4 Resources

4.114.1 URI template

/viewers/viewer-name

viewer-name Name of the viewer

4.114.2 Link relation

A Viewer resource does not contain any link relations.

4.114.3 Operations
A Viewer resource supports the following HTTP method.

Method Description
GET Retrieve the viewer provider profile.

4.114.3.1 Get a viewer

Retrieve the viewer provider profile.

4.114.3.1.1 HTTP method

GET

4.114.3.1.2 Query parameters

This operation supports view, the common query parameter.

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.114.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

534 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.114. xCP viewer single instance

4.114.3.1.4 Request body

None.

4.114.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.114.3.1.6 Supported response media types

• application/vnd.emc.xcp+json
• application/json (For compatible viewing)

4.114.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.114.3.1.8 Response body

JSON representation of a viewer provider profile. For more information about

viewer provider profiles, see “Viewer provider profile” on page 599.

Example 4-59: Viewer Profile in JSON

{
"name": "ContentViewer",
"viewerCapabilities": {
"supportLocalFile": false,
"supportPageServing": false,
"supportDistrbutedContentDelivery": true,
"supportRelativeUrl": true,
"supportUrlFallback": false,
"supportIRMContainer": false,
"supportAutomation": true
},
"featureEnablement": {
"annotation": {
"enable": true,
"tagname": ""
},
"annotationCreation": {
"enable": true,
"tagname": ""
},
"thumbnail": {

EDCPKL230200-PGR-EN-01 Development Guide 535

Chapter 4 Resources

"enable": false,
"tagname": ""
},
"printing": {
"enable": true,
"tagname": ""
},
"export": {
"enable": false,
"tagname": ""
},
"contentModification": {
"enable": false,
"tagname": ""
}
},
"supportedFormats": {
"format": [{
"pageModification": true,
"supportAnnotations": true,
"dosExtensions": {
"ext": ["pdf"]
},
"name": "pdf"
},
{
"pageModification": true,
"supportAnnotations": true,
"dosExtensions": {
"ext": ["tif",
"tiff"]
},
"name": "tiff"
},
{
"pageModification": false,
"supportAnnotations": true,
"dosExtensions": {
"ext": ["jpg",
"jpeg"]
},
"name": "jpeg"
},
{
"pageModification": false,
"supportAnnotations": true,
"dosExtensions": {
"ext": ["gif"]
},
"name": "gif"
}]
},
"environmentSettings": {
"pageServingThreshold": 100000,
"annotationFormat": "",
"automationLibrary": "",
"parameterHandler":
"com.emc.xcp.ivf.runtime.handlers.params.DocumentViewerParameterHandler",
"optionalDataHandler":
"com.emc.xcp.ivf.runtime.handlers.data.DefaultOptionalDataHandler",
"requestHandlers": {
"handlerSpecification": [{
"baseurl": "/{$objectUri}/stream?provider=ContentViewer",
"handler":
"com.emc.xcp.ivf.runtime.handlers.requests.DefaultDocumentHandler",
"tagname": "docURL",
"name": "documentDownload"
},
{
"baseurl": "/viewers/ContentViewer/{$objectUri}/view/annotations",

536 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.114. xCP viewer single instance

"handler":
"com.emc.xcp.ivf.runtime.handlers.requests.DocumentViewerCommentHandler",
"tagname": "getCommentsService",
"name": "annotationDownload"
},
{
"baseurl": "/viewers/ContentViewer/{$objectUri}/view/annotations",
"handler":
"com.emc.xcp.ivf.runtime.handlers.requests.DocumentViewerCommentHandler",
"tagname": "addCommentService",
"name": "annotationUpload"
},
{
"baseurl": "/{$objectUri}/clientaudit?provider=ContentViewer&act=Print",
"handler":
"com.emc.xcp.ivf.runtime.handlers.requests.DefaultAuditTrailHandler",
"tagname": "",
"name": "printAuditing"
},
{
"baseurl": "/{$objectUri}/page?provider=ContentViewer",
"handler":
"com.emc.xcp.ivf.runtime.handlers.requests.DefaultPageModificationHandler",
"tagname": "",
"name": "pageDeletion"
},
{
"baseurl": "/{$objectUri}/page?provider=ContentViewer",
"handler":
"com.emc.xcp.ivf.runtime.handlers.requests.DefaultPageModificationHandler",
"tagname": "",
"name": "pageReorder"
},
{
"baseurl": "/{$objectUri}/page?provider=ContentViewer",
"handler":
"com.emc.xcp.ivf.runtime.handlers.requests.DefaultPageModificationHandler",
"tagname": "",
"name": "pageInsertion"
},
{
"baseurl": "/{$objectUri}/page?provider=ContentViewer",
"handler":
"com.emc.xcp.ivf.runtime.handlers.requests.DefaultPageModificationHandler",
"tagname": "",
"name": "pageExtraction"
}]
}
},
"viewerControl": {
"attributes": {
"attr": []
},
"parameters": {
"param": [{
"value": "",
"name": "documentInfo",
"type": "custom"
},
{
"value": "{$objectUri}/searchinfo",
"name": "searchInfoUrl",
"type": "custom"
},
{
"value": "",
"name": "language",
"type": "custom"
},
{

EDCPKL230200-PGR-EN-01 Development Guide 537

Chapter 4 Resources

"value": "",
"name": "isCommentingAllowed",
"type": "custom"
},
{
"value": "DocumentViewerEventHandler",
"name": "eventhandler",
"type": "static"
},
{
"value": "/viewers/ContentViewer/{$objectUri}/view/renditions",
"name": "documentPagesServiceUrl",
"type": "static"
},
{
"value": "3",
"name": "documentPagesChunkSize",
"type": "static"
},
{
"value": "",
"name": "docURL",
"type": "runtime"
},
{
"value": "{$objectUri}/search",
"name": "searchUrl",
"type": "static"
},
{
"value": "",
"name": "isServerSideSearch",
"type": "custom"
}]
},
"type": "div"
}
}

4.115 xCP Viewer collection

A Viewer collection represents a collection of all Viewer instances.

4.115.1 URI template

/viewers

538 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.115. xCP Viewer collection

4.115.2 Feed and EDAA support

A collection of Viewer instances conforms to EDAA collection in JSON
representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed http://localhost:8080/xcp-rest/
viewers
Title Viewer Profiles Viewer Profiles
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which http://localhost:8080/xcp-rest/
follows this pattern: <feed_ viewers/ContentViewer
uri>/<viewer_name>
Title Entry title ContentViewer
Summary Entry summary ContentViewer
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.115.3 Link relation

The following table lists link relation(s) for a Viewer collection resource.

Link relation Description Resource reference

self This collection resource “xCP Viewer collection”
on page 538

EDCPKL230200-PGR-EN-01 Development Guide 539

Chapter 4 Resources

4.115.4 Operations
A Viewer collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Viewer instances

4.115.4.1 Get a viewer collection

Retrieve a collection of viewer instances.

4.115.4.1.1 HTTP method

GET

4.115.4.1.2 Query parameters

None.

4.115.4.1.3 Request headers

• Accept

• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.115.4.1.4 Request body

None.

4.115.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.115.4.1.6 Supported response media types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/json (For compatible viewing)

540 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.115. xCP Viewer collection

4.115.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.115.4.1.8 Response body

XML or JSON representation of a collection of Viewer instances.

Example 4-60: Viewer Profile collection in JSON

{
"id": "viewers",
"title": "Viewer Profiles",
"updated": "2013-11-19T21:40:16.265-05:00",
"author": "OpenText Documentum",
"links": [{
"rel": "self",
"href": "viewers"
}],
"entries": [{
"id": "viewers/AcrobatReader",
"title": "AcrobatReader",
"updated": "2013-11-19T21:40:16.332-05:00",
"summary": "AcrobatReader",
"content": {
"src": "viewers/AcrobatReader",
"content-type": "application/vnd.emc.xcp+json"
},
"links": [{
"rel": "edit",
"href": "viewers/AcrobatReader"
}]
},
{
"id": "viewers/AXViewer",
"title": "AXViewer",
"updated": "2013-11-19T21:40:16.332-05:00",
"summary": "AXViewer",
"content": {
"src": "viewers/AXViewer",
"content-type": "application/vnd.emc.xcp+json"
},
"links": [{
"rel": "edit",
"href": "viewers/AXViewer"
}]
},
{
"id": "viewers/Browser",
"title": "Browser",
"updated": "2013-11-19T21:40:16.332-05:00",
"summary": "Browser",
"content": {
"src": "viewers/Browser",

EDCPKL230200-PGR-EN-01 Development Guide 541

Chapter 4 Resources

"content-type": "application/vnd.emc.xcp+json"
},
"links": [{
"rel": "edit",
"href": "viewers/Browser"
}]
},
{
"id": "viewers/ContentViewer",
"title": "ContentViewer",
"updated": "2013-11-19T21:40:16.332-05:00",
"summary": "ContentViewer",
"content": {
"src": "viewers/ContentViewer",
"content-type": "application/vnd.emc.xcp+json"
},
"links": [{
"rel": "edit",
"href": "viewers/ContentViewer"
}]
},
{
"id": "viewers/VideoViewer",
"title": "VideoViewer",
"updated": "2013-11-19T21:40:16.332-05:00",
"summary": "VideoViewer",
"content": {
"src": "viewers/VideoViewer",
"content-type": "application/vnd.emc.xcp+json"
},
"links": [{
"rel": "edit",
"href": "viewers/VideoViewer"
}]
}]
}

4.116 xCP raw content

Viewer providers can download the binary streams of Content and Template
instances in a single chunk returned in the response body. Some viewer providers,
such as the AXViewer provider, are capable of uploading content instances by
posting binary streams in the request body.

4.116.1 URI template

/contents/content-type/content-id/stream/templates/template-type/
template-id/stream

content-type Type of the Content instance

content-id r_object-id of the Content instance
template-type Type of the Template instance
template-id r_object-id of the Template instance

542 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.116. xCP raw content

4.116.2 Operations
Raw content operations:

Method Description
GET Download the binary stream of a Content or
Template instance
POST Upload the binary stream of a Content or
Template instance

4.116.2.1 Get a Binary Stream

Download the binary stream of a Content or Template instance.

4.116.2.1.1 HTTP method

GET

To download the binary stream of a Content or Template instance:

1. Get the view link of a Content or Template instance in the following pattern:
/contents/content-type/content-id/view?contentType=format

The viewer control (“xCP view single instance” on page 529) of the instance is
returned.
2. Access docURL of the viewer control:
/contents/content-type/content-id/stream?provider=viewer-provider

The binary stream of the Content or Template instance is returned in the

response body.

4.116.2.1.2 Query parameters

The following query parameter is specific to this operation:

Parameter Description Data Type Default

use-acs Specifies whether or boolean false
not the binary stream
of the content is
retrieved from an
ACS or BOCS server
network-location Specifies the address string NA
of the ACS or BOCS
server when use-
acs is set to true

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 543

Chapter 4 Resources

4.116.2.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.116.2.1.4 Request body

None.

4.116.2.1.5 Response headers

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.116.2.1.6 Supported response media types

• application/vnd.emc.xcp+json
• application/json (For compatible viewing)

4.116.2.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

404 - Object not found

500 - Other unexpected server error

4.116.2.1.8 Response body

Binary stream of a Content or Template instance.

544 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.116. xCP raw content

4.116.2.2 Upload a Binary Stream

Upload the binary stream of a Content or Template instance.

Note: Refer to the corresponding viewer provider profile to see whether a

viewer provider is capable of posting binary streams of Content and Template
instances in the request body.

4.116.2.2.1 HTTP method

POST

To upload the binary stream of a Content or Template instance:

1. Get the view link of a Content or Template instance in the following pattern:
/contents/content-type/content-id/view?contentType=format

The viewer control (“xCP view single instance” on page 529) of the instance is
returned.
2. Place the binary stream of the Content or Template instance in the request body
and POST to the following URI:
/contents/content-type/content-id/stream?provider=viewer-provider
&versionOptions=versionOption&contentType=contentType&comments=comment

The new object URI is returned in the response.

4.116.2.2.2 Server accepted request media types

application/vnd.emc.xcp+json

4.116.2.2.3 Query parameters

The following query parameters are specific to this operation:

Parameter Description Data Type Default

provider (required) Specifies the viewer string NA
provider used to
upload binary
streams
contentType Specifies the content string NA
format
versionOptions Specifies the checkin integer NA
(required) type. Valid values
are:
• 0: current version
• 1: next minor
• 2: next major

EDCPKL230200-PGR-EN-01 Development Guide 545

Chapter 4 Resources

comment Specifies the checkin string NA

comment

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.116.2.2.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.116.2.2.5 Request body

Binary stream of the Content or Template instance.

4.116.2.2.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.116.2.2.7 Supported response media types

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

4.116.2.2.8 Response status

200 - Stream uploaded successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict.

500 - Other unexpected server error

546 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.117. xCP LightWeight Business Object single instance

4.116.2.2.9 Response body

The new object URI is returned in the response.

4.117 xCP LightWeight Business Object single

instance
A single instance of Lightweight Business Object is a resource that describes a
Lightweight business object.

4.117.1 URI template

lw-business-objects/lw-business-object-type/lw-business_object-id

lw-business-object-type Type of the lightweight business object

resource
lw-business_object-id Object ID of the lightweight business object
resource

4.117.2 Link relation

The following table lists general link relations for a Lightweight Business Object
resource.

Link relation Description Resource reference

comments Add a comment to the “xCP LightWeight Business
Lightweight Business Object Object single instance”
instance on page 547
type Type definition of this “xCP Lightweight Business
resource Object single type”
on page 558
edit Edit this Lightweight “xCP LightWeight Business
business object instance Object single instance”
on page 547
self This Lightweight business “xCP LightWeight Business
object instance Object single instance”
on page 547
relations Defines the relationship “xCP LightWeight Business
between two or more Object single instance”
resources on page 547
delete Delete this Lightweight “xCP LightWeight Business
business object instance Object single instance”
on page 547
materialize Materialize the Lightweight “xCP LightWeight Business
business object instance Object single instance”
on page 547

EDCPKL230200-PGR-EN-01 Development Guide 547

Chapter 4 Resources

Link relation Description Resource reference

dematerialize Dematerialize the “xCP LightWeight Business
Lightweight business object Object single instance”
instance on page 547
shared-parent Retrieve the shared parent of “xCP LightWeight Business
a Lightweight business object Object single instance”
instance on page 547
reparent Reparent the Lightweight “xCP LightWeight Business
Business object instance Object single instance”
on page 547

4.117.3 Operations
A Lightweight Business Object resource supports the following HTTP methods.

Method Description
GET Retrieve a Lightweight Business Object
resource
POST Update a Lightweight Business Object
resource
DELETE Delete a Lightweight Business Object
resource
POST Reparent a Lightweight Business Object
resource to another shared parent resource

4.117.3.1 Get a Lightweight Business Object

Retrieve a Lightweight Business Object resource.

4.117.3.1.1 HTTP method

GET

4.117.3.1.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

548 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.117. xCP LightWeight Business Object single instance

4.117.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.117.3.1.4 Request body

None.

4.117.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.117.3.1.6 Supported response media types

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

4.117.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 549

Chapter 4 Resources

4.117.3.1.8 Response body

XML or JSON representation of the Lightweight Business Object resource.

• The type link relation points to the type definition of the Lightweight Business
Object resource, through which you can retrieve an “xCP Lightweight Business
Object single type” on page 558.

4.117.3.2 Update a Lightweight Business Object

Update a Lightweight Business Object resource.

4.117.3.2.1 HTTP method

POST

To update a Lightweight Business Object resource, send a POST request to the edit
link relation of that resource.

4.117.3.2.2 Server accepted request media types

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

4.117.3.2.3 Query parameters

None.

4.117.3.2.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.117.3.2.5 Request body

XML or JSON representation of the Lightweight Business Object resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Lightweight Business Object single type” on page 558), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

550 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.117. xCP LightWeight Business Object single instance

4.117.3.2.6 Response headers

• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.117.3.2.7 Supported response media types

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

4.117.3.2.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.117.3.2.9 Response body

XML or JSON representation of the updated Lightweight Business Object resource:

• The type link relation points to the type definition of the Lightweight Business
Object resource, through which you can retrieve a “xCP Business Object Single
Type” on page 157.

EDCPKL230200-PGR-EN-01 Development Guide 551

Chapter 4 Resources

4.117.3.3 Delete a Lightweight Business Object

Delete a Lightweight Business Object resource.

4.117.3.3.1 HTTP method

DELETE

To delete a Lightweight Business Object resource, send a DELETE request to the

delete link relation of the resource.

4.117.3.3.2 Query parameters

None.

4.117.3.3.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.117.3.3.4 Request body

None.

4.117.3.3.5 Response headers

None.

4.117.3.3.6 Response status

200 - Empty response

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

500 - Other unexpected server error

4.117.3.3.7 Response body

Empty

552 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.117. xCP LightWeight Business Object single instance

4.117.3.4 Reparent a Lightweight Business Object

Reparent a Lightweight Business Object resource.

4.117.3.4.1 HTTP method

POST

To reparent a Lightweight Business Object resource, send a POST request to the

reparent link relation of that resource.

4.117.3.4.2 Server accepted request media types

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

4.117.3.4.3 Query parameters

None.

4.117.3.4.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.117.3.4.5 Request body

XML or JSON representation of the Lightweight Business Object resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
Lightweight Business Object single type” on page 558), the field is ignored.
• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

EDCPKL230200-PGR-EN-01 Development Guide 553

Chapter 4 Resources

4.117.3.4.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.117.3.4.7 Supported response media types

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

4.117.3.4.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.117.3.4.9 Response body

XML or JSON representation of the updated Lightweight Business Object resource:

• The type link relation points to the type definition of the Lightweight Business
Object resource, through which you can retrieve a “xCP Lightweight Business
Object single type” on page 558.
• Null values are presented as an empty string (“”).

554 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.118. xCP Lightweight Business Object collection

4.118 xCP Lightweight Business Object collection

A Lightweight Business Object collection represents a collection of Lightweight
Business Object instances of a certain type.

4.118.1 URI template

/lw-business-objects/lw-business-object-type

lw-business-object-type Type of the Lightweight Business Object

resources.

4.118.2 Feed and EDAA support

A collection of Lightweight Business Object instances conforms to Atom Feed in
XML representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed lw-business-objects/
utapp21_lwbo_all_attrs
Title Name of lightweight utapp21_lwbo_all_attrs
business object type
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which lw-business-objects/
follows this pattern: <feed_ utapp21_bo_all_attrs/
uri>/<r_object_id> 0801e24080025557
Title object_name of the entry Sample
LightweightBusinessObject
Summary object_name of the entry Sample
LightweightBusinessObject
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

EDCPKL230200-PGR-EN-01 Development Guide 555

Chapter 4 Resources

4.118.3 Link relation

The following table lists link relation(s) for a Lightweight Business Object collection
resource.

Link relation Description Resource reference

self This collection resource “xCP Lightweight Business
Object collection”
on page 555
first, last, previous, next Pagination links “xCP Lightweight Business
Object collection”
on page 555

4.118.4 Operations
A Lightweight Business Object collection resource supports the following HTTP
method.

Method Description
GET Retrieve a collection of Lightweight Business
Object instances.

4.118.4.1 Get a Lightweight Business Object collection

Retrieve a collection of Lightweight Business Object instances of a certain type.

4.118.4.1.1 HTTP method

GET

4.118.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

556 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.118. xCP Lightweight Business Object collection

4.118.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.118.4.1.4 Request body

None.

4.118.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.118.4.1.6 Supported response media types

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

4.118.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 557

Chapter 4 Resources

4.118.4.1.8 Response body

XML or JSON representation of a collection of Lightweight Business Object

instances.

• Each instance may contain all or a set of properties of the Lightweight Business
Object instance, depending on the setting of the query parameter view.

• The returned collection contains only those entries that you have access to.

• Pagination is supported.

4.119 xCP Lightweight Business Object single type

A single instance of Lightweight Business Object Type represents the type definition
of lightweight business object instances.

4.119.1 URI template

types/lw-business-objects/lw-business-object-type

lw-business-object-type Type of the Lightweight business object

resources.

4.119.2 Link relation

The following table lists general link relations for a Lightweight Business Object
Type resource.

Link relation Description Resource reference

self Type definition of “xCP Lightweight Business
Lightweight Business Object Object single type”
instances on page 558

4.119.3 Operations
A Business Object Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Lightweight
business object instances

558 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.119. xCP Lightweight Business Object single type

4.119.3.1 Get a Lightweight Business Object type

Retrieve the type definition of Lightweight business object instances of a certain
type.

4.119.3.1.1 HTTP method

GET

4.119.3.1.2 Query parameters

None.

4.119.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.119.3.1.4 Request body

None.

4.119.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.119.3.1.6 Supported response media types

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

EDCPKL230200-PGR-EN-01 Development Guide 559

Chapter 4 Resources

4.119.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.119.3.1.8 Response body

XML or JSON representation of the type definition of Lightweight Business Object

instances.

The materialization-option has these values:

• auto
• disallow
• on-request

{
"name":"lw-business-object-type",
"type":"utapp21_orderrecord",
"label":"OrderRecord",
"parent":"types/lw-business-objects/xcp_rootlightweightbo",
"shared-parent":"types/business-objects/utapp21_customerrecord",
"materialization-option":"auto",
"properties":[{
"name":"order_number",
"label":"order_number",
"type":"string",
"length":64,"default-expression":"'OrderDefault'
"},{
"name":"order_amount",
"label":"order_amount",
"type":"float
"},{
"name":"order_date",
"label":"order_date",
"type":"datetime
"},{
"name":"order_shipped",
"label":"order_shipped",
"type":"boolean"
},{
"name":"order_details",
"label":"order_details",
"type":"string",
"length":64,"repeating":true
},{
"name":"order_itemscount",
"label":"order_itemscount",
"type":"integer","repeating":true
}],
"relationships":{"source":

560 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.120. xCP Lightweight Business Object Type collection

[{"rel":"http://identifiers.emc.com/linkrel/source",
"name":"utapp21_orderrecord_localin",
"type":"types/relationships/utapp21_orderrecord_localin"},
{"rel":"http://identifiers.emc.com/linkrel/source",
"name":"utapp21_orderrecord_product",
"type":"types/relationships/utapp21_orderrecord_product"
}]},
"links":[{
"rel":"self","href":"types/lw-business-objects/utapp21_orderrecord"
},{
"rel":"http://identifiers.emc.com/linkrel/instances",
"href":"lw-business-objects/utapp21_orderrecord"
},{
"rel":"type"
},{
"rel":"edit"
},{
"rel":"canonical"
},{
"rel":"http://identifiers.emc.com/linkrel/delete"
},{
"rel":"http://identifiers.emc.com/linkrel/relations"
},{
"rel":"http://identifiers.emc.com/linkrel/materialize"
},{
"rel":"http://identifiers.emc.com/linkrel/dematerialize"
},{
"rel":"http://identifiers.emc.com/linkrel/reparent"
},{
"rel":"http://identifiers.emc.com/linkrel/shared-parent"
}]}

4.120 xCP Lightweight Business Object Type

collection
A Lightweight Business Object instances Type collection represents a collection of
type definitions for Lightweight Business Object instances.

4.120.1 URI template

/types/lw-business-objects/

4.120.2 Feed and EDAA support

A collection of Lightweight Business Object Type instances conforms to Atom Feed
in XML representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed types/lw-business-objects/
Title Lightweight Business Objects LWSO Business Objects
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed

EDCPKL230200-PGR-EN-01 Development Guide 561

Chapter 4 Resources

Feed property Feed value Example

Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which types/lw-business-objects/
contains the URI of the feed utapp21_lwloanbo
and name of the type
Title Label of the type that this utapp21_lwloanbo
entry points to
Summary Label of the type that this lwloanbo
entry points to
Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.120.3 Link relation

The following table lists link relation(s) for a Lightweight Business Object type
collection resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Lightweight Business
for Lightweight Business Object Type collection”
Object instances on page 561

4.120.4 Operations
A Lightweight Business Object Type collection resource supports the following
HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Lightweight Business Object instances

562 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.120. xCP Lightweight Business Object Type collection

4.120.4.1 Get a Lightweight Business Object type collection

Retrieve a collection of type definitions for Lightweight Business Object instances.

4.120.4.1.1 HTTP method

GET

4.120.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.120.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.120.4.1.4 Request body

None.

4.120.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 563

Chapter 4 Resources

4.120.4.1.6 Supported response media types

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

4.120.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.120.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Lightweight

Business Object instances.

• Each instance may contain all or a set of properties of the type definitions for
Lightweight Business Object instances, depending on the setting of the query
parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.121 xCP Lightweight Content single instance

A single instance of Lightweight Content is a resource that has a sharing parent
type. A lightweight content resource is an instance of a subtype of dm_document.

564 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.121. xCP Lightweight Content single instance

4.121.1 URI template

/lw-contents/lw-content-type/lw-content-r_objectId

lw-content-type Type of the lightweight content resource

lw-content-r_objectId Object ID of the lightweight content resource

4.121.2 Link relation

The following table lists general link relations for a Lightweight Content resource.

Link relation Description Resource reference

type Type definition of this “xCP lightweight content
resource single type” on page 580
self This lightweight content “xCP Lightweight Content
instance single instance” on page 564
edit Edit this lightweight content “xCP Lightweight Content
instance single instance” on page 564
delete Delete this lightweight “xCP Lightweight Content
content instance single instance” on page 564
checkout Check out this lightweight “xCP Lightweight Content
content instance single instance” on page 564
comments Comments attached to this “xCP Comment collection”
lightweight content instance on page 203
cancel-checkout Cancels the check out the “xCP Lightweight Content
lightweight content instance single instance” on page 564
download-media Link to the lightweight “xCP raw content”
content binary stream for on page 542
download
checkin-next-major Check in this lightweight “xCP lightweight content
content instance as the next single type” on page 580
major version
checkin-current-version Check in this lightweight “xCP Content Single Type”
content instance as the on page 230
current version
checkin-next-minor Check in this lightweight “xCP Content Single Type”
content instance as the next on page 230
minor version
materialize Materialize the lightweight “xCP Lightweight Content
content instance single instance” on page 564
dematerialize Dematerialize the “xCP Lightweight Content
lightweight content instance single instance” on page 564

EDCPKL230200-PGR-EN-01 Development Guide 565

Chapter 4 Resources

Link relation Description Resource reference

shared-parent Retrieve the shared parent “xCP Lightweight Content
from the lightweight content single instance” on page 564
instance
reparent Reparent the lightweight “xCP Lightweight Content
object to another specified single instance” on page 564
shared parent object
relations Defines the relationship “xCP Lightweight Content
between two or more single instance” on page 564
resources
version-history Retrieves the versions of all “xCP Lightweight Content
lightweight content instances single instance” on page 564
instances Lightweight content instance “xCP Lightweight Content
single instance” on page 564
add-comment Add a comment to the “xCP Lightweight Content
Lightweight content instance single instance” on page 564

4.121.3 Operations
A Lightweight content resource supports the following HTTP methods.

Method Description
GET Retrieve a lightweight content resource
POST Update a lightweight content resource
DELETE Delete a lightweight content resource
POST Reparent the lightweight content resource to
another specified shared parent object
POST Check out a lightweight content resource
POST Check in a lightweight content resource
POST Import a new version to a lightweight
content resource

4.121.3.1 Get a Lightweight Content

Retrieve the current version of a Lightweight content resource.

566 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.121. xCP Lightweight Content single instance

4.121.3.1.1 HTTP method

GET

4.121.3.1.2 Query parameters

The following query parameter is specific to this operation:

Parameter Description Data Type Default

recursive Specifies whether or boolean false
not to list all the
following version
policy-related link
relations in the
response body
regardless of the
content state:
• checkin-next-
major
• checkin-current-
version
• checkin-next-
minor
• checkout

Additionally, this operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.121.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

EDCPKL230200-PGR-EN-01 Development Guide 567

Chapter 4 Resources

4.121.3.1.4 Request body

None.

4.121.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.121.3.1.6 Supported response media types

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

4.121.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

4.121.3.1.8 Response body

XML or JSON representation of the Lightweight Content resource.

• The type link relation points to the type definition of the Lightweight Content
resource, through which you can retrieve an “xCP Lightweight Content single
instance” on page 564.

568 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.121. xCP Lightweight Content single instance

4.121.3.2 Update a Lightweight Content

Update the current version of a Lightweight content resource.

4.121.3.2.1 HTTP method

POST

To update the current version of a Lightweight Content resource, send a POST

request to the edit link relation of the resource with the following pattern:
lw-contents/<lw-content-type>/<objectID>

4.121.3.2.2 Server accepted request media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

4.121.3.2.3 Query parameters

None.

4.121.3.2.4 Request headers

• Accept

• Authorization

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.121.3.2.5 Request body

XML or JSON representation of the Lightweight Content resource.

• This operation updates all fields specified in the request. However, if the request
body contains a field that is not presented in the corresponding DML type (“xCP
lightweight content single type” on page 580), the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the
list, the entire list is updated.
• To set an existing field to null, use one of the following patterns.
Null in XML: <<field-name>>
Null in JSON: "<field-name>" : null

EDCPKL230200-PGR-EN-01 Development Guide 569

Chapter 4 Resources

4.121.3.2.6 Response headers

• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.121.3.2.7 Supported response media types

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

4.121.3.2.8 Response status

201 - Content updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.121.3.2.9 Response body

XML or JSON representation of the updated Lightweight Content resource:

• The type link relation points to the type definition of the Lightweight Content
resource, through which you can retrieve a “xCP lightweight content single
type” on page 580.

570 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.121. xCP Lightweight Content single instance

4.121.3.3 Delete a Lightweight Content

Delete a Lightweight content resource.

4.121.3.3.1 HTTP method

DELETE

To delete a Lightweight content resource, send a DELETE request to the delete link
relation of the resource with the following pattern:
lw-contents/<lw-content-type>/<objectID>

4.121.3.3.2 Query parameters

None

4.121.3.3.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.121.3.3.4 Request body

None.

4.121.3.3.5 Response headers

None.

4.121.3.3.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 571

Chapter 4 Resources

4.121.3.3.7 Response body

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

4.121.3.4 Check out a Lightweight Content

Check out a Lightweight content resource.

4.121.3.4.1 HTTP method

POST

To check out a Lightweight content resource, send a POST request to the checkout
link relation of the resource with the following pattern:
lw-contents/<lw-content-type>/<objectID>/lock

4.121.3.4.2 Server accepted request media types

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

4.121.3.4.3 Query parameters

None.

4.121.3.4.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.121.3.4.5 Request body

None.

572 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.121. xCP Lightweight Content single instance

4.121.3.4.6 Response headers

• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.121.3.4.7 Supported response media types

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

4.121.3.4.8 Response status

200 - Content checked out successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.121.3.4.9 Response body

XML or JSON representation of the updated Lightweight Content resource:

• The type link relation points to the type definition of the Content resource,
through which you can retrieve a “xCP lightweight content single type”
on page 580.

EDCPKL230200-PGR-EN-01 Development Guide 573

Chapter 4 Resources

4.121.3.5 Check in a Lightweight Content

Check in a Lightweight content resource or import a new version to a Lightweight
content resource.

This operation contains the following steps:

1. Upload a content by posting an “xCP File Upload Resource” on page 238.

When a content instance is successfully uploaded, the REST server returns the
201 Created status code. Additionally, the return message contains the Location
header which indicates the URI of the file uploaded.
2. Send a POST request specifying the metadata of the content to one of the
checkin link relations of the resource with the following pattern:
lw-contents/<lw-content-type>/<objectID>/<versions?version-policy=<check-in-option>>

<check-in-option> can be one of the followings:

• current-version
• next-major
• branch-version
• next-minor

Notes

• The request body must contain a reference to the content you uploaded by
using the “xCP File Upload Resource” on page 238 resource. To do this,
specify the full or relative URI of the uploaded content in source.
• To import a new version to a Lightweight content resource, append ?
retain-lock=true to the URL of the request. By doing this, the Lightweight
content remains locked (checked out), and a new version is imported to the
Content resource.

4.121.3.5.1 HTTP method

POST

4.121.3.5.2 Server accepted request media types

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

574 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.121. xCP Lightweight Content single instance

4.121.3.5.3 Query parameters

The following query parameter is specific to this operation:

Parameter Description Data Type Default

retain-lock Specifies whether or boolean false
not to retain the lock
on the Lightweight
content resource in a
checkin operation.

If you set this

parameter to true,
the Lightweight
content resource
remains locked
(checked out), and a
new version is
imported to the
Lightweight Content
resource.
version-policy Specifies the checkin String N/A
type. Valid values
are: current version,
next minor, next
major, and branch
version.

4.121.3.5.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.121.3.5.5 Request body

The request body contains a reference to the file you uploaded by using the “xCP
File Upload Resource” on page 238 resource and the metadata of the Content
resource.

Example 4-61: XML Sample

<?xml version="1.0" encoding="UTF-8"?>
<content xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:type="ut200_content_with_attrs">
<properties>
<r_version_label>CURRENT<r_version_label>
</properties>
<source>/files/d6e9ac3a-72a9-4262-ba30-398f4f701ac6

EDCPKL230200-PGR-EN-01 Development Guide 575

Chapter 4 Resources

</source>
</content>

Example 4-62: JSON Sample

{
"properties":
{ "r_version_label": [ "CURRENT" ] }
,
"source":"/files/680884ca-c104-4513-afde-aedc686ff3c3"
}

4.121.3.5.6 Response headers

• Location

• Content-Length

• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.121.3.5.7 Supported response media types

• application/vnd.emc.xcp+xml

• application/vnd.emc.documentum+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

4.121.3.5.8 Response status

200 - Content checked in successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

576 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.122. xCP Lightweight Content collection

4.121.3.5.9 Response body

XML or JSON representation of the Lightweight Content resource that you check in:

• The type link relation points to the type definition of the Lightweight Content
resource, through which you can retrieve a “xCP lightweight content single
type” on page 580.
• Null values are presented as an empty string (“”).

4.122 xCP Lightweight Content collection

A Lightweight content collection represents a collection of lightweight content
instances.

4.122.1 URI template

/lw-contents/lw-content-type

lw-content-type Type of the lightweight content resources.

4.122.2 Feed and EDAA support

A collection of lightweight content instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed lw-contents/
so_service_document
Title Name of content object ttype service_document
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which lw-contents/
follows this pattern: <feed_ so_service_document/
uri>/< r_object_id> 0901e24080025557
Title Lightweight content name so_service_document
Summary Lightweight content name so_service_document

EDCPKL230200-PGR-EN-01 Development Guide 577

Chapter 4 Resources

Feed property Feed value Example

Updated Last update time of the 2013-01-25T18:51:39.469Z
instance that this entry points
to

4.122.3 Link relation

The following table lists link relation(s) for a Lightweight content collection
resource.

Link relation Description Resource reference

self This collection resource “xCP Lightweight Content
collection” on page 577
first, last, previous, next Pagination links “xCP Lightweight Content
collection” on page 577

4.122.4 Operations
A Lightweight Content collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of lightweight content
instances.

4.122.4.1 Get a Lightweight Content collection

Retrieve a collection of lightweight content instances.

4.122.4.1.1 HTTP method

GET

4.122.4.1.2 Query parameters

This operation supports the following common query parameters:

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

578 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.122. xCP Lightweight Content collection

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.122.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.122.4.1.4 Request body

None.

4.122.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.122.4.1.6 Supported response media types

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

4.122.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 579

Chapter 4 Resources

4.122.4.1.8 Response body

XML or JSON representation of a collection of Lightweight Content instances.

• Each instance may contain all or a set of properties of the Lightweight Content
instance, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.123 xCP lightweight content single type

A single instance of Lightweight Content type represents the type definition of
lightweight content instances.

4.123.1 URI template

/types/lw-contents/lw-content-type

lw-content-type Type of the lightweight content resources.

4.123.2 Link relation

The following table lists general link relations for a Lightweight content type
resource.

Link relation Description Resource reference

self Type definition of “xCP lightweight content
lightweight content instances single type” on page 580

4.123.3 Operations
A Lightweight content type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of lightweight
content instances

580 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.123. xCP lightweight content single type

4.123.3.1 Get a Content Type

Retrieve the type definition of Content instances.

4.123.3.1.1 HTTP method

GET

4.123.3.1.2 Query parameters

None.

4.123.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.123.3.1.4 Request body

None.

4.123.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.123.3.1.6 Supported response media types

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

4.123.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 581

Chapter 4 Resources

4.123.3.1.8 Response body

XML or JSON representation of the type definition of Lightweight Content instances.

The instances link relation points to a collection of Lightweight content instances,
through which you can retrieve an “xCP Lightweight Content collection”
on page 577.

4.124 xCP Lightweight Content Type collection

A Lightweight Content Type collection represents a collection of type definitions for
lightweight content instances.

4.124.1 URI template

/types/lw-contents

4.124.2 Feed and EDAA support

A collection of Lightweight Content Type instances conforms to Atom Feed in XML
representation and EDAA collection in JSON representation.

This collection resource contains the following properties.

Feed property Feed value Example

ID URI of the feed types/lw-contents
Title Name of Feed Lightweight Contents
Updated Value of the updated 2013-01-25T18:51:39.469Z
property of the last updated
entry in the feed
Author OpenText Documentum OpenText Documentum

An entry in this collection resource contains the following properties.

Feed property Feed value Example

ID URI of the entry, which types/lw-contents/
contains the URI of the feed so_service_document
and name of the type
Title Name of the type service_document
Summary Label of the type service_document
Updated Last update time of the 2013-01-25T18:51:39.469
instance that this entry points
to

582 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.124. xCP Lightweight Content Type collection

4.124.3 Link relation

The following table lists link relation(s) for a Lightweight Content Type collection
resource.

Link relation Description Resource reference

self Collection of type definitions “xCP Lightweight Content
for Lightweight content Type collection” on page 582
instances

4.124.4 Operations
A Lightweight Content Type collection resource supports the following HTTP
method.

Method Description
GET Retrieve a collection of type definitions for
Lightweight content instances

4.124.4.1 Get a Lightweight Content Type collection

Retrieve a collection of type definitions for Lightweight Content instances.

4.124.4.1.1 HTTP method

GET

4.124.4.1.2 Query parameters

This operation supports the following common query parameters:

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

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

EDCPKL230200-PGR-EN-01 Development Guide 583

Chapter 4 Resources

4.124.4.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.124.4.1.4 Request body

None.

4.124.4.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.124.4.1.6 Supported response media types

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

4.124.4.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

584 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.125. xCP LightWeight materialization resource

4.124.4.1.8 Response body

XML or JSON representation of a collection of type definitions for Lightweight

content instances.

• Each instance may contain all or a set of properties of the type definitions for
Content instances, depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.125 xCP LightWeight materialization resource

The Lightweight materialization resource models the materialized state of a
Lightweight business object or a Lightweight content object.

4.125.1 URI template

lw-business-objects/lw-type-name/lw-object-id/materializelw-contents/
lw-content-type-name/lw-content-objectid/materialize

lw-type-name Type of the lightweight object resource

materialization The state of the lightweight object resource
lw-business_object-id Object ID of the lightweight object resource

4.125.2 Link relation

The following table lists general link relations for a Lightweight materialization
resource.

Link relation Description Resource reference

type Type definition of this “xCP Lightweight Business
resource Object single type”
on page 558
edit Edit this Lightweight “xCP LightWeight Business
Business Object instance Object single instance”
on page 547
self This Lightweight Business “xCP LightWeight Business
Object instance Object single instance”
on page 547
relations Defines the relationship “xCP LightWeight Business
between two or more Object single instance”
resources on page 547
delete Delete this Lightweight “xCP LightWeight Business
Business Object instance Object single instance”
on page 547

EDCPKL230200-PGR-EN-01 Development Guide 585

Chapter 4 Resources

Link relation Description Resource reference

comments Add a comment to the “xCP LightWeight Business
Lightweight Business Object Object single instance”
instance on page 547
materialize Materialize the Lightweight “xCP LightWeight Business
Business object instance Object single instance”
on page 547
dematerialize Dematerialize the “xCP LightWeight Business
Lightweight Business object Object single instance”
instance on page 547
shared-parent Retrieve the shared parent of “xCP LightWeight Business
a Lightweight Business object Object single instance”
instance on page 547
reparent Reparent the Lightweight “xCP LightWeight Business
Business object instance Object single instance”
on page 547

4.125.3 Operations
A Lightweight materialization object resource supports the following HTTP
methods.

Method Description
POST Materialize the lightweight object resource.
DELETE Dematerialize the lightweight object
resource.

4.125.3.1 Materialize the lightweight object

Materialize the lightweight object resource.

4.125.3.1.1 HTTP method

POST
lw-business-objects/<lw-type-name>/<lw-object-id>/<materialization>

586 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.125. xCP LightWeight materialization resource

4.125.3.1.2 Server accepted request media types

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

4.125.3.1.3 Query parameters

None.

4.125.3.1.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.125.3.1.5 Request body

None.

4.125.3.1.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.125.3.1.7 Supported response media types

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

EDCPKL230200-PGR-EN-01 Development Guide 587

Chapter 4 Resources

4.125.3.1.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute name or value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.125.3.1.9 Response body

XML or JSON representation of the updated Business Object resource:

• The type link relation points to the type definition of the Business Object
resource, through which you can retrieve a “xCP Business Object Single Type”
on page 157.
• Null values are presented as an empty string (“”).

4.125.3.2 Delete a Lightweight materialization resource

Delete a Lightweight materialization object resource.

4.125.3.2.1 HTTP method

DELETE

To delete a Lightweight materialization object resource, send a DELETE request to

the delete link relation of the resource with the following pattern:
http://127.0.0.1:8080/<xcp-rest>/lw-business-objects/<lw-object-type>/<lw-objectID>/
<materialization>

4.125.3.2.2 Query parameters

None.

588 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.126. xCP Shared Parent single instance

4.125.3.2.3 Request headers

Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.125.3.2.4 Request body

None.

4.125.3.2.5 Response headers

None.

4.125.3.2.6 Response status

204 - Object deleted successfully

400 - Bad request; invalid parameter value was provided

401 - Authentication failed

403 - Permission denied; no permission to delete the object

409 - State conflicted

500 - Other unexpected server error

4.125.3.2.7 Response body

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

4.126 xCP Shared Parent single instance

This resource models the shared parent of lightweight object.

4.126.1 URI template

/business-objects/sharedparent-business-object-type-name/
sharedparent-id/contents/sharedparent-content-object-type-name/
sharedparent-id

sharedparent-business-object-type-name Name of the shared parent of business object

type.
sharedparent-content-object-type-name Name of the shared parent of content object
type.
sharedparent-id ID of the shared parent resource.

EDCPKL230200-PGR-EN-01 Development Guide 589

Chapter 4 Resources

4.126.2 Link relation

Refer to the Link relation of “xCP LightWeight Business Object single instance”
on page 547 and “xCP Lightweight Content single instance” on page 564
collectively.

Link relation Description

lightweight-objects Collection of lighweight objects associated
with a given shared parent.
add-lightweight-objects Creates an instance of lightweight object for a
given shared parent.

4.126.3 Operations
A shared parent resource supports the following HTTP methods.

Refer to the operations of “xCP LightWeight Business Object single instance”

on page 547 and “xCP Lightweight Content single instance” on page 564
collectively.

Method Description
GET Retrieves a collection of lightweight objects
of a given shared parent r-object-id.
POST Creates a lightweight object which shares the
given shared object. The minimum property
required in the payload is type. The payload
is used for creating contentless and
contentful lwso type.

4.126.4 Get a collection of Lightweight Objects on a shared

parent
Retrieve a collection of lightweight objects of a specific shared parent resource.

4.126.4.1 HTTP method

GET

590 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.126. xCP Shared Parent single instance

4.126.4.2 Query parameters

This operation supports the following common query parameters:

• view
• links

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.126.4.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.126.4.4 Request body

None.

4.126.4.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.126.4.6 Supported response media types

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

4.126.4.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 591

Chapter 4 Resources

4.126.4.8 Response body

Response body in JSON representation:
{
"name":"business-object",
"type":"utapp21_sp_level3",
"definition":"http://10.31.157.122:8000/xCP21UTApp/types/business-objects/
utapp21_sp_level3",
"properties":{"a_is_hidden":false,
"level2boolattr":false,
"r_object_id":"0801e2408006094e",
"r_creator_name":"dmadmin",
"i_sharing_type":"0301e24080000309","r_creation_date":"2017-07-25T12:06:36.000+00:00",
"r_object_type":"utapp21_sp_level3",
"r_modifier":"dmadmin",
"i_folder_id":["0c01e2408004d500"],
"acl_name":"dm_4501e24080000100",
"level2floatattr":0,
"level3dateattr":"2017-06-20T00:00:00.000+00:00",
"acl_domain":"winsqlcs72",
"r_modify_date":"2017-07-25T12:06:36.000+00:00",
"level3strattr":["Jack","Jill"],"level1intattr":0},
"permission":{"basic-permission":"DELETE","extended-permissions":
["EXECUTE_PROC","CHANGE_LOCATION","CHANGE_STATE","CHANGE_PERMIT","CHANGE_OWNER"]},
"links":[{"rel":"type","href":"types/business-objects/utapp21_sp_level3"},
{"rel":"http://identifiers.emc.com/linkrel/instances","href":"business-objects/
utapp21_sp_level3"},
{"rel":"self","href":"business-objects/utapp21_sp_level3/0801e2408006094e"},
{"rel":"http://identifiers.emc.com/linkrel/add-lightweight-objects",
"href":"business-objects/utapp21_sp_level3/0801e2408006094e/lw-objects"},
{"rel":"http://identifiers.emc.com/linkrel/lightweight-objects",
"href":"business-objects/utapp21_sp_level3/0801e2408006094e/lw-objects"
}]}

4.126.5 Creates a lightweight object that shares a specific

shared object
Creates a lightweight object that shares a specific shared object.

4.126.5.1 HTTP method

POST

To create a lightweight object resource, send a POST request to the add-

lightweight-objects link relation of the shared parent.

4.126.5.2 Server accepted request media types

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

592 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.126. xCP Shared Parent single instance

4.126.5.3 Query parameters

None.

4.126.5.4 Request headers

• Accept
• Authorization
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.126.5.5 Request body

XML or JSON representation:

The minimum payload for creating an lwso object is as follows:

{ "type":"lwso-object-type-name" }

With Properties
{ "type":"lwso-object-type-name",
"properties" :{ "new_string":"xyz" }
}

4.126.5.6 Response headers

• Location
• Content-Length
• Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.126.5.7 Supported response media types

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

EDCPKL230200-PGR-EN-01 Development Guide 593

Chapter 4 Resources

4.126.5.8 Response status

200 - Object updated successfully

400 - Bad request; invalid attribute value

401 - Authentication failed

403 - Permission denied; no permission to update the object or setting read-only

attributes is not allowed

404 - No object found

409 - Conflict

500 - Other unexpected server error

4.126.5.9 Response body

XML or JSON representation of the shared parent resource:

• The type link relation points to the type definition of the shared parent resource,
through which you can retrieve a “xCP Business Object Single Type”
on page 157.

4.126.6 Creates a lightweight object that shares a specific

shared content
Creates a lightweight object that shares a specific shared content.

4.126.6.1 HTTP method

POST

4.126.6.2 Query parameters

None.

4.126.6.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

594 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.126. xCP Shared Parent single instance

4.126.6.4 Request body

This operation requires a multipart request. The file content is included in the
request body.

Example 4-63: File Upload Request

http://127.0.0.1:8000/xCP-App/files
Content-Type: multipart/form-data; boundary=314159265358979
--314159265358979
Content-Disposition: form-data; name=metadata
Content-Type: application/vnd.emc.documentum+json
{"properties": {"object_name": "xcp-rest"}}
--314159265358979
Content-Disposition: form-data; name=binary
Content-Type: text/plain
This is the content
--314159265358979--

Example 4-64: JSON Sample

{"type":"utapp21_orderdocument","properties":{"object_name":"lwtest.txt"},
"source":"/files/3d4306ca-996a-47c5-a33f-df4fdc0f3fa9"}

4.126.6.5 Response headers

• Location

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.126.6.6 Supported response media types

multipart/form-data

4.126.6.7 Response status

201 - Content uploaded successfully

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

EDCPKL230200-PGR-EN-01 Development Guide 595

Chapter 4 Resources

4.126.6.8 Response body

This operation returns the Location header which indicates the URI of the file
uploaded. For example:
/files/680884ca-c104-4513-afde-aedc686ff3c3

When a file is being uploaded:

• The file is renamed with the UUID (in the preceding example, 680884ca-
c104-4513-afde-aedc686ff3c3) to avoid collisions with other users that
upload files with the same name.
• A property file is created with the UUID as the file name (in the preceding
example, 680884ca-c104-4513-afde-aedc686ff3c3.properties). This
property file records the original file name and the user who uploads the content
file.

Note: The newly-uploaded file is only visible to the use who uploads it.

In addition to the Location header, this operation also returns a feed response, which
is designed for clients that are unable to read the headers. These clients can obtain
the location of the newly-uploaded file from the id property in entries.
{
"id": "files",
"title": "",
"updated": "2013-10-15T14:20:00.168-07:00",
"author": "OpenText Documentum",
"links": [{
"rel": "self",
"href": "files"
}],
"entries": [{
"id": "files/680884ca-c104-4513-afde-aedc686ff3c3",
"title": "dfc.properties",
"updated": "2013-10-15T14:20:00.168-07:00",
"summary": "dfc.properties",
"content": {
"src": "files/680884ca-c104-4513-afde-aedc686ff3c3",
"content-type": "application/vnd.emc.xcp+json"
},
"links": [{
"rel": "edit",
"href": "files/680884ca-c104-4513-afde-aedc686ff3c3"
}]
}]
}

596 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.127. xCP sShared parent collection

4.127 xCP sShared parent collection

This resource models the collection of shared parent resources.

4.127.1 URI template

/business-objects/sharedparent-business-object-type-name/contents/
sharedparent-content-object-type-name

sharedparent-business-object-type-name Name of the shared parent of business object

type.
sharedparent-content-object-type-name Name of the shared parent of content object
type.

4.127.2 Link relation

Refer to the Link relation of “xCP Lightweight Business Object collection”
on page 555 and “xCP Lightweight Content collection” on page 577 collectively.

4.127.3 Operations
A shared parent resource supports the following HTTP methods.

Refer to the operations of “xCP Lightweight Business Object collection” on page 555
and “xCP Lightweight Content collection” on page 577 collectively.

4.127.3.1 Get a shared parent collection

Retrieve a collection of shared parent object instances.

4.127.3.1.1 HTTP method

GET

4.127.3.1.2 Query parameters

This operation supports the following common query parameters:

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

EDCPKL230200-PGR-EN-01 Development Guide 597

Chapter 4 Resources

• permissions
• include-lwso—The default value is false. When the value is set as False, it returns
only the instances of shared parent resource. Otherwise, when the value is set as
True, it returns the instances of shared parent resource and instances of
materialized LWSO resource of the shared parent type.

“Common definition - query parameters” on page 69 provides more information

about common query parameters.

4.127.3.1.3 Request headers

• Accept
• Authorization

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.127.3.1.4 Request body

None.

4.127.3.1.5 Response headers

Content-Type

“Common definition - HTTP headers” on page 67 provides more information about

HTTP headers.

4.127.3.1.6 Supported response media types

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

4.127.3.1.7 Response status

200 - Information retrieved successfully

204 - No Content

400 - Invalid syntax or missing a required value

401 - Invalid or missing authentication credentials

403 - Permission denied

500 - Other unexpected server error

598 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.128. Viewer provider profile

4.127.3.1.8 Response body

XML or JSON representation of a collection of shared parent instances.

• Each instance may contain all or a set of properties of the shared parent instance,
depending on the setting of the query parameter view.
• The returned collection contains only those entries that you have access to.
• Pagination is supported.

4.128 Viewer provider profile

A viewer provider profile is an XML file that describes all aspects of a viewer
provider. The profiles are static and do not change at runtime. They are all loaded
and cached on the first request for a viewer provider profile. The following table
lists the profile locations for all viewer providers.

Viewer provider Viewer provider profile File location

Acrobat reader viewer AcrobatReader.xml <REST_services_deployment>
provider \WEB-INF\lib\xcp-ivf-
provider-acrobatreader-
<version_number>.jar\com
\emc\xcp\config\app\ivf
\providers\
Browser viewer provider Browser.xml <REST_services_deployment>
\WEB-INF\lib\xcp-ivf-
provider-browser-
<version_number>.jar\com
\emc\xcp\config\app\ivf
\providers\
Content viewer provider ContentViewer.xml <REST_services_deployment>
\WEB-INF\lib\xcp-ivf-
provider-contentviewer-
<version_number>.jar\com
\emc\xcp\config\app\ivf
\providers\
Video viewer provider VideoViewer.xml <REST_services_deployment>
\WEB-INF\lib\xcp-ivf-
provider-videoviewer-
<version_number>.jar\com
\emc\xcp\config\app\ivf
\providers\

A viewer provider profile mainly includes the following elements:

• viewerCapabilities

– supportLocalFile: indicates whether or not the viewer provider is able to

display a file loaded from local hard disks

EDCPKL230200-PGR-EN-01 Development Guide 599

Chapter 4 Resources

– supportPageServing: indicates whether or not the viewer provider supports

Documentum Imaging Services page serving. Page serving divides the
content into chunks and then send them back to the viewer one page at a time
for pagable Document content.
– supportDistrbutedContentDelivery: indicates whether or not the viewer
provider supports ACS\BOCS for content delivery
– supportRelativeUrl: indicates whether or not the viewer provider supports
ACS\BOCS for content delivery
– supportUrlFallback: indicates whether or not the viewer provider supports
standard non-cached content delivery URLs when ACS\BOCS are not
available
– supportIRMContainer: indicates whether or not the viewer provider
supports IRM
– supportAutomation: indicates whether or not the viewer provider supports
control automation
• featureEnablement

– annotation: indicates whether or not the viewer provider supports

annotations
– annotationCreation: indicates whether or not the viewer provider supports
annotation creation
– thumbnail: indicates whether or not the viewer provider supports
thumbnails
– printing: indicates whether or not the viewer provider supports printing

– export: indicates whether or not the viewer provider supports document

export
• supportedFormats: lists the supported content formats in the viewer provider
• environmentSettings

– pageServingThreshold: specifies the page serving threshold

– annotationFormat: specifies the annotation format for viewer providers
supporting annotation
– automationLibrary: specifies the automation library for viewer providers
supporting automation
– parameterHandler: specifies the class handling the parameters for the viewer
provider
– optionalDataHandler: specifies the class handling the data used by the
viewer provider
– requestHandlers: specifies the class handling the requests for the viewer
provider

600 OpenText™ Documentum™ REST Services EDCPKL230200-PGR-EN-01

 4.128. Viewer provider profile

• viewerControl

– attributes: specifies the attributes used when the system renders the viewer
control
– parameters: specifies the parameters used when the system renders the
viewer control

EDCPKL230200-PGR-EN-01 Development Guide 601