Anda di halaman 1dari 562

OpenText ™ Documentum ®

xCP REST Services


Version 16.4

Development Guide
Legal Notice

This documentation has been created for software version 16.4.


It is also valid for subsequent software versions as long as no new document version is shipped with
the product or is published at https://knowledge.opentext.com.
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 © 2018 Open Text. All Rights Reserved.
Trademarks owned by Open Text.
Adobe and Adobe PDF Library are trademarks or registered trademarks of Adobe Systems Inc. in
the U.S. and other countries.
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

Preface ................................................................................................................................ 41
Chapter 1 Overview ..................................................................................................... 43
Chapter 2 General REST Definitions ............................................................................ 45
Common Definition - HTTP Headers ................................................................ 45
Common Definition - Query Parameters ............................................................ 47
Property View .............................................................................................. 51
Predefined View Expression ...................................................................... 51
Custom View Expression .......................................................................... 51
View Expression Syntax ............................................................................ 51
Server Configuration Parameters ....................................................................... 52
HTTP Status Codes ........................................................................................... 54
Representation ................................................................................................. 55
xCP Common Elements .................................................................................... 56

Chapter 3 Authentication ............................................................................................. 59


Authentication with HTTP Basic........................................................................ 59

Chapter 4 Resources ................................................................................................... 61


xCP Advanced Repository Query Instance ......................................................... 61
URI Template ............................................................................................... 61
Link Relation................................................................................................ 61
Operations ................................................................................................... 61
Perform a Advanced Repository Query ...................................................... 62
HTTP Method ...................................................................................... 62
Query Parameters ................................................................................. 62
Request Headers .................................................................................. 62
Request Body ....................................................................................... 62
Response Headers ................................................................................ 62
Supported Response Media Types ......................................................... 63
Response Status .................................................................................... 63
Response Body ..................................................................................... 63
xCP Advanced Repository Query Single Type .................................................... 64
URI Template ............................................................................................... 64
Link Relation................................................................................................ 65
Operations ................................................................................................... 65
Get an Advanced Repository Query Type................................................... 65
HTTP Method ...................................................................................... 65
Query Parameters ................................................................................. 65
Request Headers .................................................................................. 65
Request Body ....................................................................................... 66
Response Headers ................................................................................ 66
Supported Response Media Types ......................................................... 66
Response Status .................................................................................... 66

3
Table of Contents

Response Body ..................................................................................... 66


xCP Advanced Repository Query Type Collection .............................................. 68
URI Template ............................................................................................... 68
Feed and EDAA Support .............................................................................. 68
Link Relation................................................................................................ 68
Operations ................................................................................................... 69
Get a Advanced Repository Query Type Collection ..................................... 69
HTTP Method ...................................................................................... 69
Query Parameters ................................................................................. 69
Request Headers .................................................................................. 69
Request Body ....................................................................................... 70
Response Headers ................................................................................ 70
Supported Response Media Types ......................................................... 70
Response Status .................................................................................... 70
Response Body ..................................................................................... 70
xCP Alert Query Single Instance ........................................................................ 70
URI Template ............................................................................................... 71
Link Relation................................................................................................ 71
Operations ................................................................................................... 71
Perform an Alert Query ............................................................................ 71
HTTP Method ...................................................................................... 71
Query Parameters ................................................................................. 71
Request Headers .................................................................................. 72
Request Body ....................................................................................... 72
Response Headers ................................................................................ 72
Supported Response Media Types ......................................................... 72
Response Status .................................................................................... 72
Response Body ..................................................................................... 73
xCP Alert Query Single Type ............................................................................. 75
URI Template ............................................................................................... 75
Link Relation................................................................................................ 75
Operations ................................................................................................... 75
Get an Alert Query Type ........................................................................... 75
HTTP Method ...................................................................................... 75
Query Parameters ................................................................................. 76
Request Headers .................................................................................. 76
Request Body ....................................................................................... 76
Response Headers ................................................................................ 76
Supported Response Media Types ......................................................... 76
Response Status .................................................................................... 76
Response Body ..................................................................................... 76
xCP Alert Query Type Collection ....................................................................... 77
URI Template ............................................................................................... 77
Feed and EDAA Support .............................................................................. 77
Link Relation................................................................................................ 77
Operations ................................................................................................... 78
Get an Alert Query Type Collection ........................................................... 78
HTTP Method ...................................................................................... 78
Query Parameters ................................................................................. 78
Request Headers .................................................................................. 78
Request Body ....................................................................................... 79
Response Headers ................................................................................ 79
Supported Response Media Types ......................................................... 79
Response Status .................................................................................... 79
Response Body ..................................................................................... 79
xCP Alert Single Instance .................................................................................. 80
URI Template ............................................................................................... 80

4
Table of Contents

Link Relation................................................................................................ 80
Operations ................................................................................................... 80
Get an Alert ............................................................................................. 80
HTTP Method ...................................................................................... 81
Query Parameters ................................................................................. 81
Request Headers .................................................................................. 81
Request Body ....................................................................................... 81
Response Headers ................................................................................ 81
Supported Response Media Types ......................................................... 81
Response Status .................................................................................... 81
Response Body ..................................................................................... 82
Update Alert Status .................................................................................. 82
HTTP Method ...................................................................................... 82
Server Accepted Request Media Types ................................................... 82
Query Parameters ................................................................................. 82
Request Headers .................................................................................. 82
Request Body ....................................................................................... 83
Response Headers ................................................................................ 83
Supported Response Media Types ......................................................... 83
Response Status .................................................................................... 84
Response Body ..................................................................................... 84
xCP Alert Collection ......................................................................................... 85
URI Template ............................................................................................... 85
Feed and EDAA Support .............................................................................. 85
Link Relation................................................................................................ 85
Operations ................................................................................................... 86
Get an Alert Collection.............................................................................. 86
HTTP Method ...................................................................................... 86
Query Parameters ................................................................................. 86
Request Headers .................................................................................. 86
Request Body ....................................................................................... 87
Response Headers ................................................................................ 87
Supported Response Media Types ......................................................... 87
Response Status .................................................................................... 87
Response Body ..................................................................................... 87
xCP Alert Single Type ....................................................................................... 88
URI Template ............................................................................................... 88
Link Relation................................................................................................ 88
Operations ................................................................................................... 88
Get an Alert Type ..................................................................................... 88
HTTP Method ...................................................................................... 89
Query Parameters ................................................................................. 89
Request Headers .................................................................................. 89
Request Body ....................................................................................... 89
Response Headers ................................................................................ 89
Supported Response Media Types ......................................................... 89
Response Status .................................................................................... 89
Response Body ..................................................................................... 90
xCP Alert Type Collection ................................................................................. 90
URI Template ............................................................................................... 90
Feed and EDAA Support .............................................................................. 90
Link Relation................................................................................................ 91
Operations ................................................................................................... 91
Get an Alert Type Collection ..................................................................... 91
HTTP Method ...................................................................................... 91
Query Parameters ................................................................................. 91
Request Headers .................................................................................. 92
Request Body ....................................................................................... 92

5
Table of Contents

Response Headers ................................................................................ 92


Supported Response Media Types ......................................................... 92
Response Status .................................................................................... 92
Response Body ..................................................................................... 92
xCP Annotation Collection ................................................................................ 93
URI Template ............................................................................................... 93
Feed and EDAA Support .............................................................................. 93
Link Relation................................................................................................ 93
Operations ................................................................................................... 93
Get an Annotation Collection .................................................................... 94
HTTP Method ...................................................................................... 94
Query Parameters ................................................................................. 94
Request Headers .................................................................................. 94
Request Body ....................................................................................... 94
Response Headers ................................................................................ 95
Supported Response Media Types ......................................................... 95
Response Status .................................................................................... 95
Response Body ..................................................................................... 95
Get an Annotation Collection for a User ..................................................... 96
HTTP Method ...................................................................................... 96
Query Parameters ................................................................................. 96
Request Headers .................................................................................. 96
Request Body ....................................................................................... 96
Response Headers ................................................................................ 97
Supported Response Media Types ......................................................... 97
Response Status .................................................................................... 97
Response Body ..................................................................................... 97
Create Annotations ................................................................................... 98
HTTP Method ...................................................................................... 98
Server Accepted Request Media Types ................................................... 98
Query Parameters ................................................................................. 98
Request Headers .................................................................................. 98
Request Body ....................................................................................... 98
Response Headers ................................................................................ 99
Supported Response Media Types ......................................................... 99
Response Status .................................................................................... 99
Response Body ..................................................................................... 99
xCP Application Single Instance ...................................................................... 100
URI Template ............................................................................................. 100
Link Relation.............................................................................................. 100
Operations ................................................................................................. 100
Get an Application ................................................................................. 100
HTTP Method .................................................................................... 101
Query Parameters ............................................................................... 101
Request Headers ................................................................................ 101
Request Body ..................................................................................... 101
Response Headers .............................................................................. 101
Supported Response Media Types ....................................................... 101
Response Status .................................................................................. 101
Response Body ................................................................................... 102
xCP Application Type ..................................................................................... 104
URI Template ............................................................................................. 104
Link Relation.............................................................................................. 104
Operations ................................................................................................. 104
Get an Application Type ......................................................................... 104
HTTP Method .................................................................................... 104
Query Parameters ............................................................................... 105
Request Headers ................................................................................ 105

6
Table of Contents

Request Body ..................................................................................... 105


Response Headers .............................................................................. 105
Supported Response Media Types ....................................................... 105
Response Status .................................................................................. 105
Response Body ................................................................................... 105
xCP Application Type Collection ..................................................................... 106
URI Template ............................................................................................. 106
Feed and EDAA Support ............................................................................ 106
Link Relation.............................................................................................. 106
Operations ................................................................................................. 107
Get an Application Type Collection.......................................................... 107
HTTP Method .................................................................................... 107
Query Parameters ............................................................................... 107
Request Headers ................................................................................ 107
Request Body ..................................................................................... 108
Response Headers .............................................................................. 108
Supported Response Media Types ....................................................... 108
Response Status .................................................................................. 108
Response Body ................................................................................... 108
xCP Application Configuration Single Instance ................................................ 110
URI Template ............................................................................................. 110
Link Relation.............................................................................................. 110
Operations ................................................................................................. 110
Get an Application Configuration ............................................................ 111
HTTP Method .................................................................................... 111
Query Parameters ............................................................................... 111
Request Headers ................................................................................ 111
Request Body ..................................................................................... 111
Response Headers .............................................................................. 111
Supported Response Media Types ....................................................... 111
Response Status .................................................................................. 112
Response Body ................................................................................... 112
Update an Application Configuration ...................................................... 112
HTTP Method .................................................................................... 112
Server Accepted Request Media Types ................................................. 112
Query Parameters ............................................................................... 112
Request Headers ................................................................................ 113
Request Body ..................................................................................... 113
Response Headers .............................................................................. 113
Supported Response Media Types ....................................................... 113
Response Status .................................................................................. 113
Response Body ................................................................................... 114
xCP Application Configuration Collection........................................................ 115
URI Template ............................................................................................. 115
Feed and EDAA Support ............................................................................ 115
Link Relation.............................................................................................. 116
Operations ................................................................................................. 116
Get an Application Configuration Collection ............................................ 116
HTTP Method .................................................................................... 116
Query Parameters ............................................................................... 116
Request Headers ................................................................................ 117
Request Body ..................................................................................... 117
Response Headers .............................................................................. 117
Supported Response Media Types ....................................................... 117
Response Status .................................................................................. 117
Response Body ................................................................................... 118
xCP Application Configuration Single Type ..................................................... 119

7
Table of Contents

URI Template ............................................................................................. 119


Link Relation.............................................................................................. 119
Operations ................................................................................................. 119
Get an Application Configuration Type .................................................... 119
HTTP Method .................................................................................... 119
Query Parameters ............................................................................... 120
Request Headers ................................................................................ 120
Request Body ..................................................................................... 120
Response Headers .............................................................................. 120
Supported Response Media Types ....................................................... 120
Response Status .................................................................................. 120
Response Body ................................................................................... 121
xCP Application Configuration Type Collection ............................................... 122
URI Template ............................................................................................. 122
Feed and EDAA Support ............................................................................ 122
Link Relation.............................................................................................. 122
Operations ................................................................................................. 123
Get an Application Configuration Type Collection .................................... 123
HTTP Method .................................................................................... 123
Query Parameters ............................................................................... 123
Request Headers ................................................................................ 124
Request Body ..................................................................................... 124
Response Headers .............................................................................. 124
Supported Response Media Types ....................................................... 124
Response Status .................................................................................. 124
Response Body ................................................................................... 124
xCP Business Object Single Instance................................................................. 125
URI Template ............................................................................................. 125
Link Relation.............................................................................................. 125
Operations ................................................................................................. 125
Get a Business Object .............................................................................. 126
HTTP Method .................................................................................... 126
Query Parameters ............................................................................... 126
Request Headers ................................................................................ 126
Request Body ..................................................................................... 126
Response Headers .............................................................................. 127
Supported Response Media Types ....................................................... 127
Response Status .................................................................................. 127
Response Body ................................................................................... 127
Update a Business Object ........................................................................ 127
HTTP Method .................................................................................... 127
Server Accepted Request Media Types ................................................. 128
Query Parameters ............................................................................... 128
Request Headers ................................................................................ 128
Request Body ..................................................................................... 128
Response Headers .............................................................................. 128
Supported Response Media Types ....................................................... 129
Response Status .................................................................................. 129
Response Body ................................................................................... 129
Create a Business Object.......................................................................... 129
HTTP Method .................................................................................... 129
Server Accepted Request Media Types ................................................. 129
Query Parameters ............................................................................... 130
Request Headers ................................................................................ 130
Request Body ..................................................................................... 130
Response Headers .............................................................................. 130
Supported Response Media Types ....................................................... 130
Response Status .................................................................................. 131

8
Table of Contents

Response Body ................................................................................... 131


Delete a Business Object .......................................................................... 131
HTTP Method .................................................................................... 131
Query Parameters ............................................................................... 131
Request Headers ................................................................................ 131
Request Body ..................................................................................... 131
Response Headers .............................................................................. 132
Response Status .................................................................................. 132
Response Body ................................................................................... 132
xCP Business Object Collection ........................................................................ 133
URI Template ............................................................................................. 133
Feed and EDAA Support ............................................................................ 133
Link Relation.............................................................................................. 133
Operations ................................................................................................. 134
Get a Business Object Collection .............................................................. 134
HTTP Method .................................................................................... 134
Query Parameters ............................................................................... 134
Request Headers ................................................................................ 135
Request Body ..................................................................................... 135
Response Headers .............................................................................. 135
Supported Response Media Types ....................................................... 135
Response Status .................................................................................. 135
Response Body ................................................................................... 135
xCP Business Object Single Type...................................................................... 136
URI Template ............................................................................................. 136
Link Relation.............................................................................................. 136
Operations ................................................................................................. 136
Get a Business Object Type ...................................................................... 136
HTTP Method .................................................................................... 137
Query Parameters ............................................................................... 137
Request Headers ................................................................................ 137
Request Body ..................................................................................... 137
Response Headers .............................................................................. 137
Supported Response Media Types ....................................................... 137
Response Status .................................................................................. 137
Response Body ................................................................................... 138
xCP Business Object Type Collection................................................................ 140
URI Template ............................................................................................. 140
Feed and EDAA Support ............................................................................ 140
Link Relation.............................................................................................. 140
Operations ................................................................................................. 141
Get a Business Object Type Collection ...................................................... 141
HTTP Method .................................................................................... 141
Query Parameters ............................................................................... 141
Request Headers ................................................................................ 141
Request Body ..................................................................................... 142
Response Headers .............................................................................. 142
Supported Response Media Types ....................................................... 142
Response Status .................................................................................. 142
Response Body ................................................................................... 142
xCP Cabinet Single Instance ............................................................................ 143
URI Template ............................................................................................. 143
Link Relation.............................................................................................. 143
Operations ................................................................................................. 144
Get a Cabinet ......................................................................................... 144
HTTP Method .................................................................................... 144
Query Parameters ............................................................................... 144

9
Table of Contents

Request Headers ................................................................................ 145


Request Body ..................................................................................... 145
Response Headers .............................................................................. 145
Supported Response Media Types ....................................................... 145
Response Status .................................................................................. 145
Response Body ................................................................................... 145
Get Objects in a Cabinet .......................................................................... 146
HTTP Method .................................................................................... 146
Query Parameters ............................................................................... 146
Request Headers ................................................................................ 146
Request Body ..................................................................................... 146
Response Headers .............................................................................. 146
Supported Response Media Types ....................................................... 147
Response Status .................................................................................. 147
Response Body ................................................................................... 147
Create a Cabinet ..................................................................................... 147
HTTP Method .................................................................................... 147
Server Accepted Request Media Types ................................................. 147
Query Parameters ............................................................................... 147
Request Headers ................................................................................ 148
Request Body ..................................................................................... 148
Response Headers .............................................................................. 148
Supported Response Media Types ....................................................... 149
Response Status .................................................................................. 149
Response Body ................................................................................... 149
Update a Cabinet .................................................................................... 149
HTTP Method .................................................................................... 149
Server Accepted Request Media Types ................................................. 149
Query Parameters ............................................................................... 149
Request Headers ................................................................................ 150
Request Body ..................................................................................... 150
Response Headers .............................................................................. 150
Supported Response Media Types ....................................................... 150
Response Status .................................................................................. 150
Response Body ................................................................................... 151
Delete a Cabinet ..................................................................................... 151
HTTP Method .................................................................................... 151
Query Parameters ............................................................................... 151
Request Headers ................................................................................ 151
Request Body ..................................................................................... 151
Response Headers .............................................................................. 151
Response Status .................................................................................. 152
Response Body ................................................................................... 152
xCP Cabinet Collection ................................................................................... 153
URI Template ............................................................................................. 153
Feed and EDAA Support ............................................................................ 153
Link Relation.............................................................................................. 153
Operations ................................................................................................. 154
Get a Cabinet Collection .......................................................................... 154
HTTP Method .................................................................................... 154
Query Parameters ............................................................................... 154
Request Headers ................................................................................ 155
Request Body ..................................................................................... 155
Response Headers .............................................................................. 155
Supported Response Media Types ....................................................... 155
Response Status .................................................................................. 155
Response Body ................................................................................... 155
xCP Cabinet Single Type ................................................................................. 156

10
Table of Contents

URI Template ............................................................................................. 156


