EMC® Documentum®

xCP REST ServicesVersion 2.2

Development Guide

EMC CorporationCorporate Headquarters

Hopkinton, MA 01748-91031-508-435-1000www.EMC.com

Legal Notice

Copyright © 2014-2015 EMC Corporation. All Rights Reserved.

EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATIONMAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com. Adobe and Adobe PDFLibrary are trademarks or registered trademarks of Adobe Systems Inc. in the U.S. and other countries. All other trademarksused herein are the property of their respective owners.

Documentation Feedback

Your opinion matters. We want to hear from you regarding our product documentation. If you have feedback about how we canmake our documentation better or easier to use, please send us your feedback directly at IIGDocumentationFeedback@emc.com

Table of Contents

Preface ................................................................................................................................ 37

Chapter 1 Overview ..................................................................................................... 39

Chapter 2 General REST Definitions ............................................................................ 41Common Definition - HTTP Headers ................................................................ 41Common Definition - Query Parameters ............................................................ 43Property View .............................................................................................. 46Predefined View Expression...................................................................... 46Custom View Expression .......................................................................... 46View Expression Syntax ............................................................................ 46

Server Configuration Parameters ....................................................................... 47HTTP Status Codes........................................................................................... 49Representation ................................................................................................. 50xCP Common Elements .................................................................................... 50

Chapter 3 Authentication ............................................................................................. 55Authentication with HTTP Basic........................................................................ 55

Chapter 4 Resources ................................................................................................... 57xCP Alert Query Single Instance........................................................................ 57URI Template ............................................................................................... 57Link Relation................................................................................................ 57Operations ................................................................................................... 57Perform an Alert Query ............................................................................ 57HTTP Method ...................................................................................... 58Query Parameters................................................................................. 58Request Headers .................................................................................. 58Request Body ....................................................................................... 58Response Headers ................................................................................ 58Supported Response Media Types ......................................................... 59Response Status.................................................................................... 59Response Body ..................................................................................... 59

xCP Alert Query Single Type............................................................................. 61URI Template ............................................................................................... 61Link Relation................................................................................................ 61Operations ................................................................................................... 61Get an Alert Query Type ........................................................................... 61HTTP Method ...................................................................................... 61Query Parameters................................................................................. 62Request Headers .................................................................................. 62Request Body ....................................................................................... 62Response Headers ................................................................................ 62Supported Response Media Types ......................................................... 62Response Status.................................................................................... 62

3

Table of Contents

Response Body ..................................................................................... 62xCP Alert Query Type Collection ....................................................................... 63URI Template ............................................................................................... 63Feed and EDAA Support .............................................................................. 63Link Relation................................................................................................ 63Operations ................................................................................................... 64Get an Alert Query Type Collection ........................................................... 64HTTP Method ...................................................................................... 64Query Parameters................................................................................. 64Request Headers .................................................................................. 64Request Body ....................................................................................... 65Response Headers ................................................................................ 65Supported Response Media Types ......................................................... 65Response Status.................................................................................... 65Response Body ..................................................................................... 65

xCP Alert Single Instance .................................................................................. 66URI Template ............................................................................................... 66Link Relation................................................................................................ 66Operations ................................................................................................... 66Get an Alert ............................................................................................. 66HTTP Method ...................................................................................... 67Query Parameters................................................................................. 67Request Headers .................................................................................. 67Request Body ....................................................................................... 67Response Headers ................................................................................ 67Supported Response Media Types ......................................................... 67Response Status.................................................................................... 67Response Body ..................................................................................... 68

Update Alert Status .................................................................................. 68HTTP Method ...................................................................................... 68Server Accepted Request Media Types ................................................... 68Query Parameters................................................................................. 68Request Headers .................................................................................. 68Request Body ....................................................................................... 69Response Headers ................................................................................ 69Supported Response Media Types ......................................................... 69Response Status.................................................................................... 69Response Body ..................................................................................... 70

xCP Alert Collection ......................................................................................... 71URI Template ............................................................................................... 71Feed and EDAA Support .............................................................................. 71Link Relation................................................................................................ 71Operations ................................................................................................... 72Get an Alert Collection.............................................................................. 72HTTP Method ...................................................................................... 72Query Parameters................................................................................. 72Request Headers .................................................................................. 72Request Body ....................................................................................... 73Response Headers ................................................................................ 73Supported Response Media Types ......................................................... 73Response Status.................................................................................... 73Response Body ..................................................................................... 73

xCP Alert Single Type ....................................................................................... 74URI Template ............................................................................................... 74Link Relation................................................................................................ 74Operations ................................................................................................... 74Get an Alert Type ..................................................................................... 74

4

Table of Contents

HTTP Method ...................................................................................... 75Query Parameters................................................................................. 75Request Headers .................................................................................. 75Request Body ....................................................................................... 75Response Headers ................................................................................ 75Supported Response Media Types ......................................................... 75Response Status.................................................................................... 75Response Body ..................................................................................... 76

xCP Alert Type Collection ................................................................................. 76URI Template ............................................................................................... 76Feed and EDAA Support .............................................................................. 76Link Relation................................................................................................ 77Operations ................................................................................................... 77Get an Alert Type Collection ..................................................................... 77HTTP Method ...................................................................................... 77Query Parameters................................................................................. 77Request Headers .................................................................................. 78Request Body ....................................................................................... 78Response Headers ................................................................................ 78Supported Response Media Types ......................................................... 78Response Status.................................................................................... 78Response Body ..................................................................................... 78

xCP Annotation Collection ................................................................................ 79URI Template ............................................................................................... 79Feed and EDAA Support .............................................................................. 79Link Relation................................................................................................ 79Operations ................................................................................................... 79Get an Annotation Collection .................................................................... 80HTTP Method ...................................................................................... 80Query Parameters................................................................................. 80Request Headers .................................................................................. 80Request Body ....................................................................................... 80Response Headers ................................................................................ 81Supported Response Media Types ......................................................... 81Response Status.................................................................................... 81Response Body ..................................................................................... 81

Get an Annotation Collection for a User ..................................................... 82HTTP Method ...................................................................................... 82Query Parameters................................................................................. 82Request Headers .................................................................................. 82Request Body ....................................................................................... 82Response Headers ................................................................................ 83Supported Response Media Types ......................................................... 83Response Status.................................................................................... 83Response Body ..................................................................................... 83

Create Annotations................................................................................... 84HTTP Method ...................................................................................... 84Server Accepted Request Media Types ................................................... 84Query Parameters................................................................................. 84Request Headers .................................................................................. 84Request Body ....................................................................................... 84Response Headers ................................................................................ 85Supported Response Media Types ......................................................... 85Response Status.................................................................................... 85Response Body ..................................................................................... 85

xCP Application Single Instance ........................................................................ 86URI Template ............................................................................................... 86Link Relation................................................................................................ 86

5

Table of Contents

Operations ................................................................................................... 86Get an Application ................................................................................... 86HTTP Method ...................................................................................... 87Query Parameters................................................................................. 87Request Headers .................................................................................. 87Request Body ....................................................................................... 87Response Headers ................................................................................ 87Supported Response Media Types ......................................................... 87Response Status.................................................................................... 87Response Body ..................................................................................... 88

xCP Application Type ....................................................................................... 90URI Template ............................................................................................... 90Link Relation................................................................................................ 90Operations ................................................................................................... 90Get an Application Type ........................................................................... 90HTTP Method ...................................................................................... 90Query Parameters................................................................................. 91Request Headers .................................................................................. 91Request Body ....................................................................................... 91Response Headers ................................................................................ 91Supported Response Media Types ......................................................... 91Response Status.................................................................................... 91Response Body ..................................................................................... 91

xCP Application Type Collection ....................................................................... 92URI Template ............................................................................................... 92Feed and EDAA Support .............................................................................. 92Link Relation................................................................................................ 92Operations ................................................................................................... 93Get an Application Type Collection............................................................ 93HTTP Method ...................................................................................... 93Query Parameters................................................................................. 93Request Headers .................................................................................. 93Request Body ....................................................................................... 94Response Headers ................................................................................ 94Supported Response Media Types ......................................................... 94Response Status.................................................................................... 94Response Body ..................................................................................... 94

xCP Application Configuration Single Instance .................................................. 96URI Template ............................................................................................... 96Link Relation................................................................................................ 96Operations ................................................................................................... 96Get an Application Configuration .............................................................. 97HTTP Method ...................................................................................... 97Query Parameters................................................................................. 97Request Headers .................................................................................. 97Request Body ....................................................................................... 97Response Headers ................................................................................ 97Supported Response Media Types ......................................................... 97Response Status.................................................................................... 98Response Body ..................................................................................... 98

Update an Application Configuration ........................................................ 98HTTP Method ...................................................................................... 98Server Accepted Request Media Types ................................................... 98Query Parameters................................................................................. 98Request Headers .................................................................................. 99Request Body ....................................................................................... 99Response Headers ................................................................................ 99Supported Response Media Types ......................................................... 99

6

Table of Contents

Response Status.................................................................................... 99Response Body ................................................................................... 100

xCP Application Configuration Collection........................................................ 101URI Template ............................................................................................. 101Feed and EDAA Support ............................................................................ 101Link Relation.............................................................................................. 102Operations ................................................................................................. 102Get an Application Configuration Collection ............................................ 102HTTP Method .................................................................................... 102Query Parameters............................................................................... 102Request Headers ................................................................................ 103Request Body ..................................................................................... 103Response Headers .............................................................................. 103Supported Response Media Types ....................................................... 103Response Status.................................................................................. 103Response Body ................................................................................... 103

xCP Application Configuration Single Type ..................................................... 104URI Template ............................................................................................. 104Link Relation.............................................................................................. 104Operations ................................................................................................. 104Get an Application Configuration Type.................................................... 104HTTP Method .................................................................................... 104Query Parameters............................................................................... 105Request Headers ................................................................................ 105Request Body ..................................................................................... 105Response Headers .............................................................................. 105Supported Response Media Types ....................................................... 105Response Status.................................................................................. 105Response Body ................................................................................... 106

xCP Application Configuration Type Collection ............................................... 107URI Template ............................................................................................. 107Feed and EDAA Support ............................................................................ 107Link Relation.............................................................................................. 107Operations ................................................................................................. 108Get an Application Configuration Type Collection .................................... 108HTTP Method .................................................................................... 108Query Parameters............................................................................... 108Request Headers ................................................................................ 109Request Body ..................................................................................... 109Response Headers .............................................................................. 109Supported Response Media Types ....................................................... 109Response Status.................................................................................. 109Response Body ................................................................................... 109

xCP Business Object Single Instance................................................................. 110URI Template ............................................................................................. 110Link Relation.............................................................................................. 110Operations ................................................................................................. 110Get a Business Object .............................................................................. 111HTTP Method .................................................................................... 111Query Parameters............................................................................... 111Request Headers ................................................................................ 111Request Body ..................................................................................... 111Response Headers .............................................................................. 112Supported Response Media Types ....................................................... 112Response Status.................................................................................. 112Response Body ................................................................................... 112

Update a Business Object ........................................................................ 112

7

Table of Contents

HTTP Method .................................................................................... 112Server Accepted Request Media Types ................................................. 113Query Parameters............................................................................... 113Request Headers ................................................................................ 113Request Body ..................................................................................... 113Response Headers .............................................................................. 113Supported Response Media Types ....................................................... 114Response Status.................................................................................. 114Response Body ................................................................................... 114

Create a Business Object.......................................................................... 114HTTP Method .................................................................................... 114Server Accepted Request Media Types ................................................. 114Query Parameters............................................................................... 115Request Headers ................................................................................ 115Request Body ..................................................................................... 115Response Headers .............................................................................. 115Supported Response Media Types ....................................................... 115Response Status.................................................................................. 116Response Body ................................................................................... 116

Delete a Business Object.......................................................................... 116HTTP Method .................................................................................... 116Query Parameters............................................................................... 116Request Headers ................................................................................ 116Request Body ..................................................................................... 116Response Headers .............................................................................. 117Response Status.................................................................................. 117Response Body ................................................................................... 117

xCP Business Object Collection........................................................................ 118URI Template ............................................................................................. 118Feed and EDAA Support ............................................................................ 118Link Relation.............................................................................................. 118Operations ................................................................................................. 119Get a Business Object Collection .............................................................. 119HTTP Method .................................................................................... 119Query Parameters............................................................................... 119Request Headers ................................................................................ 120Request Body ..................................................................................... 120Response Headers .............................................................................. 120Supported Response Media Types ....................................................... 120Response Status.................................................................................. 120Response Body ................................................................................... 120

xCP Business Object Single Type...................................................................... 121URI Template ............................................................................................. 121Link Relation.............................................................................................. 121Operations ................................................................................................. 121Get a Business Object Type...................................................................... 121HTTP Method .................................................................................... 122Query Parameters............................................................................... 122Request Headers ................................................................................ 122Request Body ..................................................................................... 122Response Headers .............................................................................. 122Supported Response Media Types ....................................................... 122Response Status.................................................................................. 122Response Body ................................................................................... 123

xCP Business Object Type Collection................................................................ 124URI Template ............................................................................................. 124Feed and EDAA Support ............................................................................ 124Link Relation.............................................................................................. 124

8

Table of Contents

Operations ................................................................................................. 125Get a Business Object Type Collection ...................................................... 125HTTP Method .................................................................................... 125Query Parameters............................................................................... 125Request Headers ................................................................................ 125Request Body ..................................................................................... 126Response Headers .............................................................................. 126Supported Response Media Types ....................................................... 126Response Status.................................................................................. 126Response Body ................................................................................... 126

xCP Cabinet Single Instance ............................................................................ 127URI Template ............................................................................................. 127Link Relation.............................................................................................. 127Operations ................................................................................................. 127Get a Cabinet ......................................................................................... 128HTTP Method .................................................................................... 128Query Parameters............................................................................... 128Request Headers ................................................................................ 128Request Body ..................................................................................... 128Response Headers .............................................................................. 128Supported Response Media Types ....................................................... 129Response Status.................................................................................. 129Response Body ................................................................................... 129

Get Objects in a Cabinet .......................................................................... 129HTTP Method .................................................................................... 129Query Parameters............................................................................... 130Request Headers ................................................................................ 130Request Body ..................................................................................... 130Response Headers .............................................................................. 130Supported Response Media Types ....................................................... 130Response Status.................................................................................. 130Response Body ................................................................................... 131

Create a Cabinet ..................................................................................... 131HTTP Method .................................................................................... 131Server Accepted Request Media Types ................................................. 131Query Parameters............................................................................... 131Request Headers ................................................................................ 131Request Body ..................................................................................... 131Response Headers .............................................................................. 132Supported Response Media Types ....................................................... 132Response Status.................................................................................. 132Response Body ................................................................................... 133

Update a Cabinet.................................................................................... 133HTTP Method .................................................................................... 133Server Accepted Request Media Types ................................................. 133Query Parameters............................................................................... 133Request Headers ................................................................................ 133Request Body ..................................................................................... 134Response Headers .............................................................................. 134Supported Response Media Types ....................................................... 134Response Status.................................................................................. 134Response Body ................................................................................... 135

Delete a Cabinet ..................................................................................... 135HTTP Method .................................................................................... 135Query Parameters............................................................................... 135Request Headers ................................................................................ 135Request Body ..................................................................................... 135Response Headers .............................................................................. 135

9

Table of Contents

Response Status.................................................................................. 135Response Body ................................................................................... 136

xCP Cabinet Collection ................................................................................... 137URI Template ............................................................................................. 137Feed and EDAA Support ............................................................................ 137Link Relation.............................................................................................. 137Operations ................................................................................................. 138Get a Cabinet Collection.......................................................................... 138HTTP Method .................................................................................... 138Query Parameters............................................................................... 138Request Headers ................................................................................ 139Request Body ..................................................................................... 139Response Headers .............................................................................. 139Supported Response Media Types ....................................................... 139Response Status.................................................................................. 139Response Body ................................................................................... 139

xCP Cabinet Single Type ................................................................................. 140URI Template ............................................................................................. 140Link Relation.............................................................................................. 140Operations ................................................................................................. 140Get a Cabinet Type ................................................................................. 140HTTP Method .................................................................................... 140Query Parameters............................................................................... 141Request Headers ................................................................................ 141Request Body ..................................................................................... 141Response Headers .............................................................................. 141Supported Response Media Types ....................................................... 141Response Status.................................................................................. 141Response Body ................................................................................... 142

xCP Cabinet Type Collection ........................................................................... 143URI Template ............................................................................................. 143Feed and EDAA Support ............................................................................ 143Link Relation.............................................................................................. 143Operations ................................................................................................. 144Get a Cabinet Type Collection.................................................................. 144HTTP Method .................................................................................... 144Query Parameters............................................................................... 144Request Headers ................................................................................ 144Request Body ..................................................................................... 145Response Headers .............................................................................. 145Supported Response Media Types ....................................................... 145Response Status.................................................................................. 145Response Body ................................................................................... 145

xCP Comment Single Instance ......................................................................... 146URI Template ............................................................................................. 146Link Relation.............................................................................................. 146Operations ................................................................................................. 147Get a Comment ...................................................................................... 147HTTP Method .................................................................................... 147Query Parameters............................................................................... 147Request Headers ................................................................................ 148Request Body ..................................................................................... 148Response Headers .............................................................................. 148Supported Response Media Types ....................................................... 148Response Status.................................................................................. 148Response Body ................................................................................... 149

Update a Comment ................................................................................ 149

10

Table of Contents

HTTP Method .................................................................................... 149Server Accepted Request Media Types ................................................. 149Query Parameters............................................................................... 149Request Headers ................................................................................ 150Request Body ..................................................................................... 150Response Headers .............................................................................. 150Supported Response Media Types ....................................................... 150Response Status.................................................................................. 150Response Body ................................................................................... 151

Create a Comment .................................................................................. 151HTTP Method .................................................................................... 151Server Accepted Request Media Types ................................................. 151Query Parameters............................................................................... 151Request Headers ................................................................................ 152Request Body ..................................................................................... 152Response Headers .............................................................................. 152Supported Response Media Types ....................................................... 152Response Status.................................................................................. 152Response Body ................................................................................... 153

Delete a Comment .................................................................................. 153HTTP Method .................................................................................... 153Query Parameters............................................................................... 153Request Headers ................................................................................ 153Request Body ..................................................................................... 154Response Headers .............................................................................. 154Response Status.................................................................................. 154Response Body ................................................................................... 154

xCP Comment Collection ................................................................................ 155URI Template ............................................................................................. 155Feed and EDAA Support ............................................................................ 155Link Relation.............................................................................................. 156Operations ................................................................................................. 156Get a Comment Collection ...................................................................... 157HTTP Method .................................................................................... 157Query Parameters............................................................................... 157Request Headers ................................................................................ 157Request Body ..................................................................................... 157Response Headers .............................................................................. 157Supported Response Media Types ....................................................... 158Response Status.................................................................................. 158Response Body ................................................................................... 158

xCP Comment Single Type .............................................................................. 159URI Template ............................................................................................. 159Link Relation.............................................................................................. 159Operations ................................................................................................. 159Get a Comment Type .............................................................................. 159HTTP Method .................................................................................... 160Query Parameters............................................................................... 160Request Headers ................................................................................ 160Request Body ..................................................................................... 160Response Headers .............................................................................. 160Supported Response Media Types ....................................................... 160Response Status.................................................................................. 160Response Body ................................................................................... 161

xCP Comment Type Collection ........................................................................ 162URI Template ............................................................................................. 162Feed and EDAA Support ............................................................................ 162Link Relation.............................................................................................. 162

11

Table of Contents

Operations ................................................................................................. 163Get a Comment Collection ...................................................................... 163HTTP Method .................................................................................... 163Query Parameters............................................................................... 163Request Headers ................................................................................ 163Request Body ..................................................................................... 164Response Headers .............................................................................. 164Supported Response Media Types ....................................................... 164Response Status.................................................................................. 164Response Body ................................................................................... 164

xCP Content Single Instance............................................................................ 165URI Template ............................................................................................. 165Link Relation.............................................................................................. 165Operations ................................................................................................. 166Get a Content ......................................................................................... 166HTTP Method .................................................................................... 166Query Parameters............................................................................... 166Request Headers ................................................................................ 167Request Body ..................................................................................... 167Response Headers .............................................................................. 167Supported Response Media Types ....................................................... 168Response Status.................................................................................. 168Response Body ................................................................................... 168

Update a Content ................................................................................... 168HTTP Method .................................................................................... 168Server Accepted Request Media Types ................................................. 168Query Parameters............................................................................... 169Request Headers ................................................................................ 169Request Body ..................................................................................... 169Response Headers .............................................................................. 169Supported Response Media Types ....................................................... 169Response Status.................................................................................. 170Response Body ................................................................................... 170

Delete a Content ..................................................................................... 170HTTP Method .................................................................................... 170Query Parameters............................................................................... 170Request Headers ................................................................................ 170Request Body ..................................................................................... 170Response Headers .............................................................................. 171Response Status.................................................................................. 171Response Body ................................................................................... 171

Check out a Content ............................................................................... 171HTTP Method .................................................................................... 171Server Accepted Request Media Types ................................................. 171Query Parameters............................................................................... 171Request Headers ................................................................................ 172Request Body ..................................................................................... 172Response Headers .............................................................................. 172Supported Response Media Types ....................................................... 172Response Status.................................................................................. 172Response Body ................................................................................... 173

Check in a Content ................................................................................. 173HTTP Method .................................................................................... 174Server Accepted Request Media Types ................................................. 174Query Parameters............................................................................... 174Request Headers ................................................................................ 175Request Body ..................................................................................... 175Response Headers .............................................................................. 175

12

Table of Contents

Supported Response Media Types ....................................................... 175Response Status.................................................................................. 175Response Body ................................................................................... 176

xCP Content Collection ................................................................................... 177URI Template ............................................................................................. 177Feed and EDAA Support ............................................................................ 177Link Relation.............................................................................................. 177Operations ................................................................................................. 178Get a Content Collection ......................................................................... 178HTTP Method .................................................................................... 178Query Parameters............................................................................... 178Request Headers ................................................................................ 179Request Body ..................................................................................... 179Response Headers .............................................................................. 179Supported Response Media Types ....................................................... 179Response Status.................................................................................. 179Response Body ................................................................................... 179

Create a Content..................................................................................... 180HTTP Method .................................................................................... 181Server Accepted Request Media Types ................................................. 181Query Parameters............................................................................... 181Request Headers ................................................................................ 181Request Body ..................................................................................... 181Response Headers .............................................................................. 182Supported Response Media Types ....................................................... 182Response Status.................................................................................. 182Response Body ................................................................................... 182

xCP Content Single Type................................................................................. 183URI Template ............................................................................................. 183Link Relation.............................................................................................. 183Operations ................................................................................................. 183Get a Content Type ................................................................................. 183HTTP Method .................................................................................... 183Query Parameters............................................................................... 184Request Headers ................................................................................ 184Request Body ..................................................................................... 184Response Headers .............................................................................. 184Supported Response Media Types ....................................................... 184Response Status.................................................................................. 184Response Body ................................................................................... 185

xCP Content Type Collection........................................................................... 186URI Template ............................................................................................. 186Feed and EDAA Support ............................................................................ 186Link Relation.............................................................................................. 186Operations ................................................................................................. 187Get a Content Type Collection ................................................................. 187HTTP Method .................................................................................... 187Query Parameters............................................................................... 187Request Headers ................................................................................ 187Request Body ..................................................................................... 188Response Headers .............................................................................. 188Supported Response Media Types ....................................................... 188Response Status.................................................................................. 188Response Body ................................................................................... 188

xCP Current User Instance .............................................................................. 189URI Template ............................................................................................. 189Link Relation.............................................................................................. 189

13

Table of Contents

Operations ................................................................................................. 189Get the Current User............................................................................... 190HTTP Method .................................................................................... 190Query Parameters............................................................................... 190Request Headers ................................................................................ 190Request Body ..................................................................................... 190Response Headers .............................................................................. 190Supported Response Media Types ....................................................... 190Response Status.................................................................................. 191Response Body ................................................................................... 191

xCP File Upload Resource ............................................................................... 192URI Template ............................................................................................. 192Link Relation.............................................................................................. 192Operations ................................................................................................. 192Upload a File.......................................................................................... 192HTTP Method .................................................................................... 192Query Parameters............................................................................... 192Request Headers ................................................................................ 192Request Body ..................................................................................... 193Response Headers .............................................................................. 193Supported Response Media Types ....................................................... 193Response Status.................................................................................. 193Response Body ................................................................................... 193

Location of the Uploaded File.................................................................. 194Lifecycle of the Uploaded File ................................................................. 195

xCP Folder Single Instance .............................................................................. 196URI Template ............................................................................................. 196Link Relation.............................................................................................. 196Operations ................................................................................................. 196Get a Folder ........................................................................................... 197HTTP Method .................................................................................... 197Query Parameters............................................................................... 197Request Headers ................................................................................ 197Request Body ..................................................................................... 197Response Headers .............................................................................. 198Supported Response Media Types ....................................................... 198Response Status.................................................................................. 198Response Body ................................................................................... 198

Update a Folder...................................................................................... 198HTTP Method .................................................................................... 198Server Accepted Request Media Types ................................................. 199Query Parameters............................................................................... 199Request Headers ................................................................................ 199Request Body ..................................................................................... 199Response Headers .............................................................................. 199Supported Response Media Types ....................................................... 200Response Status.................................................................................. 200Response Body ................................................................................... 200