Link Relation.............................................................................................. 156
Operations ................................................................................................. 156
Get a Cabinet Type ................................................................................. 156
HTTP Method .................................................................................... 156
Query Parameters ............................................................................... 157
Request Headers ................................................................................ 157
Request Body ..................................................................................... 157
Response Headers .............................................................................. 157
Supported Response Media Types ....................................................... 157
Response Status .................................................................................. 157
Response Body ................................................................................... 158
xCP Cabinet Type Collection ........................................................................... 159
URI Template ............................................................................................. 159
Feed and EDAA Support ............................................................................ 159
Link Relation.............................................................................................. 159
Operations ................................................................................................. 160
Get a Cabinet Type Collection.................................................................. 160
HTTP Method .................................................................................... 160
Query Parameters ............................................................................... 160
Request Headers ................................................................................ 160
Request Body ..................................................................................... 161
Response Headers .............................................................................. 161
Supported Response Media Types ....................................................... 161
Response Status .................................................................................. 161
Response Body ................................................................................... 161
xCP Comment Single Instance ......................................................................... 162
URI Template ............................................................................................. 162
Link Relation.............................................................................................. 162
Operations ................................................................................................. 163
Get a Comment ...................................................................................... 163
HTTP Method .................................................................................... 163
Query Parameters ............................................................................... 163
Request Headers ................................................................................ 164
Request Body ..................................................................................... 164
Response Headers .............................................................................. 164
Supported Response Media Types ....................................................... 164
Response Status .................................................................................. 164
Response Body ................................................................................... 165
Update a Comment ................................................................................ 165
HTTP Method .................................................................................... 165
Server Accepted Request Media Types ................................................. 165
Query Parameters ............................................................................... 165
Request Headers ................................................................................ 166
Request Body ..................................................................................... 166
Response Headers .............................................................................. 166
Supported Response Media Types ....................................................... 166
Response Status .................................................................................. 166
Response Body ................................................................................... 167
Create a Comment .................................................................................. 167
HTTP Method .................................................................................... 167
Server Accepted Request Media Types ................................................. 167
Query Parameters ............................................................................... 167
Request Headers ................................................................................ 168
Request Body ..................................................................................... 168
Response Headers .............................................................................. 168
Supported Response Media Types ....................................................... 168
Response Status .................................................................................. 168

11
Table of Contents

Response Body ................................................................................... 169


Delete a Comment .................................................................................. 169
HTTP Method .................................................................................... 169
Query Parameters ............................................................................... 169
Request Headers ................................................................................ 169
Request Body ..................................................................................... 170
Response Headers .............................................................................. 170
Response Status .................................................................................. 170
Response Body ................................................................................... 170
xCP Comment Collection ................................................................................ 171
URI Template ............................................................................................. 171
Feed and EDAA Support ............................................................................ 171
Link Relation.............................................................................................. 172
Operations ................................................................................................. 172
Get a Comment Collection ...................................................................... 173
HTTP Method .................................................................................... 173
Query Parameters ............................................................................... 173
Request Headers ................................................................................ 173
Request Body ..................................................................................... 173
Response Headers .............................................................................. 173
Supported Response Media Types ....................................................... 174
Response Status .................................................................................. 174
Response Body ................................................................................... 174
xCP Comment Single Type .............................................................................. 175
URI Template ............................................................................................. 175
Link Relation.............................................................................................. 175
Operations ................................................................................................. 175
Get a Comment Type .............................................................................. 175
HTTP Method .................................................................................... 176
Query Parameters ............................................................................... 176
Request Headers ................................................................................ 176
Request Body ..................................................................................... 176
Response Headers .............................................................................. 176
Supported Response Media Types ....................................................... 176
Response Status .................................................................................. 176
Response Body ................................................................................... 177
xCP Comment Type Collection ........................................................................ 178
URI Template ............................................................................................. 178
Feed and EDAA Support ............................................................................ 178
Link Relation.............................................................................................. 178
Operations ................................................................................................. 179
Get a Comment Collection ...................................................................... 179
HTTP Method .................................................................................... 179
Query Parameters ............................................................................... 179
Request Headers ................................................................................ 179
Request Body ..................................................................................... 180
Response Headers .............................................................................. 180
Supported Response Media Types ....................................................... 180
Response Status .................................................................................. 180
Response Body ................................................................................... 180
xCP Content Single Instance ............................................................................ 181
URI Template ............................................................................................. 181
Link Relation.............................................................................................. 181
Operations ................................................................................................. 182
Get a Content ......................................................................................... 182
HTTP Method .................................................................................... 182
Query Parameters ............................................................................... 182

12
Table of Contents

Request Headers ................................................................................ 183


Request Body ..................................................................................... 183
Response Headers .............................................................................. 183
Supported Response Media Types ....................................................... 184
Response Status .................................................................................. 184
Response Body ................................................................................... 184
Update a Content ................................................................................... 184
HTTP Method .................................................................................... 184
Server Accepted Request Media Types ................................................. 184
Query Parameters ............................................................................... 185
Request Headers ................................................................................ 185
Request Body ..................................................................................... 185
Response Headers .............................................................................. 185
Supported Response Media Types ....................................................... 185
Response Status .................................................................................. 186
Response Body ................................................................................... 186
Delete a Content ..................................................................................... 186
HTTP Method .................................................................................... 186
Query Parameters ............................................................................... 186
Request Headers ................................................................................ 186
Request Body ..................................................................................... 186
Response Headers .............................................................................. 187
Response Status .................................................................................. 187
Response Body ................................................................................... 187
Check out a Content ............................................................................... 187
HTTP Method .................................................................................... 187
Server Accepted Request Media Types ................................................. 187
Query Parameters ............................................................................... 187
Request Headers ................................................................................ 188
Request Body ..................................................................................... 188
Response Headers .............................................................................. 188
Supported Response Media Types ....................................................... 188
Response Status .................................................................................. 188
Response Body ................................................................................... 189
Check in a Content ................................................................................. 189
HTTP Method .................................................................................... 190
Server Accepted Request Media Types ................................................. 190
Query Parameters ............................................................................... 190
Request Headers ................................................................................ 191
Request Body ..................................................................................... 191
Response Headers .............................................................................. 191
Supported Response Media Types ....................................................... 191
Response Status .................................................................................. 191
Response Body ................................................................................... 192
xCP Content Collection ................................................................................... 193
URI Template ............................................................................................. 193
Feed and EDAA Support ............................................................................ 193
Link Relation.............................................................................................. 193
Operations ................................................................................................. 194
Get a Content Collection ......................................................................... 194
HTTP Method .................................................................................... 194
Query Parameters ............................................................................... 194
Request Headers ................................................................................ 195
Request Body ..................................................................................... 195
Response Headers .............................................................................. 195
Supported Response Media Types ....................................................... 195
Response Status .................................................................................. 195
Response Body ................................................................................... 195

13
Table of Contents

Create a Content ..................................................................................... 196


HTTP Method .................................................................................... 197
Server Accepted Request Media Types ................................................. 197
Query Parameters ............................................................................... 197
Request Headers ................................................................................ 197
Request Body ..................................................................................... 197
Response Headers .............................................................................. 198
Supported Response Media Types ....................................................... 198
Response Status .................................................................................. 198
Response Body ................................................................................... 198
xCP Content Single Type ................................................................................. 199
URI Template ............................................................................................. 199
Link Relation.............................................................................................. 199
Operations ................................................................................................. 199
Get a Content Type ................................................................................. 199
HTTP Method .................................................................................... 199
Query Parameters ............................................................................... 200
Request Headers ................................................................................ 200
Request Body ..................................................................................... 200
Response Headers .............................................................................. 200
Supported Response Media Types ....................................................... 200
Response Status .................................................................................. 200
Response Body ................................................................................... 201
xCP Content Type Collection ........................................................................... 202
URI Template ............................................................................................. 202
Feed and EDAA Support ............................................................................ 202
Link Relation.............................................................................................. 202
Operations ................................................................................................. 203
Get a Content Type Collection ................................................................. 203
HTTP Method .................................................................................... 203
Query Parameters ............................................................................... 203
Request Headers ................................................................................ 203
Request Body ..................................................................................... 204
Response Headers .............................................................................. 204
Supported Response Media Types ....................................................... 204
Response Status .................................................................................. 204
Response Body ................................................................................... 204
xCP Current User Instance .............................................................................. 205
URI Template ............................................................................................. 205
Link Relation.............................................................................................. 205
Operations ................................................................................................. 205
Get the Current User............................................................................... 206
HTTP Method .................................................................................... 206
Query Parameters ............................................................................... 206
Request Headers ................................................................................ 206
Request Body ..................................................................................... 206
Response Headers .............................................................................. 206
Supported Response Media Types ....................................................... 206
Response Status .................................................................................. 207
Response Body ................................................................................... 207
xCP File Upload Resource ............................................................................... 208
URI Template ............................................................................................. 208
Link Relation.............................................................................................. 208
Operations ................................................................................................. 208
Upload a File .......................................................................................... 208
HTTP Method .................................................................................... 208
Query Parameters ............................................................................... 208

14
Table of Contents

Request Headers ................................................................................ 208


Request Body ..................................................................................... 209
Response Headers .............................................................................. 209
Supported Response Media Types ....................................................... 209
Response Status .................................................................................. 209
Response Body ................................................................................... 210
Location of the Uploaded File .................................................................. 210
Lifecycle of the Uploaded File ................................................................. 211
xCP Folder Single Instance .............................................................................. 212
URI Template ............................................................................................. 212
Link Relation.............................................................................................. 212
Operations ................................................................................................. 213
Get a Folder ........................................................................................... 213
HTTP Method .................................................................................... 213
Query Parameters ............................................................................... 213
Request Headers ................................................................................ 213
Request Body ..................................................................................... 214
Response Headers .............................................................................. 214
Supported Response Media Types ....................................................... 214
Response Status .................................................................................. 214
Response Body ................................................................................... 214
Update a Folder...................................................................................... 214
HTTP Method .................................................................................... 215
Server Accepted Request Media Types ................................................. 215
Query Parameters ............................................................................... 215
Request Headers ................................................................................ 215
Request Body ..................................................................................... 215
Response Headers .............................................................................. 215
Supported Response Media Types ....................................................... 216
Response Status .................................................................................. 216
Response Body ................................................................................... 216
Create a Folder ....................................................................................... 216
HTTP Method .................................................................................... 216
Server Accepted Request Media Types ................................................. 216
Query Parameters ............................................................................... 217
Request Headers ................................................................................ 217
Request Body ..................................................................................... 217
Response Headers .............................................................................. 218
Supported Response Media Types ....................................................... 218
Response Status .................................................................................. 218
Response Body ................................................................................... 218
Copy a Document to a Folder .................................................................. 218
HTTP Method .................................................................................... 218
Server Accepted Request Media Types ................................................. 219
Query Parameters ............................................................................... 219
Request Headers ................................................................................ 219
Request Body ..................................................................................... 219
Response Headers .............................................................................. 219
Supported Response Media Types ....................................................... 220
Response Status .................................................................................. 220
Response Body ................................................................................... 220
Move a Document to a Folder .................................................................. 221
HTTP Method .................................................................................... 221
Server Accepted Request Media Types ................................................. 221
Query Parameters ............................................................................... 221
Request Headers ................................................................................ 221
Request Body ..................................................................................... 222
Response Headers .............................................................................. 222

15
Table of Contents

Supported Response Media Types ....................................................... 222


Response Status .................................................................................. 222
Response Body ................................................................................... 223
Delete a Folder ....................................................................................... 223
HTTP Method .................................................................................... 223
Query Parameters ............................................................................... 223
Request Headers ................................................................................ 223
Request Body ..................................................................................... 223
Response Headers .............................................................................. 223
Response Status .................................................................................. 223
Response Body ................................................................................... 224
xCP Folder Collection ..................................................................................... 225
URI Template ............................................................................................. 225
Feed and EDAA Support ............................................................................ 225
Link Relation.............................................................................................. 225
Operations ................................................................................................. 226
Get a Folder Collection ........................................................................... 226
HTTP Method .................................................................................... 226
Query Parameters ............................................................................... 226
Request Headers ................................................................................ 227
Request Body ..................................................................................... 227
Response Headers .............................................................................. 227
Supported Response Media Types ....................................................... 227
Response Status .................................................................................. 227
Response Body ................................................................................... 227
xCP Folder Single Type ................................................................................... 228
URI Template ............................................................................................. 228
Link Relation.............................................................................................. 228
Operations ................................................................................................. 228
Get a Folder Type ................................................................................... 228
HTTP Method .................................................................................... 229
Query Parameters ............................................................................... 229
Request Headers ................................................................................ 229
Request Body ..................................................................................... 229
Response Headers .............................................................................. 229
Supported Response Media Types ....................................................... 229
Response Status .................................................................................. 229
Response Body ................................................................................... 230
xCP Folder Type Collection ............................................................................. 231
URI Template ............................................................................................. 231
Feed and EDAA Support ............................................................................ 231
Link Relation.............................................................................................. 231
Operations ................................................................................................. 232
Get a Folder Type Collection ................................................................... 232
HTTP Method .................................................................................... 232
Query Parameters ............................................................................... 232
Request Headers ................................................................................ 232
Request Body ..................................................................................... 233
Response Headers .............................................................................. 233
Supported Response Media Types ....................................................... 233
Response Status .................................................................................. 233
Response Body ................................................................................... 233
xCP Format Single Instance ............................................................................. 234
URI Template ............................................................................................. 234
Link Relation.............................................................................................. 234
Operations ................................................................................................. 234
Get a Format .......................................................................................... 234

16
Table of Contents

HTTP Method .................................................................................... 235


Query Parameters ............................................................................... 235
Request Headers ................................................................................ 235
Request Body ..................................................................................... 235
Response Headers .............................................................................. 235
Supported Response Media Types ....................................................... 235
Response Status .................................................................................. 235
Response Body ................................................................................... 236
xCP Format Collection .................................................................................... 237
URI Template ............................................................................................. 237
Feed and EDAA Support ............................................................................ 237
Link Relation.............................................................................................. 238
Operations ................................................................................................. 238
Get a Format Collection .......................................................................... 238
HTTP Method .................................................................................... 238
Query Parameters ............................................................................... 238
Request Headers ................................................................................ 239
Request Body ..................................................................................... 239
Response Headers .............................................................................. 239
Supported Response Media Types ....................................................... 239
Response Status .................................................................................. 239
Response Body ................................................................................... 239
xCP Format Single Type .................................................................................. 240
URI Template ............................................................................................. 240
Link Relation.............................................................................................. 240
Operations ................................................................................................. 240
Get a Format Type .................................................................................. 240
HTTP Method .................................................................................... 240
Query Parameters ............................................................................... 241
Request Headers ................................................................................ 241
Request Body ..................................................................................... 241
Response Headers .............................................................................. 241
Supported Response Media Types ....................................................... 241
Response Status .................................................................................. 241
Response Body ................................................................................... 242
xCP Format Type Collection ............................................................................ 243
URI Template ............................................................................................. 243
Feed and EDAA Support ............................................................................ 243
Link Relation.............................................................................................. 243
Operations ................................................................................................. 244
Get a Format Type Collection .................................................................. 244
HTTP Method .................................................................................... 244
Query Parameters ............................................................................... 244
Request Headers ................................................................................ 244
Request Body ..................................................................................... 245
Response Headers .............................................................................. 245
Supported Response Media Types ....................................................... 245
Response Status .................................................................................. 245
Response Body ................................................................................... 245
xCP Fragment Single Instance ......................................................................... 246
URI Template ............................................................................................. 246
Link Relation.............................................................................................. 246
Operations ................................................................................................. 246
Get a Fragment ....................................................................................... 247
HTTP Method .................................................................................... 247
Query Parameters ............................................................................... 247
Request Headers ................................................................................ 247

17
Table of Contents

Request Body ..................................................................................... 247


Response Headers .............................................................................. 248
Supported Response Media Types ....................................................... 248
Response Status .................................................................................. 248
Response Body ................................................................................... 248
Attach an Aspect to an Object .................................................................. 249
HTTP Method .................................................................................... 249
Server Accepted Request Media Types ................................................. 249
Query Parameters ............................................................................... 249
Request Headers ................................................................................ 249
Request Body ..................................................................................... 249
Response Headers .............................................................................. 250
Supported Response Media Types ....................................................... 250
Response Status .................................................................................. 250
Response Body ................................................................................... 251
xCP Fragment Single Type .............................................................................. 252
URI Template ............................................................................................. 252
Link Relation.............................................................................................. 252
Operations ................................................................................................. 252
Get a Fragment Type............................................................................... 252
HTTP Method .................................................................................... 252
Query Parameters ............................................................................... 253
Request Headers ................................................................................ 253
Request Body ..................................................................................... 253
Response Headers .............................................................................. 253
Supported Response Media Types ....................................................... 253
Response Status .................................................................................. 253
Response Body ................................................................................... 253
xCP Fragment Type Collection ........................................................................ 255
URI Template ............................................................................................. 255
Feed and EDAA Support ............................................................................ 255
Link Relation.............................................................................................. 255
Operations ................................................................................................. 256
Get a Fragment Type Collection ............................................................... 256
HTTP Method .................................................................................... 256
Query Parameters ............................................................................... 256
Request Headers ................................................................................ 256
Request Body ..................................................................................... 257
Response Headers .............................................................................. 257
Supported Response Media Types ....................................................... 257
Response Status .................................................................................. 257
Response Body ................................................................................... 257
xCP Full-Text Query Single Instance ................................................................ 258
URI Template ............................................................................................. 258
Link Relation.............................................................................................. 258
Operations ................................................................................................. 258
Perform a Full-Text Query ....................................................................... 258
HTTP Method .................................................................................... 258
Query Parameters ............................................................................... 259
Request Headers ................................................................................ 259
Request Body ..................................................................................... 259
Response Headers .............................................................................. 259
Supported Response Media Types ....................................................... 260
Response Status .................................................................................. 260
Response Body ................................................................................... 260
xCP Full-Text Query Single Type ..................................................................... 271
URI Template ............................................................................................. 271

18
Table of Contents

Link Relation.............................................................................................. 271


Operations ................................................................................................. 271
Get a Full-Text Query Type ..................................................................... 271
HTTP Method .................................................................................... 272
Query Parameters ............................................................................... 272
Request Headers ................................................................................ 272
Request Body ..................................................................................... 272
Response Headers .............................................................................. 272
Supported Response Media Types ....................................................... 272
Response Status .................................................................................. 272
Response Body ................................................................................... 273
xCP Full-Text Query Type Collection ............................................................... 274
URI Template ............................................................................................. 274
Feed and EDAA Support ............................................................................ 274
Link Relation.............................................................................................. 274
Operations ................................................................................................. 275
Get a Full-Text Query Type Collection ...................................................... 275
HTTP Method .................................................................................... 275
Query Parameters ............................................................................... 275
Request Headers ................................................................................ 276
Request Body ..................................................................................... 276
Response Headers .............................................................................. 276
Supported Response Media Types ....................................................... 276
Response Status .................................................................................. 276
Response Body ................................................................................... 276
xCP Historical Query Single Instance ............................................................... 277
URI Template ............................................................................................. 277
Link Relation.............................................................................................. 277
Operations ................................................................................................. 277
Get a Historical Query ............................................................................ 277
HTTP Method .................................................................................... 278
Query Parameters ............................................................................... 278
Request Headers ................................................................................ 278
Request Body ..................................................................................... 278
Response Headers .............................................................................. 278
Supported Response Media Types ....................................................... 278
Response Status .................................................................................. 278
Response Body ................................................................................... 279
xCP Historical Query Collection ...................................................................... 280
URI Template ............................................................................................. 280
Feed and EDAA Support ............................................................................ 280
Link Relation.............................................................................................. 280
Operations ................................................................................................. 281
Get a Historical Query Collection ............................................................ 281
HTTP Method .................................................................................... 281
Query Parameters ............................................................................... 281
Request Headers ................................................................................ 282
Request Body ..................................................................................... 282
Response Headers .............................................................................. 282
Supported Response Media Types ....................................................... 282
Response Status .................................................................................. 283
Response Body ................................................................................... 283
xCP Historical Query Single Type .................................................................... 284
URI Template ............................................................................................. 284
Link Relation.............................................................................................. 284
Operations ................................................................................................. 284
Get a Historical Query Type .................................................................... 284

19
Table of Contents

HTTP Method .................................................................................... 285


Query Parameters ............................................................................... 285
Request Headers ................................................................................ 285
Request Body ..................................................................................... 285
Response Headers .............................................................................. 285
Supported Response Media Types ....................................................... 285
Response Status .................................................................................. 285
Response Body ................................................................................... 286
xCP Historical Query Type Collection .............................................................. 287
URI Template ............................................................................................. 287
Feed and EDAA Support ............................................................................ 287
Link Relation.............................................................................................. 287
Operations ................................................................................................. 288
Get a Historical Query Type Collection .................................................... 288
HTTP Method .................................................................................... 288
Query Parameters ............................................................................... 288
Request Headers ................................................................................ 288
Request Body ..................................................................................... 289
Response Headers .............................................................................. 289
Supported Response Media Types ....................................................... 289
Response Status .................................................................................. 289
Response Body ................................................................................... 289
xCP Home Document ..................................................................................... 290
URI Template ............................................................................................. 290
Resources ................................................................................................... 290
Operations ................................................................................................. 291
Get the Home Document......................................................................... 291
HTTP Method .................................................................................... 291
Query Parameters ............................................................................... 291
Request Headers ................................................................................ 292
Request Body ..................................................................................... 292
Response Headers .............................................................................. 292
Supported Response Media Types ....................................................... 292
Response Status .................................................................................. 292
Response Body ................................................................................... 292
xCP Member Single Instance ........................................................................... 300
URI Template ............................................................................................. 300
Link Relation.............................................................................................. 300
Operations ................................................................................................. 301
Get a Member ........................................................................................ 301
HTTP Method .................................................................................... 301
Query Parameters ............................................................................... 301
Request Headers ................................................................................ 301
Request Body ..................................................................................... 301
Response Headers .............................................................................. 302
Supported Response Media Types ....................................................... 302
Response Status .................................................................................. 302
Response Body ................................................................................... 302
Add a Member ....................................................................................... 303
HTTP Method .................................................................................... 303
Server Accepted Request Media Types ................................................. 303
Query Parameters ............................................................................... 303
Request Headers ................................................................................ 303
Request Body ..................................................................................... 304
Response Headers .............................................................................. 304
Supported Response Media Types ....................................................... 304
Response Status .................................................................................. 304
Response Body ................................................................................... 304

20
Table of Contents

Remove a Member .................................................................................. 305


HTTP Method .................................................................................... 305
Query Parameters ............................................................................... 305
Request Headers ................................................................................ 305
Request Body ..................................................................................... 305
Response Headers .............................................................................. 305
Response Status .................................................................................. 305
Response Body ................................................................................... 306
xCP Member Collection .................................................................................. 307
URI Template ............................................................................................. 307
Feed and EDAA Support ............................................................................ 307
Link Relation.............................................................................................. 307
Operations ................................................................................................. 308
Get a Member Collection ......................................................................... 308
HTTP Method .................................................................................... 308
Query Parameters ............................................................................... 308
Request Headers ................................................................................ 309
Request Body ..................................................................................... 309
Response Headers .............................................................................. 309
Supported Response Media Types ....................................................... 309
Response Status .................................................................................. 309
Response Body ................................................................................... 309
Get a Member Collection of a Role or Group ............................................ 310
HTTP Method .................................................................................... 310
Query Parameters ............................................................................... 310
Request Headers ................................................................................ 310
Request Body ..................................................................................... 311
Response Headers .............................................................................. 311
Supported Response Media Types ....................................................... 311
Response Status .................................................................................. 311
Response Body ................................................................................... 311
Get a Potential Member Collection of a Role or Group............................... 311
HTTP Method .................................................................................... 312
Query Parameters ............................................................................... 312
Request Headers ................................................................................ 312
Request Body ..................................................................................... 312
Response Headers .............................................................................. 313
Supported Response Media Types ....................................................... 313
Response Status .................................................................................. 313
Response Body ................................................................................... 313
xCP Member Single Type ................................................................................ 314
URI Template ............................................................................................. 314
Link Relation.............................................................................................. 314
Operations ................................................................................................. 314
Get a Member Type ................................................................................ 314
HTTP Method .................................................................................... 314
Query Parameters ............................................................................... 315
Request Headers ................................................................................ 315
Request Body ..................................................................................... 315
Response Headers .............................................................................. 315
Supported Response Media Types ....................................................... 315
Response Status .................................................................................. 315
Response Body ................................................................................... 316
xCP Member Type Collection .......................................................................... 317
URI Template ............................................................................................. 317
Feed and EDAA Support ............................................................................ 317
Link Relation.............................................................................................. 317
Operations ................................................................................................. 318

21
Table of Contents

Get a Member Type Collection................................................................. 318


HTTP Method .................................................................................... 318
Query Parameters ............................................................................... 318
Request Headers ................................................................................ 318
Request Body ..................................................................................... 319
Response Headers .............................................................................. 319
Supported Response Media Types ....................................................... 319
Response Status .................................................................................. 319
Response Body ................................................................................... 319
xCP Network Location Single Instance ............................................................. 320
URI Template ............................................................................................. 320
Link Relation.............................................................................................. 320
Operations ................................................................................................. 320
Get a Network Location .......................................................................... 320
HTTP Method .................................................................................... 320
Query Parameters ............................................................................... 321
Request Headers ................................................................................ 321
Request Body ..................................................................................... 321
Response Headers .............................................................................. 321
Supported Response Media Types ....................................................... 321
Response Status .................................................................................. 321
Response Body ................................................................................... 322
xCP Network Location Collection .................................................................... 323
URI Template ............................................................................................. 323
Feed and EDAA Support ............................................................................ 323
Link Relation.............................................................................................. 324
Operations ................................................................................................. 324
Get a Network Location Collection .......................................................... 324
HTTP Method .................................................................................... 324
Query Parameters ............................................................................... 324
Request Headers ................................................................................ 325
Request Body ..................................................................................... 325
Response Headers .............................................................................. 325
Supported Response Media Types ....................................................... 325
Response Status .................................................................................. 325
Response Body ................................................................................... 325
xCP Network Location Single Type .................................................................. 326
URI Template ............................................................................................. 326
Link Relation.............................................................................................. 326
Operations ................................................................................................. 326
Get a Network Location Type .................................................................. 326
HTTP Method .................................................................................... 327
Query Parameters ............................................................................... 327
Request Headers ................................................................................ 327
Request Body ..................................................................................... 327
Response Headers .............................................................................. 327
Supported Response Media Types ....................................................... 327
Response Status .................................................................................. 327
Response Body ................................................................................... 328
xCP Network Location Type Collection ............................................................ 329
URI Template ............................................................................................. 329
Feed and EDAA Support ............................................................................ 329
Link Relation.............................................................................................. 329
Operations ................................................................................................. 330
Get a Network Location Type Collection .................................................. 330
HTTP Method .................................................................................... 330
Query Parameters ............................................................................... 330

22
Table of Contents

Request Headers ................................................................................ 330


Request Body ..................................................................................... 331
Response Headers .............................................................................. 331
Supported Response Media Types ....................................................... 331
Response Status .................................................................................. 331
Response Body ................................................................................... 331
xCP Picklist Single Type .................................................................................. 332
URI Template ............................................................................................. 332
Link Relation.............................................................................................. 332
Operations ................................................................................................. 332
Get a Picklist .......................................................................................... 332
HTTP Method .................................................................................... 332
Query Parameters ............................................................................... 332
Request Headers ................................................................................ 333
Request Body ..................................................................................... 333
Response Headers .............................................................................. 333
Supported Response Media Types ....................................................... 333
Response Status .................................................................................. 333
Response Body ................................................................................... 333
xCP Picklist Type Collection ............................................................................ 335
URI Template ............................................................................................. 335
Feed and EDAA Support ............................................................................ 335
Link Relation.............................................................................................. 335
Operations ................................................................................................. 336
Get a Picklist Type Collection .................................................................. 336
HTTP Method .................................................................................... 336
Query Parameters ............................................................................... 336
Request Headers ................................................................................ 336
Request Body ..................................................................................... 337
Response Headers .............................................................................. 337
Supported Response Media Types ....................................................... 337
Response Status .................................................................................. 337
Response Body ................................................................................... 337
xCP Process Single Instance............................................................................. 338
URI Template ............................................................................................. 338
Link Relation.............................................................................................. 338
Operations ................................................................................................. 339
Get a Process .......................................................................................... 339
HTTP Method .................................................................................... 339
Query Parameters ............................................................................... 339
Request Headers ................................................................................ 339
Request Body ..................................................................................... 339
Response Headers .............................................................................. 339
Supported Response Media Types ....................................................... 340
Response Status .................................................................................. 340
Response Body ................................................................................... 340
Update the status of a Process ................................................................. 340
HTTP Method .................................................................................... 340
Server Accepted Request Media Types ................................................. 341
Query Parameters ............................................................................... 341
Request Headers ................................................................................ 341
Request Body ..................................................................................... 341
Response Headers .............................................................................. 341
Supported Response Media Types ....................................................... 341
Response Status .................................................................................. 342
Response Body ................................................................................... 342
xCP Process Collection .................................................................................... 343

23
Table of Contents

URI Template ............................................................................................. 343


Feed and EDAA Support ............................................................................ 343
Link Relation.............................................................................................. 343
Operations ................................................................................................. 344
Get a Process Collection .......................................................................... 344
HTTP Method .................................................................................... 344
Query Parameters ............................................................................... 344
Request Headers ................................................................................ 345
Request Body ..................................................................................... 345
Response Headers .............................................................................. 345
Supported Response Media Types ....................................................... 345
Response Status .................................................................................. 345
Response Body ................................................................................... 345
Create a Process ..................................................................................... 346
HTTP Method .................................................................................... 346
Server Accepted Request Media Types ................................................. 346
Query Parameters ............................................................................... 346
Request Headers ................................................................................ 346
Request Body ..................................................................................... 346
Response Headers .............................................................................. 348
Supported Response Media Types ....................................................... 348
Response Status .................................................................................. 348
Response Body ................................................................................... 348
xCP Process Single Type ................................................................................. 349
URI Template ............................................................................................. 349
Link Relation.............................................................................................. 349
Operations ................................................................................................. 349
Get a Process Type .................................................................................. 349
HTTP Method .................................................................................... 349
Query Parameters ............................................................................... 350
Request Headers ................................................................................ 350
Request Body ..................................................................................... 350
Response Headers .............................................................................. 350
Supported Response Media Types ....................................................... 350
Response Status .................................................................................. 350
Response Body ................................................................................... 351
xCP Process Type Collection............................................................................ 352
URI Template ............................................................................................. 352
Feed and EDAA Support ............................................................................ 352
Link Relation.............................................................................................. 352
Operations ................................................................................................. 353
Get a Process Type Collection .................................................................. 353
HTTP Method .................................................................................... 353
Query Parameters ............................................................................... 353
Request Headers ................................................................................ 353
Request Body ..................................................................................... 354
Response Headers .............................................................................. 354
Supported Response Media Types ....................................................... 354
Response Status .................................................................................. 354
Response Body ................................................................................... 354
xCP Product Information Single Instance ......................................................... 355
URI Template ............................................................................................. 355
Link Relation.............................................................................................. 355
Operations ................................................................................................. 355
Get Product Information ......................................................................... 355
HTTP Method .................................................................................... 355
Query Parameters ............................................................................... 356
Request Headers ................................................................................ 356

24
Table of Contents

Request Body ..................................................................................... 356


Response Headers .............................................................................. 356
Supported Response Media Types ....................................................... 356
Response Status .................................................................................. 356
Response Body ................................................................................... 357
xCP Product Information Type ........................................................................ 358
URI Template ............................................................................................. 358
Link Relation.............................................................................................. 358
Operations ................................................................................................. 358
Get a Product Information Type .............................................................. 358
HTTP Method .................................................................................... 358
Query Parameters ............................................................................... 358
Request Headers ................................................................................ 359
Request Body ..................................................................................... 359
Response Headers .............................................................................. 359
Supported Response Media Types ....................................................... 359
Response Status .................................................................................. 359
Response Body ................................................................................... 359
xCP Product Information Type Collection ........................................................ 360
URI Template ............................................................................................. 360
Feed and EDAA Support ............................................................................ 360
Link Relation.............................................................................................. 360
Operations ................................................................................................. 361
Get a Product Information Type Collection ............................................... 361
HTTP Method .................................................................................... 361
Query Parameters ............................................................................... 361
Request Headers ................................................................................ 361
Request Body ..................................................................................... 362
Response Headers .............................................................................. 362
Supported Response Media Types ....................................................... 362
Response Status .................................................................................. 362
Response Body ................................................................................... 362
xCP Project Single Instance ............................................................................. 363
URI Template ............................................................................................. 363
Link Relation.............................................................................................. 363
Operations ................................................................................................. 363
Get a Project ........................................................................................... 363
HTTP Method .................................................................................... 364
Query Parameters ............................................................................... 364
Request Headers ................................................................................ 364
Request Body ..................................................................................... 364
Response Headers .............................................................................. 364
Supported Response Media Types ....................................................... 364
Response Status .................................................................................. 364
Response Body ................................................................................... 365
xCP Project Collection ..................................................................................... 366
URI Template ............................................................................................. 366
Feed and EDAA Support ............................................................................ 366
Link Relation.............................................................................................. 366
Operations ................................................................................................. 367
Get a Project Collection ........................................................................... 367
HTTP Method .................................................................................... 367
Query Parameters ............................................................................... 367
Request Headers ................................................................................ 368
Request Body ..................................................................................... 368
Response Headers .............................................................................. 368
Supported Response Media Types ....................................................... 368

25
Table of Contents

Response Status .................................................................................. 368


Response Body ................................................................................... 368
xCP Project Single Type .................................................................................. 369
URI Template ............................................................................................. 369
Link Relation.............................................................................................. 369
Operations ................................................................................................. 369
Get a Project Type ................................................................................... 369
HTTP Method .................................................................................... 369
Query Parameters ............................................................................... 370
Request Headers ................................................................................ 370
Request Body ..................................................................................... 370
Response Headers .............................................................................. 370
Supported Response Media Types ....................................................... 370
Response Status .................................................................................. 370
Response Body ................................................................................... 371
xCP Project Type Collection............................................................................. 372
URI Template ............................................................................................. 372
Feed and EDAA Support ............................................................................ 372
Link Relation.............................................................................................. 372
Operations ................................................................................................. 373
Get a Project Type Collection ................................................................... 373
HTTP Method .................................................................................... 373
Query Parameters ............................................................................... 373
Request Headers ................................................................................ 374
Request Body ..................................................................................... 374
Response Headers .............................................................................. 374
Supported Response Media Types ....................................................... 374
Response Status .................................................................................. 374
Response Body ................................................................................... 374
xCP Queue List Single Instance ....................................................................... 375
URI Template ............................................................................................. 375
Link Relation.............................................................................................. 375
Operations ................................................................................................. 375
Get a Queue List ..................................................................................... 375
HTTP Method .................................................................................... 375
Query Parameters ............................................................................... 376
Request Headers ................................................................................ 376
Request Body ..................................................................................... 376
Response Headers .............................................................................. 376
Supported Response Media Types ....................................................... 376
Response Status .................................................................................. 377
Response Body ................................................................................... 377
xCP Real-Time Query Single Instance .............................................................. 379
URI Template ............................................................................................. 379
Link Relation.............................................................................................. 379
Operations ................................................................................................. 379
Perform a Real-Time Query ..................................................................... 379
HTTP Method .................................................................................... 379
Query Parameters ............................................................................... 380
Request Headers ................................................................................ 380
Request Body ..................................................................................... 380
Response Headers .............................................................................. 380
Supported Response Media Types ....................................................... 380
Response Status .................................................................................. 381
Response Body ................................................................................... 381
xCP Real-Time Query Single Type ................................................................... 383
URI Template ............................................................................................. 383

26
Table of Contents

Link Relation.............................................................................................. 383


Operations ................................................................................................. 383
Get a Real-Time Query Type ................................................................... 383
HTTP Method .................................................................................... 384
Query Parameters ............................................................................... 384
Request Headers ................................................................................ 384
Request Body ..................................................................................... 384
Response Headers .............................................................................. 384
Supported Response Media Types ....................................................... 384
Response Status .................................................................................. 384
Response Body ................................................................................... 385
xCP Real-Time Query Type Collection ............................................................. 386
URI Template ............................................................................................. 386
Feed and EDAA Support ............................................................................ 386
Link Relation.............................................................................................. 386
Operations ................................................................................................. 387
Get a Real-Time Query Type Collection .................................................... 387
HTTP Method .................................................................................... 387
Query Parameters ............................................................................... 387
Request Headers ................................................................................ 388
Request Body ..................................................................................... 388
Response Headers .............................................................................. 388
Supported Response Media Types ....................................................... 388
Response Status .................................................................................. 388
Response Body ................................................................................... 388
xCP Relationship Single Instance ..................................................................... 389
URI Template ............................................................................................. 389
Link Relation.............................................................................................. 389
Operations ................................................................................................. 389
Get a Relationship .................................................................................. 390
HTTP Method .................................................................................... 390
Query Parameters ............................................................................... 390
Request Headers ................................................................................ 390
Request Body ..................................................................................... 390
Response Headers .............................................................................. 390
Supported Response Media Types ....................................................... 391
Response Status .................................................................................. 391
Response Body ................................................................................... 391
Update a Relationship............................................................................. 391
HTTP Method .................................................................................... 391
Server Accepted Request Media Types ................................................. 391
Query Parameters ............................................................................... 392
Request Headers ................................................................................ 392
Request Body ..................................................................................... 392
Response Headers .............................................................................. 392
Supported Response Media Types ....................................................... 392
Response Status .................................................................................. 393
Response Body ................................................................................... 393
Create a Relationship .............................................................................. 393
HTTP Method .................................................................................... 393
Server Accepted Request Media Types ................................................. 393
Query Parameters ............................................................................... 393
Request Headers ................................................................................ 394
Request Body ..................................................................................... 394
Response Headers .............................................................................. 395
Supported Response Media Types ....................................................... 395
Response Status .................................................................................. 395
Response Body ................................................................................... 395