Create a Folder ....................................................................................... 200HTTP Method .................................................................................... 200Server Accepted Request Media Types ................................................. 200Query Parameters............................................................................... 201Request Headers ................................................................................ 201Request Body ..................................................................................... 201Response Headers .............................................................................. 202Supported Response Media Types ....................................................... 202Response Status.................................................................................. 202Response Body ................................................................................... 202

14

Table of Contents

Copy a Document to a Folder .................................................................. 202HTTP Method .................................................................................... 202Server Accepted Request Media Types ................................................. 203Query Parameters............................................................................... 203Request Headers ................................................................................ 203Request Body ..................................................................................... 203Response Headers .............................................................................. 203Supported Response Media Types ....................................................... 204Response Status.................................................................................. 204Response Body ................................................................................... 204

Move a Document to a Folder.................................................................. 205HTTP Method .................................................................................... 205Server Accepted Request Media Types ................................................. 205Query Parameters............................................................................... 205Request Headers ................................................................................ 205Request Body ..................................................................................... 206Response Headers .............................................................................. 206Supported Response Media Types ....................................................... 206Response Status.................................................................................. 206Response Body ................................................................................... 207

Delete a Folder ....................................................................................... 207HTTP Method .................................................................................... 207Query Parameters............................................................................... 207Request Headers ................................................................................ 207Request Body ..................................................................................... 207Response Headers .............................................................................. 207Response Status.................................................................................. 207Response Body ................................................................................... 208

xCP Folder Collection ..................................................................................... 209URI Template ............................................................................................. 209Feed and EDAA Support ............................................................................ 209Link Relation.............................................................................................. 209Operations ................................................................................................. 210Get a Folder Collection ........................................................................... 210HTTP Method .................................................................................... 210Query Parameters............................................................................... 210Request Headers ................................................................................ 210Request Body ..................................................................................... 211Response Headers .............................................................................. 211Supported Response Media Types ....................................................... 211Response Status.................................................................................. 211Response Body ................................................................................... 211

xCP Folder Single Type ................................................................................... 212URI Template ............................................................................................. 212Link Relation.............................................................................................. 212Operations ................................................................................................. 212Get a Folder Type ................................................................................... 212HTTP Method .................................................................................... 213Query Parameters............................................................................... 213Request Headers ................................................................................ 213Request Body ..................................................................................... 213Response Headers .............................................................................. 213Supported Response Media Types ....................................................... 213Response Status.................................................................................. 213Response Body ................................................................................... 214

xCP Folder Type Collection ............................................................................. 215URI Template ............................................................................................. 215Feed and EDAA Support ............................................................................ 215

15

Table of Contents

Link Relation.............................................................................................. 215Operations ................................................................................................. 216Get a Folder Type Collection ................................................................... 216HTTP Method .................................................................................... 216Query Parameters............................................................................... 216Request Headers ................................................................................ 216Request Body ..................................................................................... 217Response Headers .............................................................................. 217Supported Response Media Types ....................................................... 217Response Status.................................................................................. 217Response Body ................................................................................... 217

xCP Format Single Instance ............................................................................. 218URI Template ............................................................................................. 218Link Relation.............................................................................................. 218Operations ................................................................................................. 218Get a Format .......................................................................................... 218HTTP Method .................................................................................... 219Query Parameters............................................................................... 219Request Headers ................................................................................ 219Request Body ..................................................................................... 219Response Headers .............................................................................. 219Supported Response Media Types ....................................................... 219Response Status.................................................................................. 219Response Body ................................................................................... 220

xCP Format Collection .................................................................................... 221URI Template ............................................................................................. 221Feed and EDAA Support ............................................................................ 221Link Relation.............................................................................................. 222Operations ................................................................................................. 222Get a Format Collection .......................................................................... 222HTTP Method .................................................................................... 222Query Parameters............................................................................... 222Request Headers ................................................................................ 223Request Body ..................................................................................... 223Response Headers .............................................................................. 223Supported Response Media Types ....................................................... 223Response Status.................................................................................. 223Response Body ................................................................................... 223

xCP Format Single Type .................................................................................. 224URI Template ............................................................................................. 224Link Relation.............................................................................................. 224Operations ................................................................................................. 224Get a Format Type .................................................................................. 224HTTP Method .................................................................................... 224Query Parameters............................................................................... 225Request Headers ................................................................................ 225Request Body ..................................................................................... 225Response Headers .............................................................................. 225Supported Response Media Types ....................................................... 225Response Status.................................................................................. 225Response Body ................................................................................... 225

xCP Format Type Collection ............................................................................ 226URI Template ............................................................................................. 226Feed and EDAA Support ............................................................................ 226Link Relation.............................................................................................. 226Operations ................................................................................................. 227Get a Format Type Collection .................................................................. 227

16

Table of Contents

HTTP Method .................................................................................... 227Query Parameters............................................................................... 227Request Headers ................................................................................ 227Request Body ..................................................................................... 228Response Headers .............................................................................. 228Supported Response Media Types ....................................................... 228Response Status.................................................................................. 228Response Body ................................................................................... 228

xCP Fragment Single Instance ......................................................................... 229URI Template ............................................................................................. 229Link Relation.............................................................................................. 229Operations ................................................................................................. 229Get a Fragment....................................................................................... 230HTTP Method .................................................................................... 230Query Parameters............................................................................... 230Request Headers ................................................................................ 230Request Body ..................................................................................... 230Response Headers .............................................................................. 231Supported Response Media Types ....................................................... 231Response Status.................................................................................. 231Response Body ................................................................................... 231

Attach an Aspect to an Object.................................................................. 232HTTP Method .................................................................................... 232Server Accepted Request Media Types ................................................. 232Query Parameters............................................................................... 232Request Headers ................................................................................ 232Request Body ..................................................................................... 232Response Headers .............................................................................. 233Supported Response Media Types ....................................................... 233Response Status.................................................................................. 233Response Body ................................................................................... 234

xCP Fragment Single Type .............................................................................. 235URI Template ............................................................................................. 235Link Relation.............................................................................................. 235Operations ................................................................................................. 235Get a Fragment Type............................................................................... 235HTTP Method .................................................................................... 235Query Parameters............................................................................... 236Request Headers ................................................................................ 236Request Body ..................................................................................... 236Response Headers .............................................................................. 236Supported Response Media Types ....................................................... 236Response Status.................................................................................. 236Response Body ................................................................................... 236

xCP Fragment Type Collection ........................................................................ 238URI Template ............................................................................................. 238Feed and EDAA Support ............................................................................ 238Link Relation.............................................................................................. 238Operations ................................................................................................. 239Get a Fragment Type Collection............................................................... 239HTTP Method .................................................................................... 239Query Parameters............................................................................... 239Request Headers ................................................................................ 239Request Body ..................................................................................... 240Response Headers .............................................................................. 240Supported Response Media Types ....................................................... 240Response Status.................................................................................. 240Response Body ................................................................................... 240

17

Table of Contents

xCP Full-Text Query Single Instance ................................................................ 241URI Template ............................................................................................. 241Link Relation.............................................................................................. 241Operations ................................................................................................. 241Perform a Full-Text Query....................................................................... 241HTTP Method .................................................................................... 241Query Parameters............................................................................... 242Request Headers ................................................................................ 242Request Body ..................................................................................... 242Response Headers .............................................................................. 242Supported Response Media Types ....................................................... 243Response Status.................................................................................. 243Response Body ................................................................................... 243

xCP Full-Text Query Single Type ..................................................................... 254URI Template ............................................................................................. 254Link Relation.............................................................................................. 254Operations ................................................................................................. 254Get a Full-Text Query Type ..................................................................... 254HTTP Method .................................................................................... 255Query Parameters............................................................................... 255Request Headers ................................................................................ 255Request Body ..................................................................................... 255Response Headers .............................................................................. 255Supported Response Media Types ....................................................... 255Response Status.................................................................................. 255Response Body ................................................................................... 256

xCP Full-Text Query Type Collection ............................................................... 257URI Template ............................................................................................. 257Feed and EDAA Support ............................................................................ 257Link Relation.............................................................................................. 257Operations ................................................................................................. 258Get a Full-Text Query Type Collection...................................................... 258HTTP Method .................................................................................... 258Query Parameters............................................................................... 258Request Headers ................................................................................ 258Request Body ..................................................................................... 259Response Headers .............................................................................. 259Supported Response Media Types ....................................................... 259Response Status.................................................................................. 259Response Body ................................................................................... 259

xCP Historical Query Single Instance ............................................................... 260URI Template ............................................................................................. 260Link Relation.............................................................................................. 260Operations ................................................................................................. 260Get a Historical Query ............................................................................ 260HTTP Method .................................................................................... 261Query Parameters............................................................................... 261Request Headers ................................................................................ 261Request Body ..................................................................................... 261Response Headers .............................................................................. 261Supported Response Media Types ....................................................... 261Response Status.................................................................................. 261Response Body ................................................................................... 262

xCP Historical Query Collection ...................................................................... 263URI Template ............................................................................................. 263Feed and EDAA Support ............................................................................ 263Link Relation.............................................................................................. 263

18

Table of Contents

Operations ................................................................................................. 264Get a Historical Query Collection ............................................................ 264HTTP Method .................................................................................... 264Query Parameters............................................................................... 264Request Headers ................................................................................ 265Request Body ..................................................................................... 265Response Headers .............................................................................. 265Supported Response Media Types ....................................................... 265Response Status.................................................................................. 266Response Body ................................................................................... 266

xCP Historical Query Single Type .................................................................... 267URI Template ............................................................................................. 267Link Relation.............................................................................................. 267Operations ................................................................................................. 267Get a Historical Query Type .................................................................... 267HTTP Method .................................................................................... 268Query Parameters............................................................................... 268Request Headers ................................................................................ 268Request Body ..................................................................................... 268Response Headers .............................................................................. 268Supported Response Media Types ....................................................... 268Response Status.................................................................................. 268Response Body ................................................................................... 269

xCP Historical Query Type Collection .............................................................. 270URI Template ............................................................................................. 270Feed and EDAA Support ............................................................................ 270Link Relation.............................................................................................. 270Operations ................................................................................................. 271Get a Historical Query Type Collection .................................................... 271HTTP Method .................................................................................... 271Query Parameters............................................................................... 271Request Headers ................................................................................ 271Request Body ..................................................................................... 272Response Headers .............................................................................. 272Supported Response Media Types ....................................................... 272Response Status.................................................................................. 272Response Body ................................................................................... 272

xCP Home Document ..................................................................................... 273URI Template ............................................................................................. 273Resources................................................................................................... 273Operations ................................................................................................. 274Get the Home Document......................................................................... 274HTTP Method .................................................................................... 274Query Parameters............................................................................... 274Request Headers ................................................................................ 275Request Body ..................................................................................... 275Response Headers .............................................................................. 275Supported Response Media Types ....................................................... 275Response Status.................................................................................. 275Response Body ................................................................................... 275

xCP Member Single Instance ........................................................................... 283URI Template ............................................................................................. 283Link Relation.............................................................................................. 283Operations ................................................................................................. 284Get a Member ........................................................................................ 284HTTP Method .................................................................................... 284Query Parameters............................................................................... 284

19

Table of Contents

Request Headers ................................................................................ 284Request Body ..................................................................................... 284Response Headers .............................................................................. 285Supported Response Media Types ....................................................... 285Response Status.................................................................................. 285Response Body ................................................................................... 285

Add a Member ....................................................................................... 286HTTP Method .................................................................................... 286Server Accepted Request Media Types ................................................. 286Query Parameters............................................................................... 286Request Headers ................................................................................ 286Request Body ..................................................................................... 287Response Headers .............................................................................. 287Supported Response Media Types ....................................................... 287Response Status.................................................................................. 287Response Body ................................................................................... 287

Remove a Member.................................................................................. 288HTTP Method .................................................................................... 288Query Parameters............................................................................... 288Request Headers ................................................................................ 288Request Body ..................................................................................... 288Response Headers .............................................................................. 288Response Status.................................................................................. 288Response Body ................................................................................... 289

xCP Member Collection .................................................................................. 290URI Template ............................................................................................. 290Feed and EDAA Support ............................................................................ 290Link Relation.............................................................................................. 290Operations ................................................................................................. 291Get a Member Collection......................................................................... 291HTTP Method .................................................................................... 291Query Parameters............................................................................... 291Request Headers ................................................................................ 292Request Body ..................................................................................... 292Response Headers .............................................................................. 292Supported Response Media Types ....................................................... 292Response Status.................................................................................. 292Response Body ................................................................................... 292

Get a Member Collection of a Role or Group ............................................ 293HTTP Method .................................................................................... 293Query Parameters............................................................................... 293Request Headers ................................................................................ 293Request Body ..................................................................................... 294Response Headers .............................................................................. 294Supported Response Media Types ....................................................... 294Response Status.................................................................................. 294Response Body ................................................................................... 294

Get a Potential Member Collection of a Role or Group............................... 294HTTP Method .................................................................................... 295Query Parameters............................................................................... 295Request Headers ................................................................................ 295Request Body ..................................................................................... 295Response Headers .............................................................................. 296Supported Response Media Types ....................................................... 296Response Status.................................................................................. 296Response Body ................................................................................... 296

xCP Member Single Type ................................................................................ 297URI Template ............................................................................................. 297

20

Table of Contents

Link Relation.............................................................................................. 297Operations ................................................................................................. 297Get a Member Type ................................................................................ 297HTTP Method .................................................................................... 297Query Parameters............................................................................... 298Request Headers ................................................................................ 298Request Body ..................................................................................... 298Response Headers .............................................................................. 298Supported Response Media Types ....................................................... 298Response Status.................................................................................. 298Response Body ................................................................................... 299

xCP Member Type Collection .......................................................................... 300URI Template ............................................................................................. 300Feed and EDAA Support ............................................................................ 300Link Relation.............................................................................................. 300Operations ................................................................................................. 301Get a Member Type Collection................................................................. 301HTTP Method .................................................................................... 301Query Parameters............................................................................... 301Request Headers ................................................................................ 301Request Body ..................................................................................... 302Response Headers .............................................................................. 302Supported Response Media Types ....................................................... 302Response Status.................................................................................. 302Response Body ................................................................................... 302

xCP Network Location Single Instance............................................................. 303URI Template ............................................................................................. 303Link Relation.............................................................................................. 303Operations ................................................................................................. 303Get a Network Location .......................................................................... 303HTTP Method .................................................................................... 303Query Parameters............................................................................... 304Request Headers ................................................................................ 304Request Body ..................................................................................... 304Response Headers .............................................................................. 304Supported Response Media Types ....................................................... 304Response Status.................................................................................. 304Response Body ................................................................................... 305

xCP Network Location Collection .................................................................... 306URI Template ............................................................................................. 306Feed and EDAA Support ............................................................................ 306Link Relation.............................................................................................. 307Operations ................................................................................................. 307Get a Network Location Collection .......................................................... 307HTTP Method .................................................................................... 307Query Parameters............................................................................... 307Request Headers ................................................................................ 308Request Body ..................................................................................... 308Response Headers .............................................................................. 308Supported Response Media Types ....................................................... 308Response Status.................................................................................. 308Response Body ................................................................................... 308

xCP Network Location Single Type.................................................................. 309URI Template ............................................................................................. 309Link Relation.............................................................................................. 309Operations ................................................................................................. 309Get a Network Location Type .................................................................. 309

21

Table of Contents

HTTP Method .................................................................................... 310Query Parameters............................................................................... 310Request Headers ................................................................................ 310Request Body ..................................................................................... 310Response Headers .............................................................................. 310Supported Response Media Types ....................................................... 310Response Status.................................................................................. 310Response Body ................................................................................... 311

xCP Network Location Type Collection............................................................ 312URI Template ............................................................................................. 312Feed and EDAA Support ............................................................................ 312Link Relation.............................................................................................. 312Operations ................................................................................................. 313Get a Network Location Type Collection .................................................. 313HTTP Method .................................................................................... 313Query Parameters............................................................................... 313Request Headers ................................................................................ 313Request Body ..................................................................................... 314Response Headers .............................................................................. 314Supported Response Media Types ....................................................... 314Response Status.................................................................................. 314Response Body ................................................................................... 314

xCP Picklist Single Type.................................................................................. 315URI Template ............................................................................................. 315Link Relation.............................................................................................. 315Operations ................................................................................................. 315Get a Picklist .......................................................................................... 315HTTP Method .................................................................................... 315Query Parameters............................................................................... 315Request Headers ................................................................................ 316Request Body ..................................................................................... 316Response Headers .............................................................................. 316Supported Response Media Types ....................................................... 316Response Status.................................................................................. 316Response Body ................................................................................... 316

xCP Picklist Type Collection ............................................................................ 318URI Template ............................................................................................. 318Feed and EDAA Support ............................................................................ 318Link Relation.............................................................................................. 318Operations ................................................................................................. 319Get a Picklist Type Collection .................................................................. 319HTTP Method .................................................................................... 319Query Parameters............................................................................... 319Request Headers ................................................................................ 319Request Body ..................................................................................... 320Response Headers .............................................................................. 320Supported Response Media Types ....................................................... 320Response Status.................................................................................. 320Response Body ................................................................................... 320

xCP Process Single Instance............................................................................. 321URI Template ............................................................................................. 321Link Relation.............................................................................................. 321Operations ................................................................................................. 322Get a Process .......................................................................................... 322HTTP Method .................................................................................... 322Query Parameters............................................................................... 322Request Headers ................................................................................ 322

22

Table of Contents

Request Body ..................................................................................... 322Response Headers .............................................................................. 322Supported Response Media Types ....................................................... 323Response Status.................................................................................. 323Response Body ................................................................................... 323

Update the status of a Process ................................................................. 323HTTP Method .................................................................................... 323Server Accepted Request Media Types ................................................. 324Query Parameters............................................................................... 324Request Headers ................................................................................ 324Request Body ..................................................................................... 324Response Headers .............................................................................. 324Supported Response Media Types ....................................................... 324Response Status.................................................................................. 325Response Body ................................................................................... 325

xCP Process Collection.................................................................................... 326URI Template ............................................................................................. 326Feed and EDAA Support ............................................................................ 326Link Relation.............................................................................................. 326Operations ................................................................................................. 327Get a Process Collection .......................................................................... 327HTTP Method .................................................................................... 327Query Parameters............................................................................... 327Request Headers ................................................................................ 328Request Body ..................................................................................... 328Response Headers .............................................................................. 328Supported Response Media Types ....................................................... 328Response Status.................................................................................. 328Response Body ................................................................................... 328

Create a Process ..................................................................................... 329HTTP Method .................................................................................... 329Server Accepted Request Media Types ................................................. 329Query Parameters............................................................................... 329Request Headers ................................................................................ 329Request Body ..................................................................................... 329Response Headers .............................................................................. 331Supported Response Media Types ....................................................... 331Response Status.................................................................................. 331Response Body ................................................................................... 331

xCP Process Single Type ................................................................................. 332URI Template ............................................................................................. 332Link Relation.............................................................................................. 332Operations ................................................................................................. 332Get a Process Type.................................................................................. 332HTTP Method .................................................................................... 332Query Parameters............................................................................... 333Request Headers ................................................................................ 333Request Body ..................................................................................... 333Response Headers .............................................................................. 333Supported Response Media Types ....................................................... 333Response Status.................................................................................. 333Response Body ................................................................................... 334

xCP Process Type Collection............................................................................ 335URI Template ............................................................................................. 335Feed and EDAA Support ............................................................................ 335Link Relation.............................................................................................. 335Operations ................................................................................................. 336Get a Process Type Collection .................................................................. 336

23

Table of Contents

HTTP Method .................................................................................... 336Query Parameters............................................................................... 336Request Headers ................................................................................ 336Request Body ..................................................................................... 337Response Headers .............................................................................. 337Supported Response Media Types ....................................................... 337Response Status.................................................................................. 337Response Body ................................................................................... 337

xCP Product Information Single Instance ......................................................... 338URI Template ............................................................................................. 338Link Relation.............................................................................................. 338Operations ................................................................................................. 338Get Product Information ......................................................................... 338HTTP Method .................................................................................... 338Query Parameters............................................................................... 339Request Headers ................................................................................ 339Request Body ..................................................................................... 339Response Headers .............................................................................. 339Supported Response Media Types ....................................................... 339Response Status.................................................................................. 339Response Body ................................................................................... 340

xCP Product Information Type ........................................................................ 341URI Template ............................................................................................. 341Link Relation.............................................................................................. 341Operations ................................................................................................. 341Get a Product Information Type .............................................................. 341HTTP Method .................................................................................... 341Query Parameters............................................................................... 341Request Headers ................................................................................ 342Request Body ..................................................................................... 342Response Headers .............................................................................. 342Supported Response Media Types ....................................................... 342Response Status.................................................................................. 342Response Body ................................................................................... 342

xCP Product Information Type Collection ........................................................ 343URI Template ............................................................................................. 343Feed and EDAA Support ............................................................................ 343Link Relation.............................................................................................. 343Operations ................................................................................................. 344Get a Product Information Type Collection............................................... 344HTTP Method .................................................................................... 344Query Parameters............................................................................... 344Request Headers ................................................................................ 344Request Body ..................................................................................... 345Response Headers .............................................................................. 345Supported Response Media Types ....................................................... 345Response Status.................................................................................. 345Response Body ................................................................................... 345

xCP Project Single Instance ............................................................................. 346URI Template ............................................................................................. 346Link Relation.............................................................................................. 346Operations ................................................................................................. 346Get a Project ........................................................................................... 346HTTP Method .................................................................................... 347Query Parameters............................................................................... 347Request Headers ................................................................................ 347Request Body ..................................................................................... 347

24

Table of Contents

Response Headers .............................................................................. 347Supported Response Media Types ....................................................... 347Response Status.................................................................................. 347Response Body ................................................................................... 348

xCP Project Collection..................................................................................... 349URI Template ............................................................................................. 349Feed and EDAA Support ............................................................................ 349Link Relation.............................................................................................. 349Operations ................................................................................................. 350Get a Project Collection ........................................................................... 350HTTP Method .................................................................................... 350Query Parameters............................................................................... 350Request Headers ................................................................................ 351Request Body ..................................................................................... 351Response Headers .............................................................................. 351Supported Response Media Types ....................................................... 351Response Status.................................................................................. 351Response Body ................................................................................... 351

xCP Project Single Type .................................................................................. 352URI Template ............................................................................................. 352Link Relation.............................................................................................. 352Operations ................................................................................................. 352Get a Project Type................................................................................... 352HTTP Method .................................................................................... 352Query Parameters............................................................................... 353Request Headers ................................................................................ 353Request Body ..................................................................................... 353Response Headers .............................................................................. 353Supported Response Media Types ....................................................... 353Response Status.................................................................................. 353Response Body ................................................................................... 354

xCP Project Type Collection............................................................................. 355URI Template ............................................................................................. 355Feed and EDAA Support ............................................................................ 355Link Relation.............................................................................................. 355Operations ................................................................................................. 356Get a Project Type Collection ................................................................... 356HTTP Method .................................................................................... 356Query Parameters............................................................................... 356Request Headers ................................................................................ 357Request Body ..................................................................................... 357Response Headers .............................................................................. 357Supported Response Media Types ....................................................... 357Response Status.................................................................................. 357Response Body ................................................................................... 357

xCP Queue List Single Instance ....................................................................... 358URI Template ............................................................................................. 358Link Relation.............................................................................................. 358Operations ................................................................................................. 358Get a Queue List..................................................................................... 358HTTP Method .................................................................................... 358Query Parameters............................................................................... 359Request Headers ................................................................................ 359Request Body ..................................................................................... 359Response Headers .............................................................................. 359Supported Response Media Types ....................................................... 359Response Status.................................................................................. 360

25

Table of Contents

Response Body ................................................................................... 360xCP Real-Time Query Single Instance .............................................................. 362URI Template ............................................................................................. 362Link Relation.............................................................................................. 362Operations ................................................................................................. 362Perform a Real-Time Query..................................................................... 362HTTP Method .................................................................................... 362Query Parameters............................................................................... 363Request Headers ................................................................................ 363Request Body ..................................................................................... 363Response Headers .............................................................................. 363Supported Response Media Types ....................................................... 363Response Status.................................................................................. 364Response Body ................................................................................... 364

xCP Real-Time Query Single Type ................................................................... 366URI Template ............................................................................................. 366Link Relation.............................................................................................. 366Operations ................................................................................................. 366Get a Real-Time Query Type ................................................................... 366HTTP Method .................................................................................... 367Query Parameters............................................................................... 367Request Headers ................................................................................ 367Request Body ..................................................................................... 367Response Headers .............................................................................. 367Supported Response Media Types ....................................................... 367Response Status.................................................................................. 367Response Body ................................................................................... 368

xCP Real-Time Query Type Collection ............................................................. 369URI Template ............................................................................................. 369Feed and EDAA Support ............................................................................ 369Link Relation.............................................................................................. 369Operations ................................................................................................. 370Get a Real-Time Query Type Collection.................................................... 370HTTP Method .................................................................................... 370Query Parameters............................................................................... 370Request Headers ................................................................................ 370Request Body ..................................................................................... 371Response Headers .............................................................................. 371Supported Response Media Types ....................................................... 371Response Status.................................................................................. 371Response Body ................................................................................... 371