27
Table of Contents

Delete a Relationship .............................................................................. 395


HTTP Method .................................................................................... 395
Query Parameters ............................................................................... 396
Request Headers ................................................................................ 396
Request Body ..................................................................................... 396
Response Headers .............................................................................. 396
Response Status .................................................................................. 396
Response Body ................................................................................... 396
xCP Relationship Collection ............................................................................ 397
URI Template ............................................................................................. 397
Feed and EDAA Support ............................................................................ 397
Link Relation.............................................................................................. 397
Operations ................................................................................................. 398
Get a Relationship Collection .................................................................. 398
HTTP Method .................................................................................... 398
Query Parameters ............................................................................... 398
Request Headers ................................................................................ 399
Request Body ..................................................................................... 399
Response Headers .............................................................................. 399
Supported Response Media Types ....................................................... 399
Response Status .................................................................................. 399
Response Body ................................................................................... 399
xCP Relationship Single Type .......................................................................... 400
URI Template ............................................................................................. 400
Link Relation.............................................................................................. 400
Operations ................................................................................................. 400
Get a Relationship Type .......................................................................... 400
HTTP Method .................................................................................... 401
Query Parameters ............................................................................... 401
Request Headers ................................................................................ 401
Request Body ..................................................................................... 401
Response Headers .............................................................................. 401
Supported Response Media Types ....................................................... 401
Response Status .................................................................................. 401
Response Body ................................................................................... 402
xCP Relationship Type Collection .................................................................... 403
URI Template ............................................................................................. 403
Feed and EDAA Support ............................................................................ 403
Link Relation.............................................................................................. 403
Operations ................................................................................................. 404
Get a Relationship Type Collection .......................................................... 404
HTTP Method .................................................................................... 404
Query Parameters ............................................................................... 404
Request Headers ................................................................................ 404
Request Body ..................................................................................... 405
Response Headers .............................................................................. 405
Supported Response Media Types ....................................................... 405
Response Status .................................................................................. 405
Response Body ................................................................................... 405
xCP Rendition Collection ................................................................................ 406
URI Template ............................................................................................. 406
Feed and EDAA Support ............................................................................ 406
Link Relation.............................................................................................. 407
Operations ................................................................................................. 407
Get Renditions ....................................................................................... 407
HTTP Method .................................................................................... 407
Query Parameters ............................................................................... 407

28
Table of Contents

Request Headers ................................................................................ 409


Request Body ..................................................................................... 409
Response Headers .............................................................................. 409
Supported Response Media Types ....................................................... 409
Response Status .................................................................................. 409
Response Body ................................................................................... 410
xCP Repository Single Instance ....................................................................... 413
URI Template ............................................................................................. 413
Link Relation.............................................................................................. 413
Operations ................................................................................................. 414
Get a Repository ..................................................................................... 414
HTTP Method .................................................................................... 414
Query Parameters ............................................................................... 414
Request Headers ................................................................................ 414
Request Body ..................................................................................... 414
Response Headers .............................................................................. 414
Supported Response Media Types ....................................................... 415
Response Status .................................................................................. 415
Response Body ................................................................................... 415
xCP Repository Single Type ............................................................................ 416
URI Template ............................................................................................. 416
Link Relation.............................................................................................. 416
Operations ................................................................................................. 417
Get a Repository Type ............................................................................. 417
HTTP Method .................................................................................... 417
Query Parameters ............................................................................... 417
Request Headers ................................................................................ 417
Request Body ..................................................................................... 417
Response Headers .............................................................................. 417
Supported Response Media Types ....................................................... 418
Response Status .................................................................................. 418
Response Body ................................................................................... 418
xCP Repository Type Collection ...................................................................... 419
URI Template ............................................................................................. 419
Feed and EDAA Support ............................................................................ 419
Link Relation.............................................................................................. 419
Operations ................................................................................................. 420
Get a Repository Type Collection ............................................................. 420
HTTP Method .................................................................................... 420
Query Parameters ............................................................................... 420
Request Headers ................................................................................ 421
Request Body ..................................................................................... 421
Response Headers .............................................................................. 421
Supported Response Media Types ....................................................... 421
Response Status .................................................................................. 421
Response Body ................................................................................... 421
xCP Stateless Process Single Instance ............................................................... 422
URI Template ............................................................................................. 422
Link Relation.............................................................................................. 422
Operations ................................................................................................. 422
Create a Stateless Process ........................................................................ 422
HTTP Method .................................................................................... 422
Server Accepted Request Media Types ................................................. 423
Query Parameters ............................................................................... 423
Request Headers ................................................................................ 423
Request Body ..................................................................................... 423
Response Headers .............................................................................. 423

29
Table of Contents

Supported Response Media Types ....................................................... 424


Response Status .................................................................................. 424
Response Body ................................................................................... 424
xCP Stateless Process Single Type .................................................................... 425
xCP Task Single Instance ................................................................................. 426
URI Template ............................................................................................. 426
Link Relation.............................................................................................. 426
Operations ................................................................................................. 427
Get a Task .............................................................................................. 428
HTTP Method .................................................................................... 428
Query Parameters ............................................................................... 428
Request Headers ................................................................................ 428
Request Body ..................................................................................... 428
Response Headers .............................................................................. 429
Supported Response Media Types ....................................................... 429
Response Status .................................................................................. 429
Response Body ................................................................................... 429
Get the status of a Task............................................................................ 429
HTTP Method .................................................................................... 429
Query Parameters ............................................................................... 430
Request Headers ................................................................................ 430
Request Body ..................................................................................... 430
Response Headers .............................................................................. 430
Supported Response Media Types ....................................................... 430
Response Status .................................................................................. 430
Response Body ................................................................................... 431
Update the status of a Task ...................................................................... 431
HTTP Method .................................................................................... 431
Server Accepted Request Media Types ................................................. 431
Query Parameters ............................................................................... 431
Request Headers ................................................................................ 431
Request Body ..................................................................................... 431
Response Headers .............................................................................. 432
Supported Response Media Types ....................................................... 432
Response Status .................................................................................. 432
Response Body ................................................................................... 432
Acquire a Task ........................................................................................ 433
HTTP Method .................................................................................... 433
Server Accepted Request Media Types ................................................. 433
Query Parameters ............................................................................... 433
Request Headers ................................................................................ 433
Request Body ..................................................................................... 433
Response Headers .............................................................................. 434
Supported Response Media Types ....................................................... 434
Response Status .................................................................................. 434
Response Body ................................................................................... 434
Update a Task ........................................................................................ 434
HTTP Method .................................................................................... 434
Server Accepted Request Media Types ................................................. 435
Query Parameters ............................................................................... 435
Request Headers ................................................................................ 435
Request Body ..................................................................................... 435
Response Headers .............................................................................. 435
Supported Response Media Types ....................................................... 436
Response Status .................................................................................. 436
Response Body ................................................................................... 436
Complete a Task ..................................................................................... 436
HTTP Method .................................................................................... 436

30
Table of Contents

Server Accepted Request Media Types ................................................. 436


Query Parameters ............................................................................... 437
Request Headers ................................................................................ 437
Request Body ..................................................................................... 437
Response Headers .............................................................................. 438
Supported Response Media Types ....................................................... 438
Response Status .................................................................................. 438
Response Body ................................................................................... 438
Repeat a Task ......................................................................................... 438
HTTP Method .................................................................................... 438
Server Accepted Request Media Types ................................................. 439
Query Parameters ............................................................................... 439
Request Headers ................................................................................ 439
Request Body ..................................................................................... 439
Response Headers .............................................................................. 439
Supported Response Media Types ....................................................... 440
Response Status .................................................................................. 440
Response Body ................................................................................... 440
xCP Task Collection ........................................................................................ 441
URI Template ............................................................................................. 441
Feed and EDAA Support ............................................................................ 441
Link Relation.............................................................................................. 442
Operations ................................................................................................. 442
Get a Task Collection .............................................................................. 442
HTTP Method .................................................................................... 442
Query Parameters ............................................................................... 442
Request Headers ................................................................................ 443
Request Body ..................................................................................... 443
Response Headers .............................................................................. 443
Supported Response Media Types ....................................................... 443
Response Status .................................................................................. 443
Response Body ................................................................................... 443
xCP Task Single Type ...................................................................................... 444
URI Template ............................................................................................. 444
Link Relation.............................................................................................. 444
Operations ................................................................................................. 444
Get a Task Type ...................................................................................... 444
HTTP Method .................................................................................... 445
Query Parameters ............................................................................... 445
Request Headers ................................................................................ 445
Request Body ..................................................................................... 445
Response Headers .............................................................................. 445
Supported Response Media Types ....................................................... 445
Response Status .................................................................................. 445
Response Body ................................................................................... 446
xCP Task Type Collection ................................................................................ 447
URI Template ............................................................................................. 447
Feed and EDAA Support ............................................................................ 447
Link Relation.............................................................................................. 448
Operations ................................................................................................. 448
Get a Task Type Collection ...................................................................... 448
HTTP Method .................................................................................... 448
Query Parameters ............................................................................... 448
Request Headers ................................................................................ 449
Request Body ..................................................................................... 449
Response Headers .............................................................................. 449
Supported Response Media Types ....................................................... 449
Response Status .................................................................................. 449

31
Table of Contents

Response Body ................................................................................... 449


xCP Tasklist Query Single Instance .................................................................. 450
URI Template ............................................................................................. 450
Link Relation.............................................................................................. 450
Operations ................................................................................................. 450
Perform a Tasklist Query ......................................................................... 450
HTTP Method .................................................................................... 450
Query Parameters ............................................................................... 451
Request Headers ................................................................................ 451
Request Body ..................................................................................... 451
Response Headers .............................................................................. 451
Supported Response Media Types ....................................................... 451
Response Status .................................................................................. 452
Response Body ................................................................................... 452
xCP Tasklist Query Single Type ....................................................................... 455
URI Template ............................................................................................. 455
Link Relation.............................................................................................. 455
Operations ................................................................................................. 455
Get a Tasklist Query Type ....................................................................... 455
HTTP Method .................................................................................... 456
Query Parameters ............................................................................... 456
Request Headers ................................................................................ 456
Request Body ..................................................................................... 456
Response Headers .............................................................................. 456
Supported Response Media Types ....................................................... 456
Response Status .................................................................................. 456
Response Body ................................................................................... 457
xCP Tasklist Query Type Collection ................................................................. 458
URI Template ............................................................................................. 458
Feed and EDAA Support ............................................................................ 458
Link Relation.............................................................................................. 458
Operations ................................................................................................. 459
Get a Tasklist Query Type Collection........................................................ 459
HTTP Method .................................................................................... 459
Query Parameters ............................................................................... 459
Request Headers ................................................................................ 460
Request Body ..................................................................................... 460
Response Headers .............................................................................. 460
Supported Response Media Types ....................................................... 460
Response Status .................................................................................. 460
Response Body ................................................................................... 461
xCP Template Single Instance .......................................................................... 462
URI Template ............................................................................................. 462
Link Relation.............................................................................................. 462
Operations ................................................................................................. 462
Get a Template ....................................................................................... 462
HTTP Method .................................................................................... 463
Query Parameters ............................................................................... 463
Request Headers ................................................................................ 463
Request Body ..................................................................................... 463
Response Headers .............................................................................. 463
Supported Response Media Types ....................................................... 463
Response Status .................................................................................. 463
Response Body ................................................................................... 464
xCP Template Collection ................................................................................. 465
URI Template ............................................................................................. 465
Feed and EDAA Support ............................................................................ 465

32
Table of Contents

Link Relation.............................................................................................. 466


Operations ................................................................................................. 466
Get a Template Collection ....................................................................... 466
HTTP Method .................................................................................... 466
Query Parameters ............................................................................... 466
Request Headers ................................................................................ 467
Request Body ..................................................................................... 467
Response Headers .............................................................................. 467
Supported Response Media Types ....................................................... 467
Response Status .................................................................................. 467
Response Body ................................................................................... 468
xCP Template Single Type ............................................................................... 469
URI Template ............................................................................................. 469
Link Relation.............................................................................................. 469
Operations ................................................................................................. 469
Get a Template Type ............................................................................... 469
HTTP Method .................................................................................... 470
Query Parameters ............................................................................... 470
Request Headers ................................................................................ 470
Request Body ..................................................................................... 470
Response Headers .............................................................................. 470
Supported Response Media Types ....................................................... 470
Response Status .................................................................................. 470
Response Body ................................................................................... 471
xCP Template Type Collection ......................................................................... 472
URI Template ............................................................................................. 472
Feed and EDAA Support ............................................................................ 472
Link Relation.............................................................................................. 472
Operations ................................................................................................. 473
Get a Template Type Collection ............................................................... 473
HTTP Method .................................................................................... 473
Query Parameters ............................................................................... 473
Request Headers ................................................................................ 473
Request Body ..................................................................................... 474
Response Headers .............................................................................. 474
Supported Response Media Types ....................................................... 474
Response Status .................................................................................. 474
Response Body ................................................................................... 474
xCP User Preference Single Instance ................................................................ 476
URI Template ............................................................................................. 476
Link Relation.............................................................................................. 476
Operations ................................................................................................. 476
Get User Preferences ............................................................................... 476
HTTP Method .................................................................................... 477
Query Parameters ............................................................................... 477
Request Headers ................................................................................ 477
Request Body ..................................................................................... 477
Response Headers .............................................................................. 477
Supported Response Media Types ....................................................... 477
Response Status .................................................................................. 477
Response Body ................................................................................... 478
Update User Preferences ......................................................................... 478
HTTP Method .................................................................................... 478
Server Accepted Request Media Types ................................................. 478
Query Parameters ............................................................................... 478
Request Headers ................................................................................ 478
Request Body ..................................................................................... 479
Response Headers .............................................................................. 479

33
Table of Contents

Supported Response Media Types ....................................................... 479


Response Status .................................................................................. 479
Response Body ................................................................................... 480
xCP User Preferences Single Type .................................................................... 481
URI Template ............................................................................................. 481
Link Relation.............................................................................................. 481
Operations ................................................................................................. 481
Get a User Preferences Type .................................................................... 482
HTTP Method .................................................................................... 482
Query Parameters ............................................................................... 482
Request Headers ................................................................................ 482
Request Body ..................................................................................... 482
Response Headers .............................................................................. 482
Supported Response Media Types ....................................................... 482
Response Status .................................................................................. 482
Response Body ................................................................................... 483
xCP User Preferences Type Collection .............................................................. 484
URI Template ............................................................................................. 484
Feed and EDAA Support ............................................................................ 484
Link Relation.............................................................................................. 484
Operations ................................................................................................. 485
Get a User Preferences Type Collection .................................................... 485
HTTP Method .................................................................................... 485
Query Parameters ............................................................................... 485
Request Headers ................................................................................ 486
Request Body ..................................................................................... 486
Response Headers .............................................................................. 486
Supported Response Media Types ....................................................... 486
Response Status .................................................................................. 486
Response Body ................................................................................... 486
xCP View Single Instance ................................................................................ 487
URI Template ............................................................................................. 487
Link Relation.............................................................................................. 487
Operations ................................................................................................. 487
Get a View ............................................................................................. 487
HTTP Method .................................................................................... 487
Query Parameters ............................................................................... 488
Request Headers ................................................................................ 488
Request Body ..................................................................................... 488
Response Headers .............................................................................. 488
Supported Response Media Types ....................................................... 489
Response Status .................................................................................. 489
Response Body ................................................................................... 489
Formats ..................................................................................................... 490
xCP Viewer Single Instance ............................................................................. 491
URI Template ............................................................................................. 492
Link Relation.............................................................................................. 492
Operations ................................................................................................. 492
Get a Viewer .......................................................................................... 492
HTTP Method .................................................................................... 492
Query Parameters ............................................................................... 492
Request Headers ................................................................................ 492
Request Body ..................................................................................... 493
Response Headers .............................................................................. 493
Supported Response Media Types ....................................................... 493
Response Status .................................................................................. 493
Response Body ................................................................................... 493

34
Table of Contents

xCP Viewer Collection .................................................................................... 497


URI Template ............................................................................................. 497
Feed and EDAA Support ............................................................................ 497
Link Relation.............................................................................................. 497
Operations ................................................................................................. 498
Get a Viewer Collection........................................................................... 498
HTTP Method .................................................................................... 498
Query Parameters ............................................................................... 498
Request Headers ................................................................................ 498
Request Body ..................................................................................... 498
Response Headers .............................................................................. 498
Supported Response Media Types ....................................................... 499
Response Status .................................................................................. 499
Response Body ................................................................................... 499
xCP Raw Content ........................................................................................... 501
URI Template ............................................................................................. 501
Operations ................................................................................................. 501
Get a Binary Stream ................................................................................ 501
HTTP Method .................................................................................... 501
Query Parameters ............................................................................... 502
Request Headers ................................................................................ 502
Request Body ..................................................................................... 502
Response Headers .............................................................................. 502
Supported Response Media Types ....................................................... 503
Response Status .................................................................................. 503
Response Body ................................................................................... 503
Upload a Binary Stream .......................................................................... 503
HTTP Method .................................................................................... 503
Server Accepted Request Media Types ................................................. 504
Query Parameters ............................................................................... 504
Request Headers ................................................................................ 504
Request Body ..................................................................................... 504
Response Headers .............................................................................. 505
Supported Response Media Types ....................................................... 505
Response Status .................................................................................. 505
Response Body ................................................................................... 505
xCP LightWeight Business Object Single Instance ............................................. 506
URI Template ............................................................................................. 506
Link Relation.............................................................................................. 506
Operations ................................................................................................. 507
Get a Lightweight Business Object ........................................................... 507
HTTP Method .................................................................................... 507
Query Parameters ............................................................................... 507
Request Headers ................................................................................ 508
Request Body ..................................................................................... 508
Response Headers .............................................................................. 508
Supported Response Media Types ....................................................... 508
Response Status .................................................................................. 508
Response Body ................................................................................... 509
Update a Lightweight Business Object ..................................................... 509
HTTP Method .................................................................................... 509
Server Accepted Request Media Types ................................................. 509
Query Parameters ............................................................................... 509
Request Headers ................................................................................ 509
Request Body ..................................................................................... 510
Response Headers .............................................................................. 510
Supported Response Media Types ....................................................... 510
Response Status .................................................................................. 510

35
Table of Contents

Response Body ................................................................................... 511


Delete a Lightweight Business Object ....................................................... 511
HTTP Method .................................................................................... 511
Query Parameters ............................................................................... 511
Request Headers ................................................................................ 511
Request Body ..................................................................................... 511
Response Headers .............................................................................. 511
Response Status .................................................................................. 511
Response Body ................................................................................... 512
Reparent a Lightweight Business Object ................................................... 512
HTTP Method .................................................................................... 512
Server Accepted Request Media Types ................................................. 512
Query Parameters ............................................................................... 512
Request Headers ................................................................................ 512
Request Body ..................................................................................... 512
Response Headers .............................................................................. 513
Supported Response Media Types ....................................................... 513
Response Status .................................................................................. 513
Response Body ................................................................................... 513
xCP Lightweight Business Object Collection ..................................................... 514
URI Template ............................................................................................. 514
Feed and EDAA Support ............................................................................ 514
Link Relation.............................................................................................. 515
Operations ................................................................................................. 515
Get a Lightweight Business Object Collection ........................................... 515
HTTP Method .................................................................................... 515
Query Parameters ............................................................................... 515
Request Headers ................................................................................ 516
Request Body ..................................................................................... 516
Response Headers .............................................................................. 516
Supported Response Media Types ....................................................... 516
Response Status .................................................................................. 516
Response Body ................................................................................... 517
xCP Lightweight Business Object Single Type ................................................... 518
URI Template ............................................................................................. 518
Link Relation.............................................................................................. 518
Operations ................................................................................................. 518
Get a Lightweight Business Object Type ................................................... 518
HTTP Method .................................................................................... 518
Query Parameters ............................................................................... 519
Request Headers ................................................................................ 519
Request Body ..................................................................................... 519
Response Headers .............................................................................. 519
Supported Response Media Types ....................................................... 519
Response Status .................................................................................. 519
Response Body ................................................................................... 519
xCP Lightweight Business Object Type Collection ............................................. 522
URI Template ............................................................................................. 522
Feed and EDAA Support ............................................................................ 522
Link Relation.............................................................................................. 523
Operations ................................................................................................. 523
Get a Lightweight Business Object Type Collection ................................... 523
HTTP Method .................................................................................... 523
Query Parameters ............................................................................... 523
Request Headers ................................................................................ 524
Request Body ..................................................................................... 524
Response Headers .............................................................................. 524
Supported Response Media Types ....................................................... 524

36
Table of Contents

Response Status .................................................................................. 524


Response Body ................................................................................... 524
xCP Lightweight Content Single Instance ......................................................... 525
URI Template ............................................................................................. 525
Link Relation.............................................................................................. 525
Operations ................................................................................................. 526
Get a Lightweight Content ...................................................................... 527
HTTP Method .................................................................................... 527
Query Parameters ............................................................................... 527
Request Headers ................................................................................ 527
Request Body ..................................................................................... 527
Response Headers .............................................................................. 528
Supported Response Media Types ....................................................... 528
Response Status .................................................................................. 528
Response Body ................................................................................... 528
Update a Lightweight Content ................................................................ 528
HTTP Method .................................................................................... 528
Server Accepted Request Media Types ................................................. 529
Query Parameters ............................................................................... 529
Request Headers ................................................................................ 529
Request Body ..................................................................................... 529
Response Headers .............................................................................. 529
Supported Response Media Types ....................................................... 529
Response Status .................................................................................. 530
Response Body ................................................................................... 530
Delete a Lightweight Content .................................................................. 530
HTTP Method .................................................................................... 530
Query Parameters ............................................................................... 530
Request Headers ................................................................................ 530
Request Body ..................................................................................... 531
Response Headers .............................................................................. 531
Response Status .................................................................................. 531
Response Body ................................................................................... 531
Check out a Lightweight Content ............................................................ 531
HTTP Method .................................................................................... 531
Server Accepted Request Media Types ................................................. 531
Query Parameters ............................................................................... 532
Request Headers ................................................................................ 532
Request Body ..................................................................................... 532
Response Headers .............................................................................. 532
Supported Response Media Types ....................................................... 532
Response Status .................................................................................. 532
Response Body ................................................................................... 533
Check in a Lightweight Content .............................................................. 533
HTTP Method .................................................................................... 533
Server Accepted Request Media Types ................................................. 533
Query Parameters ............................................................................... 534
Request Headers ................................................................................ 534
Request Body ..................................................................................... 534
Response Headers .............................................................................. 535
Supported Response Media Types ....................................................... 535
Response Status .................................................................................. 535
Response Body ................................................................................... 535
xCP Lightweight Content Collection ................................................................ 536
URI Template ............................................................................................. 536
Feed and EDAA Support ............................................................................ 536
Link Relation.............................................................................................. 536
Operations ................................................................................................. 537

37
Table of Contents

Get a Lightweight Content Collection ...................................................... 537


HTTP Method .................................................................................... 537
Query Parameters ............................................................................... 537
Request Headers ................................................................................ 538
Request Body ..................................................................................... 538
Response Headers .............................................................................. 538
Supported Response Media Types ....................................................... 538
Response Status .................................................................................. 538
Response Body ................................................................................... 538
xCP Lightweight Content Single Type .............................................................. 539
URI Template ............................................................................................. 539
Link Relation.............................................................................................. 539
Operations ................................................................................................. 539
Get a Content Type ................................................................................. 539
HTTP Method .................................................................................... 539
Query Parameters ............................................................................... 539
Request Headers ................................................................................ 540
Request Body ..................................................................................... 540
Response Headers .............................................................................. 540
Supported Response Media Types ....................................................... 540
Response Status .................................................................................. 540
Response Body ................................................................................... 540
xCP Lightweight Content Type Collection ........................................................ 541
URI Template ............................................................................................. 541
Feed and EDAA Support ............................................................................ 541
Link Relation.............................................................................................. 541
Operations ................................................................................................. 542
Get a Lightweight Content Type Collection .............................................. 542
HTTP Method .................................................................................... 542
Query Parameters ............................................................................... 542
Request Headers ................................................................................ 542
Request Body ..................................................................................... 543
Response Headers .............................................................................. 543
Supported Response Media Types ....................................................... 543
Response Status .................................................................................. 543
Response Body ................................................................................... 543
xCP LightWeight Materialization Resource ...................................................... 544
URI Template ............................................................................................. 544
Link Relation.............................................................................................. 544
Operations ................................................................................................. 545
Materialize the Lightweight Object .......................................................... 545
HTTP Method .................................................................................... 545
Server Accepted Request Media Types ................................................. 545
Query Parameters ............................................................................... 545
Request Headers ................................................................................ 546
Request Body ..................................................................................... 546
Response Headers .............................................................................. 546
Supported Response Media Types ....................................................... 546
Response Status .................................................................................. 546
Response Body ................................................................................... 547
Delete a Lightweight Materialization Resource ......................................... 547
HTTP Method .................................................................................... 547
Query Parameters ............................................................................... 547
Request Headers ................................................................................ 547
Request Body ..................................................................................... 547
Response Headers .............................................................................. 547
Response Status .................................................................................. 547
Response Body ................................................................................... 548

38
Table of Contents

xCP Shared Parent Single Instance ................................................................... 549


URI Template ............................................................................................. 549
Link Relation.............................................................................................. 549
Operations ................................................................................................. 549
Get a Collection of Lightweight Objects on a Shared parent ........................... 550
HTTP Method ........................................................................................ 550
Query Parameters ................................................................................... 550
Request Headers .................................................................................... 550
Request Body ......................................................................................... 550
Response Headers .................................................................................. 551
Supported Response Media Types ........................................................... 551
Response Status ...................................................................................... 551
Response Body ....................................................................................... 551
Creates a lightweight object that shares a specific shared object ..................... 552
HTTP Method ........................................................................................ 552
Server Accepted Request Media Types ..................................................... 552
Query Parameters ................................................................................... 552
Request Headers .................................................................................... 552
Request Body ......................................................................................... 552
Response Headers .................................................................................. 553
Supported Response Media Types ........................................................... 553
Response Status ...................................................................................... 553
Response Body ....................................................................................... 554
Creates a lightweight object that shares a specific shared content ................... 554
HTTP Method ........................................................................................ 554
Query Parameters ................................................................................... 554
Request Headers .................................................................................... 554
Request Body ......................................................................................... 554
Response Headers .................................................................................. 555
Supported Response Media Types ........................................................... 555
Response Status ...................................................................................... 555
Response Body ....................................................................................... 555
xCP Shared Parent Collection .......................................................................... 557
URI Template ............................................................................................. 557
Link Relation.............................................................................................. 557
Operations ................................................................................................. 557
Get a Shared parent collection ................................................................. 557
HTTP Method .................................................................................... 557
Query Parameters ............................................................................... 558
Request Headers ................................................................................ 558
Request Body ..................................................................................... 558
Response Headers .............................................................................. 558
Supported Response Media Types ....................................................... 558
Response Status .................................................................................. 559
Response Body ................................................................................... 559
Viewer Provider Profile .................................................................................. 559

39
Table of Contents

List of Tables

40
Preface

This document is a guide to using Documentum xCP REST Services to interact with Documentum
repositories.

Intended Readership
This document is intended for developers and architects who are building REST web services.
IMPORTANT
Documentum Content Server is now OpenText Documentum Server. OpenText Documentum Server
will be called Documentum Server throughout this guide.

Revision History
The following changes have been made to this document.

Revision history

Revision Date Description


February 2018 Initial publication
April 2018 Updated for supported platforms.

41
Preface

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

43
Overview

44
Chapter 2
General REST Definitions

Common Definition - HTTP Headers


Documentum REST Services supports the following common HTTP headers:

HTTP Header Description In Request or Value Range


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

Authorization: Basic
QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Or, Kerberos authentication header


with the credential part encoded, for
example:

Authorization: Negotiate
YIIZG1hZG1pbjpwYXNzd29yZ...
Accept Acceptable media type Request • application/vnd.emc.xcp+xml
for the response
• application/vnd.emc.xcp+json

• application/xml

• application/json
Content-Type MIME type of the Request • application/vnd.emc.xcp+xml
request body or /Response
response body • application/vnd.emc.xcp+json

• application/xml

• application/json
Content Size of the entity-body, Request Non-negative number
-Length in decimal number of /Response
OCTETs, sent to the
recipient

Location URI of the Response URI


newly-created resource

45
General REST Definitions

HTTP Header Description In Request or Value Range


Name Response?
Set-Cookie Sets an HTTP cookie Response Once the user is authenticated,
Response
x-csrf-token
cookie is sent in the response header.
x-csrf-token Client (for example, Request Browsers and clients must send
Javascript) needs
x-csrf-token
to add this header
cookie value in the Request header or
for POST calls to
as parameter for any post operation
safeguard against any
to safeguard against any CSRF
CSRF vulnerability.
vulnerability.

Example:
var xhr = new XMLHttpRequest
(); xhr.setRequestHeader('x
-csrf-token', Ext.util.Cookies
.get('x-csrf-token'));
WWW Indicates the Response Used by HTTP basic authentication
-Authenticate authentication scheme and HTTP Kerberos negotiate
that should be used to authentication Set-Cookie.
access the requested
entity

46
General REST Definitions

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 Value Range Default


Parameter Type
Name
inline Determines boolean • true - return the object false
whether to show instance and embed Note: Although the
content (the object the object instance into default value is false,
instance) in an the entry's content we still recommend
atom entry or element. that you try setting
EDAA entry for a
this parameter to true
collection. • false - do not return
in your development
object instance.
environment to get the
entire content of resources
and explore the complete
data structure. In your
production environment,
you can set this parameter
to false for better
performance.
items-per Specifies the integer Any integer no less than 1 100
-page number of items
to be rendered on
one page.
page Specifies the page integer Any integer no less than 1 1
number of the
page to return.

If you set items


-per-page to
200, and page to
2, the operation
returns items 201 -
400.

47
General REST Definitions

Query Description Data Value Range Default


Parameter Type
Name
view Specifies the object string See Property View, page :default
properties to 51.
retrieve.

This parameter
works only when
inline is set to
true.

For more
information, see
Property View,
page 51.
include Determines boolean • true - return the total false
-total whether to return number of objects.
the total number
of objects. For • false - do not return
paged feeds, the total number of
objects in all pages objects.
are counted.
sort Specifies a set string This parameter consists NA
of the sort of multiple sort
specifications specifications, separated
in a returned by comma ( , ).
collection.
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

48
General REST Definitions

Query Description Data Value Range Default


Parameter Type
Name
links Determines boolean • true - return link true
whether to return relations.
link relations
in the object • false - do not return
representation. link relations.

This parameter
works only when
inline is set to
true.
recursive Determines boolean • true - return all false
whether to indirect children
return all recursively when a
indirect children request tries to get the
recursively when children of an object.
a request tries to
get the children of • false - Only return
an object. direct children when a
request tries to get the
children of an object.
permissions This query boolean • For collection false
parameter is objects–This parameter,
used by all when true, returns
the collections. permission-based links
Permission based and basic & extended
links & Permission permissions for the
info is provided collection objects.
only when this
query parameter • For single object—This
value is set to true. parameter is not
applicable. The
response would
always return
permission-based links
and basic & extended
permissions for an
object.

Refer to the Sample in


XML, page 49 section for
an example.

Example 2-1. Sample in XML


<dm:permission>
<dm:basic-permission>RELATE</dm:basic-permission>
<dm:extended-permissions>

49
General REST Definitions

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

Example 2-2. Sample in JSON


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

50
General REST Definitions

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.

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.

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

View Expression Syntax

The syntax of a view expression is defined with the following EBNF:


view-expression = predefined-view | properties-list ;

51
General REST Definitions

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.

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 The newly created resource representation that the system
=true 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, page 51 provides more details.
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.

52
General REST Definitions

Parameter Name Description


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_content
_type,authors,keywords
folders-output-mandatory-properties
=r_object_id,title,subject,r_folder_path
cabinets-output-mandatory
-properties=r_object_id,title,subject,r
_folder_path
templates-output-mandatory
-properties=a_content
_type,description,dos_extension,r
_object_type,r_object_id,object
_name,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=EMC Documentum Other configurations
content-staging-location= If these parameters are not set, the file is uploaded to the
context-path= Java temporary folder, 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 The caching period in seconds for all the rest resources
=31536000 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.

53
General REST Definitions

Parameter Name Description


file-maxInMemorySize=10240 The maximum size allowed before files are written to the
disk. The files with size below 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 true—The Update event is triggered only when the
_attr=true 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.

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

54
General REST Definitions

Status Code Description


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 The HTTP verb specified in the request (DELETE, GET, HEAD, POST,
Allowed 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).
415 Unsupported The server is refusing to service the request because the entity of the
Media Type request is in a format not supported by the requested resource for the
requested method.
500 Internal Server The server encountered an unexpected condition which prevented it from
Error fulfilling the request.

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.
http://tools.ietf.org/html/rfc4287

55
General REST Definitions

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>

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.

56
General REST Definitions

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

57
General REST Definitions

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",
"name": "highest_degree",
"type": "string",
"length": "16",
"valueAssist": "http://localhost:8080/xcp-rest/picklists/ut200_highest_degree"
}

58
Chapter 3
Authentication

xCP REST Services supports HTTP basic authentication.

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.

59
Authentication

60
Chapter 4
Resources

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.

URI Template
/dql-queries/query_name

query_name Name of the Advanced repository query

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, page 61
type Type definition of this resource xCP Advanced Repository
Query Single Type, page 64

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.

Operations
Advanced Repository Query resource supports the following HTTP method.

61
Resources

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

Perform a Advanced Repository Query

Perform a Advanced Repository query on objects in a repository.

HTTP Method

GET

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, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type