xCP Relationship Single Instance ..................................................................... 372URI Template ............................................................................................. 372Link Relation.............................................................................................. 372Operations ................................................................................................. 372Get a Relationship .................................................................................. 373HTTP Method .................................................................................... 373Query Parameters............................................................................... 373Request Headers ................................................................................ 373Request Body ..................................................................................... 373Response Headers .............................................................................. 373Supported Response Media Types ....................................................... 374Response Status.................................................................................. 374Response Body ................................................................................... 374

Update a Relationship............................................................................. 374HTTP Method .................................................................................... 374Server Accepted Request Media Types ................................................. 374

26

Table of Contents

Query Parameters............................................................................... 375Request Headers ................................................................................ 375Request Body ..................................................................................... 375Response Headers .............................................................................. 375Supported Response Media Types ....................................................... 375Response Status.................................................................................. 376Response Body ................................................................................... 376

Create a Relationship .............................................................................. 376HTTP Method .................................................................................... 376Server Accepted Request Media Types ................................................. 376Query Parameters............................................................................... 376Request Headers ................................................................................ 377Request Body ..................................................................................... 377Response Headers .............................................................................. 378Supported Response Media Types ....................................................... 378Response Status.................................................................................. 378Response Body ................................................................................... 378

Delete a Relationship .............................................................................. 378HTTP Method .................................................................................... 378Query Parameters............................................................................... 379Request Headers ................................................................................ 379Request Body ..................................................................................... 379Response Headers .............................................................................. 379Response Status.................................................................................. 379Response Body ................................................................................... 379

xCP Relationship Collection ............................................................................ 380URI Template ............................................................................................. 380Feed and EDAA Support ............................................................................ 380Link Relation.............................................................................................. 380Operations ................................................................................................. 381Get a Relationship Collection .................................................................. 381HTTP Method .................................................................................... 381Query Parameters............................................................................... 381Request Headers ................................................................................ 382Request Body ..................................................................................... 382Response Headers .............................................................................. 382Supported Response Media Types ....................................................... 382Response Status.................................................................................. 382Response Body ................................................................................... 382

xCP Relationship Single Type .......................................................................... 383URI Template ............................................................................................. 383Link Relation.............................................................................................. 383Operations ................................................................................................. 383Get a Relationship Type .......................................................................... 383HTTP Method .................................................................................... 384Query Parameters............................................................................... 384Request Headers ................................................................................ 384Request Body ..................................................................................... 384Response Headers .............................................................................. 384Supported Response Media Types ....................................................... 384Response Status.................................................................................. 384Response Body ................................................................................... 385

xCP Relationship Type Collection .................................................................... 386URI Template ............................................................................................. 386Feed and EDAA Support ............................................................................ 386Link Relation.............................................................................................. 386Operations ................................................................................................. 387Get a Relationship Type Collection .......................................................... 387

27

Table of Contents

HTTP Method .................................................................................... 387Query Parameters............................................................................... 387Request Headers ................................................................................ 387Request Body ..................................................................................... 388Response Headers .............................................................................. 388Supported Response Media Types ....................................................... 388Response Status.................................................................................. 388Response Body ................................................................................... 388

xCP Rendition Collection ................................................................................ 389URI Template ............................................................................................. 389Feed and EDAA Support ............................................................................ 389Link Relation.............................................................................................. 390Operations ................................................................................................. 390Get Renditions ....................................................................................... 390HTTP Method .................................................................................... 390Query Parameters............................................................................... 390Request Headers ................................................................................ 392Request Body ..................................................................................... 392Response Headers .............................................................................. 392Supported Response Media Types ....................................................... 392Response Status.................................................................................. 392Response Body ................................................................................... 393

xCP Repository Single Instance ....................................................................... 396URI Template ............................................................................................. 396Link Relation.............................................................................................. 396Operations ................................................................................................. 397Get a Repository ..................................................................................... 397HTTP Method .................................................................................... 397Query Parameters............................................................................... 397Request Headers ................................................................................ 397Request Body ..................................................................................... 397Response Headers .............................................................................. 397Supported Response Media Types ....................................................... 398Response Status.................................................................................. 398Response Body ................................................................................... 398

xCP Repository Single Type ............................................................................ 399URI Template ............................................................................................. 399Link Relation.............................................................................................. 399Operations ................................................................................................. 400Get a Repository Type............................................................................. 400HTTP Method .................................................................................... 400Query Parameters............................................................................... 400Request Headers ................................................................................ 400Request Body ..................................................................................... 400Response Headers .............................................................................. 400Supported Response Media Types ....................................................... 401Response Status.................................................................................. 401Response Body ................................................................................... 401

xCP Repository Type Collection ...................................................................... 402URI Template ............................................................................................. 402Feed and EDAA Support ............................................................................ 402Link Relation.............................................................................................. 402Operations ................................................................................................. 403Get a Repository Type Collection ............................................................. 403HTTP Method .................................................................................... 403Query Parameters............................................................................... 403Request Headers ................................................................................ 404

28

Table of Contents

Request Body ..................................................................................... 404Response Headers .............................................................................. 404Supported Response Media Types ....................................................... 404Response Status.................................................................................. 404Response Body ................................................................................... 404

xCP Stateless Process Single Instance ............................................................... 405URI Template ............................................................................................. 405Link Relation.............................................................................................. 405Operations ................................................................................................. 405Create a Stateless Process ........................................................................ 405HTTP Method .................................................................................... 405Server Accepted Request Media Types ................................................. 406Query Parameters............................................................................... 406Request Headers ................................................................................ 406Request Body ..................................................................................... 406Response Headers .............................................................................. 406Supported Response Media Types ....................................................... 407Response Status.................................................................................. 407Response Body ................................................................................... 407

xCP Stateless Process Single Type .................................................................... 408xCP Task Single Instance ................................................................................. 409URI Template ............................................................................................. 409Link Relation.............................................................................................. 409Operations ................................................................................................. 410Get a Task .............................................................................................. 411HTTP Method .................................................................................... 411Query Parameters............................................................................... 411Request Headers ................................................................................ 411Request Body ..................................................................................... 411Response Headers .............................................................................. 412Supported Response Media Types ....................................................... 412Response Status.................................................................................. 412Response Body ................................................................................... 412

Get the status of a Task............................................................................ 412HTTP Method .................................................................................... 412Query Parameters............................................................................... 413Request Headers ................................................................................ 413Request Body ..................................................................................... 413Response Headers .............................................................................. 413Supported Response Media Types ....................................................... 413Response Status.................................................................................. 413Response Body ................................................................................... 414

Update the status of a Task...................................................................... 414HTTP Method .................................................................................... 414Server Accepted Request Media Types ................................................. 414Query Parameters............................................................................... 414Request Headers ................................................................................ 414Request Body ..................................................................................... 414Response Headers .............................................................................. 415Supported Response Media Types ....................................................... 415Response Status.................................................................................. 415Response Body ................................................................................... 415

Acquire a Task........................................................................................ 416HTTP Method .................................................................................... 416Server Accepted Request Media Types ................................................. 416Query Parameters............................................................................... 416Request Headers ................................................................................ 416Request Body ..................................................................................... 416

29

Table of Contents

Response Headers .............................................................................. 417Supported Response Media Types ....................................................... 417Response Status.................................................................................. 417Response Body ................................................................................... 417

Update a Task ........................................................................................ 417HTTP Method .................................................................................... 417Server Accepted Request Media Types ................................................. 418Query Parameters............................................................................... 418Request Headers ................................................................................ 418Request Body ..................................................................................... 418Response Headers .............................................................................. 418Supported Response Media Types ....................................................... 419Response Status.................................................................................. 419Response Body ................................................................................... 419

Complete a Task ..................................................................................... 419HTTP Method .................................................................................... 419Server Accepted Request Media Types ................................................. 419Query Parameters............................................................................... 420Request Headers ................................................................................ 420Request Body ..................................................................................... 420Response Headers .............................................................................. 421Supported Response Media Types ....................................................... 421Response Status.................................................................................. 421Response Body ................................................................................... 421

Repeat a Task ......................................................................................... 421HTTP Method .................................................................................... 421Server Accepted Request Media Types ................................................. 422Query Parameters............................................................................... 422Request Headers ................................................................................ 422Request Body ..................................................................................... 422Response Headers .............................................................................. 422Supported Response Media Types ....................................................... 423Response Status.................................................................................. 423Response Body ................................................................................... 423

xCP Task Collection ........................................................................................ 424URI Template ............................................................................................. 424Feed and EDAA Support ............................................................................ 424Link Relation.............................................................................................. 425Operations ................................................................................................. 425Get a Task Collection .............................................................................. 425HTTP Method .................................................................................... 425Query Parameters............................................................................... 425Request Headers ................................................................................ 426Request Body ..................................................................................... 426Response Headers .............................................................................. 426Supported Response Media Types ....................................................... 426Response Status.................................................................................. 426Response Body ................................................................................... 426

xCP Task Single Type ...................................................................................... 427URI Template ............................................................................................. 427Link Relation.............................................................................................. 427Operations ................................................................................................. 427Get a Task Type ...................................................................................... 427HTTP Method .................................................................................... 428Query Parameters............................................................................... 428Request Headers ................................................................................ 428Request Body ..................................................................................... 428Response Headers .............................................................................. 428

30

Table of Contents

Supported Response Media Types ....................................................... 428Response Status.................................................................................. 428Response Body ................................................................................... 429

xCP Task Type Collection ................................................................................ 430URI Template ............................................................................................. 430Feed and EDAA Support ............................................................................ 430Link Relation.............................................................................................. 431Operations ................................................................................................. 431Get a Task Type Collection ...................................................................... 431HTTP Method .................................................................................... 431Query Parameters............................................................................... 431Request Headers ................................................................................ 432Request Body ..................................................................................... 432Response Headers .............................................................................. 432Supported Response Media Types ....................................................... 432Response Status.................................................................................. 432Response Body ................................................................................... 432

xCP Tasklist Query Single Instance .................................................................. 433URI Template ............................................................................................. 433Link Relation.............................................................................................. 433Operations ................................................................................................. 433Perform a Tasklist Query......................................................................... 433HTTP Method .................................................................................... 433Query Parameters............................................................................... 434Request Headers ................................................................................ 434Request Body ..................................................................................... 434Response Headers .............................................................................. 434Supported Response Media Types ....................................................... 434Response Status.................................................................................. 435Response Body ................................................................................... 435

xCP Tasklist Query Single Type ....................................................................... 438URI Template ............................................................................................. 438Link Relation.............................................................................................. 438Operations ................................................................................................. 438Get a Tasklist Query Type ....................................................................... 438HTTP Method .................................................................................... 439Query Parameters............................................................................... 439Request Headers ................................................................................ 439Request Body ..................................................................................... 439Response Headers .............................................................................. 439Supported Response Media Types ....................................................... 439Response Status.................................................................................. 439Response Body ................................................................................... 440

xCP Tasklist Query Type Collection ................................................................. 441URI Template ............................................................................................. 441Feed and EDAA Support ............................................................................ 441Link Relation.............................................................................................. 441Operations ................................................................................................. 442Get a Tasklist Query Type Collection........................................................ 442HTTP Method .................................................................................... 442Query Parameters............................................................................... 442Request Headers ................................................................................ 443Request Body ..................................................................................... 443Response Headers .............................................................................. 443Supported Response Media Types ....................................................... 443Response Status.................................................................................. 443Response Body ................................................................................... 444

31

Table of Contents

xCP Template Single Instance .......................................................................... 445URI Template ............................................................................................. 445Link Relation.............................................................................................. 445Operations ................................................................................................. 445Get a Template ....................................................................................... 445HTTP Method .................................................................................... 446Query Parameters............................................................................... 446Request Headers ................................................................................ 446Request Body ..................................................................................... 446Response Headers .............................................................................. 446Supported Response Media Types ....................................................... 446Response Status.................................................................................. 446Response Body ................................................................................... 447

xCP Template Collection ................................................................................. 448URI Template ............................................................................................. 448Feed and EDAA Support ............................................................................ 448Link Relation.............................................................................................. 449Operations ................................................................................................. 449Get a Template Collection ....................................................................... 449HTTP Method .................................................................................... 449Query Parameters............................................................................... 449Request Headers ................................................................................ 450Request Body ..................................................................................... 450Response Headers .............................................................................. 450Supported Response Media Types ....................................................... 450Response Status.................................................................................. 450Response Body ................................................................................... 450

xCP Template Single Type ............................................................................... 451URI Template ............................................................................................. 451Link Relation.............................................................................................. 451Operations ................................................................................................. 451Get a Template Type ............................................................................... 451HTTP Method .................................................................................... 452Query Parameters............................................................................... 452Request Headers ................................................................................ 452Request Body ..................................................................................... 452Response Headers .............................................................................. 452Supported Response Media Types ....................................................... 452Response Status.................................................................................. 452Response Body ................................................................................... 453

xCP Template Type Collection ......................................................................... 454URI Template ............................................................................................. 454Feed and EDAA Support ............................................................................ 454Link Relation.............................................................................................. 454Operations ................................................................................................. 455Get a Template Type Collection ............................................................... 455HTTP Method .................................................................................... 455Query Parameters............................................................................... 455Request Headers ................................................................................ 455Request Body ..................................................................................... 456Response Headers .............................................................................. 456Supported Response Media Types ....................................................... 456Response Status.................................................................................. 456Response Body ................................................................................... 456

xCP User Preference Single Instance ................................................................ 458URI Template ............................................................................................. 458Link Relation.............................................................................................. 458

32

Table of Contents

Operations ................................................................................................. 458Get User Preferences............................................................................... 458HTTP Method .................................................................................... 459Query Parameters............................................................................... 459Request Headers ................................................................................ 459Request Body ..................................................................................... 459Response Headers .............................................................................. 459Supported Response Media Types ....................................................... 459Response Status.................................................................................. 459Response Body ................................................................................... 460

Update User Preferences ......................................................................... 460HTTP Method .................................................................................... 460Server Accepted Request Media Types ................................................. 460Query Parameters............................................................................... 460Request Headers ................................................................................ 460Request Body ..................................................................................... 461Response Headers .............................................................................. 461Supported Response Media Types ....................................................... 461Response Status.................................................................................. 461Response Body ................................................................................... 462

xCP User Preferences Single Type .................................................................... 463URI Template ............................................................................................. 463Link Relation.............................................................................................. 463Operations ................................................................................................. 463Get a User Preferences Type .................................................................... 464HTTP Method .................................................................................... 464Query Parameters............................................................................... 464Request Headers ................................................................................ 464Request Body ..................................................................................... 464Response Headers .............................................................................. 464Supported Response Media Types ....................................................... 464Response Status.................................................................................. 464Response Body ................................................................................... 465

xCP User Preferences Type Collection .............................................................. 466URI Template ............................................................................................. 466Feed and EDAA Support ............................................................................ 466Link Relation.............................................................................................. 466Operations ................................................................................................. 467Get a User Preferences Type Collection .................................................... 467HTTP Method .................................................................................... 467Query Parameters............................................................................... 467Request Headers ................................................................................ 467Request Body ..................................................................................... 468Response Headers .............................................................................. 468Supported Response Media Types ....................................................... 468Response Status.................................................................................. 468Response Body ................................................................................... 468

xCP View Single Instance ................................................................................ 469URI Template ............................................................................................. 469Link Relation.............................................................................................. 469Operations ................................................................................................. 469Get a View ............................................................................................. 469HTTP Method .................................................................................... 469Query Parameters............................................................................... 470Request Headers ................................................................................ 470Request Body ..................................................................................... 470Response Headers .............................................................................. 470Supported Response Media Types ....................................................... 471

33

Table of Contents

Response Status.................................................................................. 471Response Body ................................................................................... 471

Formats ..................................................................................................... 472xCP Viewer Single Instance ............................................................................. 473URI Template ............................................................................................. 474Link Relation.............................................................................................. 474Operations ................................................................................................. 474Get a Viewer .......................................................................................... 474HTTP Method .................................................................................... 474Query Parameters............................................................................... 474Request Headers ................................................................................ 474Request Body ..................................................................................... 475Response Headers .............................................................................. 475Supported Response Media Types ....................................................... 475Response Status.................................................................................. 475Response Body ................................................................................... 475

xCP Viewer Collection .................................................................................... 479URI Template ............................................................................................. 479Feed and EDAA Support ............................................................................ 479Link Relation.............................................................................................. 479Operations ................................................................................................. 480Get a Viewer Collection........................................................................... 480HTTP Method .................................................................................... 480Query Parameters............................................................................... 480Request Headers ................................................................................ 480Request Body ..................................................................................... 480Response Headers .............................................................................. 480Supported Response Media Types ....................................................... 481Response Status.................................................................................. 481Response Body ................................................................................... 481

xCP Raw Content ........................................................................................... 483URI Template ............................................................................................. 483Operations ................................................................................................. 483Get a Binary Stream ................................................................................ 483HTTP Method .................................................................................... 483Query Parameters............................................................................... 484Request Headers ................................................................................ 484Request Body ..................................................................................... 484Response Headers .............................................................................. 484Supported Response Media Types ....................................................... 485Response Status.................................................................................. 485Response Body ................................................................................... 485

Upload a Binary Stream .......................................................................... 485HTTP Method .................................................................................... 485Server Accepted Request Media Types ................................................. 486Query Parameters............................................................................... 486Request Headers ................................................................................ 486Request Body ..................................................................................... 486Response Headers .............................................................................. 487Supported Response Media Types ....................................................... 487Response Status.................................................................................. 487Response Body ................................................................................... 487

Viewer Provider Profile .................................................................................. 488

34

Table of Contents

List of Tables

35

Table of Contents

36

Preface

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

Intended ReadershipThis document is intended for developers and architects who are building REST web services.

Revision HistoryThe following changes have been made to this document.

Revision history

Revision Date Description

January 2015 Initial publication

37

Preface

38

Chapter 1Overview

EMC Documentum xCelerated Composition Platform (xCP) REST Services is a set of RESTful webservice interfaces that enable you to assemble various pre-built software components and servicesto create and manage solutions, with a high degree of flexibility.

39

Overview

40

Chapter 2General REST Definitions

Common Definition - HTTP HeadersDocumentum REST Services supports the following common HTTP headers:

HTTP HeaderName

Description In Request orResponse?

Value Range

Authorization Authorization headerfor authentication

Request HTTP basic authentication headerwith the credential part encoded, forexample:

Authorization: BasicQWxhZGRpbjpvcGVuIHNlc2FtZQ==

Or, Kerberos authentication headerwith the credential part encoded, forexample:

Authorization: NegotiateYIIZG1hZG1pbjpwYXNzd29yZ...

Accept Acceptable media typefor the response

Request • application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml

• application/json

Content-Type MIME type of therequest body orresponse body

Request/Response

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

• application/xml

• application/json

Content-Length

Size of the entity-body,in decimal number ofOCTETs, sent to therecipient

Request/Response

Non-negative number

Location URI of thenewly-created resource

Response URI

41

General REST Definitions

HTTP HeaderName

Description In Request orResponse?

Value Range

Set-Cookie Sets an HTTP cookieResponse

Response Used by client token.

x-csrf-token

cookie is added in the response header.Browsers and clients must send

x-csrf-token

cookie in the Request header or asparameter for any post operationto safeguard against any CSRFvulnerability.

WWW-Authenticate

Indicates theauthentication schemethat should be used toaccess the requestedentity

Response Used by HTTP basic authenticationand HTTP Kerberos negotiateauthentication Set-Cookie.

42

General REST Definitions

Common Definition - Query ParametersDocumentum REST Services supports the following common query parameters:

Note: For a specific resource, it may not support all the following query parameters. For detailedinformation about what query parameters a resource supports, see the Query Parameters sectionof that resource.

QueryParameterName

Description DataType

Value Range Default

inline Determineswhether to showcontent (the objectinstance) in anatom entry orEDAA entry for acollection.

boolean • true - return the objectinstance and embedthe object instance intothe entry’s contentelement.

• false - do not returnobject instance.

false

Note: Although thedefault value is false,we still recommendthat you try settingthis parameter to truein your developmentenvironment to get theentire content of resourcesand explore the completedata structure. In yourproduction environment,you can set this parameterto false for betterperformance.

items-per-page

Specifies thenumber of itemsto be rendered onone page.

integer Any integer no less than 1 100

page Specifies the pagenumber of thepage to return.

If you set items-per-page to200, and page to2, the operationreturns items 201 -400.

integer Any integer no less than 1 1

43

General REST Definitions

QueryParameterName

Description DataType

Value Range Default

view Specifies the objectproperties toretrieve.

This parameterworks only wheninline is set totrue.

For moreinformation, seeProperty View,page 46.

string See Property View, page46.

:default

include-total

Determineswhether to returnthe total numberof objects. Forpaged feeds,objects in all pagesare counted.

boolean • true - return the totalnumber of objects.

• false - do not returnthe total number ofobjects.

false

sort Specifies a setof the sortspecificationsin a returnedcollection.

string This parameter consistsof multiple sortspecifications, separatedby comma ( , ).

Each sort specificationconsists of a property (anynon-repeating property)by which to sort the resultsand its sort order (DESCor ASC), separated by thewhitespace character ( ).

The sort order is optional.if not specified, the defaultsort order is ASC.

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

Example:

sort=r_modify_datedesc,object-idasc,title

NA

44

General REST Definitions

QueryParameterName

Description DataType

Value Range Default

links Determineswhether to returnlink relationsin the objectrepresentation

This parameterworks only wheninline is set totrue.

boolean • true - return linkrelations.

• false - do not returnlink relations.

true

recursive Determineswhether toreturn allindirect childrenrecursively whena request tries toget the children ofan object.

boolean • true - return allindirect childrenrecursively when arequest tries to get thechildren of an object.

• false - Only returndirect children when arequest tries to get thechildren of an object.

false

45

General REST Definitions

Property View

You can use the property view to specify the object properties to retrieve in an operation. This can bedone by creating a view expression in the view query parameter. A view expression can either be apredefined 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 tothe client.

If you use this view expression, the performancemay degrade when a request tries to retrieve acollection resource.

:default Returns the default set of properties of therequested object to the client. This is the defaultvalue if there is no value specified for the viewquery parameter.

Custom View Expression

A custom view expression contains a list of property names of the properties that you want to retrieveseparated 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 expressionis considered as invalid and rejected. In this case, the server returns the HTTP 400 Bad Requeststatus.

View Expression Syntax

The syntax of a view expression is defined with the following EBNF:view-expression = predefined-view | properties-list ;

46

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-1. Predefined view example

view=:all

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

Example 2-2. 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 requestedobject are returned.

Server Configuration ParametersDocumentum REST Services supports the following server configuration parameters:

Parameter Name Description

inline=false Displays the inline representation of resources in thecollection.

items-per-page=100 The default number of items in a single page if the querystring argument items-per-page is not specified.

page=1 The default page number if no value is specified as part ofthe query string.

include-total=false The total count of the feed items that the system does notreturn in one page.

show-created-resource-in-response=true

The newly created resource representation that the systemincludes 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 forwhich the object Id is passed.

default-view-type=default Specifies the default value for the view. The sectionProperty View, page 46 provides more details.

check-readonly-properties=false The system checks if the incoming message containsread-only properties and if yes, displays an error. Thedefault value is false.

47

General REST Definitions

Parameter Name Description

business-objects-output-mandatory-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

Output mandatory properties.

use-defaults=false

data-validation=true

time-dimension=DAILY

calculation-step=2

relative-last-time=100

data-sanitization=true

xCP URI Parameters

feed-author=EMC Documentum Other configurations

content-staging-location=

context-path=

If these parameters are not set, the file is uploaded to theJava temporary folder, which can be specified by using thejava.io.tmpdir system parameter.

allow-text-sanitizer-policies=FORMATTING,STYLES,LINKS,IMAGES

Security configurations

types-resources-caching-age=31536000