62
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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": "EMC Documentum",
"items-per-page": 2,
"links": [{
"rel": "self",
"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",

63
Resources

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

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.

URI Template
/types/dql-queries/query-type

query-type Type of the Advanced repository query

64
Resources

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 Advanced xCP Advanced Repository
repository query Query Single Type, page 64
instances [1] Advanced Repository Query xCP Advanced Repository
instance Query Instance, page 61
[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/

Operations
A Advanced Repository Query Type resource supports the following HTTP method.

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

Get an Advanced Repository Query Type

Retrieve the type definition of a Advanced repository query.

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

65
Resources

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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

66
Resources

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

67
Resources

xCP Advanced Repository Query Type


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

URI Template
/types/dql-queries

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 property 2016-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


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

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

68
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Advanced Repository
for Advanced Repository Query Type Collection, page 68
Query instances

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

Get a Advanced Repository Query Type Collection

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

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

69
Resources

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

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.

70
Resources

URI Template
/alert-queries/query_name

query_name Name of the alert query

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, page 70

Operations
An Alert Query resource supports the following HTTP method.

Method Description
GET Retrieve the results of an alert query

Perform an Alert Query

Retrieve the results of an alert query.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


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

71
Resources

• 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, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

72
Resources

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>EMC 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>
<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: "EMC Documentum"
links:
{
rel: "self"
href: "alert-queries/utapp21_loanalertquery"
}

entries:
{
id: "alert-queries/utapp21_loanalertquery/456959915"

73
Resources

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

74
Resources

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.

URI Template
/types/alert-queries/query-type

query-type Type of the alert query

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 Query xCP Alert Query Single Type,
instances page 75
[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/

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

Method Description
GET Retrieve the type definition of Alert Query
instances

Get an Alert Query Type

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

HTTP Method

GET

75
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

Response Body

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

76
Resources

xCP Alert Query Type Collection


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

URI Template
/types/alert-queries

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


ID URI of the entry, which contains http://localhost:8080/xcp-rest
the URI of the feed and name /types/alert-queries/base-alert
of the type -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 instance 2013-01-25T18:51:39.469Z
that this entry points to

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

77
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Alert Query Type
for Alert Query instances Collection, page 77

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

Get an Alert Query Type Collection

Retrieve a collection of type definitions for Alert Query instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

78
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

79
Resources

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.

URI Template
/alerts/alert-type/alert-id

alert-type Type of the alert


alert-id ID of the alter

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

Link Relation Description Resource Reference


type Type definition of this resource xCP Alert Single Type, page 88
status [1] Status of the Alert instance Not applicable
self This Alert instance xCP Alert Single Instance, page
80
[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/

Operations
An Alert resource supports the following HTTP methods.

Method Description
GET Retrieve an Alert resource

PUT Update the status of an Alert resource

Get an Alert

Retrieve an Alert resource.

80
Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

Response Status
200 - Information retrieved successfully
204 - No Content

81
Resources

400 - Invalid syntax or missing a required value


401 - Invalid or missing authentication credentials
403 - Permission denied
500 - Other unexpected server error

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, page 88.
• 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 ("").

Update Alert Status

Update the status of an Alert resource.

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

Server Accepted Request Media Types

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

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type

82
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

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

Status XML Representation JSON Representation


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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

83
Resources

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

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, page 88.
• The status link relation indicates the updated status of the Alert resource.
• Null values are presented as an empty string ("").

84
Resources

xCP Alert Collection


An Alert collection represents a collection of Alert instances.

URI Template
/alerts/alert-type

alert-type Type of the alert

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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
follows this pattern: -rest/Alert/xcp-base-alert
feed_uri/entry_id /18765432199812ce
Title Entry title Entry title
Summary Entry summary Entry summary
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

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

85
Resources

Link Relation Description Resource Reference


self This collection resource xCP Alert Collection, page 85
first, last, previous, next Pagination links xCP Alert Collection, page 85

Operations
An Alert collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Alert instances.

Get an Alert Collection

Retrieve a collection of Alert instances of a certain type.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

86
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

87
Resources

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.

URI Template
/types/alert-type

alert-type Type of the alert

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, page 88
instances
instances [1] Collection of the Alert instances xCP Alert Collection, 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/

Operations
An Alert Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Alert instances

Get an Alert Type

Retrieve the type definition of Alert instances.

88
Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

89
Resources

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,
page 85.

xCP Alert Type Collection


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

URI Template
/types/alerts

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


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

90
Resources

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

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

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

Get an Alert Type Collection

Retrieve a collection of type definitions for Alert instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

91
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

92
Resources

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 , page 559provides detailed information
about viewer providers.

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

Feed and EDAA Support


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

Link Relation
This resource does not have any link relations.

Operations
An Annotation collection resource supports the following HTTP methods.

93
Resources

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

Get an Annotation Collection

Retrieve all annotations on a Content instance.

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,
page 490 provides more information about content formats.

Query Parameters

This operation does not support any query parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

94
Resources

Response Headers

• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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

95
Resources

Get an Annotation Collection for a User

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

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

Note: The viewer provider must support the content format of the annotations. The section Formats,
page 490 provides more information about content formats.

Query Parameters

This operation does not support any query parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

96
Resources

Response Headers

• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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

97
Resources

Create Annotations

Create annotations on a Content instance.

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, page 98) to the Content instance in the following
pattern:
viewers/viewer-provider/contents/content-type/
content-id/view/annotations

Server Accepted Request Media Types

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

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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

98
Resources

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.

Response Headers

• Location
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

Response Body

JSON representation of an Annotation collection.

99
Resources

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.

URI Template
/application

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, page 100
type Type definition of this resource xCP Application Type, page
104
projects [1] Collection of all projects in the xCP Project Collection, page
application 366
roles [1] collection of all roles defined in xCP Member Collection, page
this application 307
[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/

Operations
An Application resource supports the following HTTP method.

Method Description
GET Retrieve an Application resource

Get an Application

Retrieve the information about an xCP application.

100
Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
For more details about the query parameters, see Common Definition - Query Parameters, page 47.

Request Headers

• Accept
• Authorization

Request Body

None.

Response Headers

Content-Type

Supported Response Media Types

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

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

101
Resources

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, page 104.
• 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>
<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"

102
Resources

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

103
Resources

xCP Application Type


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

URI Template
/types/projects/xcp_project

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, page
Application instance 104
instances [1] Collection of the project xCP Application Configuration
instances Collection, page 115
[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/

Operations
An Application Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Application
instances

Get an Application Type

Retrieve the type definition of Application instances.

HTTP Method

GET

104
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization

Request Body

None.

Response Headers

Content-Type

Supported Response Media Types

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

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

Response Body

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

105
Resources

xCP Application Type Collection


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

URI Template
/types/projects

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


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

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

106
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Application Type
for Application instances Collection, page 106

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

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

Get an Application Type Collection

Retrieve a collection of type definitions for Application instances.

HTTP Method

GET

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, page 47.

Request Headers

• Accept
• Authorization

107
Resources

Request Body

None.

Response Headers

Content-Type

Supported Response Media Types

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

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

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.

108
Resources

109
Resources

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.

URI Template
/application-configurations/xcp_application_configuration
/application_configuration-id

application_configuration-id Object ID of the application configuration

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

Link Relation Description Resource Reference


type Type definition of this resource xCP Application Configuration
Single Type, page 119
instances [1] Collection of the Application xCP Application Configuration
Configuration instances Collection, page 115
edit This Application Configuration xCP Application Configuration
instance Single Instance, page 110
[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/

Operations
An Application Configuration resource supports the following HTTP methods.

Method Description
GET Retrieve an Application Configuration resource

POST Update an Application Configuration resource

110
Resources

Get an Application Configuration

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

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

111
Resources

• application/xml (For compatible viewing)


• application/json (For compatible viewing)

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

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, page 119.
• Null values are presented as an empty string ("").

Update an Application Configuration

Update an Application Configuration instance.

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

Server Accepted Request Media Types

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

Query Parameters

None.

112
Resources

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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, page 119), 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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

Response Status
200 - Object updated successfully
400 - Bad request; invalid attribute name or value
401 - Authentication failed

113
Resources

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

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, page 119.
• Null values are presented as an empty string ("").

114
Resources

xCP Application Configuration Collection


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

URI Template
/application-configurations/xcp_application_configuration

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_configuration
Title Name of configuration type xcp_application_configuration
Updated Value of the updated property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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: /application-configurations
feed_uri/entry_id /xcp_application_configuration
/08001538800049ab
Title Name of the application xcp_application_configuration
configuration type with the -0
running number appended to it
Summary Name of application xcp_application_configuration
configuration type with -0
running number appended to it
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

115
Resources

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, page 115
first, last, previous, next Pagination links xCP Application Configuration
Collection, page 115

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

Method Description
GET Retrieve a collection of Application
Configuration instances.

Get an Application Configuration Collection

Retrieve a collection of Application Configuration instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


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

116
Resources

Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

117
Resources

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.

118
Resources

xCP Application Configuration Single Type


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

URI Template
/types/application-configurations/xcp_application_configuration

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

Link Relation Description Resource Reference


self Type definition of Application xCP Application Configuration
Configuration instances Single Type, page 119
instances [1] Collection of the Application xCP Application Configuration
Configuration instances Collection, page 115
[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/

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

Method Description
GET Retrieve the type definition of Application
Configuration instances

Get an Application Configuration Type

Retrieve the type definition of Application Configuration instances.

HTTP Method

GET

119
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

120
Resources

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, page 115.

121
Resources

xCP Application Configuration Type Collection


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

URI Template
/types/application-configurations

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


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

Link Relation
The following table lists link relation(s) for an Application Configuration Type resource.

122
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Application Configuration
for Application Configuration Type Collection, page 122
instances

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

Get an Application Configuration Type Collection

Retrieve a collection of type definitions for Application Configuration instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

123
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

124
Resources

xCP Business Object Single Instance


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

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

Link Relation
The following table lists general link relations for a Business Object resource.

Link Relation Description Resource Reference


type Type definition of this resource xCP Business Object Single
Type, page 136
instances [1] Collection of the Business xCP Business Object Collection,
Object instances page 133
edit Edit this Business Object xCP Business Object Single
instance Instance, page 125
self This Business Object instance xCP Business Object Single
Instance, page 125
comments [1] Comments attached to this xCP Comment Collection, page
Business Object instance 171
add-comment Add a comment to the Business xCP Business Object Single
Object instance Instance, page 125
delete [1] Delete this Business Object xCP Business Object Single
instance Instance, page 125
[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/

Operations
A Business Object resource supports the following HTTP methods.

125
Resources

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,
page 162.
POST Add comments to a Business Object resource.
See xCP Comment Single Instance, page 162.
DELETE Delete a Business Object resource

Get a Business Object

Retrieve a Business Object resource.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

126
Resources

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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, page 136.
• Null values are presented as an empty string ("").

Update a Business Object

Update a Business Object resource.

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

127
Resources

Server Accepted Request Media Types

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

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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,
page 136), 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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

128
Resources

Supported Response Media Types

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

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

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, page 136.
• Null values are presented as an empty string ("").

Create a Business Object

Create a Business Object resource.

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

Server Accepted Request Media Types

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

129
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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, page 136), 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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

130
Resources

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

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, page 136.
• Null values are presented as an empty string ("").

Delete a Business Object

Delete a Business Object resource.

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

Query Parameters

None.

Request Headers

• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

131
Resources

Response Headers

None.

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

Response Body

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

132
Resources

xCP Business Object Collection


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

URI Template
/business-objects/business-object-type

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

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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: /business-objects/test-business
feed_uri/entry_id -type/0800153880005b89
Title object_name of the entry Sample BusinessObject
Summary object_name of the entry Sample BusinessObject
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Business Object collection resource.

133
Resources

Link Relation Description Resource Reference


self This collection resource xCP Business Object Collection,
page 133
first, last, previous, next Pagination links xCP Business Object Collection,
page 133

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

Method Description
GET Retrieve a collection of Business Object instances.

Get a Business Object Collection

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

HTTP Method

GET

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, page 47 provides more information about common query
parameters.

134
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

135
Resources

xCP Business Object Single Type


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

URI Template
/types/business-objects/business-object-type

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

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, page 136
instances [1] Collection of the Business xCP Business Object Collection,
Object instances page 133
defaults [1] Default values specified on a xCP Business Object Single
Business Object type Type, page 136
[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/

Operations
A Business Object Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Business Object
instances

Get a Business Object Type

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

136
Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

137
Resources

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

138
Resources

},{
"rel":"http://identifiers.emc.com/linkrel/lightweight-objects"
},{
"rel":"http://identifiers.emc.com/linkrel/add-lightweight-objects"
}]}

139
Resources

xCP Business Object Type Collection


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

URI Template
/types/business-objects/

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


ID URI of the entry, which contains http://127.0.0.1:8080/xcp
the URI of the feed and name -rest/types/business-objects/
of the type xcp_business_objects/
Title Label of the type that this entry test-business-object-type
points to
Summary Label of the type that this entry test-business-object-type
points to
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

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

140
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Business Object Type
for Business Object instances Collection, page 140

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

Get a Business Object Type Collection

Retrieve a collection of type definitions for Business Object instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

141
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

142
Resources

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.

URI Template
/cabinets/cabinet-type/cabinet-id

cabinet-type Type of the cabinet


cabinet-id Object ID of the cabinet

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

Link Relation Description Resource Reference


type Type definition of this resource xCP Cabinet Single Type, page
156
instances [1] Collection of the Cabinet xCP Cabinet Collection, page
instances 153
self This Cabinet instance xCP Cabinet Single Instance,
page 143
objects [1] Objects located in this Cabinet xCP Folder Collection, page 225
resource
add Add an instance of an object xCP Cabinet Single Instance,
inside this Cabinet instance page 143
add-comment Add a comment to the Cabinet xCP Cabinet Single Instance,
instance page 143
self This instance xCP Cabinet Single Instance,
page 143
edit Edit this instance xCP Cabinet Single Instance,
page 143

143
Resources

Link Relation Description Resource Reference


delete Delete this instance xCP Cabinet Single Instance,
page 143
[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/

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

Get a Cabinet

Retrieve a Cabinet resource.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

144
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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, page 156.
• Null values are presented as an empty string ("").

145
Resources

Get Objects in a Cabinet

Retrieve objects in a Cabinet resource.

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

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

146
Resources

Supported Response Media Types

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

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

Response Body

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

Create a Cabinet

Create a Cabinet resource.

HTTP Method

POST

Server Accepted Request Media Types

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

Query Parameters

None.

147
Resources

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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, page 156),
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",
"properties": {
"single_attr_string": "emc",
}
}

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

148
Resources

Supported Response Media Types

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

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

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, page 156.
• Null values are presented as an empty string ("").

Update a Cabinet

Update the metadata of a Cabinet resource.

HTTP Method

POST

Server Accepted Request Media Types

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

Query Parameters

None.

149
Resources

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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, page 156),
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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

Response Status
200 - Object updated successfully
400 - Bad request; invalid attribute name or value
401 - Authentication failed

150
Resources

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

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, page 156.
• Null values are presented as an empty string ("").

Delete a Cabinet

Delete a Cabinet resource.

HTTP Method

DELETE

Query Parameters

None.

Request Headers

• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

None.

151
Resources

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

Response Body

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

152
Resources

xCP Cabinet Collection


A Cabinet collection represents a collection of Cabinet instances.

URI Template
/cabinets/cabinet-type/

cabinet-type Type of the cabinet

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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
follows this pattern: -rest/cabinets/dm_cabinet
feed_uri/entry_id /0c01e24080012a95
Title Entry title xcp_sample_cabinet
Summary Entry summary xCP Sample Cabinet
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

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

153
Resources

Link Relation Description Resource Reference


self This collection resource xCP Cabinet Collection, page
153
first, last, previous, next Pagination links xCP Cabinet Collection, page
153

Operations
A Cabinet collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Cabinet instances

Get a Cabinet Collection

Retrieve a collection of Cabinet instances of a certain type.

HTTP Method

GET

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, page 47 provides more information about common query
parameters.

154
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

155
Resources

xCP Cabinet Single Type


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

URI Template
/types/cabinets/cabinet-type

cabinet-type Type of the cabinets

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, page
instances 156
instances [1] Collection of the Cabinet xCP Cabinet Collection, page
instances 153
[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/

Operations
A Cabinet Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Cabinet instances

Get a Cabinet Type

Retrieve the type definition of Cabinet instances.

HTTP Method

GET

156
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

157
Resources

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, page 153.

158
Resources

xCP Cabinet Type Collection


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

URI Template
/types/cabinets

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


ID URI of the entry, which contains http://localhost:8080/xcp-rest
the URI of the feed and name /types/cabinets/dm_cabinet
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 instance 2013-01-25T18:51:39.469Z
that this entry points to

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

159
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Cabinet Type Collection,
for Cabinet instances page 159

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

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

Get a Cabinet Type Collection

Retrieve a collection of type definitions for Cabinet instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

160
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

161
Resources

xCP Comment Single Instance


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

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
comment-id r_object-id of the comment

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

162
Resources

Link Relation Description Resource Reference


type Type definition of this resource xCP Comment Single Type,
page 175
self This Comment instance xCP Comment Single Instance,
page 162
edit Edit this Comment instance xCP Comment Single Instance,
page 162
delete [1] Delete this Comment instance xCP Comment Single Instance,
page 162
[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/

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

Get a Comment

Retrieve a Comment resource.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links

163
Resources

Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

164
Resources

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, page 175.
• Null values are presented as an empty string ("").

Update a Comment

Update a Comment resource.

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

Server Accepted Request Media Types

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

Query Parameters

None.

165
Resources

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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, page 175),
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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

Response Status
200 - Object updated successfully
400 - Bad request; invalid attribute name or value
401 - Authentication failed

166
Resources

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

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, page 175.
• Null values are presented as an empty string ("").

Create a Comment

Create a Comment resource.

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

Server Accepted Request Media Types

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

Query Parameters

None.

167
Resources

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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, page 175), 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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

168
Resources

404 - No object found


409 - Conflict
500 - Other unexpected server error

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, page 175.
• Null values are presented as an empty string ("").

Delete a Comment

Delete a Comment resource.

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

Query Parameters

None.

Request Headers

• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

169
Resources

Request Body

None.

Response Headers

None.

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

Response Body

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

170
Resources

xCP Comment Collection


A Comment collection represents a collection of comments instances, which can be attached to
business objects, contents, or folders.

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

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

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.

171
Resources

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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: /business-objects/ut200_bo_all
feed_uri/entry_id _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 instance 2013-01-25T18:51:39.469Z
that this entry points to

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, page
171
first, last, previous, next Pagination links xCP Comment Collection, page
171

Operations
A Comment collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Comment instances.

172
Resources

Get a Comment Collection

Retrieve a collection of Comment instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

173
Resources

Supported Response Media Types

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

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

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.

174
Resources

xCP Comment Single Type


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

URI Template
/types/comments/comment-type

comment-type Type of the Comment resources.

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 page 175
instances [1] Collection of the Comment xCP Comment Collection, page
instances 171
[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/

Operations
A Comment Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Comment
instances

Get a Comment Type

Retrieve the type definition of Comment instances

175
Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

176
Resources

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, page 171.

177
Resources

xCP Comment Type Collection


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

URI Template
/types/comments

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


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

Link Relation
The following table lists link relation(s) for a Comment Type collection resource.

178
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Comment Type Collection,
for Comment instances page 178

Operations
A Comment Type Collection resource supports the following HTTP method.

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

Get a Comment Collection

Retrieve a collection of type definitions for Comment instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

179
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

180
Resources

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.

URI Template
/contents/content-type/content-id

content-type Type of the content


content-id r_object-id of the content

Link Relation
The following table lists general link relations for a Content resource.

Link Relation Description Resource Reference


type Type definition of this resource xCP Content Single Type, page
199
instances [1] Collection of the Content xCP Content Collection, page
instances 193
self This Content instance xCP Content Single Instance,
page 181
edit Edit this Content instance xCP Content Single Instance,
page 181
delete [1] Delete this Content instance xCP Content Single Instance,
page 181
checkout [1] Check out this Content instance xCP Content Single Instance,
page 181
comments [1] Comments attached to this xCP Comment Collection, page
Content instance 171
add-comment Add a comment to this Content xCP Content Single Instance,
instance page 181
download-media [1] Link to the content binary xCP Raw Content, page 501
stream for download
checkin-next-major [1] Check in this Content instance xCP Content Single Type, page
as the next major version 199
checkin-current-version [1] Check in this Content instance xCP Content Single Type, page
as the current version 199

181
Resources

Link Relation Description Resource Reference


checkin-next-minor [1] Check in this Content instance xCP Content Single Type, page
as the next minor version 199
[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/

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

Get a Content

Retrieve the current version of a Content resource.

HTTP Method

GET

Query Parameters

The following query parameter is specific to this operation:

182
Resources

Parameter Description Data Type Default


recursive Specifies whether or not to list all boolean false
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, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

183
Resources

Supported Response Media Types

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

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

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, page 199.
• Null values are presented as an empty string ("").

Update a Content

Update the current version of a Content resource.

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

Server Accepted Request Media Types

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

184
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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, page 199),
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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

185
Resources

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

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, page 199.
• Null values are presented as an empty string ("").

Delete a Content

Delete a Content resource.

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

Query Parameters

None.

Request Headers

• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

186
Resources

Response Headers

None.

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

Response Body

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

Check out a Content

Check out a Content resource.

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

Server Accepted Request Media Types

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

Query Parameters

None.

187
Resources

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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, page 199),
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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

Response Status
201 - Content checked out successfully
400 - Bad request; invalid attribute name or value
401 - Authentication failed

188
Resources

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

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, page 199.
• Null values are presented as an empty string ("").

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, page 208.
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
Note:
• The request body must contain a reference to the content you uploaded by using the xCP File
Upload Resource, page 208 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>

189
Resources

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.

HTTP Method

POST

Server Accepted Request Media Types

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

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.

190
Resources

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

The request body contains a reference to the file you uploaded by using the xCP File Upload
Resource, page 208 resource and the metadata of the Content resource.

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

191
Resources

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, page 199.
• Null values are presented as an empty string ("").

192
Resources

xCP Content Collection


A Content collection represents a collection of Content instances.

URI Template
/contents/content-type

content-type Type of the content

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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
follows this pattern: -rest/contents/test-content
feed_uri/entry_id /186923apt7
Title Content name testContent.txt
Summary Content name testContent.txt
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Content collection resource.

193
Resources

Link Relation Description Resource Reference


self This collection resource xCP Content Collection, page
193
first, last, previous, next Pagination links xCP Content Collection, page
193

Operations
A Content collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Content instances.

POST Create a Content instance.

Get a Content Collection

Retrieve a collection of Content instances.

HTTP Method

GET

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, page 47 provides more information about common query
parameters.

194
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

195
Resources

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, page 208.
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

Note:
• The request body must contain a reference to the content you uploaded by using the xCP File
Upload Resource, page 208 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"
}
}

• 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, page 462
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"?>

196
Resources

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

HTTP Method

POST

Server Accepted Request Media Types

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

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

The request body contains the following:


• A reference to the file you uploaded by using the xCP File Upload Resource, page 208 resource or
a reference to a Template resource (xCP Template Single Instance, page 462)
• The metadata of the Content resource

197
Resources

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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, page 199.
• Null values are presented as an empty string ("").

198
Resources

xCP Content Single Type


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

URI Template
/types/contents/content-type

content-type Type of the Content

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, page
instances 199
instances [1] Collection of the Content xCP Content Collection, page
instances 193
[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/

Operations
A Content Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Content instances

Get a Content Type

Retrieve the type definition of Content instances.

HTTP Method

GET

199
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

200
Resources

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, page 193.

201
Resources

xCP Content Type Collection


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

URI Template
/types/contents

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


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

Link Relation
The following table lists link relation(s) for a Content Type collection resource.

202
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Content Type Collection,
for Content instances page 202

Operations
A Content Type Collection resource supports the following HTTP method.

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

Get a Content Type Collection

Retrieve a collection of type definitions for Content instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

203
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

204
Resources

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.

URI Template
/currentuser

Link Relation
The following table lists general link relations for a Current User resource.

Link Relation Description Resource Reference


type Type definition of this resource xCP Member Single Type, page
314
preferences [1] Preferences of the current user xCP User Preference Single
Instance, page 476
self This Current User instance xCP Current User Instance,
page 205
roles [1] Application roles to which this xCP Member Collection, page
Current User instance belongs 307
[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/

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, page 476.
GET Retrieve application roles to which a current
user belongs. See xCP Member Collection, page
307.

205
Resources

Get the Current User

Retrieve the metadata, type definition, and preferences of the current user.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

206
Resources

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

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, page 314.
• Null values are presented as an empty string ("").

207
Resources

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,
page 196).

URI Template
/files

Link Relation
This resource does not contain any link relation.

Operations
A File Upload resource supports the following HTTP method.

Method Description
POST Upload a file to a temporary folder

Upload a File

Upload a file to a temporary folder.

HTTP Method

POST

Query Parameters

None.

Request Headers

• Accept
• Authorization

208
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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

Response Headers

• Location
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

multipart/form-data

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

209
Resources

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 example above, 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 example above,
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": "EMC 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"
}]
}]
}

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.