The caching period in seconds for all the rest resourcesaccessed with /types/** and /service/** URL. The defaultvalue is one year.

report-dfc-ticket-timeout=600 This parameter is used in Crystal Reports. The durationfor which docbase authentication ticket is valid. Thedefault value is 10 minutes.

48

General REST Definitions

Parameter Name Description

file-maxInMemorySize=10240 The maximum size allowed before files are written to thedisk. The files with size below this value are stored in thememory; else stored in the disk directly.

file-maxUploadSize=10240 The maximum file size that can be uploaded.

HTTP Status CodesDocumentum REST Services supports the following HTTP status codes:

Status Code Description

200 OK The request has succeeded. The information returned with the response isdependent on the method used in the request, for example: GET an entitycorresponding to the requested resource is sent in the response; PUT anentity 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 theentity of the response, with the most specific URI for the resource given bya Location header field. The entity format is specified by the media typegiven in the Content-Type header field.

204 No Content The server has fulfilled the request but does not need to return anentity-body.

304 Not Modified The server responds with this status code if the client has performed aconditional GET request and access is allowed, but the document has notbeen modified.

400 Bad Request The request could not be understood by the server due to malformedsyntax, missing or invalid information (such as a validation error on aninput field, or a missing required value). The client should not repeat therequest without modifications.

401 Unauthorized The authentication credentials included with this request are missing orinvalid. The response must include a WWW-Authenticate header fieldcontaining a challenge applicable to the requested resource.

403 Forbidden The server has recognized your credentials, but you do not possess theauthorization to perform this request, and the request should not berepeated.

404 Not Found The request specifies a URI of a resource that does not exist.

405 Method NotAllowed

The HTTP verb specified in the request (DELETE, GET, HEAD, POST,PUT) is not allowed for the resource identified by the request URI.

406 Not Acceptable The resource identified by this request URI is not capable of generatinga representation corresponding to one of the media types in the Acceptheader of the request.

49

General REST Definitions

Status Code Description

409 Conflict The request could not be completed, because it would cause a conflict inthe current state of the resources supported by the server (for example, anattempt to create a new resource with a unique identifier already assignedto some existing resource).

415 UnsupportedMedia Type

The server is refusing to service the request because the entity of therequest is in a format not supported by the requested resource for therequested method.

500 Internal ServerError

The server encountered an unexpected condition which prevented it fromfulfilling the request.

RepresentationxCP REST Services supports two representation formats, JSON and XML.

JSON is the primary format for resource representation. Collection-based resources are presented asEDAA, which is a JSON representation of an Atom feed. For more information about EDAA, see thePlatform REST Services EMC 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 aboutAtom, see RFC42870.

http://tools.ietf.org/html/rfc4287

xCP Common ElementsThis section describes the common elements that can appear in type definitions.

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

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

Example 2-3. 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>

50

General REST Definitions

</events>

Example 2-4. 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"

}}]

RelationshipsIf the relationships section appears in a type definition, instances of that type can participate in arelationship 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 theut200_bo_rel_1way_hasm type as the source and participate in relationships of theut200_bo_rel_2way_121 type as the target.

Example 2-5. 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-6. 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"}]

51

General REST Definitions

}

FragmentsIf the fragments section appears in a type definition, instances of that type can have certain types offragments (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-7. Sample in XML

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

</fragments>

Example 2-8. Sample in JSON

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

} ],

Correspondingly, if a runtime instance has fragments attached, an extra properties section appearswhere xsi:type specifies the fragment type:<dm:properties xsi:type="ut200_architect_aspect-properties">

<dm:education>today</dm:education><dm:years_of_experience>today</dm:years_of_experience>

</dm:properties>

Picklists

If a property with valueAssist appears in a type definition, instances of that type can have picklistsof the type defined in valueAssist.

Example 2-9. Sample in XML

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

Example 2-10. Sample in JSON

{"label": "Highest Degree Achieved","name": "highest_degree","type": "string","length": "16","valueAssist": "http://localhost:8080/xcp-rest/picklists/ut200_highest_degree"

}

52

General REST Definitions

53

General REST Definitions

54

Chapter 3Authentication

xCP REST Services supports HTTP basic authentication.

Authentication with HTTP BasicxCP REST Services implements HTTP Basic authentication, which passes both usernames andpasswords to the REST server.

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

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

Example 3-1. Username/password Pair for dmadmin/password

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

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

55

Authentication

56

Chapter 4Resources

xCP Alert Query Single InstanceA single instance of Alert Query represents an Alert Query defined in xCP Designer. This resourceenables you to perform a query on metadata of Alert instances in a repository.

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 SingleInstance, page 57

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.

57

Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:• view

• links

• inline

• items-per-page

• page

• include-total

• sort

An Alert Query resource does not support sort on multiple attributes, meaning that you canspecify at most one attribute as the sort criterion when performing a query.

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

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

58

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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

Example 4-1. 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>

59

Resources

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

}}}

60

Resources

xCP Alert Query Single TypeA single instance of Alert Query Type represents the type definition of an alert query that isconfigured 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 Queryinstances

xCP Alert Query Single Type,page 61

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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 Queryinstances

Get an Alert Query Type

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

HTTP Method

GET

61

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

62

Resources

xCP Alert Query Type CollectionAn 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/alert-queries/base-alert-query

Title Title of the alert query base-alert-query

Summary Summary of the alert query Base Alert Query

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

63

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Alert Query instances

xCP Alert Query TypeCollection, page 63

Operations

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

Method Description

GET Retrieve a collection of type definitions for AlertQuery 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

64

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 Queryinstances, depending on the setting of the query parameter view.

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

• Pagination is supported.

65

Resources

xCP Alert Single InstanceA single instance of Alert represents an alert in the system. An alert is triggered when the triggercondition 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 74

status [1] Status of the Alert instance Not applicable

self This Alert instance xCP Alert Single Instance, page66

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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.

66

Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content

67

Resources

400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, via which you canretrieve an xCP Alert Single Type, page 74.

• The status link relation indicates the status of the Alert resource, via which you can updatethe 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 theAlert 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

68

Resources

Common Definition - HTTP Headers , page 41 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/> {"status" : "new" }

ACKNOWLEDGED <acknowledged/> {"status" :"acknowledged" }

CLOSED <closed/> {"status" : "closed" }

Response Headers

• Location

• Content-Length

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

69

Resources

Response Body

XML or JSON representation of the updated Alert resource:• The type link relation points to the type definition of the Alert resource, via which you canretrieve a xCP Alert Single Type, page 74.

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

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

70

Resources

xCP Alert CollectionAn 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 Collectionin 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/Alert/xcp-base-alert/18765432199812ce

Title Entry title Entry title

Summary Entry summary Entry summary

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

71

Resources

Link Relation Description Resource Reference

self This collection resource xCP Alert Collection, page 71

first, last, previous, next Pagination links xCP Alert Collection, page 71

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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

72

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 settingof the query parameter view.

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

• Pagination is supported.

73

Resources

xCP Alert Single TypeA single instance of Alert Type represents the type definition of Alert instances. An Alert Typeresource is configured based on a Historical Query resource and exposes one or more columns ofthe 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 Alertinstances

xCP Alert Single Type, page 74

instances [1] Collection of the Alert instances xCP Alert Collection, page 71

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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.

74

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

75

Resources

Response Body

XML or JSON representation of the type definition of Alert instances. The instances link relationpoints to a collection of Alert instances, via which you can retrieve an xCP Alert Collection, page 71.

xCP Alert Type CollectionAn 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/alerts/xcp-base-alert

Title Alert title xcp-base-alert

Summary Alert summary Base Alert

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

76

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 definitionsfor Alert instances

xCP Alert Type Collection,page 76

Operations

An Alert Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions for Alertinstances

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 43 provides more information about common queryparameters.

77

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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.

78

Resources

xCP Annotation CollectionAn Annotation collection resource handles annotation requests for the viewer framework in xCPREST services. Annotations are markups displayed on documents and images. They can berepresented 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 providercan understand and consume. Viewer Provider Profile , page 488provides detailed informationabout 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 whichannotations are attached

content-id Object ID of the Content instance to whichannotations 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.

79

Resources

Method Description

GET Retrieve all annotations on a Content instance

GET Retrieve annotations created by a specific useron 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 472 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 41 provides more information about HTTP headers.

Request Body

None.

80

Resources

Response Headers

• Content-Type

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

Supported Response Media Types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/json (For compatible viewing)

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

JSON representation of an Annotation collection. This collection contains all annotations attachedto a Content instance.

Example 4-3. 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"}]

81

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 Contentinstance 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 472 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 41 provides more information about HTTP headers.

Request Body

None.

82

Resources

Response Headers

• Content-Type

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

Supported Response Media Types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/json (For compatible viewing)

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

Example 4-4. 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"}]

83

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 84) to the Content instance in the followingpattern:

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 41 provides more information about HTTP headers.

Request Body

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

Example 4-5. Annotation Content using the Content Viewer provider

{pageNumber: 5,pageHeight: 590,pageWidth: 416,commentColor: "red",

84

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 41 provides more information about HTTP headers.

Supported Response Media Types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/json (For compatible viewing)

Response Status201 - Content uploaded successfully400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

JSON representation of an Annotation collection.

85

Resources

xCP Application Single InstanceA single instance of Application represents an xCP application. This resource contains properties ofthe 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 SingleInstance, page 86

type Type definition of this resource xCP Application Type, page 90

projects [1] Collection of all projects in theapplication

xCP Project Collection, page349

roles [1] collection of all roles defined inthis application

xCP Member Collection, page290

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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.

86

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

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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

87

Resources

Response Body

XML or JSON representation of the Application resource.• The type link relation points to the type definition of the Application resource, via which you canretrieve an xCP Application Type, page 90.

• The projects link relation points to the collection of all project defined in the Applicationresource.

• 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 applicationconfiguration instances in the Application resource.

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

Example 4-6. 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-7. 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"

88

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

89

Resources

xCP Application TypeA 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 anApplication instance

xCP Application Type, page 90

instances [1] Collection of the projectinstances

xCP Application ConfigurationCollection, page 101

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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 Applicationinstances

Get an Application Type

Retrieve the type definition of Application instances.

HTTP Method

GET

90

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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

91

Resources

xCP Application Type CollectionAn 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/projects/xcp_application/

Title Project Project

Summary Project Project

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

92

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Application instances

xCP Application TypeCollection, page 92

Operations

An Application Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forApplication 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 43.

Request Headers

• Accept

• Authorization

93

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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, dependingon the setting of the query parameter view.

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

• Pagination is supported.

94

Resources

95

Resources

xCP Application Configuration Single InstanceA single instance of Application Configuration describes the parameters and endpoints of anapplication. 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 ConfigurationSingle Type, page 104

instances [1] Collection of the ApplicationConfiguration instances

xCP Application ConfigurationCollection, page 101

edit This Application Configurationinstance

xCP Application ConfigurationSingle Instance, page 96

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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

96

Resources

Get an Application Configuration

Retrieve the information about the application parameters and endpoints of an ApplicationConfiguration 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

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

Supported Response Media Types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

97

Resources

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, viawhich you can retrieve an xCP Application Configuration Single Type, page 104.

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

98

Resources

Request Headers

• Accept

• Authorization

• Content-Type

Common Definition - HTTP Headers , page 41 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 containsa field that is not presented in the corresponding DML type (xCP Application ConfigurationSingle Type, page 104), the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the list, the entirelist 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 41 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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed

99

Resources

403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - 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, viawhich you can retrieve an xCP Application Configuration Single Type, page 104.

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

100

Resources

xCP Application Configuration CollectionAn Application Configuration collection represents a collection of Application Configurationinstances.

URI Template

/application-configurations/xcp_application_configuration

Feed and EDAA Support

A collection of Application Configuration instances conforms to Atom Feed in XML representationand 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/application-configurations/xcp_application_configuration/08001538800049ab

Title Name of the applicationconfiguration type with therunning number appended to it

xcp_application_configuration-0

Summary Name of applicationconfiguration type withrunning number appended to it

xcp_application_configuration-0

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

101

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 ConfigurationCollection, page 101

first, last, previous, next Pagination links xCP Application ConfigurationCollection, page 101

Operations

An Application Configuration collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of ApplicationConfiguration 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

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

102

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

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, dependingon the setting of the query parameter view.

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

• Pagination is supported.

103

Resources

xCP Application Configuration Single TypeA single instance of Application Configuration Type represents the type definition of ApplicationConfiguration 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 ApplicationConfiguration instances

xCP Application ConfigurationSingle Type, page 104

instances [1] Collection of the ApplicationConfiguration instances

xCP Application ConfigurationCollection, page 101

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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 ApplicationConfiguration instances

Get an Application Configuration Type

Retrieve the type definition of Application Configuration instances.

HTTP Method

GET

104

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

105

Resources

Response Body

XML or JSON representation of the type definition of Application Configuration instances. Theinstances link relation points to a collection of Application Configuration instances, via which youcan retrieve an xCP Application Configuration Collection, page 101.

106

Resources

xCP Application Configuration Type CollectionAn Application Configuration Type collection represents a collection of type definitions forApplication Configuration instances.

URI Template

/types/application-configurations

Feed and EDAA Support

A collection of Application Configuration Type instances conforms to Atom Feed in XMLrepresentation 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/application-configurations/xcp_application_configuration/

Title Application Configuration NA

Summary Application Configuration NA

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

107

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Application Configurationinstances

xCP Application ConfigurationType Collection, page 107

Operations

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

Method Description

GET Retrieve a collection of type definitions forApplication 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 43 provides more information about common queryparameters.

108

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

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

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

• Pagination is supported.

109

Resources

xCP Business Object Single InstanceA 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 SingleType, page 121

instances [1] Collection of the BusinessObject instances

xCP Business Object Collection,page 118

edit Edit this Business Objectinstance

xCP Business Object SingleInstance, page 110

self This Business Object instance xCP Business Object SingleInstance, page 110

comments [1] Comments attached to thisBusiness Object instance

xCP Comment Collection, page155

delete [1] Delete this Business Objectinstance

xCP Business Object SingleInstance, page 110

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

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

Operations

A Business Object resource supports the following HTTP methods.

Method Description

GET Retrieve a Business Object resource

110

Resources

Method Description

POST Create a Business Object resource

POST Update a Business Object resource

GET Retrieve comments from a Business Objectresource. See xCP Comment Single Instance,page 146.

POST Add comments to a Business Object resource.See xCP Comment Single Instance, page 146.

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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

111

Resources

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, via whichyou can retrieve an xCP Business Object Single Type, page 121.

• 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 resourcein the following pattern:http://127.0.0.1:8080/rest-app-name/business-objects/business-object-type/objectId

112

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 41 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 containsa field that is not presented in the corresponding DML type (xCP Business Object Single Type,page 121), the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the list, the entirelist 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 41 provides more information about HTTP headers.

113

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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - 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, via whichyou can retrieve a xCP Business Object Single Type, page 121.

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

114

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

• Content-Type

Common Definition - HTTP Headers , page 41 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 (xCPBusiness Object Single Type, page 121), the field is ignored.

• Unspecified fields are set the default values in Content 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 41 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)

115

Resources

Response Status201 - Object created successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - 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, via whichyou can retrieve a xCP Business Object Single Type, page 121.

• 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 theresource 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 41 provides more information about HTTP headers.

Request Body

None.

116

Resources

Response Headers

None.

Response Status204 - Object deleted successfully400 - Bad request; invalid parameter value was provided401 - Authentication failed403 - Permission denied; no permission to delete the object409 - State conflicted500 - Other unexpected server error

Response Body

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

117

Resources

xCP Business Object CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/business-objects/test-business-type/0800153880005b89

Title object_name of the entry Sample BusinessObject

Summary object_name of the entry Sample BusinessObject

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

118

Resources

Link Relation Description Resource Reference

self This collection resource xCP Business Object Collection,page 118

first, last, previous, next Pagination links xCP Business Object Collection,page 118

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

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

119

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, dependingon the setting of the query parameter view.

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

• Pagination is supported.

120

Resources

xCP Business Object Single TypeA 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 BusinessObject instances

xCP Business Object SingleType, page 121

instances [1] Collection of the BusinessObject instances

xCP Business Object Collection,page 118

defaults [1] Default values specified on aBusiness Object type

xCP Business Object SingleType, page 121

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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 Objectinstances

Get a Business Object Type

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

121

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

122

Resources

Response Body

XML or JSON representation of the type definition of Business Object instances. The instanceslink relation points to a collection of Business Object instances, via which you can retrieve an xCPBusiness Object Collection, page 118.

123

Resources

xCP Business Object Type CollectionA Business Object instances Type collection represents a collection of type definitions for BusinessObject instances.

URI Template

/types/business-objects/

Feed and EDAA Support

A collection of Business Object Type instances conforms to Atom Feed in XML representation andEDAA 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://127.0.0.1:8080/xcp-rest/types/business-objects/xcp_business_objects/

Title Label of the type that this entrypoints to

test-business-object-type

Summary Label of the type that this entrypoints to

test-business-object-type

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

124

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Business Object instances

xCP Business Object TypeCollection, page 124

Operations

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

Method Description

GET Retrieve a collection of type definitions forBusiness 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

125

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 Objectinstances, depending on the setting of the query parameter view.

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

• Pagination is supported.

126

Resources

xCP Cabinet Single InstanceA single instance of Cabinet represents a cabinet in a repository. Cabinets are the highest levelof organization visible to users in a repository.

A Cabinet object extends from dm_folder. Any object that extends from dm_sysobject are storedin cabinets. A cabinet cannot be placed inside another cabinet or a folder. Super user privileges arerequired to create or remove a cabinet. Any user who has the Write permission to a cabinet canmodify 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, page140

instances [1] Collection of the Cabinetinstances

xCP Cabinet Collection, page137

self This Cabinet instance xCP Cabinet Single Instance,page 127

objects [1] Objects located in this Cabinetresource

xCP Folder Collection, page 209

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

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

Operations

A Cabinet resource supports the following HTTP methods.

127

Resources

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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

128

Resources

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, via which you canretrieve an xCP Cabinet Single Type, page 140.

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

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 Cabinetresource in the following pattern:http://127.0.0.1:8080/rest-app-name/processes/process-system-name/cabinet-id/objects

129

Resources

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

130

Resources

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.

Request Headers

• Accept

• Authorization

• Content-Type

Common Definition - HTTP Headers , page 41 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 afield that is not presented in the corresponding DML type (xCP Cabinet Single Type, page 140),the field is ignored.

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

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

Null in XML: <field-name>

131

Resources

Null in JSON: "field-name" : null

Example 4-8. 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-9. 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 41 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 Status201 - Object created successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed409 - Conflict500 - Other unexpected server error

132

Resources

Response Body

XML or JSON representation of the created Cabinet resource:• The type link relation points to the type definition of the Cabinet resource, via which you canretrieve a xCP Cabinet Single Type, page 140.

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

Request Headers

• Accept

• Authorization

• Content-Type

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

133

Resources

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 afield that is not presented in the corresponding DML type (xCP Cabinet Single Type, page 140),the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the list, the entirelist 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 41 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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

134

Resources

Response Body

XML or JSON representation of the updated Cabinet resource:• The type link relation points to the type definition of the Cabinet resource, via which you canretrieve a xCP Cabinet Single Type, page 140.

• 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 41 provides more information about HTTP headers.

Request Body

None.

Response Headers

None.

Response Status204 - Object deleted successfully400 - Bad request; invalid parameter value was provided401 - Authentication failed403 - Permission denied; no permission to delete the object409 - State conflicted500 - Other unexpected server error

135

Resources

Response Body

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

136

Resources

xCP Cabinet CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/cabinets/dm_cabinet/0c01e24080012a95

Title Entry title xcp_sample_cabinet

Summary Entry summary xCP Sample Cabinet

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

137

Resources

Link Relation Description Resource Reference

self This collection resource xCP Cabinet Collection, page137

first, last, previous, next Pagination links xCP Cabinet Collection, page137

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

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

138

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 thesetting of the query parameter view.

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

• Pagination is supported.

139

Resources

xCP Cabinet Single TypeA 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 Cabinetinstances

xCP Cabinet Single Type, page140

instances [1] Collection of the Cabinetinstances

xCP Cabinet Collection, page137

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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

140

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

141

Resources

Response Body

XML or JSON representation of the type definition of Cabinet instances. The instances link relationpoints to a collection of Cabinet instances, via which you can retrieve an xCP Cabinet Collection,page 137.

142

Resources

xCP Cabinet Type CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/cabinets/dm_cabinet

Title Title of the cabinet type dm_cabinet

Summary Summary of the cabinet type Base Cabinet

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

143

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Cabinet instances

xCP Cabinet Type Collection,page 143

Operations

A Cabinet Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forCabinet 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

144

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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.

145

Resources

xCP Comment Single InstanceA 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 commentis attached to

business-object-id r_object-id of the business object that thiscomment 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 attachedto

content-id r_object-id of the content that this commentis 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 attachedto

folder-id r_object-id of the folder that this commentis attached to

comment-id r_object-id of the comment

Link Relation

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

146

Resources

Link Relation Description Resource Reference

type Type definition of this resource xCP Comment Single Type,page 159

self This Comment instance xCP Comment Single Instance,page 146

edit Edit this Comment instance xCP Comment Single Instance,page 146

delete [1] Delete this Comment instance xCP Comment Single Instance,page 146

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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

147

Resources

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

148

Resources

Response Body

XML or JSON representation of the Comment resource.• The type link relation points to the type definition of the Comment resource, via which you canretrieve an xCP Comment Single Type, page 159.

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

149

Resources

Request Headers

• Accept

• Authorization

• Content-Type

Common Definition - HTTP Headers , page 41 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 afield that is not presented in the corresponding DML type (xCP Comment Single Type, page 159),the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the list, the entirelist 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 41 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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed

150

Resources

403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - 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, via which you canretrieve a xCP Comment Single Type, page 159.

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

151

Resources

Request Headers

• Accept

• Authorization

• Content-Type

Common Definition - HTTP Headers , page 41 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 therequest body contains a field that is not presented in the corresponding DML type (xCP CommentSingle Type, page 159), the field is ignored.

• Unspecified fields are set the default values in Content 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 41 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 Status201 - Object created successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed

152

Resources

404 - No object found409 - Conflict500 - 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, via which you canretrieve a xCP Comment Single Type, page 159.

• 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 resourcewith 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 41 provides more information about HTTP headers.

153

Resources

Request Body

None.

Response Headers

None.

Response Status204 - Object deleted successfully400 - Bad request; invalid parameter value was provided401 - Authentication failed403 - Permission denied; no permission to delete the object409 - State conflicted500 - Other unexpected server error

Response Body

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

154

Resources

xCP Comment CollectionA Comment collection represents a collection of comments instances, which can be attached tobusiness 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 commentis attached to

business-object-id r_object-id of the business object that thiscomment 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 attachedto

content-id r_object-id of the content that this commentis 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 attachedto

folder-id r_object-id of the folder that this commentis attached to

Feed and EDAA Support

A collection of Comment instances conforms to Atom Feed in XML representation and EDAACollection in JSON representation.

This collection resource contains the following properties.

155

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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/business-objects/ut200_bo_all_attribute/0800153880008be0/comments/1268153880005be2

Title object_name of the entry Sample Comment

Summary object_name of the entry Sample Comment

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

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

first, last, previous, next Pagination links xCP Comment Collection, page155

Operations

A Comment collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of Comment instances.

156

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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

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

157

Resources

Supported Response Media Types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 thesetting of the query parameter view.

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

• Pagination is supported.

158

Resources

xCP Comment Single TypeA 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 Commentinstances

xCP Comment Single Type,page 159

instances [1] Collection of the Commentinstances

xCP Comment Collection, page155

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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 Commentinstances

Get a Comment Type

Retrieve the type definition of Comment instances

159

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

160

Resources

Response Body

XML or JSON representation of the type definition of Comment instances. The instances linkrelation points to a collection of Comment instances, via which you can retrieve an xCP CommentCollection, page 155.

161

Resources

xCP Comment Type CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/comments/xcp_comments

Title Name of the comment type xcp_comments

Summary comments comments

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

162

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Comment instances

xCP Comment Type Collection,page 162

Operations

A Comment Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forComment 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

163

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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.

164

Resources

xCP Content Single InstanceA single instance of Content is a resource that describes a content. A Content resource is an instanceof 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, page183

instances [1] Collection of the Contentinstances

xCP Content Collection, page177

self This Content instance xCP Content Single Instance,page 165

edit Edit this Content instance xCP Content Single Instance,page 165

delete [1] Delete this Content instance xCP Content Single Instance,page 165

checkout [1] Check out this Content instance xCP Content Single Instance,page 165

comments [1] Comments attached to thisContent instance

xCP Comment Collection, page155

download-media [1] Link to the content binarystream for download

xCP Raw Content, page 483

checkin-next-major [1] Check in this Content instanceas the next major version

xCP Content Single Type, page183

checkin-current-version [1] Check in this Content instanceas the current version

xCP Content Single Type, page183

165

Resources

Link Relation Description Resource Reference

checkin-next-minor [1] Check in this Content instanceas the next minor version

xCP Content Single Type, page183

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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:

166

Resources

Parameter Description Data Type Default

recursive Specifies whether or not to list allthe following version policy-relatedlink relations in the response bodyregardless of the content state:• checkin-next-major

• checkin-current-version

• checkin-next-minor

• checkout

For example, when this parameteris set to true, the checkout linkrelation appears evenwhen the Contentresource is checked out.

boolean false

Additionally, this operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

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

167

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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, via which you canretrieve an xCP Content Single Type, page 183.

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

168

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

• Content-Type

Common Definition - HTTP Headers , page 41 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 afield that is not presented in the corresponding DML type (xCP Content Single Type, page 183),the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the list, the entirelist 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 41 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)

169

Resources

Response Status201 - Content updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - 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, via which you canretrieve a xCP Content Single Type, page 183.

• 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 resourcewith 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 41 provides more information about HTTP headers.

Request Body

None.

170

Resources

Response Headers

None.

Response Status204 - Object deleted successfully400 - Bad request; invalid parameter value was provided401 - Authentication failed403 - Permission denied; no permission to delete the object409 - State conflicted500 - Other unexpected server error

Response Body

HTTP 204 No Content status upon a successful delete operation. The response body containsno 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 resourcewith 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.

171

Resources

Request Headers

• Accept

• Authorization

• Content-Type

Common Definition - HTTP Headers , page 41 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 afield that is not presented in the corresponding DML type (xCP Content Single Type, page 183),the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the list, the entirelist 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 41 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 Status201 - Content checked out successfully400 - Bad request; invalid attribute name or value401 - Authentication failed

172

Resources

403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - 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, via which you canretrieve a xCP Content Single Type, page 183.

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

When a content instance is successfully uploaded, the REST server returns the 201 Createdstatus code. Additionally, the return message contains the Location header which indicates theURI of the file uploaded.

2. Send a POST request specifying the metadata of the content to one of the checkin link relationsof 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 FileUpload Resource, page 192 resource. To do this, specify the full or relative URI of the uploadedcontent in source.

Example 4-10. 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><source>http://127.0.0.1:8080/xcp-rest/files/d6e9ac3a-72a9-4262-ba30-398f4f701ac6</source></properties></content>

173

Resources

Example 4-11. JSON Sample

{"properties": {"source":"/files/680884ca-c104-4513-afde-aedc686ff3c3"}}

• To import a new version to a Content resource, append ?retain-lock=true to the URL of therequest. By doing this, the Content remains locked (checked out), and a new version is importedto 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 ornot to retain the lock onthe Content resourcein a checkin operation.

If you set thisparameter to true,the Content resourceremains locked(checked out), anda new version isimported to theContent resource.

boolean false

174

Resources

Request Headers

• Accept

• Authorization

• Content-Type

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

Request Body

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

Response Headers

• Location

• Content-Length

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status201 - Content checked in successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

175

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, via which you canretrieve a xCP Content Single Type, page 183.

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

176

Resources

xCP Content CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/contents/test-content/186923apt7

Title Content name testContent.txt

Summary Content name testContent.txt

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

177

Resources

Link Relation Description Resource Reference

self This collection resource xCP Content Collection, page177

first, last, previous, next Pagination links xCP Content Collection, page177

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

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

178

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 thesetting of the query parameter view.

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

• Pagination is supported.

179

Resources

Create a Content

You can create a Content resource from scratch or from a Template resource in your home cabinet orin 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 192.

When a content instance is successfully uploaded, the REST server returns the 201 Createdstatus code. Additionally, the return contains the Location header which indicates the URI ofthe file uploaded.

2. Send a POST request specifying the metadata of the content to a collection of Content resources ofthat 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 FileUpload Resource, page 192 resource. To do this, specify the full or relative URI of the uploadedcontent 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><source>http://127.0.0.1:8080/xcp-rest/files/d6e9ac3a-72a9-4262-ba30-398f4f701ac6</source>

</properties></content>

Example 4-13. JSON Sample

{"properties": {"source":"/files/680884ca-c104-4513-afde-aedc686ff3c3"}}

• Alternatively, you can create the Content resource under a specified folder by sending the POSTrequest 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 metadataof the content to either your home document or the objects link relation of a Folder resource. Therequest body must contain a reference to the corresponding xCP Template Single Instance, page 445resource. To do this, specify the full or relative URI of the Template resource 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">

180

Resources

<properties><source>http://127.0.0.1:8080/xcp-rest/templates/xcp_template/

0900492d800001da</source></properties></content>

Example 4-15. JSON Sample

{"properties": {"source":"/templates/xcp_template/0900492d800001da"}}

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 41 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 192 resource ora reference to a Template resource (xCP Template Single Instance, page 445)

• The metadata of the Content resource

181

Resources

Response Headers

• Location

• Content-Length

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status201 - Object created successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - 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, via which you canretrieve a xCP Content Single Type, page 183.

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

182

Resources

xCP Content Single TypeA single instance of Content Type represents the type definition of Content instances.

URI Template

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

xCP Content Single Type, page183

instances [1] Collection of the Contentinstances

xCP Content Collection, page177

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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

183

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

184

Resources

Response Body

XML or JSON representation of the type definition of Content instances. The instances linkrelation points to a collection of Content instances, via which you can retrieve an xCP ContentCollection, page 177.

185

Resources

xCP Content Type CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/contents/testContentType

Title Content type testContentType

Summary Content Summary test content type

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

186

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Content instances

xCP Content Type Collection,page 186

Operations

A Content Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forContent 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

187

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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.

188

Resources

xCP Current User InstanceAn instance of Current User is a resource that describes the current user together with theauthentication 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, page297

preferences [1] Preferences of the current user xCP User Preference SingleInstance, page 458

self This Current User instance xCP Current User Instance,page 189

roles [1] Application roles to which thisCurrent User instance belongs

xCP Member Collection, page290

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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 Userresource. See xCP User Preference SingleInstance, page 458.

GET Retrieve application roles to which a currentuser belongs. See xCP Member Collection, page290.

189

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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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)

190

Resources

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, via which youcan retrieve an xCP Member Single Type, page 297.

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

191

Resources

xCP File Upload ResourceA File Upload resource enables a client to upload a file to a temporary folder and obtain the URI ofthe newly-uploaded file. This resource is used in the content creation operation (Create a Content,page 180).

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

192

Resources

Common Definition - HTTP Headers , page 41 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-16. File Upload Request

http://127.0.0.1:8000/xCP-App/filesContent-Type: multipart/form-data; boundary=314159265358979--314159265358979Content-Disposition: form-data; name=metadataContent-Type: application/vnd.emc.documentum+json{"properties": {"object_name": "xcp-rest"}}--314159265358979Content-Disposition: form-data; name=binaryContent-Type: text/plainThis is the content--314159265358979--

Response Headers

• Location

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

Supported Response Media Types

multipart/form-data

Response Status201 - Content uploaded successfully400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

This operation returns the Location header which indicates the URI of the file uploaded. For example:/files/680884ca-c104-4513-afde-aedc686ff3c3

193

Resources

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 theoriginal 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 forclients that are unable to read the headers. These clients can obtain the location of the newly-uploadedfile 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 thecontent-staging-location parameter in server-configuration.properties. If thisparameter is not set, the file is uploaded to the Java temporary folder, which can be specified byusing the java.io.tmpdir system parameter.

194

Resources

Lifecycle of the Uploaded File

The lifecycle of a temporary file depends on the status of the content creation operation that utilizesthe uploaded file.• If the client application completes the content creation operation successfully, xCP RESTfulServices automatically deletes the uploaded file.

• If the client application terminates the content creation operation before completion, the clientapplication has to invoke an HTTP DELETE on the temporary file resource to remove theuploaded file.

• If content creation operation is accidentally terminated, xCP RESTful Services does notautomatically delete the uploaded file. You must execute a cleanup script to delete orphan files.

195

Resources

xCP Folder Single InstanceA single instance of Folder represents a folder, which is an instance of dm_folder or one of itssubtypes.

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

instances [1] Collection of the Folderinstances

xCP Folder Collection, page 209

self This instance xCP Folder Single Instance,page 196

edit Edit this instance xCP Folder Single Instance,page 196

delete [1] Delete this instance xCP Folder Single Instance,page 196

comments [1] Comments attached to theFolder instance

xCP Comment Collection, page155

objects [1] Objects in the Folder instance xCP Content Collection, page177

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

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

Operations

A Folder resource supports the following HTTP methods.

196

Resources

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 thefolder 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

197

Resources

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, via which you canretrieve an xCP Folder Single Type, page 212.

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

Update a Folder

Update a Folder resource.

HTTP Method

POST

198

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 41 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 afield that is not presented in the corresponding DML type (xCP Folder Single Type, page 212),the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the list, the entirelist 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 41 provides more information about HTTP headers.

199

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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - 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, via which you canretrieve a xCP Folder Single Type, page 212.

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

200

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

• Content-Type

Common Definition - HTTP Headers , page 41 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 bodyresembles the following samples:

Example 4-17. 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-18. 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 therequest body contains a field that is not presented in the corresponding DML type (xCP FolderSingle Type, page 212), the field is ignored.

• Unspecified fields are set the default values in Content 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

201

Resources

Response Headers

• Location

• Content-Length

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status201 - Object created successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - 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, via which you canretrieve a xCP Folder Single Type, page 212.

• 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

202

Resources

To copy a Content instance to a Folder instance, send a POST request to the objects link relationof 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 41 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 41 provides more information about HTTP headers.

203

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 Status201 - Object copied successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

Response Body

XML or JSON representation of the Folder resource. You can find the copied Content instanceby 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-19. 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"}

}

204

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

205

Resources

Common Definition - HTTP Headers , page 41 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 41 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 Status201 - Object moved successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

206

Resources

Response Body

XML or JSON representation of the Folder resource. You can find the moved Content instance byaccessing the objects link relation of the Folder instance. The moved Content instance is listedunder the entries section as shown in the example Objects in Folder, page 204.

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 resourcewith 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 41 provides more information about HTTP headers.

Request Body

None.

Response Headers

None.

Response Status204 - Object deleted successfully400 - Bad request; invalid parameter value was provided401 - Authentication failed403 - Permission denied; no permission to delete the object

207

Resources

409 - State conflicted500 - Other unexpected server error

Response Body

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

208

Resources

xCP Folder CollectionA 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 Collectionin 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://127.0.0.1:8080/xcp-rest/folders/test-folder-type/0b5db83d80020938

Title Entry title test-folder-type-1

Summary Entry summary test-folder-type-1

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

209

Resources

Link Relation Description Resource Reference

self This collection resource xCP Folder Collection, page 209

first, last, previous, next Pagination links xCP Folder Collection, page 209

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

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

210

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 thesetting of the query parameter view.

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

• Pagination is supported.

211

Resources

xCP Folder Single TypeA 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 Folderinstances

xCP Folder Single Type, page212

instances [1] Collection of the Folderinstances

xCP Folder Collection, page 209

defaults [1] Defaults of the type definition xCP Folder Single Type, page212

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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.

212

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

213

Resources

Response Body

XML or JSON representation of the type definition of Folder instances. The instances link relationpoints to a collection of Folder instances, via which you can retrieve an xCP Folder Collection,page 209.

214

Resources

xCP Folder Type CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/folders/test-folder-type

Title Folder type test-folder-type

Summary Summary folder-summary

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

215

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Folder instances

xCP Folder Type Collection,page 215

Operations

A Folder Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forFolder 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

216

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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.

217

Resources

xCP Format Single InstanceA 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, page224

instances [1] Collection of the Formatinstances

xCP Format Collection, page221

self This Format instance xCP Format Single Instance,page 218

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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.

218

Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content

219

Resources

400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, via which you canretrieve an xCP Format Single Type, page 224.

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

220

Resources

xCP Format CollectionA 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 Collectionin 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/formats/xcp_format/275db83d80000102

Title name property of the formatresource

test-format

Summary description property of theformat resource

This is a test format

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

221

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

first, last, previous, next Pagination links xCP Format Collection, page221

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 43 provides more information about common queryparameters.

222

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 thesetting of the query parameter view.

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

• Pagination is supported.

223

Resources

xCP Format Single TypeA 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 Formatinstances

xCP Format Single Type, page224

instances [1] Collection of the Formatinstances

xCP Format Collection, page221

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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

224

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the type definition of Format instances. The instances link relationpoints to a collection Format instances, via which you can retrieve an xCP Format Collection, page 221.

225

Resources

xCP Format Type CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/formats/test-format

Title Format type name test-format

Summary label property of the typeinstance

test-xcp-format

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

226

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Format instances

xCP Format Type Collection,page 226

Operations

A Format Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forFormat 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

227

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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.

228

Resources

xCP Fragment Single InstanceA single instance of Fragment represents an aspect attached to a persistent object. In xCP RESTservices, aspects are a mechanism for adding properties to a persistent object without changing itstype definition. For example, you can attach properties to a business-object instance of a certain typewithout 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 typecan be attached. In xCP REST services, this setting is indicated in the eligibility section of thetype definition for fragments. xCP Fragment Single Type, page 235 provides more information aboutfragments type definition.

Similarly, a type definition of certain persistent objects (for example, business objects, folders, andcontents) also specifies the type of fragments applicable to the corresponding instances in thefragments section. For detailed information, see Fragments in xCP Common Elements, page 50.

URI Template

persistent_object_path/fragments/fragment_type

persistent_object_path Path of the persistent object to which theFragment 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 235

self This Fragment instance xCP Fragment Single Instance,page 229

Operations

A Fragment resource supports the following HTTP methods.

229

Resources

Method Description

GET Retrieve a Fragment instance

POST Attach an aspect (Fragment instance) to apersistent object

Get a Fragment

Retrieve a Fragment instance attached to a persistent object.

HTTP Method

GET

Example 4-20. 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

230

Resources

Response Headers

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, via which you canretrieve an xCP Fragment Single Type, page 235.

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

Example 4-21. 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"}]}

231

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 thepersistent 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. Formore information about this association, see xCP Fragment Single Type, page 235 and the subsectionFragments in xCP Common Elements, page 50.

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 41 provides more information about HTTP headers.

Request Body

XML or JSON representation of the persistent object with the aspect to attach presented in thefragments section. In the following example, the fragment named utapp21_aspect_all_attrsis attached to a business object of the type utapp21_bo_with_aspect.

Example 4-22. Sample Request in JSON

{

232

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 41 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 Status201 - Object created successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed

233

Resources

404 - No object found409 - Conflict500 - Other unexpected server error

Response Body

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

234

Resources

xCP Fragment Single TypeA 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 acertain type of Fragments can be attached. For detailed information, see Response Body, page 236.

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 Fragmentinstances

xCP Fragment Single Type,page 235

Operations

A Fragment Type resource supports the following HTTP method.

Method Description

GET Retrieve the type definition of Fragmentinstances

Get a Fragment Type

Retrieve the type definition of Fragment instances.

HTTP Method

GET

235

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the type definition of Fragment instances. Properties to attach topersistent objects are defined in the properties section. Types of objects to which this type of

236

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 thefollowing types:• utapp21_bo_with_aspect

• utapp21_content_with_aspect

• utapp21_folder_with_aspect

Example 4-23. 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>

237

Resources

xCP Fragment Type CollectionA Fragment Type collection is a resource that represents a collection of type definitions for Fragmentinstances.

URI Template

/types/fragments

Feed and EDAA Support

A collection of Fragment Type instances conforms to Atom Feed in XML representation and EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 theURI of the feed with the nameof the type appended.

http://localhost:8080/xcp-rest/types/fragments/utapp21_aspect_all_attrs

Title Entry title utapp21_aspect_all_attrs

Summary Entry summary Utapp21 Aspect All Attrs

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

238

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Fragment instances

xCP Fragment Type Collection,page 238

Operations

A Fragment Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forFragment 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

239

Resources

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

Request Body

None.

Response Headers

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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.

240

Resources

xCP Full-Text Query Single InstanceA 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 usingfacets.

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 SingleInstance, page 241

type Type definition of this resource xCP Full-Text Query SingleType, page 254

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

241

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 canspecify at most one attribute as the sort criterion when performing a query.

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

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

242

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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

Example 4-24. Query Results in Atom Feed

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

243

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>

244

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

245

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

246

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

247

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

248

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

249

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

250

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

251

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,

252

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

]}

]}

253

Resources

xCP Full-Text Query Single TypeA single instance of Full-Text Query Type represents the type definition of a full-text query that isconfigured 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-textquery

xCP Full-Text Query SingleType, page 254

instances [1] Full-Text Query instance xCP Full-Text Query SingleInstance, page 241

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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.

254

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

255

Resources

Response Body

XML or JSON representation of the type definition of a full-text query. The Type definition mainlycontains the following elements:

Element Description

properties Specifies a set of properties that are displayed inthe output table in xCP.

expression-set Specifies a set of condition constraints with ANDor 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 aresult

• All: Returns all versions of a result

256

Resources

xCP Full-Text Query Type CollectionA Full-Text Query Type collection represents a collection of type definitions for Full-Text Queryinstances.

URI Template

/types/fulltext-queries

Feed and EDAA Support

A collection of Full-Text Query Type instances conforms to Atom Feed in XML representation andEDAA 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/fulltext-queries/sample_query

Title Query name sample_query

Summary Summary of the query A sample query

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

257

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Full-Text Query instances

xCP Full-Text Query TypeCollection, page 257

Operations

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

Method Description

GET Retrieve a collection of type definitions forFull-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

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

258

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 Queryinstances, depending on the setting of the query parameter view.

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

• Pagination is supported.

259

Resources

xCP Historical Query Single InstanceA single instance of the Historical Query resource functions as a business activity monitor (BAM) thatcaptures 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 resultset 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 HistoricalQuery instances

xCP Historical QueryCollection, page 263

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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.

260

Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content

261

Resources

400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the Historical Query resource.

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

262

Resources

xCP Historical Query CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 followsthis pattern: <Feed_URI>/<sequence_number>

http://127.0.0.1:8080/xcp-rest/historical-queries/ut200_hq_bo_all_attribute/0

Title Entry title Entry title

Summary Entry summary Entry summary

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

263

Resources

Link Relation Description Resource Reference

self This collection resource xCP Historical QueryCollection, page 263

first, last, previous, next Pagination links xCP Historical QueryCollection, page 263

Operations

A Historical Query collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of Historical Queryinstances.

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 DefaultValue

time-dimension Controls the time granularity aspectfor BAM reports. This parameterspecifies the aggregation table fromwhich the request retrieves data. Forexample, if you set this parameter toHOURLY, the request retrieves datafrom the HOURLY aggregation table.

string HOURLY,DAILY,WEEKLY,QUARTERLY,and YEARLY

DAILY

relative-last-time Specifies the relative period of timeto look back for.

For example, the followingcombination retrieves data of thelast two hours from the hourly

integer = > 1 1

264

Resources

Name Description Data Type Value Range DefaultValue

aggregation table on which step 1calculation 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

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

Supported Response Media Types

• application/atom+xml

• application/vnd.emc.xcp+json

265

Resources

• application/xml (For compatible viewing)

• application/json (For compatible viewing)

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, dependingon the setting of the query parameter view.

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

• Pagination is supported.

266

Resources

xCP Historical Query Single TypeA 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 HistoricalQuery instances

xCP Historical Query SingleType, page 267

instances [1] Collection of the HistoricalQuery instances

xCP Historical QueryCollection, page 263

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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 Queryinstances

Get a Historical Query Type

Retrieve the type definition of Historical Query instances.

267

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

268

Resources

Response Body

XML or JSON representation of the type definition of Historical Query instances. The instanceslink relation points to a collection of Historical Query instances, via which you can retrieve an xCPHistorical Query Collection, page 263.

269

Resources

xCP Historical Query Type CollectionA Historical Query Type collection represents a collection of type definitions for Historical Queryinstances.

URI Template

/types/historical-queries

Feed and EDAA Support

A collection of Historical Query Type instances conforms to Atom Feed in XML representationand 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

/types/historical-queries/xcp-historical-query

Title Title xcp-historical-query

Summary Summary xcp-historical-query

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

270

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Historical Query instances

xCP Historical Query TypeCollection, page 270

Operations

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

Method Description

GET Retrieve a collection of type definitions forHistorical 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

271

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 Queryinstances, depending on the setting of the query parameter view.

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

• Pagination is supported.

272

Resources

xCP Home DocumentHome Document is an entry point to the REST Server. This resource enables a client application inthe runtime environment to discover resources, media types, and operations that the REST Serversupports.

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 396

application [1] Application instance xCP Application SingleInstance, page 86

business-object-types [1] Type definitions of businessobjects

xCP Business Object SingleType, page 121

content-types [1] Type definitions of contents xCP Content Single Type, page183

folder-types [1] Type definitions of folders xCP Folder Single Type, page212

picklist-types [1] Type definitions of picklist xCP Picklist Single Type, page315

relationship-types [1] Type definitions ofrelationships

xCP Relationship Single Type,page 383

alert-types [1] Type definitions of alerts xCP Alert Single Type, page 74

processes [1] Type definitions of processes xCP Process Single Type, page332

fulltext-query [1] Type definitions of fulltextqueries

xCP Full-Text Query SingleType, page 254

historical-query [1] Type definitions of historicalqueries

xCP Historical Query SingleType, page 267

realtime-query [1] Type definitions of realtimequeries

xCP Real-Time Query SingleType, page 366

alert-query [1] Type definitions of alert queries xCP Alert Query Single Type,page 61

273

Resources

Resource Description Resource Reference

tasklist-query [1] Type definitions of tasklistqueries

xCP Tasklist Query SingleType, page 438

upload [1] File upload xCP File Upload Resource,page 192

about Product information xCP Product InformationSingle Instance, page 338

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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, andoperations 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 43 provides more information about common queryparameters.

274

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the Home Document resource.

Example 4-26. Home Document in JSON

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

275

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

276

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

277

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

278

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>

279

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>

280

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>

281

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>

282

Resources

xCP Member Single InstanceA 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, page297

potentialmembers [1] Collection of potentialmembersof this Member.

This link relation only exists inrole and group members.

xCP Member Collection, page290

members [1] Collection of the Memberinstances that belong to thisMember.

This link relation only exists inrole and group members.

xCP Member Collection, page290

self This Member instance xCP Member Single Instance,page 283

preferences Preferences of the Member xCP User Preference SingleInstance, page 458

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

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

283

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 groupmember

DELETE Remove a Member resource from a role or groupmember

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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

284

Resources

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, via which you canretrieve an xCP Member Single Type, page 297.

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

285

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 linkrelation 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 ofthe member resourceto which you add amember

integer NA

Request Headers

• Accept

• Authorization

• Content-Type

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

286

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 41 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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - 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 updatedMember resource.

• The type link relation points to the type definition of the Member resource, via which you canretrieve a xCP Member Single Type, page 297.

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

287

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 thepotentialmembers 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 themember resource fromwhich you remove amember

integer NA

Request Headers

• Authorization

Common Definition - HTTP Headers , page 41 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 Status204 - Object deleted successfully

288

Resources

400 - Bad request; invalid parameter value was provided401 - Authentication failed403 - Permission denied; no permission to delete the object409 - State conflicted500 - Other unexpected server error

Response Body

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

289

Resources

xCP Member CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/members/xcp_member/1201f70180000900

Title user_name or group_name test-member

Summary user_name or group_name test-member

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

290

Resources

Link Relation Description Resource Reference

self This collection resource xCP Member Collection, page290

first, last, previous, next Pagination links xCP Member Collection, page290

Operations

A Member collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of Member instances of acertain type.

GET Retrieve a collection of members of a role orgroup

GET Retrieve a collection of potential members of arole 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 43 provides more information about common queryparameters.

291

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 thesetting of the query parameter view.

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

• Pagination is supported.

292

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 ofthe 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 themember resource towhich the collectionof Member resourcesbelongs

integer NA

This operation supports the following common query parameters:• view

• links

• inline

• items-per-page

• page

• include-total

• sort

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

293

Resources

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 thesetting 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.

294

Resources

HTTP Method

GET

To get the potential members of a role or group member, send a GET request to thepotentialmembers 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 themember resource towhich the collectionof Member resourcesbelongs

integer NA

This operation supports the following common query parameters:• view

• links

• inline

• items-per-page

• page

• include-total

• sort

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

295

Resources

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 thesetting of the query parameter view.

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

• Pagination is supported.

296

Resources

xCP Member Single TypeA 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 Memberinstances

xCP Member Single Type, page297

instances [1] Collection of the Memberinstances

xCP Member Collection, page290

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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

297

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

298

Resources

Response Body

XML or JSON representation of the type definition of Member instances. The instances linkrelation points to a collection of Member instances, via which you can retrieve an xCP MemberCollection, page 290.

299

Resources

xCP Member Type CollectionAMember 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/members/xcp_member

Title xcp_member xcp_member

Summary Label of the type Format Type

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

300

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Member instances

xCP Member Type Collection,page 300

Operations

A Member Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forMember 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

301

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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.

302

Resources

xCP Network Location Single InstanceA single instance of Network Location is a resource that records information about the networklocations 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 SingleType, page 309

self This Network Location instance xCP Network Location SingleInstance, page 303

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

303

Resources

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

304

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, via whichyou can retrieve an xCP Network Location Single Type, page 309.

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

305

Resources

xCP Network Location CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/network-locations/xcp_network_location/0800492d8000d7fa

Title Entry title host1_network_location

Summary Entry summary host1 network location

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

306

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 LocationCollection, page 306

first, last, previous, next Pagination links xCP Network LocationCollection, page 306

Operations

A Network Location collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of Network Locationinstances.

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 43 provides more information about common queryparameters.

307

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, dependingon the setting of the query parameter view.

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

• Pagination is supported.

308

Resources

xCP Network Location Single TypeA single instance of Network Location Type represents the type definition of Network Locationinstances.

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

xCP Network Location SingleType, page 309

instances [1] Collection of the NetworkLocation instances

xCP Network LocationCollection, page 306

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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 Locationinstances

Get a Network Location Type

Retrieve the type definition of Network Location instances.

309

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

310

Resources

Response Body

XML or JSON representation of the type definition of Network Location instances. The instanceslink relation points to a collection of Network Location instances, via which you can retrieve an xCPNetwork Location Collection, page 306.

311

Resources

xCP Network Location Type CollectionA Network Location Type collection represents a collection of type definitions for Network Locationinstances.

URI Template

/types/network-locations

Feed and EDAA Support

A collection of Network Location Type instances conforms to Atom Feed in XML representationand 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/network-locations/xcp-network-location

Title Name of the network locationtype

xcp-network-location

Summary Summary xCP Network locations

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

312

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Network Location instances

xCP Network Location TypeCollection, page 312

Operations

A Network Location Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forNetwork 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

313

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 Locationinstances, depending on the setting of the query parameter view.

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

• Pagination is supported.

314

Resources

xCP Picklist Single TypeA single instance of the Picklist Type resource is a static list that contains one or more key/valuepairs 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, page315

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.

315

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the Picklist Type resource.

Example 4-28. 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"

316

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

} ]}

317

Resources

xCP Picklist Type CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/picklists/xcp_wq_view_filter

Title Type of the picklist xcp_wq_view_filter

Summary Summary Workqueue View Filter Picklist

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

318

Resources

Link Relation Description Resource Reference

self Collection of Picklist typedefinitions

xCP Picklist Type Collection,page 318

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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

319

Resources

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 settingof the query parameter view.

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

• Pagination is supported.

320

Resources

xCP Process Single InstanceA single instance of Process represents a process of the dm_workflow object type. This resourcedescribes 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, page332

instances [1] Collection of the Processinstances

xCP Process Collection, page 326

self This Process instance xCP Process Single Instance,page 321

tasks Tasks belong to this Processinstance

xCP Task Collection, page 424

attachments Business objects involved inthis Process instance

xCP Business Object Collection,page 118

terminate Terminate this Processinstance.

/processes/process-system-name/object-id/status

resume Resume this Process instance. /processes/process-system-name/object-id/status

halt Halt this Process instance. /processes/process-system-name/object-id/status

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

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

321

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 41 provides more information about HTTP headers.

Request Body

None.

Response Headers

Content-Type

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

322

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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, via which you canretrieve an xCP Process Single Type, page 332.

• 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 ofthe 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 theProcess resource in the following pattern:http://127.0.0.1:8080/rest-app-name/processes/process-system-name/object-id/status

323

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 41 provides more information about HTTP headers.

Request Body

XML or JSON representation of the status of the Process resource.

Example 4-30. Resume a halted process

<resume><user-name>testUser</user-name></resume>

Response Headers

• Location

• Content-Length

• Content-Type

Common Definition - HTTP Headers , page 41 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)

324

Resources

Response Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

Response Body

The response does not contain any data.

325

Resources

xCP Process CollectionA 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 Collectionin 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/processes/xcp-process/4d01e24080030611

Title Entry title xcp-process

Summary Entry summary xcp process

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

326

Resources

Link Relation Description Resource Reference

self This collection resource xCP Process Collection, page326

first, last, previous, next Pagination links xCP Process Collection, page326

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 43 provides more information about common queryparameters.

327

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 thesetting of the query parameter view.

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

• Pagination is supported.

328

Resources

Create a Process

Create a Process instance of a certain process. You can create a Process instance with a reference toan existing business object. Alternatively, you can add an inline business object when creating aProcess resource.

HTTP Method

POST

To create a Process instance of a certain process, send a POST request to the collection of Processinstances 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 41 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 332) specifies mandatory packagesof 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 therequest body contains a field that is not presented in the corresponding DML type (xCP ProcessSingle Type, page 332), the field is ignored.

329

Resources

• Unspecified fields are set the default values in Content 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-31. 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-32. 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>

330

Resources

Response Headers

• Location

• Content-Length

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status201 - Object created successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - 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, via which you canretrieve a xCP Process Single Type, page 332.

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

331

Resources

xCP Process Single TypeA 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 Processinstances

xCP Process Single Type, page332

instances [1] Collection of the Processinstances

xCP Process Collection, page326

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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

332

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

333

Resources

Response Body

XML or JSON representation of the type definition of Process instances. The instances link relationpoints to a collection of Process instances, via which you can retrieve an xCP Process Collection,page 326.

334

Resources

xCP Process Type CollectionA 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 EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/processes/xcp-process

Title Process type xcp-process

Summary Process type summary xcp process

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

335

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Process instances

xCP Process Type Collection,page 335

Operations

A Process Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forprocesses

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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

336

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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.

337

Resources

xCP Product Information Single InstanceA Product Information resource provides general information about the product, including theproduct 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 341

about This Product Informationinstance

xCP Product InformationSingle Instance, page 338

self This Product Informationinstance

xCP Product InformationSingle Instance, page 338

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, minorversion, and so on.

HTTP Method

GET

338

Resources

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

339

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, via whichyou can retrieve an xCP Product Information Type, page 341.

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

340

Resources

xCP Product Information TypeA 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 ProductInformation instance

xCP Product Information Type,page 341

about Product Information instance xCP Product InformationSingle Instance, page 338

Operations

A Product Information Type resource supports the following HTTP method.

Method Description

GET Retrieve the type definition of the ProductInformation instance

Get a Product Information Type

Retrieve the type definition of the Product Information instance.

HTTP Method

GET

Query Parameters

None.

341

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the type definition of the Product Information instance. The aboutlink relation points to the Product Information instance , via which you can retrieve an xCP ProductInformation Single Instance, page 338.

342

Resources

xCP Product Information Type CollectionA Product Information Type collection represents a collection of type definitions for the ProductInformation instance.

URI Template

/types/products

Feed and EDAA Support

A collection of Product Information Type instances conforms to Atom Feed in XML representationand 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/products/xcp_product_info

Title Type name xcp_product_info

Summary Summary Application Product Info

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

343

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor the Product Information

xCP Product Information TypeCollection, page 343

Operations

A Product Information Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions for theProduct 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

344

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 ProductInformation 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

xCP Project Single InstanceA single instance of Project represents a standalone unit that is reusable and can be included in morethan 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 areinstances of xcp-project. For more information, see xCP Project Single Type, page 352.

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

self This Project instance xCP Project Single Instance,page 346

Operations

A Project resource supports the following HTTP method.

Method Description

GET Retrieve a Project resource

Get a Project

Retrieve a Project resource.

346

Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content

347

Resources

400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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, via which you canretrieve an xCP Project Single Type, page 352.

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

348

Resources

xCP Project CollectionA Project collection represents a collection of Project instances of the xcp_project type. For moreinformation about xcp_project, see xCP Project Single Type, page 352.

URI Template

/projects/xcp_project

Feed and EDAA Support

A collection of Project instances conforms to Atom Feed in XML representation and EDAA Collectionin 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/projects/sample-project

Title Entry title sample-project

Summary Entry summary Sample Project

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

349

Resources

Link Relation Description Resource Reference

self This collection resource xCP Project Collection, page349

first, last, previous, next Pagination links xCP Project Collection, page349

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 aboutxcp_project, see xCP Project Single Type, page 352.

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 43 provides more information about common queryparameters.

350

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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 thesetting of the query parameter view.

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

• Pagination is supported.

351

Resources

xCP Project Single TypeA single instance of Project Type represents the type definition of Project instances.

URI Template

types/projects/xcp_projectOnly 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 Projectinstances

xCP Project Single Type, page352

instances [1] Collection of the Projectinstances

xCP Project Collection, page349

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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

352

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

353

Resources

Response Body

XML or JSON representation of the type definition of Project instances. The instances link relationpoints to a collection of Project instances, via which you can retrieve an xCP Project Collection,page 349.

354

Resources

xCP Project Type CollectionA 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 onlycontains one entry.

URI Template

/types/projects

Feed and EDAA Support

A collection of Project Type instances conforms to Atom Feed in XML representation and EDAACollection 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 propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/projects/xcp-project

Title xcp_project xcp_project

Summary Project Project

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

355

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Project instances

xCP Project Type Collection,page 355

Operations

A Project Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forProject 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 43 provides more information about common queryparameters.

356

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - 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.

357

Resources

xCP Queue List Single InstanceA single instance of Queue List returns a list of queues belonging to the current user from a set ofqueues 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 358

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

358

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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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)

359

Resources

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the Queue List resource.

Example 4-33. 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"

360

Resources

},"links": [{

"rel": "edit","href": "queues/xcp_queue/null"

}]}]

}

Example 4-34. 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>

361

Resources

xCP Real-Time Query Single InstanceA 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 SingleInstance, page 362

type Type definition of this resource xCP Real-Time Query SingleType, page 366

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

362

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 canspecify at most one attribute as the sort criterion when performing a query.

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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)

363

Resources

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

Example 4-35. 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-36. Query Results in EDAA Collection

{

364

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"

}}}

365

Resources

xCP Real-Time Query Single TypeA single instance of Real-Time Query Type represents the type definition of a real-time query that isconfigured 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-timequery

xCP Real-Time Query SingleType, page 366

instances [1] Real-Time Query instance xCP Real-Time Query SingleInstance, page 362

[1] This link relation is defined by xCP. The fully qualified xCP link relation path must be prefixedwith 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.

366

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

367

Resources

Response Body

XML or JSON representation of the type definition of a real-time query. The Type definition mainlycontains the following elements:

Element Description

properties Specifies a set of properties that are displayed inthe output table in xCP.

expression-set Specifies a set of condition constraints with ANDor OR operators.

sort Specifies sort settings.

options Specifies which version of the result to return.Valid values are:• LATEST: Only returns the latest version of aresult

• All: Returns all versions of a result

368

Resources

xCP Real-Time Query Type CollectionA Real-Time Query Type collection represents a collection of type definitions for Real-Time Queryinstances.

URI Template

/types/realtime-queries

Feed and EDAA Support

A collection of Real-Time Query Type instances conforms to Atom Feed in XML representationand EDAA Collection in JSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost:8080/xcp-rest/types/realtime-queries/

Title Name of Feed RealtimeQueries

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/realtime-queries/sample_query

Title Query name sample_query

Summary Summary of the query A sample query

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

The following table lists link relation(s) for a Real-Time Query Type collection resource.

369

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Real-Time Query instances

xCP Real-Time Query TypeCollection, page 369

Operations

A Real-Time Query Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forReal-Time Query instances

Get a Real-Time Query Type Collection

Retrieve a collection of type definitions for Real-Time 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

370

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of a collection of type definitions for Real-Time Query instances.

• Each instance may contain all or a set of properties of the type definitions for Real-Time Queryinstances, depending on the setting of the query parameter view.

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

• Pagination is supported.

371

Resources

xCP Relationship Single InstanceA single instance of Relationship defines the fact that two or more resources are related to each other.For example, one Business Object resource can be related to another Business Object resource.

URI Template

/relationships/relationships-type/relationships-id

relationships-type Type of the relationship

relationships-id Object ID of the relationship

Link Relation

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

Link Relation Description Resource Reference

type Type definition of this resource xCP Relationship Single Type,page 383

instances [1] Collection of the Relationshipinstances

xCP Relationship Collection,page 380

self This Relationship instance xCP Relationship SingleInstance, page 372

source Source of the relationship Any resource that can berelated to other resources

target Target of the relationship Any resource that can berelated to other resources

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

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

Operations

A Relationship resource supports the following HTTP methods.

372

Resources

Method Description

GET Retrieve a Relationship resource

POST Update a Relationship resource

POST Create a Relationship resource

DELETE Update a Relationship resource

Get a Relationship

Retrieve a Relationship resource.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

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

373

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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the Relationship resource.• The type link relation points to the type definition of the Relationship resource, via which youcan retrieve an xCP Relationship Single Type, page 383.

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

Update a Relationship

Update a Relationship resource.

HTTP Method

POST

Server Accepted Request Media Types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

374

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

• Content-Type

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

Request Body

XML or JSON representation of the Relationship resource.• This operation updates all fields specified in the request. However, if the request body contains afield that is not presented in the corresponding DML type (xCP Relationship Single Type, page383), the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the list, the entirelist 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 41 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)

375

Resources

Response Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

Response Body

XML or JSON representation of the updated Relationship resource:• The type link relation points to the type definition of the Relationship resource, via which youcan retrieve a xCP Relationship Single Type, page 383.

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

Create a Relationship

Create a Relationship resource of a certain type.

HTTP Method

POST

To create a Relationship resource of a certain type, send a POST request to the collection ofRelationship resources of that type in the following pattern:http://127.0.0.1:8080/rest-app-name/relationships/relationship-type

Server Accepted Request Media Types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

Query Parameters

None.

376

Resources

Request Headers

• Accept

• Authorization

• Content-Type

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

Request Body

XML or JSON representation of the Relationship resource.• This operation creates a Relationship resource with all fields specified in the request. However,if the request body contains a field that is not presented in the corresponding DML type (xCPRelationship Single Type, page 383), the field is ignored.

• Unspecified fields are set the default values in Content 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-37. Request Body in XML

<?xml version="1.0" encoding="UTF-8"?><dm:relationship xmlns:dm="http://identifiers.emc.com/documentum"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:type="ut200_bo_rel_2way_121"dm:definition="http://127.0.0.1:8080/xcp-rest/types/relationships/ut200_bo_rel_2way_121"><dm:properties xsi:type="ut200_bo_rel_2way_121-properties"><dm:r_object-id>3700153880000a04</dm:r_object-id><dm:int_attr_single>0</dm:int_attr_single><dm:source>0000000000000001</dm:source><dm:target>0000000000000002</dm:target></dm:properties></dm:relationship>

Example 4-38. Request Body in JSON

{"name": "relationship","type": "ut200_bo_rel_2way_121","definition": "http://127.0.0.1:8080/xcp-rest/types/relationships/ut200_bo_rel_2way_121","properties": {"r_object-id": "3700153880000a04","int_attr_single": 0,"source": "0000000000000000","target": "0000000000000000"}}

377

Resources

Response Headers

• Location

• Content-Length

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status201 - Object created successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

Response Body

XML or JSON representation of the Relationship resource:• The type link relation points to the type definition of the Relationship resource, via which youcan retrieve a xCP Relationship Single Type, page 383.

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

Delete a Relationship

Delete a Relationship resource.

HTTP Method

DELETE

378

Resources

Query Parameters

None.

Request Headers

• Authorization

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

Request Body

None.

Response Headers

None.

Response Status204 - Object deleted successfully400 - Bad request; invalid parameter value was provided401 - Authentication failed403 - Permission denied; no permission to delete the object409 - State conflicted500 - Other unexpected server error

Response Body

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

379

Resources

xCP Relationship CollectionA Relationship collection represents a collection of Relationship instances.

URI Template

/relationships

Feed and EDAA Support

A collection of Relationship instances conforms to Atom Feed in XML representation and EDAACollection in JSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost:8080/xcp-rest/relationships/sample-relationship

Title Title of the relationships Sample Relationships

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/relationships/sample-relationship/080015388000cd5e

Title Entry title sample-relationship-a

Summary Entry summary A Sample Relationship

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

380

Resources

Link Relation Description Resource Reference

self This collection resource xCP Relationship Collection,page 380

first, last, previous, next Pagination links xCP Relationship Collection,page 380

Operations

A Relationship collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of Relationship instances

Get a Relationship Collection

Retrieve a collection of Relationship 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 43 provides more information about common queryparameters.

381

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of a collection of Relationship instances.• Each instance may contain all or a set of properties of the Relationship instance, depending on thesetting of the query parameter view.

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

• Pagination is supported.

382

Resources

xCP Relationship Single TypeA single instance of Relationship Type represents the type definition of Relationship instances.

URI Template

/types/relationship-type

relationship-type Type of the relationship

Link Relation

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

Link Relation Description Resource Reference

self Type definition of Relationshipinstances

xCP Relationship Single Type,page 383

instances [1] Collection of the Relationshipinstances

xCP Relationship Collection,page 380

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

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

Operations

A Relationship Type resource supports the following HTTP method.

Method Description

GET Retrieve the type definition of Relationshipinstances

Get a Relationship Type

Retrieve the type definition of Relationship instances.

383

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

384

Resources

Response Body

XML or JSON representation of the type definition of Relationship instances. The instanceslink relation points to a collection of Relationship instances, via which you can retrieve an xCPRelationship Collection, page 380.

385

Resources

xCP Relationship Type CollectionA Relationship Type collection represents a collection of type definitions for Relationship instances.

URI Template

/types/relationships

Feed and EDAA Support

A collection of Relationship Type instances conforms to Atom Feed in XML representation and EDAACollection in JSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost:8080/xcp-rest/types/relationships

Title Name of Feed Relationships

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/relationships/sample-relationship-type

Title Title of the relationship loan_proc_emp

Summary Summary of the relationship Proc Loan-Proc EMP

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

386

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Relationship instances

xCP Relationship TypeCollection, page 386

Operations

A Relationship Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forRelationship instances

Get a Relationship Type Collection

Retrieve a collection of type definitions for Relationship 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

387

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

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

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

• Pagination is supported.

388

Resources

xCP Rendition CollectionA Rendition collection represents a collection of pages within a Content instance considered asDocument.

URI Template

viewers/provider-Name/contents/content-type/content-id/view/renditions

viewers/provider-Name/templates/template-type/template-id/view/renditions

provider-Name Name of the viewer provider

content-type Type of the content

content-id Object ID of the content

template-type Type of the template

template-id Object ID of the template

Feed and EDAA Support

A collection of Rendition instances conforms to Atom Feed in XML representation and EDAACollection in JSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost:8080/xcp-rest/ContentViewer/xcp-rest/contents/xcp-contents/00000000001/view/renditions

Title Renditions Renditions

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

Author EMC Documentum EMC Documentum

An entry in this collection resource contains the following properties.

389

Resources

Feed Property Feed Value Example

ID URI of the entry, which followsthis pattern: <Feed_URI>/<rendition_id>

http://localhost:8080/xcp-rest/ContentViewer/contents/xcp-contents/00000000001/view/renditions/1

Title Page number Page 1

Summary Page number Page 1

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

Link Relation Description Resource Reference

self This Rendition collectionresource.

xCP Rendition Collection, page389

Operations

A Rendition collection resource supports the following HTTP method.

Method Description

GET Retrieve a Rendition collection resource

Get Renditions

Retrieve renditions of a Content instance or a Template instance.

HTTP Method

GET

Query Parameters

The following query parameters are specific to this operation:

390

Resources

Parameter Description Type Required or Not

start Specifies the start page

This parameter isnot supported ona standalone RESTserver.

integer Yes

limit Specifies themaximumnumber of pages toreturn in the result

This parameter isnot supported ona standalone RESTserver.

integer Yes

totalPages Specifies the totalnumber of pages in theContent instance

integer No

pages Specifies a list ofcomma separated pageindexes of the pagesthat are extracted fromthe Content instance.Page indexes are 1based. Page rangespecifications (forexample, 1-4) aresupported.

string No

format Specifies the contentformat

string No

location Specifies the ACS orBOCS server wherexCP REST servicesretrieves the pageinformation

string No

isFullyRenderedDoc Indicates whetheror not the entiredocument is rendered

boolean No

items-per-page Specifies the numberof items to be renderedon one page

integer Yes

page Specifies the pagenumber of the page toreturn.If you set items-per-page to 200,and page to 2, the

integer Yes

391

Resources

operation returnsitems 201 to 400.

Additionally, this operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

• Content-Type

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

Supported Response Media Types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/json (For compatible viewing)

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied404 - Object not found500 - Other unexpected server error

392

Resources

Response Body

Atom Feed in XML representation or EDAA Collection in JSON representation of the Renditioncollection resource. Each entry in the collection represents one page of the Content instance. ThepageContentUrl property points to the actual rendition content for that page.

Example 4-39. Response in JSON

{"id": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/view/renditions","title": "Document Renditions","updated": "2014-02-14T14:43:52.565+08:00","author": "EMC Documentum","total": 17,"links": [

{"rel": "self","href": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/view/renditions"

},{

"rel": "next","href": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/view/renditions?items-per-page=10&page=2"

},{

"rel": "last","href": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/view/renditions?items-per-page=10&page=2"

}],"entries": [

{"id": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/view/renditions/1","title": "Page: 1","updated": "2014-02-14T14:43:52.565+08:00","summary": "Page: 1","content": {

"name": "viewer","type": "xcp_viewer_page","definition": "http://10.37.3.201:8000/xCP21UTApp/types/viewers/xcp_viewer_page","properties": {

"pageNumber": 1,"pageContentUrl": "http://content_server:9080/ACS/servlet/ACS?command=read&version=2.3&docbaseid=01e240&basepath=C%3A%5CDocumentum%5Cdata%5Cxcp21H2wk2%5Cthumbnail_storage_01%5C0001e240&filepath=80%5C00%5C14%5Ca2.jpg&objectid=0901e2408002b4c7&cacheid=dAQEAgA%3D%3DohQAgA%3D%3D&format=jpeg_lres&pagenum=0&pagemod=000000000&signature=pIlbnwYd%2BPOmMetr9l3n2yA8rL7EclsYHneJ8lOFvehv9In3SyNIwx9260GqWHKBX0evUrE2myHd8Lw69sNeJZ094yy7sZwT6KeY8Ar1n0q8bVG%2FNHaGRPHC9SqoxWEqUTGm6VJPrX1fkfYcK%2Bq3kYwP905xkYelw0bK6Caj6cg%3D&servername=acs_server&mode=1&timestamp=1392360232&length=17894&mime_type=image%2Fjpeg&parallel_streaming=true&expire_delta=360","pageType": 0

},"links": [],"content-type": "application/vnd.emc.xcp+json"

393

Resources

},"links": [

{"rel": "edit","href": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/view/renditions/1"

}]

},{

"id": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/view/renditions/2",

"title": "Page: 2","updated": "2014-02-14T14:43:52.566+08:00","summary": "Page: 2","content": {

"name": "viewer","type": "xcp_viewer_page","definition": "http://10.37.3.201:8000/xCP21UTApp/types/viewers/xcp_viewer_page","properties": {

"pageNumber": 2,"pageContentUrl": "http://content_server:9080/ACS/servlet/ACS?command=read&version=2.3&docbaseid=01e240&basepath=C%3A%5CDocumentum%5Cdata%5Cxcp21H2wk2%5Cthumbnail_storage_01%5C0001e240&filepath=80%5C00%5C14%5Ca3.jpg&objectid=0901e2408002b4c7&cacheid=dAQEAgA%3D%3DoxQAgA%3D%3D&format=jpeg_lres&pagenum=0&pagemod=000000001&signature=rmBhpImwIMap5DmSWsu5q%2Fw0RfwCZRLPNJjgL9%2F%2FIxKz9GpN%2BYpJbCnrXFT5yaTTaiWzHxhlh6N3WzEa2gwf602Ugf6M36W7cKn4EgxzdzUoMilU5NPaaF2%2Fs9NsJMEkv7%2By18HPbVxyl3W8eEyqcFLIyyzdP31onUcyvjjQNCM%3D&servername=acs_server&mode=1&timestamp=1392360232&length=17894&mime_type=image%2Fjpeg&parallel_streaming=true&expire_delta=360","pageType": 0

},"links": [],"content-type": "application/vnd.emc.xcp+json"

},"links": [

{"rel": "edit","href": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/view/renditions/2"

}]

},...{

"id": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/view/renditions/10","title": "Page: 10","updated": "2014-02-14T14:43:52.572+08:00","summary": "Page: 10","content": {

"name": "viewer","type": "xcp_viewer_page","definition": "http://10.37.3.201:8000/xCP21UTApp/types/viewers/xcp_viewer_page","properties": {

"pageNumber": 10,"pageContentUrl": "http://content_server:9080/ACS/servlet/ACS?command=read&version=2.3&docbaseid=C%3A%5CDocumentum%5Cdata%5Cxcp21H2wk2%5Cthumbnail_storage_01%5C0001e240&filepath=80%5C00%5C14%5Cab.jpg&objectid=0901e2408002b4c7

394

Resources

&cacheid=dAQEAgA%3D%3DqxQAgA%3D%3D&format=jpeg_lres&pagenum=0&pagemod=000000009&signature=raz%2Bbe%2BPybJbDCKnk63UwqMIQovxdxwUF8hCUaij1k%2B40MhYWd%2B3P03RwVFzwiEIr4YjL7LiV3UXEEn5x%2F8CyTzJ4QVmIHFN28Gwzz0PWZkiazJ2fEleJ%2B1CucU70DaBUvpLFNnkbPY7Tl44c0lxh3i8p22MXewOjO6QQ82xE5E%3D&servername=acs_server&mode=1&timestamp=1392360232&length=17894&mime_type=image%2Fjpeg&parallel_streaming=true&expire_delta=360","pageType": 0

},"links": [],"content-type": "application/vnd.emc.xcp+json"

},"links": [

{"rel": "edit","href": "viewers/ContentViewer/contents/dm_document/0901e2408002b4c7/view/renditions/10"

}]

}]

}

395

Resources

xCP Repository Single InstanceA single instance of Repository represents a repository in xCP. This resource exposes severalunderlying resources such as cabinets and members via link relations.

URI Template

/repositories/xcp_repositoryOnly one instance of the xcp_repository type exists. Therefore, this instance does not havea repository ID.

Link Relation

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

Link Relation Description Resource Reference

type Type definition of this resource xCP Repository Single Type,page 399

current-user [1] Current user belongs to thisrepository

xCP Current User Instance,page 189

cabinets [1] Cabinets belong to thisrepository

xCP Cabinet Collection, page137

templates [1] Templates belong to thisrepository

xCP Template Collection, page448

members [1] Members belong to thisrepository

xCP Member Collection, page290

self This Repository instance xCP Repository Single Instance,page 396

formats [1] Formats belong to thisrepository

xCP Format Collection, page221

network-locations [1] Network locations belong tothis repository

xCP Network LocationCollection, page 306

queues [1] Queues belong to thisrepository

xCP Queue List Single Instance,page 358

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

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

396

Resources

Operations

A Repository resource supports the following HTTP method.

Method Description

GET Retrieve a repository

Get a Repository

Retrieve the repository of the xcp_repository type.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

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

397

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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the Repository resource. This operation returns the name of therepository. Underlying resources such as cabinets and members are exposed via link relations.

398

Resources

xCP Repository Single TypeA single instance of Repository Type is a resource that represents the type definition of the xCPrepository. This resource exposes several underlying resources of the repository instance such ascabinets and members via link relations.

URI Template

types/repositories/xcp_repositoryOnly one repository type (xcp_repository) exists.

Link Relation

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

Link Relation Description Resource Reference

instances [1] Instance of the repository type xCP Repository Single Instance,page 396

current-user [1] Current user belongs to thexCP repository

xCP Current User Instance,page 189

cabinets [1] Cabinets belong to the xCPrepository

xCP Cabinet Collection, page137

templates [1] Templates belong to the xCPrepository

xCP Template Collection, page448

members [1] Members belong to the xCPrepository

xCP Member Collection, page290

self This Repository Type instance xCP Repository Single Instance,page 396

formats [1] Formats belong to the xCPrepository

xCP Format Collection, page221

network-locations [1] Network locations belong tothe xCP repository

xCP Network LocationCollection, page 306

queues [1] Queues belong to the xCPrepository

xCP Queue List Single Instance,page 358

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

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

399

Resources

Operations

A Repository Type resource supports the following HTTP method.

Method Description

GET Retrieve the type definition of the xCP repository

Get a Repository Type

Retrieve the type definition of the xCP repository.

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

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

400

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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the type definition of the xCP repository. This resource also exposesseveral underlying resources of the repository instance such as cabinets and members via linkrelations.

401

Resources

xCP Repository Type CollectionA Repository Type collection is a resource that represents a collection of type definitions forRepository instances. Currently, only one type definition (xcp_repository) for repositories exists.Therefore, this collection resource only contains one entry.

URI Template

types/repositories/

Feed and EDAA Support

A collection of Repository Type instances conforms to Atom Feed in XML representation and EDAACollection in JSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost:8080/xcp-rest/types/repositories

Title Name of Feed Repositories

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/repositories/xcp_repository

Title Repository type title xcp_repository

Summary Repository type summary Repository

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

402

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Repository instances

xCP Repository TypeCollection, page 402

Operations

A Repository Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forRepository instances

Get a Repository Type Collection

Retrieve a collection of type definitions for Repository instances. Currently, only one type definition(xcp_repository) for repositories exists. Therefore, this collection resource only contains one entry.

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 43 provides more information about common queryparameters.

403

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of a collection of type definitions for Repository instances. Currently,only one type definition (xcp_repository) for repositories exists. Therefore, this collectionresource only contains one entry.

404

Resources

xCP Stateless Process Single InstanceA single instance of Stateless Process represents a process that runs synchronously as a singletransaction. The synchronous transaction commits only at the end of the process. If an error occursduring the process, the entire process fails.

URI Template

Not applicable.Once a stateless process is started and executed by the system, the response contains therepresentation of the instance after execution. However, the system does not create an object ID forthe instance, meaning that you are not able to obtain a Stateless Process instance via a GET request.

Link Relation

The following table lists general link relation for a Stateless Process resource.

Link Relation Description Resource Reference

type Type definition of this resource xCP Stateless Process SingleType, page 408

Operations

A Stateless Process resource supports the following HTTP method.

Method Description

POST Create and execute a Stateless Process instance

Create a Stateless Process

Create and execute a Stateless Process instance.

HTTP Method

POST

To create and execute a Stateless Process resource of a certain type, set the run-stateless propertyto true in the payload and then send a POST request to the collection of Process resources of thattype in the following pattern:

405

Resources

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 41 provides more information about HTTP headers.

Request Body

XML or JSON representation of the Stateless Process instance.• This operation creates and executes a Stateless Process instance with all fields specified in therequest. However, if the request body contains a field that is not presented in the correspondingDML type (xCP Stateless Process Single Type, page 408), the field is ignored.

• Unspecified fields are set the default values in Content 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 41 provides more information about HTTP headers.

406

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 Status201 - Object created successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

Response Body

XML or JSON representation of the Stateless Process resource:• The type link relation points to the type definition of the Stateless Process resource, via whichyou can retrieve a xCP Stateless Process Single Type, page 408.

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

407

Resources

xCP Stateless Process Single TypeA single instance of Stateless Process Type represents the type definition of Stateless Processinstances. The type definition of Stateless Process resources is identical to that of Process resources.However, a Stateless Process resource is different from a Process instance in the following aspects:• A Stateless Process cannot contain any task.

• A Stateless Process runs synchronously.

• Once a Stateless Process instance is created and executed, the response contains the representationof the instance.

• Some properties defined in a Process type are not supported in a Stateless Process instance.

• A Stateless Process instance only contains the type link relation.

• A Stateless Process instance has the runnable-stateless property set to true.

xCP Process Single Type, page 332 provides more information about the type definition.

408

Resources

xCP Task Single InstanceA single instance of Task represents an execution unit contained in a process. This resource definesdata manipulated in a task, the activity performer, the transition rules, and so on.

URI Template

/processes/process-system-name/process-id/tasks/task-name/task-id

process-system-name System name of the process where this taskbelongs

process-id Object ID of the process where this task belongs

task-name Name of the task

task-id Object ID of the task

Link Relation

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

Link Relation Description Resource Reference

type Type definition of thisresource

xCP Task Single Type, page 427

instances [1] Collection of the Taskinstances

xCP Task Collection, page 424

edit Update this Taskinstance

xCP Task Single Instance, page 409

up Process to which thisTask instance belongs

xCP Process Single Instance, page 321

halt Halt this task /processes/process-system-name/process-id/tasks/task-name/task-id/status

resume Resume this task /processes/process-system-name/process-id/tasks/task-name/task-id/status

complete Complete this task /processes/process-system-name/process-id/tasks/task-name/task-id/status

delegate Delegate this task /processes/process-system-name/process-id/tasks/task-name/task-id/status

409

Resources

Link Relation Description Resource Reference

repeat Repeat this task /processes/process-system-name/process-id/tasks/task-name/task-id/status

reject Reject this task /processes/process-system-name/process-id/tasks/task-name/task-id/status

acquire Acquire this task /processes/process-system-name/process-id/tasks/task-name/task-id/status

unhold Unhold this task /processes/process-system-name/process-id/tasks/task-name/task-id/status

assign Assign this task /processes/process-system-name/process-id/tasks/task-name/task-id/status

reassign Reassign this task /processes/process-system-name/process-id/tasks/task-name/task-id/status

unassign Unassign this task /processes/process-system-name/process-id/tasks/task-name/task-id/status

change-workqueue Move this task toanother workqueue

/processes/process-system-name/process-id/tasks/task-name/task-id/status

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

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

Operations

A Task resource supports the following HTTP methods.

Method Description

GET Retrieve a Task resource

410

Resources

Method Description

GET Retrieve the status of a Task resource

PUT Update the status of a Task resource

PUT Acquire a Task resource

PUT Update the data of a Task resource

PUT Hold or unhold a Task resource

PUT Complete the data of a Task resource

PUT Repeat the data of a Task resource

Get a Task

Retrieve a Task resource.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

411

Resources

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the Task resource.• The type link relation points to the type definition of the Task resource, via which you canretrieve an xCP Task Single Type, page 427.

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

Get the status of a Task

Retrieve the status a Task resource.

HTTP Method

GET

412

Resources

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

413

Resources

Response Body

XML or JSON representation of the status of the Task resource.

Update the status of a Task

Update the status a Task resource. You can update the status of a Task resource to one of thefollowings:• halt

• resume

• terminate

HTTP Method

PUT

To update the status of a Task resource, send a PUT request to the status link relation of the Taskresource in the following pattern:http://127.0.0.1:8080/rest-app-name/processes/process-system-name/process-id/task-name/task-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

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

Request Body

XML or JSON representation of the status of the Task resource.

414

Resources

Example 4-40. Halt a running process

{"halt":{}}

Example 4-41. Resume a halted process

{"resume":{}}

Example 4-42. Terminate a process

{"terminate":{}}

Response Headers

• Location

• Content-Length

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

Response Body

The response does not contain any data.

415

Resources

Acquire a Task

Acquire the data of a task.

HTTP Method

PUT

To acquire the data of a Task resource, send a PUT request to the status link relation of the Taskresource in the following pattern:http://127.0.0.1:8080/rest-app-name/processes/process-system-name/process-id/task-name/task-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

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

Request Body

Example 4-43. Acquire a process

{"acquire":{}

}

416

Resources

Response Headers

• Location

• Content-Length

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

Response Body

The response does not contain any data.

Update a Task

Update the data of a task.

HTTP Method

PUT

To update the data of a Task resource, send a PUT request to the status link relation of the Taskresource in the following pattern:http://127.0.0.1:8080/rest-app-name/processes/process-system-name/process-id/task-name/task-id/status

417

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 41 provides more information about HTTP headers.

Request Body

XML or JSON representation of the updated data.

Example 4-44. Update a process

{"edit":{

"data":{"variables":{

"employee_location":"","student_location":"raichur"

"packages":{"package0":{"properties":{"id":"0000000000000000"}},"package1":{"href":"business-objects/nsoct11_student/

0800492d80009575","properties":{}}},

"attachments":[]}

}}

Response Headers

• Location

• Content-Length

• Content-Type

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

418

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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

Response Body

The response does not contain any data.

Complete a Task

Complete the data of a task.

HTTP Method

PUT

To complete the data of a Task resource, send a PUT request to the status link relation of the Taskresource in the following pattern:http://127.0.0.1:8080/rest-app-name/processes/process-system-name/process-id/task-name/task-id/status

Server Accepted Request Media Types

• application/vnd.emc.xcp+xml

• application/vnd.emc.xcp+json

419

Resources

Query Parameters

None.

Request Headers

• Accept

• Authorization

• Content-Type

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

Request Body

XML or JSON representation of the completed data.

Example 4-45. Complete a process

{"complete":{

"data":{"variables":{

"variable_0":"","variables_1":"somevalue"

"packages":{"package0":{"properties":{"id":"0000000000000000"}},"package1":{"href":"business-objects/nsoct11_student/

0800492d80009575","properties":{}}

},"attachments":[]

}}

}

Alternatively, you can complete the data with sign-off information.

Example 4-46. Complete a process with sing-off

{"complete":{

"data":{"variables":{"var0":"000","var1":111},"packages":{

"package0":{"properties":{"id":"0000000a"} }},

"attachments":[]},

"task-requirements":{"sign-off-password":"password"}

}}

420

Resources

Response Headers

• Location

• Content-Length

• Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

Response Body

The response does not contain any data.

Repeat a Task

Repeat the data of a task.

HTTP Method

PUT

To repeat the data of a Task resource, send a PUT request to the status link relation of the Taskresource in the following pattern:http://127.0.0.1:8080/rest-app-name/processes/process-system-name/process-id/task-name/task-id/status

421

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 41 provides more information about HTTP headers.

Request Body

XML or JSON representation of the repeated data.

Example 4-47. Repeat a process

{"repeat":{"data":{"variables":{"employee_location":"","student_location":"raichur"},"packages":{"package0":{"properties":{"id":"0000000000000000"}},

"package1":{"href":"business-objects/nsoct11_student/0800492d8000a2ec","properties":{}}},

"attachments":[]},"task-requirements":

{"user-name":["user-name"]}}

}

Response Headers

• Location

• Content-Length

• Content-Type

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

422

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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

Response Body

The response does not contain any data.

423

Resources

xCP Task CollectionA Task collection represents a collection of Task instances.

URI Template

/processes/process-system-name/process-id/tasks/task-name/

process-system-name System name of the process where this taskbelongs

process-id Object ID of the process where this task belongs

task-name Name of the task

Feed and EDAA Support

A collection of Task instances conforms to Atom Feed in XML representation and EDAA Collection inJSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost:8000/xCP21UTApp/processes/process-system-name/process-id/tasks/task-name

Title Task tile Sample tasks

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8000/xCP21UTApp/processes/process-system-name/process-id/tasks/task-name/task-id

Title Entry title Sample task

Summary Entry summary Sample task

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

424

Resources

Link Relation

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

Link Relation Description Resource Reference

self This collection resource xCP Task Collection, page 424

first, last, previous, next Pagination links xCP Task Collection, page 424

Operations

A Task collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of Task instances

Get a Task Collection

Retrieve a collection of Task 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 43 provides more information about common queryparameters.

425

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of a collection of Task instances.• Each instance may contain all or a set of properties of the Task instance, depending on the settingof the query parameter view.

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

• Pagination is supported.

426

Resources

xCP Task Single TypeA single instance of Task Type represents the type definition of Task instances.

URI Template

types/processes/process-system-name/tasks/task-name

process-system-name System name of the process to which the tasksbelong

task-name Name of the task

Link Relation

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

Link Relation Description Resource Reference

self Type definition of Taskinstances

xCP Task Single Type, page 427

instances [1] Collection of the Task instances xCP Task Collection, page 424

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

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

Operations

A Task Type resource supports the following HTTP method.

Method Description

GET Retrieve the type definition of Task instances

Get a Task Type

Retrieve the type definition of Task instances.

427

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

428

Resources

Response Body

XML or JSON representation of the type definition of tasks. The instances link relation points to acollection of Task instances, via which you can retrieve an xCP Task Collection, page 424.

429

Resources

xCP Task Type CollectionA Task Type collection represents a collection of type definitions for Task instances that belong to acertain process type.

URI Template

types/processes/process-system-name/tasks

process-system-name System name of the process to which the tasksbelong

Feed and EDAA Support

A collection of Task Type instances conforms to Atom Feed in XML representation and EDAACollection in JSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost:8080/xcp-rest/types/xcp-process/tasks

Title Name of Feed xCP Tasks

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/xcp-process/tasks/sample-task

Title Task title sample-task

Summary Task summary Sample task

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

430

Resources

Link Relation

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

Link Relation Description Resource Reference

self Collection of type definitionsfor Task instances

xCP Task Type Collection, page430

Operations

A Task Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions for Taskinstances

Get a Task Type Collection

Retrieve a collection of type definitions for Task 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 43 provides more information about common queryparameters.

431

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

• Each instance may contain all or a set of properties of the type definitions for Task instances,depending on the setting of the query parameter view.

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

• Pagination is supported.

432

Resources

xCP Tasklist Query Single InstanceA single instance of Tasklist Query Single represents a task list query configured in xCP Designer.This resource enables you to perform a query on tasks assigned to a work queue, the current user,or all users.

URI Template

/tasklist-queries/query_name

query_name Name of the task list query

Link Relation

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

Link Relation Description Resource Reference

self This Tasklist Query instance xCP Tasklist Query SingleInstance, page 433

type Type definition of this resource xCP Tasklist Query SingleType, page 438

Operations

A Tasklist resource supports the following HTTP method.

Method Description

GET Retrieve the results of a task list query

Perform a Tasklist Query

Perform a task list query on metadata of tasks assigned to a work queue, the current user, or all users.

HTTP Method

GET

433

Resources

Query Parameters

This operation supports the following common query parameters:• view

• links

• inline

• items-per-page

• page

• include-total

• sort

A Tasklist Query resource does not support sort on multiple attributes, meaning that you canspecify at most one attribute as the sort criterion when performing a query.

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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)

434

Resources

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

Example 4-48. Response in JSON when inline set to true

{"id": "tasklist-queries/dec10_qtlq1","title": "dec10_qtlq1","updated": "2013-12-09T21:27:08.800-08:00","author": "EMC Documentum","page": 1,"items-per-page": 10,"links": [{

"rel": "self","href": "tasklist-queries/dec10_qtlq1"

}],"entries": [{

"id": "tasklist-queries/dec10_qtlq1/888622289","title": "dec10_qtlq1-0","updated": "2013-12-09T21:27:08.800-08:00","summary": "dec10_qtlq1-0","content": {

"name": "tasklist-query","type": "dec10_qtlq1","definition": "http://localhost:8000/dec10/types/

tasklist-queries/dec10_qtlq1","properties": {

"task_priority": 21,"workqueue_flag": 0,..."workqueue_name": "region","workqueue_priority": 21,"task_subject": "Work queue task-1","task_performer_name": "region"

},"links": [{

"rel": "type","href": "types/processes/dec10_myprocess/tasks/

dec10_work_queue_task_1"}, {

"rel": "http://identifiers.emc.com/linkrel/attachments","href": "processes/dec10_myprocess/4d01e24080001d00/attachments"

}, {"rel": "self","href": "processes/dec10_myprocess/4d01e24080001d00/tasks/

dec10_work_queue_task_1/1b01e24080097ab0"

435

Resources

}, ....{"rel": "http://identifiers.emc.com/linkrel/acquire","href": "processes/dec10_myprocess/4d01e24080001d00/tasks/

dec10_work_queue_task_1/1b01e24080097ab0/status"}],"content-type": "application/vnd.emc.xcp+json"

}}, {

"id": "tasklist-queries/dec10_qtlq1/1988225431","title": "dec10_qtlq1-0","updated": "2013-12-09T21:27:08.802-08:00","summary": "dec10_qtlq1-0","content": {

"name": "tasklist-query","type": "dec10_qtlq1","definition": "http://localhost:8000/dec10/types/tasklist-queries/

dec10_qtlq1","properties": {

"task_priority": 21,..."task_performer_name": "region"

},"links": [{

"href": "types/processes/dec10_myprocess/tasks/dec10_work_queue_task_1"}...

{"rel": "http://identifiers.emc.com/linkrel/acquire","href": "processes/dec10_myprocess/4d01e24080001d01/tasks/

dec10_work_queue_task_1/1b01e24080097ac5/status"}],"content-type": "application/vnd.emc.xcp+json"

}}]}

Example 4-49. Response in XML when inline set to true

<feed xmlns="http://www.w3.org/2005/Atom"xmlns:dm="http://identifiers.emc.com/vocab/xcp">

<id>tasklist-queries/dec10_qtlq1</id><title type="text">dec10_qtlq1</title><updated>2013-12-10T05:40:05.834Z</updated><link href="tasklist-queries/dec10_qtlq1" rel="self"/><author><name>EMC Documentum</name></author><dm:page>1</dm:page><dm:items-per-page>10</dm:items-per-page><entry><id>tasklist-queries/dec10_qtlq1/917251435</id><title type="text">dec10_qtlq1-0</title><updated>2013-12-10T05:40:05.835Z</updated><link href="tasklist-queries/dec10_qtlq1/917251435" rel="edit"/><summary type="text">dec10_qtlq1-0</summary><content type="application/vnd.emc.xcp+xml"><dm:tasklist-query xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:type="dec10_qtlq1"dm:definition="http://localhost:8000/dec10/types/tasklist-queries/dec10_qtlq1">

<dm:properties xsi:type="dec10_qtlq1-properties"><dm:task_priority>21</dm:task_priority><dm:workqueue_flag>0</dm:workqueue_flag><dm:activity_system_name>dec10_myprocess_

436

Resources

work_queue_task_1</dm:activity_system_name>...<dm:task_performer_name>region</dm:task_performer_name></dm:properties><dm:links><dm:link rel="type" href="types/tasklist-queries/dec10_qtlq1"/><dm:link rel="http://identifiers.emc.com/linkrel/instances"

href="tasklist-queries/dec10_qtlq1"/><dm:link rel="self" href="types/tasklist-queries/dec10_qtlq1/defaults"/></dm:links></dm:tasklist-query></content></entry><entry><id>tasklist-queries/dec10_qtlq1/1964143150</id><title type="text">dec10_qtlq1-0</title><updated>2013-12-10T05:40:05.986Z</updated><link href="tasklist-queries/dec10_qtlq1/1964143150" rel="edit"/><summary type="text">dec10_qtlq1-0</summary><content type="application/vnd.emc.xcp+xml"><dm:tasklist-query xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xsi:type="dec10_qtlq1"dm:definition="http://localhost:8000/dec10/types/tasklist-queries/dec10_qtlq1">

<dm:properties xsi:type="dec10_qtlq1-properties"><dm:task_priority>21</dm:task_priority>...</dm:properties><dm:links><dm:link rel="type" href="types/tasklist-queries/dec10_qtlq1"/><dm:link rel="http://identifiers.emc.com/linkrel/instances"

href="tasklist-queries/dec10_qtlq1"/><dm:link rel="self" href="types/tasklist-queries/dec10_qtlq1/defaults"/></dm:links></dm:tasklist-query></content></entry></feed>

437

Resources

xCP Tasklist Query Single TypeA single instance of Tasklist Query Type is represents the type definition of a task list query that isconfigured in xCP Designer.

URI Template

/types/tasklist-queries/query-type

query-type Type of the task list query

Link Relation

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

Link Relation Description Resource Reference

self Type definition of TasklistQuery instances

xCP Tasklist Query SingleType, page 438

instances [1] Tasklist Query instance xCP Tasklist Query SingleInstance, page 433

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

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

Operations

A Tasklist Query Type resource supports the following HTTP method.

Method Description

GET Retrieve the type definition of a task list query

Get a Tasklist Query Type

Retrieve the type definition of a task list query.

438

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

439

Resources

Response Body

XML or JSON representation of the type definition of a task list query. The Type definition mainlycontains the following elements:

Element Description

processes Defines a list of processes to which the tasklist is scoped. A task list can be scoped to allprocesses or a subset of processes. The list ofprocesses also defines which packages andprocess variables are available.

properties Specifies a set of properties that are displayed inthe output table in xCP.

expression-set Specifies a set of condition constraints with ANDor OR operators.

sort Specifies sort settings.

scope Defines the search scope. Valid values are:• USER: Searches tasks assigned to the currentuser

• ALL_USERS: Searches tasks assigned to allusers

• WORKQUEUE: Searches tasks assigned to awork queue

workqueue-view-filter Defines the work queue view filter. Valid valuesare:• SHOW_ALL_TASKS: Shows all tasks in thework queue

• SHOW_UNASSIGNED_TASKS: Showsunassigned tasks in the work queue

• SHOW_PROCESSOR_ELIGIBLE_AND_OWNED_TASKS: Shows the tasks that the processorcan work on and the tasks that the processorowns in the work queue

• SHOW_PROCESSOR_ELIGIBLE_TASKS:Shows the tasks that the processor can workon in the work queue

440

Resources

xCP Tasklist Query Type CollectionA Tasklist Query Type collection represents a collection of type definitions for Tasklist Queryinstances.

URI Template

/types/tasklist-queries

Feed and EDAA Support

A collection of Tasklist Query Type instances conforms to Atom Feed in XML representation andEDAA Collection in JSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost:8080/xcp-rest/types/tasklist-queries

Title Name of Feed Tasklist Queries

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/tasklist-queries/sample-query

Title Title of the query sample-tasklist-query

Summary Summary of the query Sample query

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

441

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Tasklist Query instances

xCP Tasklist Query TypeCollection, page 441

Operations

A Tasklist Query Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forTasklist Query instances

Get a Tasklist Query Type Collection

Retrieve a collection of type definitions for Tasklist Query instances.

HTTP Method

GET

Query Parameters

The following query parameter is specific to this operation:

Parameter Description Data Type

work-queuename Specifies the name of theworkqueue to which tasks areassigned. This parameter isrequired when scope is set toWORKQUEUE.

string

This operation supports the following common query parameters:• view

• links

• inline

• items-per-page

• page

• include-total

• sort

442

Resources

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

443

Resources

Response Body

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

• Each instance may contain all or a set of properties of the type definitions for Tasklist Queryinstances, depending on the setting of the query parameter view.

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

• Pagination is supported.

444

Resources

xCP Template Single InstanceA single instance of Template represents a document (the Content resource) stored in the Templatecabinet. This resource also adds extra properties on top of a regular document.

URI Template

/templates/template-type/r_object-id

template-type Type of the template

r_object-id Object ID of the template

Link Relation

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

Link Relation Description Resource Reference

type Type definition of this resource xCP Template Single Type,page 451

view [1] Viewer configuration for theTemplate resource

xCP Viewer Single Instance,page 473

self This Template instance xCP Template Single Instance,page 445

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

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

Operations

A Template resource supports the following HTTP methods.

Method Description

GET Retrieve a Template resource

Get a Template

Retrieve a Template resource.

445

Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content

446

Resources

400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the Template resource.• The type link relation points to the type definition of the Template resource, via which you canretrieve an xCP Template Single Type, page 451.

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

447

Resources

xCP Template CollectionA Template collection represents a collection of Template instances.

URI Template

/templates/template-type

template-type Type of the template

Feed and EDAA Support

A collection of Template instances conforms to Atom Feed in XML representation and EDAACollection in JSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost:8080/xcp-rest/templates/xcp-template

Title Type of the template xcp-template

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/entry_id

http://localhost:8080/xcp-rest/templates/xcp-template/0901e240800001da

Title Entry title PowerPoint Pre-3.0Presentation

Summary Entry summary PowerPoint Pre-3.0Presentation

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

448

Resources

Link Relation

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

Link Relation Description Resource Reference

self This collection resource xCP Template Collection, page448

first, last, previous, next Pagination links xCP Template Collection, page448

Operations

A Template collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of Template instances.

Get a Template Collection

Retrieve a collection of Template 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 43 provides more information about common queryparameters.

449

Resources

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of a collection of Template instances.• Each instance may contain all or a set of properties of the Template instance, depending on thesetting of the query parameter view.

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

• Pagination is supported.

450

Resources

xCP Template Single TypeA single instance of Template Type represents the type definition of Template instances.

URI Template

/types/templates/template-type

template-type Type of the template

Link Relation

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

Link Relation Description Resource Reference

self Type definition of Templateinstances

xCP Template Single Type,page 451

instances [1] Collection of the Templateinstances

xCP Template Collection, page448

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

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

Operations

A Template Type resource supports the following HTTP method.

Method Description

GET Retrieve the type definition of Templateinstances

Get a Template Type

Retrieve the type definition of Template instances.

451

Resources

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

452

Resources

Response Body

XML or JSON representation of the type definition of Template instances. The instances linkrelation points to a collection of Template instances, via which you can retrieve an xCP TemplateCollection, page 448.

453

Resources

xCP Template Type CollectionA Template Type collection represents a collection of type definitions for Template instances.

URI Template

/types/templates

Feed and EDAA Support

A collection of Template Type instances conforms to Atom Feed in XML representation and EDAACollection in JSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost:8080/xcp-rest/types/templates/

Title Name of Feed Templates

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost:8080/xcp-rest/types/templates/xcp-templates

Title Type of the templates xCP template

Summary Summary xCP template

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

454

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor Template instances

xCP Template Type Collection,page 454

Operations

A Template Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions forTemplate instances

Get a Template Type Collection

Retrieve a collection of type definitions for Template 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

455

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

• Each instance may contain all or a set of properties of the type definitions for Template instances,depending on the setting of the query parameter view.

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

• Pagination is supported.

456

Resources

457

Resources

xCP User Preference Single InstanceA single instance of User Preferences is a resource that describes the preferences of the current user.

URI Template

/preferences

Link Relation

The following table lists general link relations for a User Preferences resource.

Link Relation Description Resource Reference

type Type definition of this resource xCP User Preferences SingleType, page 463

currentuser [1] Owner of the preferences xCP Current User Instance,page 189

self This User Preferences instance xCP User Preference SingleInstance, page 458

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

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

Operations

A User Preferences resource supports the following HTTP methods.

Method Description

GET Retrieve a User Preferences resource

POST Update a User Preferences resource

Get User Preferences

Retrieve the User Preferences resource of the current user.

458

Resources

HTTP Method

GET

Query Parameters

This operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content

459

Resources

400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the User Preferences resource.• The type link relation points to the type definition of the User Preferences resource, via whichyou can retrieve an xCP User Preferences Single Type, page 463.

• The currentuser link relation points to the owner of the User Preferences resource, via whichyou can retrieve an xCP Current User Instance, page 189.

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

Update User Preferences

Update the User Preferences resource of the current user.

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 41 provides more information about HTTP headers.

460

Resources

Request Body

XML or JSON representation of the User Preferences resource.• This operation updates all fields specified in the request. However, if the request body contains afield that is not presented in the corresponding DML type (xCP User Preferences Single Type,page 463), the field is ignored.

• Repeating properties are processed as lists. If you update one of the values in the list, the entirelist 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 41 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 Status200 - Object updated successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict500 - Other unexpected server error

461

Resources

Response Body

XML or JSON representation of the updated User Preferences resource:• The type link relation points to the type definition of the User Preferences resource, via whichyou can retrieve a xCP User Preferences Single Type, page 463.

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

462

Resources

xCP User Preferences Single TypeA single instance of User Preferences Type represents the type definition of the User Preferencesinstance of the current user.

URI Template

/types/preferences-type

preferences-type Type of the user preferences

Link Relation

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

Link Relation Description Resource Reference

self Type definition of UserPreferences instances

xCP User Preferences SingleType, page 463

preferences [1] User preferences of the currentuser

xCP User Preference SingleInstance, page 458

current-user [1] Current user xCP Current User Instance,page 189

collection [1] Collection of User PreferencesType resources

xCP User Preferences TypeCollection, page 466

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

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

Operations

A User Preferences Type resource supports the following HTTP method.

Method Description

GET Retrieve the type definition of the UserPreferences instance

463

Resources

Get a User Preferences Type

Retrieve the type definition of the User Preferences instance of the current user.

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content

464

Resources

400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of the type definition of the User Preferences instance of the currentuser. The preferences link relation points to the User Preferences instance of the current user.

465

Resources

xCP User Preferences Type CollectionA User Preferences Type collection represents a collection of type definitions for User Preferencesinstances.

URI Template

/types/preferences

Feed and EDAA Support

A collection of User Preferences Type instances conforms to Atom Feed in XML representationand EDAA Collection in JSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost8:8080/xcp-rest/types/preferences

Title Preferences Preferences

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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 containsthe URI of the feed and nameof the type.

http://localhost8:8080/xcp-rest/types/preferences/xcp_preference

Title User Preferences Type Test User Preferences

Summary Summary xCP User Preferences

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

466

Resources

Link Relation Description Resource Reference

self Collection of type definitionsfor User Preferences instances

xCP User Preferences TypeCollection, page 466

Operations

A User Preferences Type Collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of type definitions for UserPreferences instances

Get a User Preferences Type Collection

Retrieve a collection of type definitions for User Preferences 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 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

467

Resources

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

Request Body

None.

Response Headers

Content-Type

Common Definition - HTTP Headers , page 41 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 Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

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

• Each instance may contain all or a set of properties of the type definitions for User Preferencesinstances, depending on the setting of the query parameter view.

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

• Pagination is supported.

468

Resources

xCP View Single InstanceA single instance of View represents a viewer control that contains information about how a viewercontrol is rendered and information about the content to be rendered.

URI Template

/contents/content-type/content-id/view

/templates/template-type/template-id/view

contetn-type Type of the content

content-id ID of the content

template-type Type of the template

template-id ID of the template

Link Relation

A View resource does not have any link relation.

Operations

A View resource supports the following HTTP method.

Method Description

GET Retrieve a View resource

Get a View

Retrieve the information about how Content or Template instances can be rendered.

HTTP Method

GET

469

Resources

Query Parameters

The following query parameters are specific to this operation:

Parameter Description Data Type

contentType Indicates the content format,such as PDF

string

ann Indicates whether or notthe viewer control supportsannotations

boolean

man Indicates whether or notthe viewer control supportsannotation modifications

boolean

prn Indicates whether or notthe viewer control supportsprinting

boolean

thm Indicates whether or notthe viewer control supportsthumbnails

boolean

Additionally, this operation supports the following common query parameters:• view

• links

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

470

Resources

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

Supported Response Media Types

• application/vnd.emc.xcp+json

• application/json (For compatible viewing)

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied404 - Object not found500 - Other unexpected server error

Response Body

JSON representation of the View resource.

Example 4-50.

{"objectUri": "templates/xcp_template/0900492d800001f8","objectId": "0900492d800001f8","provider": "ContentViewer","objectName": "Blank PDF Document","providerType": "div","format": "pdf","versionLabel": "1.0,CURRENT","automationLibrary": "","pageCount": -1,"allowThumbnail": false,"allowPageModify": false,"displayAnnotations": false,"allowAnnotate": false,"supportUrlFallback": false,"optionalData": "","userAnnotationUrl": "","allAnnotationsUrl": "","documentUploadUrl": "","annotationUploadUrl": "","printAuditUrl": "","exportAuditUrl": "","viewerAutomationUrl": "","pageDeletionUrl": "","pageReorderUrl": "","pageInsertionUrl": "","pageExtractionUrl": "","parameterList": [{"name": "documentInfo","value": "{\"objectId\":\"0900492d800001f8\",\"objectName\":\"Blank PDF Document\",

471

Resources

\"pageCount\":-1,\"assetClass\":\"Document\",\"documentPages\":null,\"rendering\":false,\"rendered\":false}"

},{"name": "searchInfoUrl","value": "null,{$objectUri}/searchinfo"},{"name": "language","value": "en_US"},{"name": "isCommentingAllowed","value": "false"},{"name": "eventhandler","value": "DocumentViewerEventHandler"},{"name": "documentPagesServiceUrl","value": "/viewers/ContentViewer/{$objectUri}/view/renditions"},{"name": "documentPagesChunkSize","value": "3"},{"name": "docURL","value": "/xcp-rest/templates/xcp_template/0900492d800001f8/stream?

provider=ContentViewer"},{"name": "searchUrl","value": "{$objectUri}/search"},{"name": "isServerSideSearch","value": "false"}]}

Formats

The viewer framework supports many formats for content display. The list of formats can be found inapp_name/WEB-INF/classes/com/emc/xcp/config/web/applicationContext-ivf.xml.

The applicationContext-ivf.xml file also lists the viewer provider used to render the contentof a specific format. By modifying the key-value entries in this file, you can configure the mappingbetween formats and viewer providers for an xCP application.

Note: This configuration is available in xCP Designer UI. It is also a part of the applicationdeployment.

Example 4-51. Sample applicationContext-ivf.xml

<?xml version="1.0" ?><beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns="http://www.springframework.org/schema/beans"xsi:schemaLocation="http://www.springframework.org/schema/beans

472

Resources

http://www.springframework.org/schema/beans/spring-beans-3.0.xsdhttp://www.springframework.org/schema/contexthttp://www.springframework.org/schema/context/spring-context-3.0.xsdhttp://www.springframework.org/schema/aophttp://www.springframework.org/schema/aop/spring-aop-3.0.xsd"><bean class="com.emc.xcp.ivf.runtime.Format2ViewerMapping"><property name="formatMapping"><map><entry key="pdf" value="ContentViewer"></entry><entry key="tiff" value="ContentViewer"></entry><entry key="jpeg" value="ContentViewer"></entry><entry key="gif" value="ContentViewer"></entry><entry key="png" value="ContentViewer"></entry><entry key="bmp" value="ContentViewer"></entry><entry key="msw8" value="ContentViewer"></entry><entry key="msw12" value="ContentViewer"></entry><entry key="msw14" value="ContentViewer"></entry><entry key="ppt8" value="ContentViewer"></entry><entry key="ppt12" value="ContentViewer"></entry><entry key="ppt14" value="ContentViewer"></entry><entry key="excel8book" value="ContentViewer"></entry><entry key="excel12book" value="ContentViewer"></entry><entry key="excel14book" value="ContentViewer"></entry><entry key="msg" value="ContentViewer"></entry><entry key="mpeg-4v" value="VideoViewer"></entry><entry key="ogg" value="VideoViewer"></entry><entry key="webm" value="VideoViewer"></entry><entry key="3gp" value="VideoViewer"></entry><entry key="3g2" value="VideoViewer"></entry><entry key="asf" value="VideoViewer"></entry><entry key="avi" value="VideoViewer"></entry><entry key="flv" value="VideoViewer"></entry><entry key="f4v" value="VideoViewer"></entry><entry key="mpeg" value="VideoViewer"></entry><entry key="m4v" value="VideoViewer"></entry><entry key="quicktime" value="VideoViewer"></entry><entry key="wmv" value="VideoViewer"></entry></map></property></bean></beans>

xCP Viewer Single InstanceA single instance of Viewer represents a viewer provider profile. This profile describes the followingaspects of a viewer provider:• Viewer Capabilities

• Feature Enablement

• Supported Formats

• Environment Settings

• Viewer Control

For more information about viewer provider profiles, see Viewer Provider Profile , page 488.

473

Resources

URI Template

/viewers/viewer-name

viewer-name Name of the viewer

Link Relation

A Viewer resource does not contain any link relations.

Operations

A Viewer resource supports the following HTTP method.

Method Description

GET Retrieve the viewer provider profile.

Get a Viewer

Retrieve the viewer provider profile.

HTTP Method

GET

Query Parameters

This operation supports the following common query parameter:• view

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

474

Resources

Request Body

None.

Response Headers

Content-Type

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

Supported Response Media Types

• application/vnd.emc.xcp+json

• application/json (For compatible viewing)

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

JSON representation of a viewer provider profile. For more information about viewer providerprofiles, see Viewer Provider Profile , page 488.

Example 4-52. Viewer Profile in JSON

{"name": "ContentViewer","viewerCapabilities": {"supportLocalFile": false,"supportPageServing": false,"supportDistrbutedContentDelivery": true,"supportRelativeUrl": true,"supportUrlFallback": false,"supportIRMContainer": false,"supportAutomation": true},"featureEnablement": {"annotation": {"enable": true,"tagname": ""},"annotationCreation": {"enable": true,

475

Resources

"tagname": ""},"thumbnail": {"enable": false,"tagname": ""},"printing": {"enable": true,"tagname": ""},"export": {"enable": false,"tagname": ""},"contentModification": {"enable": false,"tagname": ""}},"supportedFormats": {"format": [{"pageModification": true,"supportAnnotations": true,"dosExtensions": {"ext": ["pdf"]},"name": "pdf"},{"pageModification": true,"supportAnnotations": true,"dosExtensions": {"ext": ["tif","tiff"]},"name": "tiff"},{"pageModification": false,"supportAnnotations": true,"dosExtensions": {"ext": ["jpg","jpeg"]},"name": "jpeg"},{"pageModification": false,"supportAnnotations": true,"dosExtensions": {"ext": ["gif"]},"name": "gif"}]},"environmentSettings": {"pageServingThreshold": 100000,"annotationFormat": "","automationLibrary": "","parameterHandler": "com.emc.xcp.ivf.runtime.handlers.params.DocumentViewerParameterHandler","optionalDataHandler": "com.emc.xcp.ivf.runtime.handlers.data.DefaultOptionalDataHandler","requestHandlers": {"handlerSpecification": [{"baseurl": "/{$objectUri}/stream?provider=ContentViewer","handler": "com.emc.xcp.ivf.runtime.handlers.requests.DefaultDocumentHandler",

476

Resources

"tagname": "docURL","name": "documentDownload"},{"baseurl": "/viewers/ContentViewer/{$objectUri}/view/annotations","handler": "com.emc.xcp.ivf.runtime.handlers.requests.DocumentViewerCommentHandler","tagname": "getCommentsService","name": "annotationDownload"},{"baseurl": "/viewers/ContentViewer/{$objectUri}/view/annotations","handler": "com.emc.xcp.ivf.runtime.handlers.requests.DocumentViewerCommentHandler","tagname": "addCommentService","name": "annotationUpload"},{"baseurl": "/{$objectUri}/clientaudit?provider=ContentViewer&act=Print","handler": "com.emc.xcp.ivf.runtime.handlers.requests.DefaultAuditTrailHandler","tagname": "","name": "printAuditing"},{"baseurl": "/{$objectUri}/page?provider=ContentViewer","handler": "com.emc.xcp.ivf.runtime.handlers.requests.DefaultPageModificationHandler","tagname": "","name": "pageDeletion"},{"baseurl": "/{$objectUri}/page?provider=ContentViewer","handler": "com.emc.xcp.ivf.runtime.handlers.requests.DefaultPageModificationHandler","tagname": "","name": "pageReorder"},{"baseurl": "/{$objectUri}/page?provider=ContentViewer","handler": "com.emc.xcp.ivf.runtime.handlers.requests.DefaultPageModificationHandler","tagname": "","name": "pageInsertion"},{"baseurl": "/{$objectUri}/page?provider=ContentViewer","handler": "com.emc.xcp.ivf.runtime.handlers.requests.DefaultPageModificationHandler","tagname": "","name": "pageExtraction"}]}},"viewerControl": {"attributes": {"attr": []},"parameters": {"param": [{"value": "","name": "documentInfo","type": "custom"},{"value": "{$objectUri}/searchinfo","name": "searchInfoUrl","type": "custom"},{"value": "","name": "language",

477

Resources

"type": "custom"},{"value": "","name": "isCommentingAllowed","type": "custom"},{"value": "DocumentViewerEventHandler","name": "eventhandler","type": "static"},{"value": "/viewers/ContentViewer/{$objectUri}/view/renditions","name": "documentPagesServiceUrl","type": "static"},{"value": "3","name": "documentPagesChunkSize","type": "static"},{"value": "","name": "docURL","type": "runtime"},{"value": "{$objectUri}/search","name": "searchUrl","type": "static"},{"value": "","name": "isServerSideSearch","type": "custom"}]},"type": "div"}}

478

Resources

xCP Viewer CollectionA Viewer collection represents a collection of all Viewer instances.

URI Template

/viewers

Feed and EDAA Support

A collection of Viewer instances conforms to EDAA Collection in JSON representation.

This collection resource contains the following properties.

Feed Property Feed Value Example

ID URI of the feed http://localhost:8080/xcp-rest/viewers

Title Viewer Profiles Viewer Profiles

Updated Value of the updated propertyof the last updated entry in thefeed

2013-01-25T18:51:39.469Z

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, whichfollows this pattern:feed_uri/viewer_name

http://localhost:8080/xcp-rest/viewers/ContentViewer

Title Entry title ContentViewer

Summary Entry summary ContentViewer

Updated Last update time of the instancethat this entry points to

2013-01-25T18:51:39.469Z

Link Relation

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

Link Relation Description Resource Reference

self This collection resource xCP Viewer Collection, page479

479

Resources

Operations

A Viewer collection resource supports the following HTTP method.

Method Description

GET Retrieve a collection of Viewer instances

Get a Viewer Collection

Retrieve a collection of Viewer instances.

HTTP Method

GET

Query Parameters

None.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

Content-Type

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

480

Resources

Supported Response Media Types

• application/atom+xml

• application/vnd.emc.xcp+json

• application/json (For compatible viewing)

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied500 - Other unexpected server error

Response Body

XML or JSON representation of a collection of Viewer instances.

Example 4-53. Viewer Profile Collection in JSON

{"id": "viewers","title": "Viewer Profiles","updated": "2013-11-19T21:40:16.265-05:00","author": "EMC Documentum","links": [{"rel": "self","href": "viewers"}],"entries": [{"id": "viewers/AcrobatReader","title": "AcrobatReader","updated": "2013-11-19T21:40:16.332-05:00","summary": "AcrobatReader","content": {"src": "viewers/AcrobatReader","content-type": "application/vnd.emc.xcp+json"},"links": [{"rel": "edit","href": "viewers/AcrobatReader"}]},{"id": "viewers/AXViewer","title": "AXViewer","updated": "2013-11-19T21:40:16.332-05:00","summary": "AXViewer","content": {"src": "viewers/AXViewer","content-type": "application/vnd.emc.xcp+json"},"links": [{

481

Resources

"rel": "edit","href": "viewers/AXViewer"}]},{"id": "viewers/Browser","title": "Browser","updated": "2013-11-19T21:40:16.332-05:00","summary": "Browser","content": {"src": "viewers/Browser","content-type": "application/vnd.emc.xcp+json"},"links": [{"rel": "edit","href": "viewers/Browser"}]},{"id": "viewers/ContentViewer","title": "ContentViewer","updated": "2013-11-19T21:40:16.332-05:00","summary": "ContentViewer","content": {"src": "viewers/ContentViewer","content-type": "application/vnd.emc.xcp+json"},"links": [{"rel": "edit","href": "viewers/ContentViewer"}]},{"id": "viewers/VideoViewer","title": "VideoViewer","updated": "2013-11-19T21:40:16.332-05:00","summary": "VideoViewer","content": {"src": "viewers/VideoViewer","content-type": "application/vnd.emc.xcp+json"},"links": [{"rel": "edit","href": "viewers/VideoViewer"}]}]}

482

Resources

xCP Raw ContentViewer providers can download the binary streams of Content and Template instances in a singlechunk returned in the response body. Some viewer providers, such as the AXViewer provider, arecapable of uploading content instances by posting binary streams in the request body.

URI Template

/contents/content-type/content-id/stream

/templates/template-type/template-id/stream

content-type Type of the Content instance

content-id r_object-id of the Content instance

template-type Type of the Template instance

template-id r_object-id of the Template instance

Operations

Raw content operations:

Method Description

GET Download the binary stream of a Content orTemplate instance

POST Upload the binary stream of a Content orTemplate instance

Get a Binary Stream

Download the binary stream of a Content or Template instance.

HTTP Method

GET

To download the binary stream of a Content or Template instance:1. Get the view link of a Content or Template instance in the following pattern:

483

Resources

/contents/content-type/content-id/view?contentType=format

The viewer control (xCP View Single Instance, page 469) of the instance is returned.

2. Access docURL of the viewer control:/contents/content-type/content-id/stream?provider=viewer-provider

The binary stream of the Content or Template instance is returned in the response body.

Query Parameters

The following query parameter is specific to this operation:

Parameter Description Data Type Default

use-acs Specifies whetheror not the binarystream of the content isretrieved from an ACSor BOCS server

boolean false

network-location Specifies the addressof the ACS or BOCSserver when use-acsis set to true

string NA

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

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

Request Body

None.

Response Headers

• Content-Type

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

484

Resources

Supported Response Media Types

• application/vnd.emc.xcp+json

• application/json (For compatible viewing)

Response Status200 - Information retrieved successfully204 - No Content400 - Invalid syntax or missing a required value401 - Invalid or missing authentication credentials403 - Permission denied404 - Object not found500 - Other unexpected server error

Response Body

Binary stream of a Content or Template instance.

Upload a Binary Stream

Upload the binary stream of a Content or Template instance.

Note: Refer to the corresponding viewer provider profile to see whether a viewer provider is capableof posting binary streams of Content and Template instances in the request body.

HTTP Method

POST

To upload the binary stream of a Content or Template instance:1. Get the view link of a Content or Template instance in the following pattern:

/contents/content-type/content-id/view?contentType=format

The viewer control (xCP View Single Instance, page 469) of the instance is returned.

2. Place the binary stream of the Content or Template instance in the request body and POST to thefollowing URI:/contents/content-type/content-id/stream?provider=viewer-provider&versionOptions=versionOption&contentType=contentType&comments=comment

The new object URI is returned in the response.

485

Resources

Server Accepted Request Media Types

• application/vnd.emc.xcp+json

Query Parameters

The following query parameters are specific to this operation:

Parameter Description Data Type Default

provider (required) Specifies the viewerprovider used toupload binary streams

string NA

contentType Specifies the contentformat

string NA

versionOptions(required)

Specifies the checkintype. Valid values are:• 0: current version

• 1: next minor

• 2: next major

integer NA

comment Specifies the checkincomment

string NA

Common Definition - Query Parameters, page 43 provides more information about common queryparameters.

Request Headers

• Accept

• Authorization

• Content-Type

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

Request Body

Binary stream of the Content or Template instance.

486

Resources

Response Headers

• Location

• Content-Length

• Content-Type

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

Supported Response Media Types

• application/vnd.emc.documentum+json

• application/json (For compatible viewing)

Response Status200 - Stream uploaded successfully400 - Bad request; invalid attribute name or value401 - Authentication failed403 - Permission denied; no permission to update the object or setting read-only attributesis not allowed404 - No object found409 - Conflict.500 - Other unexpected server error

Response Body

The new object URI is returned in the response.

487

Resources

Viewer Provider ProfileA viewer provider profile is an XML file that describes all aspects of a viewer provider. The profilesare static and do not change at runtime. They are all loaded and cached on the first request for aviewer provider profile. The following table lists the profile locations for all viewer providers.

Viewer Provider Viewer ProviderProfile

File Location

Acrobat reader viewerprovider

AcrobatReader.xml

REST_services_deployment\WEB-INF\lib\xcp-ivf-provider-acrobatreader-version_number.jar\com\emc\xcp\config\app\ivf\providers\

AX viewer provider AXViewer.xml REST_services_deployment\WEB-INF\lib\xcp-ivf-provider-axviewer-version_number.jar\com\emc\xcp\config\app\ivf\providers\

Browser viewer provider Browser.xml REST_services_deployment\WEB-INF\lib\xcp-ivf-provider-browser-version_number.jar\com\emc\xcp\config\app\ivf\providers\

Content viewer provider ContentViewer.xml

REST_services_deployment\WEB-INF\lib\xcp-ivf-provider-contentviewer-version_number.jar\com\emc\xcp\config\app\ivf\providers\

Video viewer provider VideoViewer.xml REST_services_deployment\WEB-INF\lib\xcp-ivf-provider-videoviewer-version_number.jar\com\emc\xcp\config\app\ivf\providers\

A viewer provider profile mainly includes the following elements:• viewerCapabilities— supportLocalFile: indicates whether or not the viewer provider is able to display a fileloaded from local hard disks

— supportPageServing: indicates whether or not the viewer provider supports DocumentumImaging Services page serving. Page serving divides the content into chunks and then sendthem back to the viewer one page at a time for pagable Document content.

— supportDistrbutedContentDelivery: indicates whether or not the viewer providersupports ACS\BOCS for content delivery

— supportRelativeUrl: indicates whether or not the viewer provider supports ACS\BOCSfor content delivery

— supportUrlFallback: indicates whether or not the viewer provider supports standardnon-cached content delivery URLs when ACS\BOCS are not available

— supportIRMContainer: indicates whether or not the viewer provider supports IRM

— supportAutomation: indicates whether or not the viewer provider supports controlautomation

• featureEnablement— annotation: indicates whether or not the viewer provider supports annotations

— annotationCreation: indicates whether or not the viewer provider supports annotationcreation

488

Resources

— thumbnail: indicates whether or not the viewer provider supports thumbnails

— printing: indicates whether or not the viewer provider supports printing

— export: indicates whether or not the viewer provider supports document export

• supportedFormats: lists the supported content formats in the viewer provider

• environmentSettings— pageServingThreshold: specifies the page serving threshold

— annotationFormat: specifies the annotation format for viewer providers supportingannotation

— automationLibrary: specifies the automation library for viewer providers supportingautomation

— parameterHandler: specifies the class handling the parameters for the viewer provider

— optionalDataHandler: specifies the class handling the data used by the viewer provider

— requestHandlers: specifies the class handling the requests for the viewer provider

• viewerControl— attributes: specifies the attributes used when the system renders the viewer control

— parameters: specifies the parameters used when the system renders the viewer control

489

Resources

490

Resources

491