210
Resources

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.

211
Resources

xCP Folder Single Instance


A single instance of Folder represents a folder, which is an instance of dm_folder or one of its
subtypes.

URI Template
/folders/folder-type/folder-id

folder-type Type of the folder


folder-id Object ID of the folder

Link Relation
The following table lists general link relations for a Folder resource.

Link Relation Description Resource Reference


type Type definition of this resource xCP Folder Single Type, page
228
instances [1] Collection of the Folder xCP Folder Collection, page 225
instances
self This instance xCP Folder Single Instance,
page 212
edit Edit this instance xCP Folder Single Instance,
page 212
delete [1] Delete this instance xCP Folder Single Instance,
page 212
comments [1] Comments attached to the xCP Comment Collection, page
Folder instance 171
add Add an instance of an object xCP Folder Single Instance,
inside this Folder instance page 212
add-comment Add a comment to the Folder xCP Folder Single Instance,
instance page 212
objects [1] Objects in the Folder instance xCP Content Collection, page
193
[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/

212
Resources

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

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.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

213
Resources

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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, page 228.
• Null values are presented as an empty string ("").

Update a Folder

Update a Folder resource.

214
Resources

HTTP Method

POST

Server Accepted Request Media Types

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

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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, page 228),
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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

215
Resources

Supported Response Media Types

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

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

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, page 228.
• Null values are presented as an empty string ("").

Create a Folder

Create a Folder resource.

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

Server Accepted Request Media Types

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

216
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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, page 228), 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

217
Resources

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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, page 228.
• Null values are presented as an empty string ("").

Copy a Document to a Folder

Copy a document (a Content instance) to a folder by using the objects link relation.

HTTP Method

POST

218
Resources

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

Server Accepted Request Media Types

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

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

A reference to the Content instance to copy.


{
"href":"/contents/content-type/content-id"
}
For example:
{
"href":"/contents/contents/dm_document/0900492d80012f02"
}

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

219
Resources

Supported Response Media Types

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

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

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: "EMC 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"
href: "contents/dm_document/2901492f80012f44"
}
}

220
Resources

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

Move a Document to a Folder

Move a document (a Content instance) to a folder by using the objects link relation.

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

Server Accepted Request Media Types

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

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type

221
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

222
Resources

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 Objects in Folder, page 220.

Delete a Folder

Delete a Folder resource.

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

Query Parameters

None.

Request Headers

• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

None.

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

223
Resources

409 - State conflicted


500 - Other unexpected server error

Response Body

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

224
Resources

xCP Folder Collection


A Folder collection represents a collection of Folder instances of a certain folder type.

URI Template
/folders/folder-type

folder-type Type of the folder

Feed and EDAA Support


A collection of Folder 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
/folders/test-folder-type
Title Folder type test-folder-type
Updated Value of the updated property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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
follows this pattern: -rest/folders/test-folder-type
feed_uri/entry_id /0b5db83d80020938
Title Entry title test-folder-type-1
Summary Entry summary test-folder-type-1
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Folder collection resource.

225
Resources

Link Relation Description Resource Reference


self This collection resource xCP Folder Collection, page 225
first, last, previous, next Pagination links xCP Folder Collection, page 225

Operations
A Folder collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Folder instances.

Get a Folder Collection

Retrieve a collection of Folder instances.

HTTP Method

GET

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, page 47 provides more information about common query
parameters.

226
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

Response Body

XML or JSON representation of a collection of Folder instances.


• Each instance may contain all or a set of properties of the Folder 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.

227
Resources

xCP Folder Single Type


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

URI Template
/types/folders/folder-type

folder-type Type of the folder

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, page
instances 228
instances [1] Collection of the Folder xCP Folder Collection, page 225
instances
defaults [1] Defaults of the type definition xCP Folder Single Type, page
228
[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/

Operations
A Folder Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Folder instances

Get a Folder Type

Retrieve the type definition of Folder instances.

228
Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

229
Resources

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 Collection,
page 225.

230
Resources

xCP Folder Type Collection


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

URI Template
/types/folders

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
Updated Value of the updated property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


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

Link Relation
The following table lists link relation(s) for a Folder Type collection resource.

231
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Folder Type Collection,
for Folder instances page 231

Operations
A Folder Type Collection resource supports the following HTTP method.

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

Get a Folder Type Collection

Retrieve a collection of type definitions for Folder instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

232
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

233
Resources

xCP Format Single Instance


A single instance of Format is a resource that defines the format of a file based on its file extension.

URI Template
/formats/format-type/format-id

format-type Type of the format


format-id Format ID

Link Relation
The following table lists general link relations for a Format resource.

Link Relation Description Resource Reference


type Type definition of this resource xCP Format Single Type, page
240
instances [1] Collection of the Format xCP Format Collection, page
instances 237
self This Format instance xCP Format Single Instance,
page 234
[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/

Operations
A Format resource supports the following HTTP methods.

Method Description
GET Retrieve a Format resource

Get a Format

Retrieve a Format resource.

234
Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

Response Status
200 - Information retrieved successfully
204 - No Content

235
Resources

400 - Invalid syntax or missing a required value


401 - Invalid or missing authentication credentials
403 - Permission denied
500 - Other unexpected server error

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, page 240.
• Null values are presented as an empty string ("").

236
Resources

xCP Format Collection


A Format collection represents a collection of Format instances of a certain type.

URI Template
/formats/format-type

format-type Type of the format

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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
follows this pattern: -rest/formats/xcp_format
feed_uri/entry_id /275db83d80000102
Title name property of the format test-format
resource
Summary description property of the This is a test format
format resource
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

237
Resources

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, page
237
first, last, previous, next Pagination links xCP Format Collection, page
237

Operations
A Format collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Format instances.

Get a Format Collection

Retrieve a collection of Format instances of a certain type.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

238
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

239
Resources

xCP Format Single Type


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

URI Template
/types/format-type

format-type Type of the format

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, page
instances 240
instances [1] Collection of the Format xCP Format Collection, page
instances 237
[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/

Operations
A Format Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Format instances

Get a Format Type

Retrieve the type definition of Format instances.

HTTP Method

GET

240
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

241
Resources

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,
page 237.

242
Resources

xCP Format Type Collection


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

URI Template
/types/formats

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


ID URI of the entry, which contains http://localhost:8080/xcp-rest
the URI of the feed and name /types/formats/test-format
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 instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Format Type collection resource.

243
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Format Type Collection,
for Format instances page 243

Operations
A Format Type Collection resource supports the following HTTP method.

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

Get a Format Type Collection

Retrieve a collection of type definitions for Format instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

244
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

245
Resources

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, page 252 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, page 56.

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

Link Relation
The following table lists general link relations for a Fragment resource.

Link Relation Description Resource Reference


type Type definition of this instance xCP Fragment Single Type,
page 252
self This Fragment instance xCP Fragment Single Instance,
page 246

Operations
A Fragment resource supports the following HTTP methods.

246
Resources

Method Description
GET Retrieve a Fragment instance

POST Attach an aspect (Fragment instance) to a


persistent object

Get a Fragment

Retrieve a Fragment instance attached to a persistent object.

HTTP Method

GET

Example 4-23. Request Example


http://127.0.0.1:8000/xCPApp/business-objects/utapp21_bo_with_aspect/0800492d8001d71b/
fragments/utapp21_aspect_all_attrs

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

247
Resources

Response Headers

• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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, page 252.
• Null values are presented as an empty string ("").

Example 4-24. 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",
"href": "types/fragments/o18_aspect1"},
{"rel": "self",
"href": "types/fragments/o18_aspect1/defaults"}
]
}

248
Resources

Attach an Aspect to an Object

Attach an aspect (Fragment instance) to a persistent object.

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, page 252 and the subsection
Fragments in xCP Common Elements, page 56.

Server Accepted Request Media Types

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

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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-25. Sample Request in JSON


{

249
Resources

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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

250
Resources

404 - No object found


409 - Conflict
500 - Other unexpected server error

Response Body

XML or JSON representation of the persistent object with the newly-attached aspect presented in the
fragments section.

251
Resources

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, page 253.

URI Template
/types/fragments/fragment-type

fragment-type Type of the fragment

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

Operations
A Fragment Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Fragment
instances

Get a Fragment Type

Retrieve the type definition of Fragment instances.

HTTP Method

GET

252
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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

253
Resources

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-26. 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"
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>

254
Resources

xCP Fragment Type Collection


A Fragment Type collection is a resource that represents a collection of type definitions for Fragment
instances.

URI Template
/types/fragments

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


ID URI of the entry, which is the http://localhost:8080/xcp-rest
URI of the feed with the name /types/fragments/utapp21
of the type appended. _aspect_all_attrs
Title Entry title utapp21_aspect_all_attrs
Summary Entry summary Utapp21 Aspect All Attrs
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Fragment Type collection resource.

255
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Fragment Type Collection,
for Fragment instances page 255

Operations
A Fragment Type Collection resource supports the following HTTP method.

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

Get a Fragment Type Collection

Retrieve a collection of type definitions for Fragment instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

256
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

257
Resources

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.

URI Template
/fulltext-queries/query_name

query_name Name of the full-text query

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, page 258
type Type definition of this resource xCP Full-Text Query Single
Type, page 271

Operations
A Full-Text Query resource supports the following HTTP method.

Method Description
GET Retrieve the results of a full-text query

Perform a Full-Text Query

Perform a full-text query in a repository and navigate the results using facets.

HTTP Method

GET

258
Resources

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, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

259
Resources

Supported Response Media Types

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

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

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-27. 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>EMC Documentum</name>
</author>
<dm:page>1</dm:page>
<dm:items-per-page>10</dm:items-per-page>
<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"/>

260
Resources

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

261
Resources

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

262
Resources

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

263
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-28. Query Results in EDAA Collection


{
"id": "fulltext-queries/iigbook_book_ftq",
"title": "iigbook_book_ftq",
"updated": "2014-01-23T09:12:07.323Z",
"author": "EMC 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",

264
Resources

"borrow_times": 0,
"page": 382,
"image_url": "http://img3.douban.com/mpic/s8099754.jpg",
"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",

265
Resources

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

266
Resources

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

267
Resources

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

268
Resources

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

269
Resources

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

270
Resources

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.

URI Template
/types/fulltext-queries/query-type

query-type Type of the full-text query

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, page 271
instances [1] Full-Text Query instance xCP Full-Text Query Single
Instance, page 258
[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/

Operations
A Full-Text Query Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of a full-text query

Get a Full-Text Query Type

Retrieve the type definition of a full-text query.

271
Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

272
Resources

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

273
Resources

xCP Full-Text Query Type Collection


A Full-Text Query Type collection represents a collection of type definitions for Full-Text Query
instances.

URI Template
/types/fulltext-queries

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


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

Link Relation
The following table lists link relation(s) for a Full-Text Query Type collection resource.

274
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Full-Text Query Type
for Full-Text Query instances Collection, page 274

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

Get a Full-Text Query Type Collection

Retrieve a collection of type definitions for Full-Text Query instances.

HTTP Method

GET

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, page 47 provides more information about common query
parameters.

275
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

276
Resources

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.

URI Template
historical-queries/historical-query-name/sequence_number

historical-query-name Type of the historical query


sequence_number Zero-based sequence number

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, page 280
[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/

Operations
A Historical Query resource supports the following HTTP method.

Method Description
GET Retrieve a Historical Query resource

Get a Historical Query

Retrieve a Historical Query instance.

277
Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

Response Status
200 - Information retrieved successfully
204 - No Content

278
Resources

400 - Invalid syntax or missing a required value


401 - Invalid or missing authentication credentials
403 - Permission denied
500 - Other unexpected server error

Response Body

XML or JSON representation of the Historical Query resource.


Null values are presented as an empty string ("").

279
Resources

xCP Historical Query Collection


A Historical Query collection represents a collection of Historical Query instances.

URI Template
historical-queries/historical-query-name

historical-query-name Type of the historical query

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
Title Historical Queries Historical Queries
Updated Value of the updated property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


ID URI of the entry, which follows http://127.0.0.1:8080/xcp-rest
this pattern: <Feed_URI> /historical-queries/ut200_hq
/<sequence_number> _bo_all_attribute/0
Title Entry title Entry title
Summary Entry summary Entry summary
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Historical Query collection resource.

280
Resources

Link Relation Description Resource Reference


self This collection resource xCP Historical Query
Collection, page 280
first, last, previous, next Pagination links xCP Historical Query
Collection, page 280

Operations
A Historical Query collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Historical Query
instances.

Get a Historical Query Collection

Retrieve a collection of Historical Query instances.

HTTP Method

GET

Query Parameters

The following query parameters are specific to this operation:

Name Description Data Type Value Range Default


Value
time-dimension Controls the time granularity aspect string HOURLY, DAILY
for BAM reports. This parameter DAILY,
specifies the aggregation table from WEEKLY,
which the request retrieves data. For QUARTERLY,
example, if you set this parameter to and YEARLY
HOURLY, the request retrieves data
from the HOURLY aggregation table.
relative-last-time Specifies the relative period of time integer =>1 1
to look back for.

For example, the following


combination retrieves data of the
last two hours from the hourly

281
Resources

Name Description Data Type Value Range Default


Value
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, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

282
Resources

• application/xml (For compatible viewing)


• application/json (For compatible viewing)

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

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.

283
Resources

xCP Historical Query Single Type


A single instance of Historical Query Type represents the type definition of Historical Query instances.

URI Template
/types/historical-queries/historical-query-type

historical-query-type Type of the historical query

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, page 284
instances [1] Collection of the Historical xCP Historical Query
Query instances Collection, page 280
[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/

Operations
A Historical Query Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Historical Query
instances

Get a Historical Query Type

Retrieve the type definition of Historical Query instances.

284
Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

285
Resources

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, page 280.

286
Resources

xCP Historical Query Type Collection


A Historical Query Type collection represents a collection of type definitions for Historical Query
instances.

URI Template
/types/historical-queries

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


ID URI of the entry, which contains /types/historical-queries/xcp
the URI of the feed and name -historical-query
of the type
Title Title xcp-historical-query
Summary Summary xcp-historical-query
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Historical Query Type collection resource.

287
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Historical Query Type
for Historical Query instances Collection, page 287

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

Get a Historical Query Type Collection

Retrieve a collection of type definitions for Historical Query instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

288
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

289
Resources

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.

URI Template
/service

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,
page 413
application [1] Application instance xCP Application Single
Instance, page 100
business-object-types [1] Type definitions of business xCP Business Object Single
objects Type, page 136
content-types [1] Type definitions of contents xCP Content Single Type, page
199
folder-types [1] Type definitions of folders xCP Folder Single Type, page
228
picklist-types [1] Type definitions of picklist xCP Picklist Single Type, page
332
relationship-types [1] Type definitions of xCP Relationship Single Type,
relationships page 400
alert-types [1] Type definitions of alerts xCP Alert Single Type, page 88
processes [1] Type definitions of processes xCP Process Single Type, page
349
fulltext-query [1] Type definitions of fulltext xCP Full-Text Query Single
queries Type, page 271
historical-query [1] Type definitions of historical xCP Historical Query Single
queries Type, page 284
realtime-query [1] Type definitions of realtime xCP Real-Time Query Single
queries Type, page 383
alert-query [1] Type definitions of alert queries xCP Alert Query Single Type,
page 75

290
Resources

Resource Description Resource Reference


tasklist-query [1] Type definitions of tasklist xCP Tasklist Query Single
queries Type, page 455
upload [1] File upload xCP File Upload Resource,
page 208
about Product information xCP Product Information
Single Instance, page 355
[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/

Operations
The Home Document resource supports the following HTTP method.

Method Description
GET Retrieve the Home Document resource

Get the Home Document

Retrieve the Home Document, which contains information about the resources, media types, and
operations that the REST Server supports.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

291
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

Response Body

XML or JSON representation of the Home Document resource.

Example 4-29. Home Document in JSON


{
"resources": {
"http://identifiers.emc.com/linkrel/repositories": {
"href": "repositories/xcp_repository",
"hints": {

292
Resources

"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",
"application/vnd.emc.xcp+json",
"application/atom+xml"]
}
},
"http://identifiers.emc.com/linkrel/relationship-types": {
"href": "types/relationships",
"hints": {

293
Resources

"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"]
}
},
"http://identifiers.emc.com/linkrel/alert-query": {
"href": "types/alert-queries",

294
Resources

"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-30. 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>

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

296
Resources

<resource rel="http://identifiers.emc.com/linkrel/relationship-types">
<link href="types/relationships" />
<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/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>

297
Resources

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

298
Resources

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

299
Resources

xCP Member Single Instance


A single instance of Member represents one of the following objects:
• user
• group
• role

URI Template
/members/xcp_member/member-id

member-id r_object-id of the Member resource

Link Relation
The following table lists general link relations for a Member resource.

Link Relation Description Resource Reference


type Type definition of this resource xCP Member Single Type, page
314
potentialmembers [1] Collection of potential members xCP Member Collection, page
of this Member. 307

This link relation only exists in


role and group members.
members [1] Collection of the Member xCP Member Collection, page
instances that belong to this 307
Member.

This link relation only exists in


role and group members.
self This Member instance xCP Member Single Instance,
page 300
preferences Preferences of the Member xCP User Preference Single
Instance, page 476
[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/

300
Resources

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

Get a Member

Retrieve a Member resource.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

301
Resources

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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, page 314.
• 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: "dmadmin@localhost.com"
}
links:
{
rel: "type"
href: "types/members/xcp_member"
}
{

302
Resources

rel: "self"
href: "members/xcp_member/1101e24080000102"
}
{
rel: "http://identifiers.emc.com/linkrel/preferences"
href: "preferences/xcp_preference"
}
}

Add a Member

Add an existing member to a role or group member.

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

Server Accepted Request Media Types

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

Query Parameters

The following query parameter is specific to this operation:

Parameter Description Data Type Default


member-of r_object-id of integer NA
the member resource
to which you add a
member

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

303
Resources

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

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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, page 314.
• Null values are presented as an empty string ("").

304
Resources

Remove a Member

Remove a member from a role or group member.

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

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

Request Headers

• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

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

Response Headers

None.

Response Status
204 - Object deleted successfully

305
Resources

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

Response Body

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

306
Resources

xCP Member Collection


A Member collection represents a collection of Member instances.

URI Template
/Members/member-type

member-type Type of the member

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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
follows this pattern: -rest/members/xcp_member
feed_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 instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Member collection resource.

307
Resources

Link Relation Description Resource Reference


self This collection resource xCP Member Collection, page
307
first, last, previous, next Pagination links xCP Member Collection, page
307

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

Get a Member Collection

Retrieve a collection of Member instances of a certain type.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

308
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

309
Resources

Get a Member Collection of a Role or Group

Retrieve a collection of Member instances under a role or group.

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

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, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

310
Resources

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

Get a Potential Member Collection of a Role or Group

Retrieve a collection of Potential Member instances under a role or group.

311
Resources

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

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, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

312
Resources

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

313
Resources

xCP Member Single Type


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

URI Template
/types/member-type

member-type Type of the Members

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, page
instances 314
instances [1] Collection of the Member xCP Member Collection, page
instances 307
[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/

Operations
A Member Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Member instances

Get a Member Type

Retrieve the type definition of Member instances.

HTTP Method

GET

314
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

315
Resources

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, page 307.

316
Resources

xCP Member Type Collection


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

URI Template
/types/members

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


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

Link Relation
The following table lists link relation(s) for a Member Type collection resource.

317
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Member Type Collection,
for Member instances page 317

Operations
A Member Type Collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
Member Type instances

Get a Member Type Collection

Retrieve a collection of type definitions for Member Type instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

318
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

319
Resources

xCP Network Location Single Instance


A single instance of Network Location is a resource that records information about the network
locations of hosts.

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

Link Relation
The following table lists general link relations for a Network Location resource.

Link Relation Description Resource Reference


type Type definition of this resource xCP Network Location Single
Type, page 326
self This Network Location instance xCP Network Location Single
Instance, page 320

Operations
A Network Location resource supports the following HTTP method.

Method Description
GET Retrieve a Network Location resource

Get a Network Location

Retrieve a Network Location resource.

HTTP Method

GET

320
Resources

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

321
Resources

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, page 326.
• Null values are presented as an empty string ("").

322
Resources

xCP Network Location Collection


A Network Location collection represents a collection of Network Location instances.

URI Template
/network-locations/networklocation-type

networklocation-type Type of the network location

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
Updated Value of the updated property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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
follows this pattern: -rest/network-locations
feed_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 instance 2013-01-25T18:51:39.469Z
that this entry points to

323
Resources

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, page 323
first, last, previous, next Pagination links xCP Network Location
Collection, page 323

Operations
A Network Location collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Network Location
instances.

Get a Network Location Collection

Retrieve a collection of Network Location instances of a certain type.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

324
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

325
Resources

xCP Network Location Single Type


A single instance of Network Location Type represents the type definition of Network Location
instances.

URI Template
/types/network-locations/networklocation-type

networklocation-type Type of the network location

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 Single
Location instances Type, page 326
instances [1] Collection of the Network xCP Network Location
Location instances Collection, page 323
[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/

Operations
A Network Location Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Network Location
instances

Get a Network Location Type

Retrieve the type definition of Network Location instances.

326
Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

327
Resources

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, page 323.

328
Resources

xCP Network Location Type Collection


A Network Location Type collection represents a collection of type definitions for Network Location
instances.

URI Template
/types/network-locations

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


ID URI of the entry, which contains http://localhost:8080/xcp-rest
the URI of the feed and name /types/network-locations/xcp
of the type -network-location
Title Name of the network location xcp-network-location
type
Summary Summary xCP Network locations
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Network Location Type collection resource.

329
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Network Location Type
for Network Location instances Collection, page 329

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

Get a Network Location Type Collection

Retrieve a collection of type definitions for Network Location instances.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

330
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

331
Resources

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.

URI Template
/types/picklists/picklist-type

picklist-type Type of the picklist

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, page
332

Operations
A Picklist Type resource supports the following HTTP method.

Method Description
GET Retrieve a Picklist Type resource

Get a Picklist

Retrieve a Picklist Type resource, which describes the type definition of a certain value.

HTTP Method

GET

Query Parameters

None.

332
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

Response Body

XML or JSON representation of the Picklist Type resource.

Example 4-31. 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"

333
Resources

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-32. 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
} ]
}

334
Resources

xCP Picklist Type Collection


A Picklist Type collection represents a collection of Picklist type definitions.

URI Template
/types/picklists

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


ID URI of the entry, which contains http://localhost:8080/xcp-rest
the URI of the feed and name /types/picklists/xcp_wq_view
of the type _filter
Title Type of the picklist xcp_wq_view_filter
Summary Summary Workqueue View Filter Picklist
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Picklist Type collection resource.

335
Resources

Link Relation Description Resource Reference


self Collection of Picklist type xCP Picklist Type Collection,
definitions page 335

Operations
A Picklist Type Collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Picklist type definitions

Get a Picklist Type Collection

Retrieve a collection of Picklist type definitions.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

336
Resources

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

337
Resources

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.

URI Template
/processes/process-system-name/object-id

process-system-name System name of the process


object-id Object ID of the process

Link Relation
The following table lists general link relations for a Process resource.

Link Relation Description Resource Reference


type Type definition of this resource xCP Process Single Type, page
349
instances [1] Collection of the Process xCP Process Collection, page 343
instances
self This Process instance xCP Process Single Instance,
page 338
tasks Tasks belong to this Process xCP Task Collection, page 441
instance
attachments Business objects involved in xCP Business Object Collection,
this Process instance page 133
terminate Terminate this Process /processes/process-system
instance -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/

338
Resources

Operations
A Process resource supports the following HTTP methods.

Method Description
GET Retrieve a Process resource

PUT Update the status of a Process resource

Get a Process

Retrieve the metadata, packages, and variables of a Process resource.

HTTP Method

GET

Query Parameters

This operation does not support any query parameters.

Request Headers

• Accept
• Content-Type
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

339
Resources

Supported Response Media Types

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

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

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, page 349.
• Null values are presented as an empty string ("").

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

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

340
Resources

Server Accepted Request Media Types

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

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

XML or JSON representation of the status of the Process resource.

Example 4-33. Resume a halted process


<resume>
<user-name>testUser</user-name>
</resume>

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

341
Resources

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

Response Body

The response does not contain any data.

342
Resources

xCP Process Collection


A Process collection represents a collection of Process instances of a specific process.

URI Template
/processes/process-system-name

process-system-name System name of the process

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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
follows this pattern: -rest/processes/xcp-process
feed_uri/entry_id /4d01e24080030611
Title Entry title xcp-process
Summary Entry summary xcp process
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Process collection resource.

343
Resources

Link Relation Description Resource Reference


self This collection resource xCP Process Collection, page
343
first, last, previous, next Pagination links xCP Process Collection, page
343

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.

Get a Process Collection

Retrieve a collection of Process instances of a certain type.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

344
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

345
Resources

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.

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

Server Accepted Request Media Types

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

Query Parameters

None.

Request Headers

• Accept
• Authorization
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

XML or JSON representation of the Process resource.


• If the corresponding DML type (xCP Process Single Type, page 349) 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, page 349), the field is ignored.

346
Resources

• 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-34. 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-35. 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>

347
Resources

Response Headers

• Location
• Content-Length
• Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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, page 349.
• Null values are presented as an empty string ("").

348
Resources

xCP Process Single Type


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

URI Template
/types/processes/process-system-name

process-system-name System name of the process resource

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, page
instances 349
instances [1] Collection of the Process xCP Process Collection, page
instances 343
[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/

Operations
A Process Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of the process

Get a Process Type

Retrieve the type definition of the process.

HTTP Method

GET

349
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

350
Resources

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, page 343.

351
Resources

xCP Process Type Collection


A Process Type collection represents a collection of type definitions for processes.

URI Template
/types/processes

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


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

Link Relation
The following table lists link relation(s) for a Process Type collection resource.

352
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Process Type Collection,
for Process instances page 352

Operations
A Process Type Collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of type definitions for
processes

Get a Process Type Collection

Retrieve a collection of type definitions for processes.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

353
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

354
Resources

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.

URI Template
/product-info

Link Relation
The following table lists general link relations for a Product Information resource.

Link Relation Description Resource Reference


type Type definition of this resource xCP Product Information Type,
page 358
about This Product Information xCP Product Information
instance Single Instance, page 355
self This Product Information xCP Product Information
instance Single Instance, page 355

Operations
A Product Information resource supports the following HTTP method.

Method Description
GET Retrieve a Product Information resource

Get Product Information

Retrieve general information about the product, including the product name, major version, minor
version, and so on.

HTTP Method

GET

355
Resources

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

356
Resources

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, page 358.
• Null values are presented as an empty string ("").

357
Resources

xCP Product Information Type


A Product Information Type represents the type definition of the Product Information instance.

URI Template
/types/products/xcp_product_info

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 Product xCP Product Information Type,
Information instance page 358
about Product Information instance xCP Product Information
Single Instance, page 355

Operations
A Product Information Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of the Product
Information instance

Get a Product Information Type

Retrieve the type definition of the Product Information instance.

HTTP Method

GET

Query Parameters

None.

358
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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, page 355.

359
Resources

xCP Product Information Type Collection


A Product Information Type collection represents a collection of type definitions for the Product
Information instance.

URI Template
/types/products

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


ID URI of the entry, which contains http://localhost:8080/xcp-rest
the URI of the feed and name /types/products/xcp_product
of the type _info
Title Type name xcp_product_info
Summary Summary Application Product Info
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Product Information Type collection resource.

360
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Product Information Type
for the Product Information Collection, page 360

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

Get a Product Information Type Collection

Retrieve a collection of type definitions for the Product Information instance.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization

361
Resources

Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

362
Resources

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, page 369.

URI Template
/projects/xcp_project/project_name

project_name Name of the project

Link Relation
The following table lists general link relations for a Project resource.

Link Relation Description Resource Reference


type Type definition of this resource xCP Project Single Type, page
369
self This Project instance xCP Project Single Instance,
page 363

Operations
A Project resource supports the following HTTP method.

Method Description
GET Retrieve a Project resource

Get a Project

Retrieve a Project resource.

363
Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

Response Status
200 - Information retrieved successfully
204 - No Content

364
Resources

400 - Invalid syntax or missing a required value


401 - Invalid or missing authentication credentials
403 - Permission denied
500 - Other unexpected server error

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, page 369.
• Null values are presented as an empty string ("").

365
Resources

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, page 369.

URI Template
/projects/xcp_project

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC 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: /projects/sample-project
feed_uri/entry_id
Title Entry title sample-project
Summary Entry summary Sample Project
Updated Last update time of the instance 2013-01-25T18:51:39.469Z
that this entry points to

Link Relation
The following table lists link relation(s) for a Project collection resource.

366
Resources

Link Relation Description Resource Reference


self This collection resource xCP Project Collection, page
366
first, last, previous, next Pagination links xCP Project Collection, page
366

Operations
A Project collection resource supports the following HTTP method.

Method Description
GET Retrieve a collection of Project instances.

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, page 369.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

367
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

368
Resources

xCP Project Single Type


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

URI Template
types/projects/xcp_project
Only one project type (xcp_project) exists.

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, page
instances 369
instances [1] Collection of the Project xCP Project Collection, page
instances 366
[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/

Operations
A Project Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of Project instances

Get a Project Type

Retrieve the type definition of xCP projects.

HTTP Method

GET

369
Resources

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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
Resources

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,
page 366.

371
Resources

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.

URI Template
/types/projects

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 property 2013-01-25T18:51:39.469Z
of the last updated entry in the
feed
Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

Feed Property Feed Value Example


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

Link Relation
The following table lists link relation(s) for a Project Type collection resource.

372
Resources

Link Relation Description Resource Reference


self Collection of type definitions xCP Project Type Collection,
for Project instances page 372

Operations
A Project Type Collection resource supports the following HTTP method.

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

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.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

373
Resources

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

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.

374
Resources

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.

URI Template
queues/xcp_queue?filter=tasklist-query-type='tasklist-query
-name'&currentuser=true

tasklist-query-name Name of the task list query

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,
page 375

Operations
A Queue List resource supports the following HTTP method.

Method Description
GET Retrieve a Queue List resource

Get a Queue List

Retrieve a Queue List instance of the current user.

HTTP Method

GET

375
Resources

Query Parameters

This operation supports the following common query parameters:


• view
• links
• inline
• items-per-page
• page
• include-total
• sort
Common Definition - Query Parameters, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

376
Resources

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

Response Body

XML or JSON representation of the Queue List resource.

Example 4-36. Response in JSON


{
"id": "queues/xcp_queue",
"title": "xcp_queue",
"updated": "2013-12-09T20:53:13.992-08:00",
"author": "EMC 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"
},
"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"

377
Resources

},
"links": [{
"rel": "edit",
"href": "queues/xcp_queue/null"
}]
}]
}

Example 4-37. 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>EMC 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>

378
Resources

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.

URI Template
/realtime-queries/query_name

query_name Name of the real-time query

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 instance xCP Real-Time Query Single
Instance, page 379
type Type definition of this resource xCP Real-Time Query Single
Type, page 383

Operations
A Real-Time Query resource supports the following HTTP method.

Method Description
GET Retrieve the results of a real-time query

Perform a Real-Time Query

Perform a real-time query on metadata of objects in a repository.

HTTP Method

GET

379
Resources

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, page 47 provides more information about common query
parameters.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

380
Resources

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

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-38. 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>EMC 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>
<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-39. Query Results in EDAA Collection


{

381
Resources

id: "realtime-queries/xcp_folder_rt_query"
title: "xcp_folder_rt_query"
updated: "2014-01-23T17:43:08.442+08:00"
author: "EMC 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"
summary: "utapp21_folder_all_attrs-92076"
content: {
src: "realtime-queries/xcp_folder_rt_query/278070062"
content-type: "application/vnd.emc.xcp+json"
}
}
}

382
Resources

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.

URI Template
/types/realtime-queries/query-type

query-type Type of the real-time query

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, page 383
instances [1] Real-Time Query instance xCP Real-Time Query Single
Instance, page 379
[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/

Operations
A Real-Time Query Type resource supports the following HTTP method.

Method Description
GET Retrieve the type definition of a real-time query

Get a Real-Time Query Type

Retrieve the type definition of a real-time query.

383
Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept
• Authorization
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type
Common Definition - HTTP Headers , page 45 provides more information about HTTP headers.

Supported Response Media Types

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

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

384
Resources

Response Body

XML or JSON representation of the type definition of a real-time 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.
sort Specifies sort settings.
options Specifies which version of the result to return.
Valid values are:
• LATEST: Only