Eidosmedia Rest Application Server documentation

1. Endpoints

1.1. Auth

1.1.1. checkConnection

GET /v3/auth/connection/check

Cheks if the current connection is still alive

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 1. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>
Samples

1.1.2. getConnection

GET /v3/auth/connection

Retrieves connection informations of the user last login

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLoginInfo

Content Type

  • application/json

Responses
Table 2. http response codes
Code Message Datatype

200

successful operation

ResponseLoginInfo

401

Not authorized

<<>>
Samples

1.1.3. getLogin

GET /v3/auth/login

Perform a login through CAS ticket into the system

Description
Parameters
Query Parameters
Name Description Required Default Pattern

applicationId

the applicationId

X

null

connectionId

the connectionId to connect to

X

null

ticket

the CAS ticket

X

null

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

loadConfig

load and resolve user configuration (default: true)

-

true

showUserInfo

show user info (default: false)

-

false

showGroups

if showUserInfo is set to true, shows also user's groups information in the response (default: true)

-

true

showPrivileges

show user privileges (default: false)

-

false

databaseId

the databaseId to use (default: the main databaseId)

-

null

showAvailableConnections

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null
Return Type

ResponseLoginResponse

Content Type

  • application/json

Responses
Table 3. http response codes
Code Message Datatype

200

successful operation

ResponseLoginResponse

401

Not authorized

<<>>
Samples

1.1.4. getLogout

GET /v3/auth/logout

Perform a login into the system

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 4. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>
Samples

1.1.5. postLogin

POST /v3/auth/copy

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

LoginCopyRequest

X
Return Type

ResponseLoginResponse

Content Type

  • application/json

Responses
Table 5. http response codes
Code Message Datatype

200

successful operation

ResponseLoginResponse
Samples

1.1.6. postLogin_1

POST /v3/auth/login

Perform a login into the system

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

LoginRequest

X
Return Type

ResponseLoginResponse

Content Type

  • application/json

Responses
Table 6. http response codes
Code Message Datatype

200

successful operation

ResponseLoginResponse

401

Not authorized

<<>>
Samples

1.2. Bundle

1.2.1. getBundleRoot

GET /v3/bundle/{source}/root

Return the bundle root

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the bundle (loid, uuid, path)

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 7. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.2.2. getChannelCopiesList

GET /v3/bundle/{source}/channelcopies

List bundle channel copies; the source can be the master or a channel copy, and the api will always return all the channel copies of the bundle, even if the source is a channel copy itself

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the bundle (loid, uuid, path)

X

null
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 8. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

400

Bad request

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.2.3. getFolderList

GET /v3/bundle/{source}

List bundle items

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the bundle (loid, uuid, path)

X

null
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWholeBundle

Option that indicates wheather to return the whole bundle informations,in case of channel copy as input

-

false

excludeChainDocuments

Option that indicates wheather to exclude chained documents from bundle informations

-

true

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 9. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

400

Bad request

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.2.4. getFolderListDefaultView

GET /v3/bundle/{source}/view

List bundle items and apply the default view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the bundle (loid, uuid, path)

X

null
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

viewPath

the view path (default: file system root)

-

/

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 10. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.2.5. getFolderListView

POST /v3/bundle/{source}/view

List bundle items and apply the default view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the bundle (loid, uuid, path)

X

null
Body Parameter
Name Description Required Default Pattern

body

FolderViewListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 11. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.2.6. getFolderListView_1

GET /v3/bundle/{source}/view/{view}

List bundle items and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the bundle (loid, uuid, path)

X

null

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

viewPath

the view path (default: file system root)

-

/

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 12. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.2.7. getFolderListView_2

POST /v3/bundle/{source}/view/{view}

List bundle items and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the bundle (loid, uuid, path)

X

null

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

FolderViewListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 13. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.2.8. getFolderListWithPatterns

GET /v3/bundle/{source}/recursive

List all bundle items, by default recursively, using EomDb method list_with_patterns

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the bundle (loid, uuid, path)

X

null
Query Parameters
Name Description Required Default Pattern

recursive

-

true

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 14. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.2.9. getFolderList_3

GET /v3/bundle/{source}/chain

List bundle chain documents

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the bundle (loid, uuid, path)

X

null
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 15. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.3. Conf

1.3.1. clearCache

POST /v3/conf/xmlfiles/clearcache

Clears the memory cache of the xml files and relate entities.

Description
Parameters
Return Type

ResponseByte[]

Content Type

  • /

Responses
Table 16. http response codes
Code Message Datatype

200

successful operation

ResponseByte[]

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.3.2. getCollage

GET /v3/conf/collage

Reads collage configuration

Description
Parameters
Query Parameters
Name Description Required Default Pattern

databaseId

the databaseId to use (default: the main databaseId)

-

null

channel

-

null

token

API token

X

null
Return Type

ResponseCollageConfig

Content Type

  • application/json

Responses
Table 17. http response codes
Code Message Datatype

200

successful operation

ResponseCollageConfig

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.3.3. getColumnCatalogsConfig

GET /v3/conf/catalogs

Returns the list of the valid column catalogs for the current user

Description

This is identical to POST /v3/object/create but the given shape is then applied to the created story

Parameters
Query Parameters
Name Description Required Default Pattern

file

configuration file name

-

columnCfgCatalogs.cfg

type

configuration type

-

ALL

databaseId

database id

-

null
Return Type

ResponseListColumnCatalogsConfig

Content Type

  • application/json

Responses
Table 18. http response codes
Code Message Datatype

200

successful operation

ResponseListColumnCatalogsConfig

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.3.4. getConfigFileXml

GET /v3/conf/xmlfile

Returns a XML configuration file, such as a PageAccessories. The file and its related entities are cached in memory.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

path

file path

-

null

databaseId

database id

-

null

resolveHrefEntity

resolve 'hrefEntity' attribute, must be true for a pageAccessories file (default: false)

-

false
Return Type

ResponseByte[]

Content Type

  • application/xml;charset=utf-8

Responses
Table 19. http response codes
Code Message Datatype

200

successful operation

ResponseByte[]

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.3.5. getConnections

GET /v3/conf/connections

Returns the list of configured database connections

Description
Parameters
Query Parameters
Name Description Required Default Pattern

showRepositories

toggle repository list and default repository (default: false)

-

false
Return Type

ResponseConnectionsInfo

Content Type

  • application/json

Responses
Table 20. http response codes
Code Message Datatype

200

successful operation

ResponseConnectionsInfo
Samples

1.3.6. getIndexes

GET /v3/conf/indexes

Returns the list of indexes

Description
Parameters
Query Parameters
Name Description Required Default Pattern

databaseId

database id

-

null
Return Type

ResponseListDatabaseIndexes

Content Type

  • application/json

Responses
Table 21. http response codes
Code Message Datatype

200

successful operation

ResponseListDatabaseIndexes

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.3.7. getPageAccessories

POST /v3/conf/{source}/pageaccessories

Get page accessories

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the story to retrieve

X

null
Body Parameter
Name Description Required Default Pattern

body

PageAccessoriesRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponsePageAccessoriesResponse

Content Type

  • application/json

Responses
Table 22. http response codes
Code Message Datatype

200

successful operation

ResponsePageAccessoriesResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.3.8. getPageAccessoriesFromPath

POST /v3/conf/pageaccessories

Get page accessories from path

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

PageAccessoriesFromPathRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponsePageAccessoriesResponse

Content Type

  • application/json

Responses
Table 23. http response codes
Code Message Datatype

200

successful operation

ResponsePageAccessoriesResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.3.9. getShapeTemplatesList

POST /v3/conf/shapetemplates/list

Get shape templates list

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ShapeTemplatesListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListShapeTemplatesResponse

Content Type

  • application/json

Responses
Table 24. http response codes
Code Message Datatype

200

successful operation

ResponseListShapeTemplatesResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.3.10. getShapeTemplatesList_1

POST /v3/conf/shapetemplates/{source}/list

Get shape templates list about given source

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

source object

X

null
Body Parameter
Name Description Required Default Pattern

body

ShapeTemplatesListBaseRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListShapeTemplatesResponse

Content Type

  • application/json

Responses
Table 25. http response codes
Code Message Datatype

200

successful operation

ResponseListShapeTemplatesResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found, if the story cannot be found

<<>>
Samples

1.3.11. getSiteConfigXml

GET /v3/conf/siteconfigxml

Returns the SiteConfig file as XML

Description
Parameters
Query Parameters
Name Description Required Default Pattern

databaseId

database id

-

null

refresh

reload siteconfig's modified entities from the repository (default: false)

-

false

forceRefresh

reload all siteconfig entities from the repository (default: false)

-

false
Return Type

ResponseString

Content Type

  • application/xml;charset=utf-8

Responses
Table 26. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.3.12. resolvePAth

GET /v3/conf/{source}/resolvepath

Resolve path starting from a source and finding the resolution path in the site configuration

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

source object

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 27. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.4. ConfCache

1.4.1. getAllCommands

GET /v3/conf/cache/commands

Reads the commands cache for for all connected databases.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoObjectType

Content Type

  • application/json

Responses
Table 28. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoObjectType

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.2. getAllCommandsRefresh

GET /v3/conf/cache/commands/refresh

Refreshes the commands cache for all connected databases.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoCommand

Content Type

  • application/json

Responses
Table 29. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoCommand

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.3. getAllCommandsTimestamp

GET /v3/conf/cache/commands/timestamp

Returns the last update timestamp of the commands cache for all database connected.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 30. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.4. getAllGroups

GET /v3/conf/cache/groups

Reads the groups cache for all database connected

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoGroup

Content Type

  • application/json

Responses
Table 31. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoGroup

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.5. getAllGroupsRefresh

GET /v3/conf/cache/groups/refresh

Refreshes the groups cache for connected databases.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoGroup

Content Type

  • application/json

Responses
Table 32. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoGroup

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.6. getAllGroupsTimestamp

GET /v3/conf/cache/groups/timestamp

Returns the last update timestamp of the groups cache for all database connected.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 33. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.7. getAllJobs

GET /v3/conf/cache/jobs

Reads the jobs cache for all database connected.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoJob

Content Type

  • application/json

Responses
Table 34. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoJob

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.8. getAllJobsRefresh

GET /v3/conf/cache/jobs/refresh

Refreshes the jobs cache for all connected databases.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoJob

Content Type

  • application/json

Responses
Table 35. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoJob

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.9. getAllJobsTimestamp

GET /v3/conf/cache/jobs/timestamp

Returns the last update timestamp of the jobs cache for all database connected.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 36. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.10. getAllObjectTypes

GET /v3/conf/cache/objecttypes

Reads the object types cache for all connected databases

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoObjectType

Content Type

  • application/json

Responses
Table 37. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoObjectType

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.11. getAllObjectTypesRefresh

GET /v3/conf/cache/objecttypes/refresh

Refreshes the object types cache for all connected databases.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoObjectType

Content Type

  • application/json

Responses
Table 38. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoObjectType

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.12. getAllObjectTypesTimestamp

GET /v3/conf/cache/objecttypes/timestamp

Returns the last update timestamp of the object types cache for all database connected.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 39. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.13. getAllUsers

GET /v3/conf/cache/users

Reads the users cache for all database connected.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

showSystemAttributesXml

shows system attributes XML information in the response (default: false)

-

false

showAttributesXml

shows attributes XML information in the response (default: false)

-

false

showVirtualAttributesXml

shows virtual attributes XML information in the response (default: false)

-

false

onlyActive

return only active users

-

false

token

API token

X

null
Return Type

ResponseCacheInfoUser

Content Type

  • application/json

Responses
Table 40. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoUser

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.14. getAllUsersRefresh

GET /v3/conf/cache/users/refresh

Refreshes the users cache for all databaseconnected.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

showSystemAttributesXml

shows system attributes XML information in the response (default: false)

-

false

showAttributesXml

shows attributes XML information in the response (default: false)

-

false

showVirtualAttributesXml

shows virtual attributes XML information in the response (default: false)

-

false

onlyActive

return only active users

-

false

token

API token

X

null
Return Type

ResponseCacheInfoUser

Content Type

  • application/json

Responses
Table 41. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoUser

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.15. getAllUsersTimestamp

GET /v3/conf/cache/users/timestamp

Returns the last update timestamp of the users cache for all database connected.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 42. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.16. getAllWorkflows

GET /v3/conf/cache/workflows

Reads the workflows cache for all database connected

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoWorkflow

Content Type

  • application/json

Responses
Table 43. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoWorkflow

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.17. getAllWorkflowsRefresh

GET /v3/conf/cache/workflows/refresh

Refreshes the workflows cache for all connected databases.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoWorkflow

Content Type

  • application/json

Responses
Table 44. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoWorkflow

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.18. getAllWorkflowsTimestamp

GET /v3/conf/cache/workflows/timestamp

Returns the last update timestamp of the workflows cache for all database connected.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 45. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.19. getCommands

GET /v3/conf/cache/commands/{databaseId}

Reads the commands cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoObjectType

Content Type

  • application/json

Responses
Table 46. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoObjectType

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.20. getCommandsRefresh

GET /v3/conf/cache/commands/refresh/{databaseId}

Refreshes the commands cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoCommand

Content Type

  • application/json

Responses
Table 47. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoCommand

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.21. getCommandsTimestamp

GET /v3/conf/cache/commands/timestamp/{databaseId}

Returns the last update timestamp of the commands cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 48. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.22. getGroups

GET /v3/conf/cache/groups/{databaseId}

Reads the groups cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoGroup

Content Type

  • application/json

Responses
Table 49. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoGroup

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.23. getGroupsRefresh

GET /v3/conf/cache/groups/refresh/{databaseId}

Refreshes the groups cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoGroup

Content Type

  • application/json

Responses
Table 50. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoGroup

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.24. getGroupsTimestamp

GET /v3/conf/cache/groups/timestamp/{databaseId}

Returns the last update timestamp of the groups cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 51. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.25. getJobs

GET /v3/conf/cache/jobs/{databaseId}

Reads the jobs cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoJob

Content Type

  • application/json

Responses
Table 52. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoJob

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.26. getJobsRefresh

GET /v3/conf/cache/jobs/refresh/{databaseId}

Refreshes the jobs cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoJob

Content Type

  • application/json

Responses
Table 53. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoJob

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.27. getJobsTimestamp

GET /v3/conf/cache/jobs/timestamp/{databaseId}

Returns the last update timestamp of the jobs cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 54. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.28. getObjectTypes

GET /v3/conf/cache/objecttypes/{databaseId}

Reads the object types cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoObjectType

Content Type

  • application/json

Responses
Table 55. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoObjectType

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.29. getObjectTypesRefresh

GET /v3/conf/cache/objecttypes/refresh/{databaseId}

Refreshes the object types cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoObjectType

Content Type

  • application/json

Responses
Table 56. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoObjectType

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.30. getObjectTypesTimestamp

GET /v3/conf/cache/objecttypes/timestamp/{databaseId}

Returns the last update timestamp of the object types cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 57. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.31. getRefresh

GET /v3/conf/cache/refresh

Refreshes each system caches.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseMapDatabaseIdListCacheInfoSystemCacheItem

Content Type

  • application/json

Responses
Table 58. http response codes
Code Message Datatype

200

successful operation

ResponseMapDatabaseIdListCacheInfoSystemCacheItem

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.32. getRefresh_1

GET /v3/conf/cache/refresh/{databaseId}

Refreshes each system cache of the database.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListCacheInfoSystemCacheItem

Content Type

  • application/json

Responses
Table 59. http response codes
Code Message Datatype

200

successful operation

ResponseListCacheInfoSystemCacheItem

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.33. getTimestamp

GET /v3/conf/cache/timestamp

Returns the timestamp of the last update for each system cache.

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseMapDatabaseIdMapSystemCachesLong

Content Type

  • application/json

Responses
Table 60. http response codes
Code Message Datatype

200

successful operation

ResponseMapDatabaseIdMapSystemCachesLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.34. getTimestamp_2

GET /v3/conf/cache/timestamp/{databaseId}

Returns the timestamp of the last update for each system cache in the database.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseMapSystemCachesLong

Content Type

  • application/json

Responses
Table 61. http response codes
Code Message Datatype

200

successful operation

ResponseMapSystemCachesLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.35. getUsers

GET /v3/conf/cache/users/{databaseId}

Reads the users cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

showSystemAttributesXml

shows system attributes XML information in the response (default: false)

-

false

showAttributesXml

shows attributes XML information in the response (default: false)

-

false

showVirtualAttributesXml

shows virtual attributes XML information in the response (default: false)

-

false

onlyActive

return only active users

-

false

token

API token

X

null
Return Type

ResponseCacheInfoUser

Content Type

  • application/json

Responses
Table 62. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoUser

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.36. getUsersRefresh

GET /v3/conf/cache/users/refresh/{databaseId}

Refreshes the users cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

showSystemAttributesXml

shows system attributes XML information in the response (default: false)

-

false

showAttributesXml

shows attributes XML information in the response (default: false)

-

false

showVirtualAttributesXml

shows virtual attributes XML information in the response (default: false)

-

false

onlyActive

return only active users

-

false

token

API token

X

null
Return Type

ResponseCacheInfoUser

Content Type

  • application/json

Responses
Table 63. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoUser

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.37. getUsersTimestamp

GET /v3/conf/cache/users/timestamp/{databaseId}

Returns the last update timestamp of the users cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 64. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.38. getWorkflows

GET /v3/conf/cache/workflows/{databaseId}

Reads the workflows cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoWorkflow

Content Type

  • application/json

Responses
Table 65. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoWorkflow

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.39. getWorkflowsRefresh

GET /v3/conf/cache/workflows/refresh/{databaseId}

Refreshes the workflows cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCacheInfoWorkflow

Content Type

  • application/json

Responses
Table 66. http response codes
Code Message Datatype

200

successful operation

ResponseCacheInfoWorkflow

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.4.40. getWorkflowsTimestamp

GET /v3/conf/cache/workflows/timestamp/{databaseId}

Returns the last update timestamp of the workflows cache for the database identified by the {databaseId}.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

databaseId

Database identifier

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong

Content Type

  • application/json

Responses
Table 67. http response codes
Code Message Datatype

200

successful operation

ResponseLong

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.5. ContainerBundle

1.5.1. channelCopy

POST /v3/container/bundle/{source}/channelcopy

Create a new channel copy

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

ChannelCopyRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseChannelCopyResponse

Content Type

  • application/json

Responses
Table 68. http response codes
Code Message Datatype

200

successful operation

ResponseChannelCopyResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.5.2. listContentItemActions

GET /v3/container/bundle/{source}/channelcopy/actions

list content items actions for the channel copy

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Query Parameters
Name Description Required Default Pattern

channel

-

null

inheritFrom

-

null

token

API token

X

null
Return Type

ResponseListContentItemAction

Content Type

  • application/json

Responses
Table 69. http response codes
Code Message Datatype

200

successful operation

ResponseListContentItemAction

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6. ContainerDrawer

1.6.1. changePosition

PUT /v3/container/drawer/{source}/shortcut/{shortcut}/position/{position}

Change item position in a drawer

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

shortcut

item to change

X

null

position

position (zero based). If equals -1 the item will be moved on tail

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 70. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.2. clear

PUT /v3/container/drawer/{source}/item/clear

Clear all items of a drawer

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 71. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.3. deleteItem

DELETE /v3/container/drawer/{source}/item/{item}

Delete an item from drawer.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the drawer

X

null

item

item to remove

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 72. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.4. deleteItems

DELETE /v3/container/drawer/{source}/item

Delete items from a drawer.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the drawer

X

null
Body Parameter
Name Description Required Default Pattern

body

the item list to remove ObjectListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListError

Content Type

  • application/json

Responses
Table 73. http response codes
Code Message Datatype

200

successful operation

ResponseListError

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.5. get

GET /v3/container/drawer/{source}

Get a drawer info

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the drawer to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showItems

shows the items in the drawer (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseDrawer

Content Type

  • application/json

Responses
Table 74. http response codes
Code Message Datatype

200

successful operation

ResponseDrawer

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.6. getObject

GET /v3/container/drawer/object/{source}

Get list of the drawers info where the source is contained

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the source

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showItems

shows the items in the drawer (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseListDrawer

Content Type

  • application/json

Responses
Table 75. http response codes
Code Message Datatype

200

successful operation

ResponseListDrawer

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.7. getQueryString

GET /v3/container/drawer/{source}/querystring

Gets the query string value of a drawer

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the drawer

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 76. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.8. post

POST /v3/container/drawer

Create a drawer

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectDrawerManualCreateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseDrawer

Content Type

  • application/json

Responses
Table 77. http response codes
Code Message Datatype

200

successful operation

ResponseDrawer

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.9. postAddItem

POST /v3/container/drawer/{source}/item

Add more items to a drawer

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the drawer

X

null
Body Parameter
Name Description Required Default Pattern

body

item list to add ObjectListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListError

Content Type

  • application/json

Responses
Table 78. http response codes
Code Message Datatype

200

successful operation

ResponseListError

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.10. postAddItemPosition

PUT /v3/container/drawer/{source}/item/{item}/position/{position}

Add an item intto a drawer in the specified position

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the drawer

X

null

item

item to add

X

null

position

positon indicates the position where add the item if position is 0, the item is added in first position if position is greater than the cardinality (maximum size) and the drawer is full it throws an error if position is greater than the number of the current elements, and the drawer is not full, it is added at the end if position is >=0 and < number of the current elements, the item is added in the position. After the insertion, if the number of elements is greater than the drawer capacity, the last item is removed.

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 79. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.11. postAddItem_1

POST /v3/container/drawer/{source}/item/{item}

Add an item into a drawer

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the drawer

X

null

item

item to add

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectDrawerAddItemRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 80. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.12. postAutomatic

POST /v3/container/drawer/automatic

Create a drawer

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectDrawerAutomaticCreateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseDrawer

Content Type

  • application/json

Responses
Table 81. http response codes
Code Message Datatype

200

successful operation

ResponseDrawer

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.13. putMoveItem

PUT /v3/container/drawer/{source}/item/{item}/move/{target}

Moves an item from source drawer to target drawer

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the source drawer

X

null

item

item to move

X

null

target

the target drawer

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 82. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.14. putQueryString

PUT /v3/container/drawer/{source}/querystring

Sets the query string value in a drawer

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the drawer

X

null
Body Parameter
Name Description Required Default Pattern

body

query string to set [string]

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 83. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.6.15. update

PUT /v3/container/drawer/{source}

Update a drawer

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectDrawerUpdateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 84. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.7. ContainerLiveblog

1.7.1. deleteLiveBlog

DELETE /v3/container/liveblog/{source}

Deletes a liveblog

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the source that identify the live blog

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 85. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.7.2. getContent

GET /v3/container/liveblog/{source}/content

Gives the liveblog content

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the liveblog to retrieve

X

null
Header Parameters
Name Description Required Default Pattern

Range

Request only part of an object. Bytes are numbered from 0.

-

null
Query Parameters
Name Description Required Default Pattern

maxSize

max object size in MB at which truncate the request

-

null

version

content version (default: -1)

-

-1

raw

boolean value to choose whether to get raw or resolved content (default: false)

-

false

showDtd

boolean value to choose whether to get inline dtd within an XML document (default: false)

-

false

token

API token

X

null
Return Type

-

Responses
Table 86. http response codes
Code Message Datatype

200

Object content as stream

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.7.3. getLiveBlog

GET /v3/container/liveblog/{source}

Gives information for a given liveblog

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the liveblog to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 87. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.7.4. getLiveBlogPostsList

POST /v3/container/liveblog/{source}

Get posts of liveblog filtered by request

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the source that identify the live blog

X

null
Body Parameter
Name Description Required Default Pattern

body

Note: The filters are in AND. The list of each filter is in OR LiveBlogSearchRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLiveBlogPostListResponse

Content Type

  • application/json

Responses
Table 88. http response codes
Code Message Datatype

200

successful operation

ResponseLiveBlogPostListResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.7.5. getPosts

POST /v3/container/liveblog/posts

Get all given posts

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLiveBlogPostListResponse

Content Type

  • application/json

Responses
Table 89. http response codes
Code Message Datatype

200

successful operation

ResponseLiveBlogPostListResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.7.6. postFromDefaultTemplate

POST /v3/container/liveblog/from/template

Creates a liveblog using the default template

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

LiveBlogCreateTemplateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 90. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found, if the Template or the WorkFlow status cannot be found

<<>>
Samples

1.7.7. postFromTemplate

POST /v3/container/liveblog/from/template/{source}

Creates a liveblog using the given template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the template to use

X

null
Body Parameter
Name Description Required Default Pattern

body

LiveBlogCreateTemplateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 91. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found, if the Template or the WorkFlow stauts cannot be found

<<>>
Samples

1.7.8. putLiveBlog

PUT /v3/container/liveblog/{source}

Updates an liveblog content

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the liveblog to update

X

null
Body Parameter
Name Description Required Default Pattern

body

the content to write [object]

-
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

checkIn

specify if check-in should be invoked instead of performing a check_in action (default: true)

-

true

keepCheckedOut

specify the value of keepCheckedOut parameter during check-in operation (default: false)

-

false

unlock

if the option checkIn is set to false, this options dictates if the object is unlocked at the end of the operation (default: false)

-

false

newVersion

if the option checkIn is set to true, specify the value of newVersion parameter (default: false)

-

false

checkOut

specify if check-out should be executed (default: false)

-

false

checkOutClean

specify if clean check-out should be executed (default: false)

-

false

addContentItemsId

add id in content item if it is not present (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 92. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.8. ContainerLiveblogPost

1.8.1. copyLiveBlogPost

POST /v3/container/liveblog/{source}/post/from/{post}

Creates an object copying content and metadata from the given post id from another liveblog

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the liveblog where to add the new post

X

null

post

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCobaltResponse

Content Type

  • application/json

Responses
Table 93. http response codes
Code Message Datatype

200

successful operation

ResponseCobaltResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If WorkFlow status cannot be found

<<>>
Samples

1.8.2. deleteLiveBlog

DELETE /v3/container/liveblog/{source}/post/{post}

Deletes a post

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the liveblog to which belongs the post

X

null

post

the source that identify the post

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 94. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.8.3. getPost

GET /v3/container/liveblog/{source}/post/{post}

Gives information for a given post

Description
Parameters
Path Parameters
Name Description Required Default Pattern

post

the post to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCobaltResponse

Content Type

  • application/json

Responses
Table 95. http response codes
Code Message Datatype

200

successful operation

ResponseCobaltResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.8.4. postLiveBlogPost

POST /v3/container/liveblog/{source}/post

Create an object with the given content

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the liveblog where to add a new post

X

null
Form Parameter
Name Description Required Default Pattern

options

<pre>{ \\&quot;systemAttributes\\&quot;: \\&quot;string\\&quot;, \\&quot;attributes\\&quot;: \\&quot;string\\&quot;, \\&quot;moderated\\&quot;: true (it will be ignored when updates a post), \\&quot;summary\\&quot;: the live blog post summary, \\&quot;title\\&quot;: the live blog post title, \\&quot;description\\&quot;: the live blog post description, \\&quot;type\\&quot;: the live blog post type, \\&quot;timestamp\\&quot;: the number of milliseconds from the epochof 1970-01-01T00:00:00Z, if present, will be used to create the post name, \\&quot;createMode\\&quot;: specify the creation mode (default: EXCEPTION, other values: AUTO_RENAME, REPLACE, NEW_VERSION), }</pre> [ref]

-

null

content

the content to write [file]

X

null

attachments

attachments to save [FormDataBodyPart]

-

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCobaltResponse

Content Type

  • application/json

Responses
Table 96. http response codes
Code Message Datatype

200

successful operation

ResponseCobaltResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If WorkFlow status cannot be found

<<>>
Samples

1.8.5. postLiveBlogPostApproved

POST /v3/container/liveblog/{source}/post/{post}/approve

Put status approved to post

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the liveblog to which belongs the post

X

null

post

the post to update

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 97. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.8.6. postLiveBlogPostDeleted

POST /v3/container/liveblog/{source}/post/{post}/delete

Put status deleted to post

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the liveblog to which belongs the post

X

null

post

the post to update

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 98. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.8.7. postLiveBlogPostPending

POST /v3/container/liveblog/{source}/post/{post}/pending

Put status pending to post

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the liveblog to which belongs the post

X

null

post

the post to update

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 99. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.8.8. postLiveBlogPostRejected

POST /v3/container/liveblog/{source}/post/{post}/reject

Put status rejected to post

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the liveblog to which belongs the post

X

null

post

the post to update

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 100. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.8.9. putLiveBlogPost

PUT /v3/container/liveblog/{source}/post/{post}

Update the post

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the liveblog to which belongs the post

X

null

post

the post to update

X

null
Form Parameter
Name Description Required Default Pattern

options

<pre>{ \\&quot;systemAttributes\\&quot;: \\&quot;string\\&quot;, \\&quot;attributes\\&quot;: \\&quot;string\\&quot;, \\&quot;moderated\\&quot;: true (it will be ignored when updates a post), \\&quot;summary\\&quot;: the live blog post summary, \\&quot;title\\&quot;: the live blog post title, \\&quot;description\\&quot;: the live blog post description, \\&quot;type\\&quot;: the live blog post type, \\&quot;timestamp\\&quot;: the number of milliseconds from the epochof 1970-01-01T00:00:00Z, if present, will be used to create the post name }</pre> [ref]

-

null

content

the content to write [file]

X

null

attachments

attachments to save [FormDataBodyPart]

-

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseCobaltResponse

Content Type

  • application/json

Responses
Table 101. http response codes
Code Message Datatype

200

successful operation

ResponseCobaltResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.9. ContainerOpendocument

1.9.1. openDocument

POST /v3/container/{source}/opendocument

Open a generic container (DWP, DWC, PGL, PRP, PRX, CompoundStory)

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

The container (DWP, DWC, PGL, PRP, PRX, CompoundStory) to open

X

null
Body Parameter
Name Description Required Default Pattern

body

OpenDocumentOptions

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseOpenDocumentResponse

Content Type

  • application/json

Responses
Table 102. http response codes
Code Message Datatype

200

successful operation

ResponseOpenDocumentResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.9.2. openDocumentNoParam

POST /v3/container/opendocument

Open a generic container (DWP, DWC, PGL, PRP, PRX, CompoundStory)

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

OpenDocumentOptions

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseOpenDocumentResponse

Content Type

  • application/json

Responses
Table 103. http response codes
Code Message Datatype

200

successful operation

ResponseOpenDocumentResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.9.3. openDocuments

POST /v3/container/opendocuments

Open a generic container (DWP, DWC, PGL, PRP, PRX, CompoundStory)

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

OpenDocumentsRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseOpenDocumentResponse[]

Content Type

  • application/json

Responses
Table 104. http response codes
Code Message Datatype

200

successful operation

ResponseOpenDocumentResponse[]

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10. ContainerTopic

1.10.1. addDivider

POST /v3/container/topic/{topic}/divider

Add a divider into a topic

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null
Body Parameter
Name Description Required Default Pattern

body

AddDividerRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseDividerObjectInfo

Content Type

  • application/json

Responses
Table 105. http response codes
Code Message Datatype

200

successful operation

ResponseDividerObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.2. addDividerInTopicItem

POST /v3/container/topic/{topic}/topicitem/{topicItem}/divider

Add a divider into a topic

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

topicItem

the topic item source

X

null
Body Parameter
Name Description Required Default Pattern

body

AddDividerRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseDividerObjectInfo

Content Type

  • application/json

Responses
Table 106. http response codes
Code Message Datatype

200

successful operation

ResponseDividerObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.3. addTopicItem

POST /v3/container/topic/{topic}/topicitem

Add a topic item into a topic

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicItemCreateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicItem

Content Type

  • application/json

Responses
Table 107. http response codes
Code Message Datatype

200

successful operation

ResponseTopicItem

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.4. addTopicSubItem

POST /v3/container/topic/{topic}/topicitem/{topicItem}/topicsubitem

Add a topic subitem into a topic

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

topicItem

the topic item source

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicItemCreateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicSubItem

Content Type

  • application/json

Responses
Table 108. http response codes
Code Message Datatype

200

successful operation

ResponseTopicSubItem

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.5. attachToTopicItem

PUT /v3/container/topic/{topic}/topicitem/{topicItem}/attach/{attachment}

Attach an object to a topic item

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

topicItem

the topic item source

X

null

attachment

X

null
Body Parameter
Name Description Required Default Pattern

body

FileSystemShowOptions

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicItem

Content Type

  • application/json

Responses
Table 109. http response codes
Code Message Datatype

200

successful operation

ResponseTopicItem

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.6. attachToTopicSubItem

PUT /v3/container/topic/{topic}/topicitem/{topicItem}/topicsubitem/{topicSubItem}/attach/{attachment}

Attach an object to a topic subitem

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

topicItem

the topic item source

X

null

topicSubItem

the topic item source

X

null

attachment

X

null
Body Parameter
Name Description Required Default Pattern

body

FileSystemShowOptions

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicSubItem

Content Type

  • application/json

Responses
Table 110. http response codes
Code Message Datatype

200

successful operation

ResponseTopicSubItem

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.7. deleteDivider

DELETE /v3/container/topic/{topic}/divider/{divider}

Delete a divider into a topic

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

divider

the divider id

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 111. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.8. deleteDivider_1

DELETE /v3/container/topic/{topic}/topicitem/{topicItem}/divider/{divider}

Delete a divider into a topic item

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

topicItem

the topic item source

X

null

divider

the divider id

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 112. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.9. deleteTopicItem

DELETE /v3/container/topic/{topic}/topicitem/{topicItem}

Delete a topic item into a topic

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

topicItem

the topic item source

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 113. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.10. deleteTopicSubItem

DELETE /v3/container/topic/{topic}/topicitem/{topicItem}/topicsubitem/{topicSubItem}

Delete a topic subitem into a topic

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

topicItem

the topic item source

X

null

topicSubItem

the topic subitem source

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 114. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.11. get

GET /v3/container/topic/{topic}

Reads a topic

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showCorrelates

shows correlated objects in the response (default: false)

-

false

showAttachment

shows attached object in the response (default: false)

-

false

limitToChildren

limit the read to the object's children (default: true)

-

true

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseTopic

Content Type

  • application/json

Responses
Table 115. http response codes
Code Message Datatype

200

successful operation

ResponseTopic

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.12. getStructure

GET /v3/container/topic/{topic}/structure

Reads a topic structure (topic information and related topic item ids)

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseTopic

Content Type

  • application/json

Responses
Table 116. http response codes
Code Message Datatype

200

successful operation

ResponseTopic

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.13. move

PUT /v3/container/topic/move

Move a topic items into a topic or topics into a topic plan

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

TopicMoveRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicMoveResponse

Content Type

  • application/json

Responses
Table 117. http response codes
Code Message Datatype

200

successful operation

ResponseTopicMoveResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.14. post

POST /v3/container/topic

Creates an empty topic

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

EmptyTopicCreateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopic

Content Type

  • application/json

Responses
Table 118. http response codes
Code Message Datatype

200

successful operation

ResponseTopic

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.15. postFromDefaultTemplate

POST /v3/container/topic/from/template

Creates a topic using the default template

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

TopicCreateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopic

Content Type

  • application/json

Responses
Table 119. http response codes
Code Message Datatype

200

successful operation

ResponseTopic

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.16. postFromTemplate

POST /v3/container/topic/from/template/{source}

Create a topic using the given template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the template to use

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicCreateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopic

Content Type

  • application/json

Responses
Table 120. http response codes
Code Message Datatype

200

successful operation

ResponseTopic

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.17. update

PUT /v3/container/topic/{topic}

Update title and description of a topic

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicUpdateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopic

Content Type

  • application/json

Responses
Table 121. http response codes
Code Message Datatype

200

successful operation

ResponseTopic

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.18. updateDivider

PUT /v3/container/topic/{topic}/divider/{divider}

Update a divider into a topic

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

divider

the divider id

X

null
Body Parameter
Name Description Required Default Pattern

body

UpdateDividerRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseDividerObjectInfo

Content Type

  • application/json

Responses
Table 122. http response codes
Code Message Datatype

200

successful operation

ResponseDividerObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.19. updateDivider_2

PUT /v3/container/topic/{topic}/topicitem/{topicItem}/divider/{divider}

Update a divider into a topic item

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

topicItem

the topic item source

X

null

divider

the divider id

X

null
Body Parameter
Name Description Required Default Pattern

body

UpdateDividerRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseDividerObjectInfo

Content Type

  • application/json

Responses
Table 123. http response codes
Code Message Datatype

200

successful operation

ResponseDividerObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.20. updateTopicItem

PUT /v3/container/topic/{topic}/topicitem/{topicItem}

Update a topic item

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

topicItem

the topic item source

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicItemUpdateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicItemObjectInfo

Content Type

  • application/json

Responses
Table 124. http response codes
Code Message Datatype

200

successful operation

ResponseTopicItemObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.10.21. updateTopicSubItem

PUT /v3/container/topic/{topic}/topicitem/{topicItem}/topicsubitem/{topicSubItem}

Update a topic subitem

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topic

the topic source

X

null

topicItem

the topic item source

X

null

topicSubItem

the topic subitem source

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicItemUpdateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicItemObjectInfo

Content Type

  • application/json

Responses
Table 125. http response codes
Code Message Datatype

200

successful operation

ResponseTopicItemObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.11. ContainerTopicplan

1.11.1. addDivider

POST /v3/container/topicplan/{topicPlan}/divider

Add a divider into a topic plan

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topicPlan

the topic plan source

X

null
Body Parameter
Name Description Required Default Pattern

body

AddDividerRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseDividerObjectInfo

Content Type

  • application/json

Responses
Table 126. http response codes
Code Message Datatype

200

successful operation

ResponseDividerObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.11.2. addTopic

PUT /v3/container/topicplan/{topicPlan}/add/{topic}

Add topic to topic plan

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topicPlan

X

null

topic

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicAddRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopic

Content Type

  • application/json

Responses
Table 127. http response codes
Code Message Datatype

200

successful operation

ResponseTopic

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.11.3. deleteDivider

DELETE /v3/container/topicplan/{topicPlan}/divider/{divider}

Delete a divider into a topic plan

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topicPlan

the topic plan source

X

null

divider

the divider id

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 128. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.11.4. deleteTopic

DELETE /v3/container/topicplan/{topicPlan}/delete/{topic}

Delete topic from topic plan

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topicPlan

X

null

topic

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 129. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.11.5. get

GET /v3/container/topicplan/{topicPlan}

Reads a topic plan

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topicPlan

the topic plan source

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showCorrelates

shows correlated objects in the response (default: false)

-

false

showAttachment

shows attached object in the response (default: false)

-

false

limitToChildren

limit the read to the object's children (default: true)

-

true

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseTopicPlan

Content Type

  • application/json

Responses
Table 130. http response codes
Code Message Datatype

200

successful operation

ResponseTopicPlan

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.11.6. getStructure

GET /v3/container/topicplan/{topicPlan}/structure

Reads a topic plan structure (topic plan information and related topic ids)

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topicPlan

the topic plan source

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseTopicPlan

Content Type

  • application/json

Responses
Table 131. http response codes
Code Message Datatype

200

successful operation

ResponseTopicPlan

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.11.7. post

POST /v3/container/topicplan

Creates an empty topic plan

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

EmptyTopicPlanCreateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicPlan

Content Type

  • application/json

Responses
Table 132. http response codes
Code Message Datatype

200

successful operation

ResponseTopicPlan

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.11.8. postFromDefaultTemplate

POST /v3/container/topicplan/from/template

Creates a topic plan using the default template

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

TopicPlanCreateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicPlan

Content Type

  • application/json

Responses
Table 133. http response codes
Code Message Datatype

200

successful operation

ResponseTopicPlan

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.11.9. postFromTemplate

POST /v3/container/topicplan/from/template/{source}

Create a topic plan using the given template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the template to use

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicPlanCreateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicPlan

Content Type

  • application/json

Responses
Table 134. http response codes
Code Message Datatype

200

successful operation

ResponseTopicPlan

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.11.10. updateDivider

PUT /v3/container/topicplan/{topicPlan}/divider/{divider}

Update a divider into a topic plan

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topicPlan

the topic plan source

X

null

divider

the divider id

X

null
Body Parameter
Name Description Required Default Pattern

body

UpdateDividerRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseDividerObjectInfo

Content Type

  • application/json

Responses
Table 135. http response codes
Code Message Datatype

200

successful operation

ResponseDividerObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.12. ContainerWeb

1.12.1. channelCopy

POST /v3/container/web/{source}/channelcopy

Create a channel copy for each story linked to the web container taking into account of cross references

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

WebChannelCopyRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfoList

Content Type

  • application/json

Responses
Table 136. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.13. Crossreference

1.13.1. getCrossReferenceByXpath

POST /v3/crossreference

Get cross references by xpath

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

GetCrossReferenceRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseGetCrossReferenceResponse

Content Type

  • application/json

Responses
Table 137. http response codes
Code Message Datatype

200

successful operation

ResponseGetCrossReferenceResponse

400

Invalid data

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.13.2. setCrossReferenceByXpathAndIndex

POST /v3/crossreference/{source}

Set cross reference by xpath and index

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the source where set cross reference

X

null
Body Parameter
Name Description Required Default Pattern

body

SetCrossReferenceRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseSetCrossReferenceResponseBean

Content Type

  • application/json

Responses
Table 138. http response codes
Code Message Datatype

200

successful operation

ResponseSetCrossReferenceResponseBean

400

Invalid data

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14. Folder

1.14.1. createFolder

POST /v3/folder

Create a new folder recursively

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

FolderCreateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 139. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.2. getFolderList

GET /v3/folder/{source}

List folder content

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the folder (loid, uuid, path)

X

null
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 140. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.3. getFolderListDefaultView

GET /v3/folder/{source}/view

List folder content and apply the default view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the folder (loid, uuid, path)

X

null
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

viewPath

the view path (default: file system root)

-

/

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 141. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.4. getFolderListView

POST /v3/folder/{source}/view

List folder content and apply the default view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the folder (loid, uuid, path)

X

null
Body Parameter
Name Description Required Default Pattern

body

FolderViewListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 142. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.5. getFolderListView_1

GET /v3/folder/{source}/view/{view}

List folder content and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the folder (loid, uuid, path)

X

null

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

viewPath

the view path (default: file system root)

-

/

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 143. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.6. getFolderListView_2

POST /v3/folder/{source}/view/{view}

List root folder content and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the folder (loid, uuid, path)

X

null

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

FolderViewListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 144. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.7. getHomeFolderList

GET /v3/folder/home

List home folder content

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

databaseId

the databaseId to use (default: the main databaseId)

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 145. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.8. getHomeFolderListDefaultView

GET /v3/folder/home/view

List home folder content and apply the default view for the response

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

viewPath

the view path (default: file system root)

-

/

databaseId

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 146. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.9. getHomeFolderListView

POST /v3/folder/home/view

List home folder content and apply the default view for the response

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

FixedFolderViewListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 147. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.10. getHomeFolderListView_3

GET /v3/folder/home/view/{view}

List home folder content and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

viewPath

the view path (default: file system root)

-

/

databaseId

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 148. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.11. getHomeFolderListView_4

POST /v3/folder/home/view/{view}

List home folder content and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

FixedFolderViewListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 149. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.12. getListPatterns

GET /v3/folder/{source}/filter

List folder with pattern and some filter

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the folder (loid, uuid, path)

X

null
Query Parameters
Name Description Required Default Pattern

patternSequence

the sequence of the patterns (ORed) [String]

-

null

excludeFolders

specifies if the list must exclude the subfolders

-

false

showHidden

specifies if the list must show hidden files

-

false

recursive

specifies if the list must be recursive

-

false

howMany

how many objects will be returned (0 for all)

-

0

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 150. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.13. getRootFolderList

GET /v3/folder/root

List root folder content

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

databaseId

the databaseId to use (default: the main databaseId)

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 151. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.14. getRootFolderListDefaultView

GET /v3/folder/root/view

List root folder content and apply the default view for the response

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

viewPath

the view path (default: file system root)

-

/

databaseId

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 152. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.15. getRootFolderListView

POST /v3/folder/root/view

List root folder content and apply the default view for the response

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

FixedFolderViewListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 153. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.16. getRootFolderListView_5

GET /v3/folder/root/view/{view}

List root folder content and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

viewPath

the view path (default: file system root)

-

/

databaseId

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 154. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.17. getRootFolderListView_6

POST /v3/folder/root/view/{view}

List root folder content and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

FixedFolderViewListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 155. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.18. getSubfolders

GET /v3/folder/{source}/subfolders

List folder’s subfolders

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the folder (loid, uuid, path)

X

null
Query Parameters
Name Description Required Default Pattern

limit

limit the resolved elements (default: 20)

-

20

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 156. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.19. getWorkFolderList

GET /v3/folder/work

List work folder content

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

databaseId

the databaseId to use (default: the main databaseId)

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 157. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.20. getWorkFolderListDefaultView

GET /v3/folder/work/view

List work folder content and apply the default view for the response

Description
Parameters
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

viewPath

the view path (default: file system root)

-

/

databaseId

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 158. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.21. getWorkFolderListView

POST /v3/folder/work/view

List work folder content and apply the default view for the response

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

FixedFolderViewListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 159. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.22. getWorkFolderListView_7

GET /v3/folder/work/view/{view}

List work folder content and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

sortBy

property to use for sorting

-

null

viewPath

the view path (default: file system root)

-

/

databaseId

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 160. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.14.23. getWorkFolderListView_8

POST /v3/folder/work/view/{view}

List root folder content and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

FixedFolderViewListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseFolderViewInfoList

Content Type

  • application/json

Responses
Table 161. http response codes
Code Message Datatype

200

successful operation

ResponseFolderViewInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.15. Group

1.15.1. createGroup

POST /v3/group/create

Create a user group

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

GroupCreateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseGroup

Content Type

  • application/json

Responses
Table 162. http response codes
Code Message Datatype

200

successful operation

ResponseGroup

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.15.2. deleteGroup

DELETE /v3/group/delete

Delete a user group

Description
Parameters
Query Parameters
Name Description Required Default Pattern

databaseId

the database identifier

X

null

groupName

the name of the group to be deleted

X

null

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • /

Responses
Table 163. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.15.3. updateGroup

POST /v3/group/update

Update a user group

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

GroupUpdateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseGroup

Content Type

  • application/json

Responses
Table 164. http response codes
Code Message Datatype

200

successful operation

ResponseGroup

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.16. Message

1.16.1. destroyInbox

DELETE /v3/message/inbox/destroy

Destroies a bulk of mail, of the connected user, passed as list of sources.

Description

If it has not been possible destroy any mails, an errors field will be filled with the source and the message of the error cause.

Parameters
Body Parameter
Name Description Required Default Pattern

body

MailListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseErrorList

Content Type

  • application/json

Responses
Table 165. http response codes
Code Message Datatype

200

successful operation

ResponseErrorList

401

Not authorized

<<>>
Samples

1.16.2. destroyOutbox

DELETE /v3/message/outbox/destroy

Destroies a bulk of mail, of the connected user, passed as list of sources.

Description

If it has not been possible destroy any mails, an errors field will be filled with the source and the message of the error cause.

Parameters
Body Parameter
Name Description Required Default Pattern

body

MailListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseErrorList

Content Type

  • application/json

Responses
Table 166. http response codes
Code Message Datatype

200

successful operation

ResponseErrorList

401

Not authorized

<<>>
Samples

1.16.3. getInbox

GET /v3/message/inbox

List user mail inbox

Description
Parameters
Query Parameters
Name Description Required Default Pattern

limit

limit the resolved elements (default: 20)

-

20

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 167. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.16.4. getOutbox

GET /v3/message/outbox

List user mail outbox

Description
Parameters
Query Parameters
Name Description Required Default Pattern

limit

limit the resolved elements (default: 20)

-

20

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: true)

-

true

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showParent

shows the parent info in the response (default: true)

-

true

propagateShowOptionsToFolderAndParent

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseFolderInfoList

Content Type

  • application/json

Responses
Table 168. http response codes
Code Message Datatype

200

successful operation

ResponseFolderInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.16.5. sendMail

POST /v3/message/sendmail

Send a mail

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

MailMessageRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • /

Responses
Table 169. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17. Object

1.17.1. deleteDestroy

DELETE /v3/object/{source}/destroy

Destroys a given object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to destroy

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 170. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.2. deleteDestroyList

DELETE /v3/object/destroy

Destroies a bulk of objects passed as list of sourecs.

Description

If it has not been possible destroy any objects, an errors field will be filled with the source and the message of the error cause.

Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseErrorList

Content Type

  • application/json

Responses
Table 171. http response codes
Code Message Datatype

200

successful operation

ResponseErrorList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.3. deleteDiscard

DELETE /v3/object/{source}/discard

Discards the given object moving it to the recycle bin

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to discard

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 172. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.4. deleteDiscardList

DELETE /v3/object/discard

Discards a bulk of object moving it to the recycle bin

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

FileSystemObjectListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseErrorList

Content Type

  • application/json

Responses
Table 173. http response codes
Code Message Datatype

200

successful operation

ResponseErrorList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.5. getLastVersionLoid

GET /v3/object/{source}/lastversionloid

Returns a file’s last version loid

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the file source

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • text/plain

Responses
Table 174. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.6. getObject

GET /v3/object/{source}

Gives information for a given object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 175. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.7. getObjectFamily

GET /v3/object/{uuid}/family

Returns the members of a story family, i.e. the list of objects that share a common SUID.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

uuid

the UUID that defines the family

X

null
Query Parameters
Name Description Required Default Pattern

databaseId

-

null

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseStoryFamilyResponse

Content Type

  • application/json

Responses
Table 176. http response codes
Code Message Datatype

200

successful operation

ResponseStoryFamilyResponse

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.17.8. getObjectView

GET /v3/object/{source}/view/{view}

Retrieves the given object and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseBundleObjectViewInfo

Content Type

  • application/json

Responses
Table 177. http response codes
Code Message Datatype

200

successful operation

ResponseBundleObjectViewInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.9. getObjectViewList

GET /v3/object/{source}/view

Retrieves the given object and apply the default view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseBundleObjectViewInfo

Content Type

  • application/json

Responses
Table 178. http response codes
Code Message Datatype

200

successful operation

ResponseBundleObjectViewInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.10. getThumbnail

GET /v3/object/{source}/thumbnail

Gives the thumbnail of the given object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to from which read the thumbnail

X

null
Query Parameters
Name Description Required Default Pattern

version

the thumbnail version (default: -1)

-

-1

maxSize

max thumbnail size in MB at which truncate the request

-

null

token

API token

X

null
Return Type

-

Responses
Table 179. http response codes
Code Message Datatype

200

Object content as stream

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.17.11. getThumbnailInfo

GET /v3/object/{source}/thumbnail/info

Gives the thumbnail’s information of the given object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to from which read the thumbnail

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 180. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.12. post

POST /v3/object/checkpoint

Creates a checkpoint for the given object

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

CheckpointRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 181. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.17.13. postEffectiveAccessMasks

POST /v3/object/effectiveaccessmask

Returns the effective access mask for a list of objects

Description

A zero effective mask is returned in case of object’s error

Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectAccessMaskRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLong[]

Content Type

  • application/json

Responses
Table 182. http response codes
Code Message Datatype

200

successful operation

ResponseLong[]

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.17.14. postObjectFireEvent

POST /v3/object/fireevent

Fires an extended event to the configured Notification service

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectFireEventRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListErrorDatabaseId

Content Type

  • application/json

Responses
Table 183. http response codes
Code Message Datatype

200

successful operation

ResponseListErrorDatabaseId

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.15. postObjectList

POST /v3/object

Gives information for a bulk of objects passed as list of sources.

Description

If it has not been possible retrieve the information of any objects, an errors field will be filled with the source and the message of the error cause.

Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectInfoListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfoList

Content Type

  • application/json

Responses
Table 184. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.17.16. postObjectUpdatedList

POST /v3/object/updated

Gives the list of updated objects based on given ucount(s).

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectInfoListUpdatedRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectListUpdatedResponse

Content Type

  • application/json

Responses
Table 185. http response codes
Code Message Datatype

200

successful operation

ResponseObjectListUpdatedResponse

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.17.17. postObjectView

POST /v3/object/view/{view}

Retrieves all the objects in the given list and apply the given view for the response

Description
Parameters
Path Parameters
Name Description Required Default Pattern

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectInfoListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectViewList

Content Type

  • application/json

Responses
Table 186. http response codes
Code Message Datatype

200

successful operation

ResponseObjectViewList

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.17.18. postObjectViewList

POST /v3/object/view

Retrieves all the objects in the given list and apply the default view for the response

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectInfoListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectViewList

Content Type

  • application/json

Responses
Table 187. http response codes
Code Message Datatype

200

successful operation

ResponseObjectViewList

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.17.19. putCheckin

PUT /v3/object/{source}/checkin

Perform the checkin operation on the given object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to checkin

X

null
Query Parameters
Name Description Required Default Pattern

checkIn

if set to false just the 'check_in' action is performed (default: true)

-

true

keepCheckedOut

if the option checkIn is set to true, specify the value of keepCheckedOut parameter (default: false)

-

false

newVersion

if the option checkIn is set to true, specify the value of newVersion parameter (default: false)

-

false

unlock

if the option checkIn is set to false, this options dictates if the object is unlocked at the end of the operation (default: false)

-

false

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 188. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.20. putCheckout

PUT /v3/object/{source}/checkout

Perform the checkout operation on the given object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to checkout

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

clean

if a clean checkout should be performed (default: false)

-

false

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 189. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.21. putCopy

PUT /v3/object/{source}/copy

Copies an object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to copy

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectCopyRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 190. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.22. putLock

PUT /v3/object/{source}/lock

Locks an object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to lock

X

null
Query Parameters
Name Description Required Default Pattern

for

check permissions for that operation is done before the object's lock (default: UNDEFINED)

-

UNDEFINED

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 191. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.23. putLockContentItem

PUT /v3/object/{source}/lock/contentitem/{id}

Locks the file with the given contentitem id in the given bundle

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the bundle

X

null

id

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseLockContentItemBean

Content Type

  • application/json

Responses
Table 192. http response codes
Code Message Datatype

200

successful operation

ResponseLockContentItemBean

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.24. putLockList

PUT /v3/object/lock

Locks each object in the given list

Description

If it has not been possible to lock any objects, an errors field will be filled with the source and the message of the error cause

Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfoList

Content Type

  • application/json

Responses
Table 193. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.17.25. putMetadata

PUT /v3/object/{source}/metadata

Updates attributes and system attributes of the given object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to update

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectMetadataRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 194. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.26. putMove

PUT /v3/object/{source}/move

Moves an object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to move

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectMoveRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 195. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.27. putObject

PUT /v3/object/{source}

Updates an object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to update

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectUpdateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 196. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.28. putRename

PUT /v3/object/{source}/rename

Renames an object

Description

If the object is a bundle, every element of the bundle is first locked and then renamed

Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to rename

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectRenameRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 197. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.29. putRestore

PUT /v3/object/{source}/restore

Restores an object from the recycle bin

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to restore

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 198. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.30. putRestoreList

PUT /v3/object/restore

Restores a bulk of objects from the recycle bin

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectRestoreListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseErrorList

Content Type

  • application/json

Responses
Table 199. http response codes
Code Message Datatype

200

successful operation

ResponseErrorList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.31. putUndoCheckOut

PUT /v3/object/{source}/undocheckout

Performs undo checkout of an object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object on which to do undo checkout

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 200. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.32. putUnlock

PUT /v3/object/{source}/unlock

Unlocks an object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to unlock

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 201. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.33. putUnlockList

PUT /v3/object/unlock

Unlocks each object in the given list

Description

If it has not been possible to unlock any objects, an errors field will be filled with the source and the message of the error cause

Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectListRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfoList

Content Type

  • application/json

Responses
Table 202. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.17.34. setStatus

PUT /v3/object/{source}/status

Set the specified status to an object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to update

X

null
Body Parameter
Name Description Required Default Pattern

body

the status to set ObjectStatusRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 203. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.35. setStatus_1

POST /v3/object/{source}/status

set an object’s workflow status

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

an object identifier (uuid, loid, path)

X

null
Body Parameter
Name Description Required Default Pattern

body

set status request SetStatusRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 204. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.17.36. updateAttributesMultipleBulk

PUT /v3/object/attributes/multiplebulk

Updates the attributes of multiple objects, according to the given list. Each item of the list associates an object with its attributes and other options

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectAttributesMultipleBulkRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListError

Content Type

  • application/json

Responses
Table 205. http response codes
Code Message Datatype

200

successful operation

ResponseListError

401

Not authorized

<<>>
Samples

1.17.37. updateAttributesSingleBulk

PUT /v3/object/attributes/singlebulk

Updates the attributes of the given objects list. A single attribute value is applied to all the objects in the list

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectAttributesSingleBulkRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListError

Content Type

  • application/json

Responses
Table 206. http response codes
Code Message Datatype

200

successful operation

ResponseListError

401

Not authorized

<<>>
Samples

1.17.38. updateSystemAttributesMultipleBulk

PUT /v3/object/systemattributes/multiplebulk

Updates the system attributes of multiple objects, according to the given list. Each item of the list associates an object with its system attributes and other options

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectSystemAttributesMultipleBulkRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListError

Content Type

  • application/json

Responses
Table 207. http response codes
Code Message Datatype

200

successful operation

ResponseListError

401

Not authorized

<<>>
Samples

1.17.39. updateSystemAttributesSingleBulk

PUT /v3/object/systemattributes/singlebulk

Updates the system attributes of the given objects list. A single system attribute value is applied to all the objects in the list

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectSystemAttributesSingleBulkRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListError

Content Type

  • application/json

Responses
Table 208. http response codes
Code Message Datatype

200

successful operation

ResponseListError

401

Not authorized

<<>>
Samples

1.18. ObjectAction

1.18.1. doAction

POST /v3/object/{source}/action/{name}

Executes the specified action for the object.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

name

name of the action to execute

X

null
Body Parameter
Name Description Required Default Pattern

body

[string]

-
Query Parameters
Name Description Required Default Pattern

baseUri

-

null

token

API token

X

null
Return Type

ResponseObjectActionResponse

Content Type

  • application/json

Responses
Table 209. http response codes
Code Message Datatype

200

successful operation

ResponseObjectActionResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.18.2. doExternalActionDelete

DELETE /v3/object/action/external/{actionRedirectKey}

Executes a reverse proxy to external endpoint, specified by the path param.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

actionRedirectKey

key of the url to redirect

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 210. http response codes
Code Message Datatype

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.18.3. doExternalActionGet

GET /v3/object/action/external/{actionRedirectKey}

Executes a reverse proxy to external endpoint, specified by the path param.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

actionRedirectKey

key of the url to redirect

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 211. http response codes
Code Message Datatype

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.18.4. doExternalActionPost

POST /v3/object/action/external/{actionRedirectKey}

Executes a reverse proxy to external endpoint, specified by the path param.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

actionRedirectKey

key of the url to redirect

X

null
Body Parameter
Name Description Required Default Pattern

body

request body [ByteArray]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 212. http response codes
Code Message Datatype

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.18.5. doExternalActionPut

PUT /v3/object/action/external/{actionRedirectKey}

Executes a reverse proxy to external endpoint, specified by the path param.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

actionRedirectKey

key of the url to redirect

X

null
Body Parameter
Name Description Required Default Pattern

body

request body [ByteArray]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 213. http response codes
Code Message Datatype

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.18.6. getActions

GET /v3/object/{source}/actions

Gets the list of the configured actions for the object.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Query Parameters
Name Description Required Default Pattern

category

category filter

-

null

token

API token

X

null
Return Type

ResponseListString

Content Type

  • application/json

Responses
Table 214. http response codes
Code Message Datatype

200

successful operation

ResponseListString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.19. ObjectBinder

1.19.1. getBinderList

GET /v3/object/binder/list

Gives basefolder informations, matching candidate in the configuration. If there’s no match, candidate is set by default to story

Description
Parameters
Query Parameters
Name Description Required Default Pattern

databaseId

database id (optional)

-

null

candidate

candidate to match in basefolder configuration. If no one basefolder is found, the algorithm try to match candidate story

X

null

token

API token

X

null
Return Type

ResponseBinderListResponse

Content Type

  • application/json

Responses
Table 215. http response codes
Code Message Datatype

200

successful operation

ResponseBinderListResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.19.2. getBinderList_1

POST /v3/object/binder/list

Gives basefolder informations calculated starting from parameters in the request

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectBinderRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseBinderListResponse

Content Type

  • application/json

Responses
Table 216. http response codes
Code Message Datatype

200

successful operation

ResponseBinderListResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.19.3. getBinderList_2

GET /v3/object/binder/list/{source}

Gives basefolder informations from a given object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

The source from witch is found the basefolder list

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseBinderListResponse

Content Type

  • application/json

Responses
Table 217. http response codes
Code Message Datatype

200

successful operation

ResponseBinderListResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.20. ObjectCollaborator

1.20.1. addCollaborator

PUT /v3/object/{source}/collaborator

Adds all the given collaborators to the collaborators list

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

an object identified (uuid, loid, path)

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectCollaboratorsRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListString

Content Type

  • application/json

Responses
Table 218. http response codes
Code Message Datatype

200

successful operation

ResponseListString

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.20.2. addCollaborator_1

PUT /v3/object/{source}/collaborator/{name}

Adds the given collaborator to the collaborators list

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

an object identified (uuid, loid, path)

X

null

name

a principal

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListString

Content Type

  • application/json

Responses
Table 219. http response codes
Code Message Datatype

200

successful operation

ResponseListString

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.20.3. deleteCollaborator

DELETE /v3/object/{source}/collaborator

Removes all the given collaborators from the collaborators list

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

an object identified (uuid, loid, path)

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectCollaboratorsRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListString

Content Type

  • application/json

Responses
Table 220. http response codes
Code Message Datatype

200

successful operation

ResponseListString

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.20.4. deleteCollaborator_2

DELETE /v3/object/{source}/collaborator/{name}

Removes the given collaborator from the collaborators list

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

an object identified (uuid, loid, path)

X

null

name

a principal

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListString

Content Type

  • application/json

Responses
Table 221. http response codes
Code Message Datatype

200

successful operation

ResponseListString

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.20.5. getObject

GET /v3/object/{source}/collaborator

List object collaborators

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

an object identified (uuid, loid, path)

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListString

Content Type

  • application/json

Responses
Table 222. http response codes
Code Message Datatype

200

successful operation

ResponseListString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.21. ObjectContent

1.21.1. getContent

GET /v3/object/{source}/content

Gives the object content

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null
Header Parameters
Name Description Required Default Pattern

Range

Request only part of an object. Bytes are numbered from 0.

-

null
Query Parameters
Name Description Required Default Pattern

maxSize

max object size in MB at which truncate the request

-

null

version

content version (default: -1)

-

-1

raw

boolean value to choose whether to get raw or resolved content (default: false)

-

false

showDtd

boolean value to choose whether to get inline dtd within an XML document (default: false)

-

false

token

API token

X

null
Return Type

-

Responses
Table 223. http response codes
Code Message Datatype

200

Object content as stream

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.21.2. getContentBinary

GET /v3/object/{source}/content/binary

Gives the object content in binary. No content parsing is done.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

maxSize

max object size in MB at which truncate the request

-

null

version

content version (default: -1)

-

-1

token

API token

X

null
Return Type

-

Responses
Table 224. http response codes
Code Message Datatype

200

Object content as stream

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.21.3. getContentDownload

GET /v3/object/{source}/content/download

Allow to download the object content

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null
Header Parameters
Name Description Required Default Pattern

Range

Request only part of an object. Bytes are numbered from 0.

-

null
Query Parameters
Name Description Required Default Pattern

version

content version (default: -1)

-

-1

raw

boolean value to choose whether to get raw or resolved content (default: false)

-

false

showDtd

boolean value to choose whether to get inline dtd within an XML document (default: false)

-

false

token

API token

X

null
Return Type

-

Responses
Table 225. http response codes
Code Message Datatype

200

Object content as stream

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.21.4. getFormat

GET /v3/object/{source}/content/{format}

Gives the object format

Description
Parameters
Path Parameters
Name Description Required Default Pattern

format

the format or format alias to retrieve

X

null

source

the object to retrieve

X

null
Header Parameters
Name Description Required Default Pattern

Range

Request only part of an object. Bytes are numbered from 0.

-

null
Query Parameters
Name Description Required Default Pattern

maxSize

max object size in MB at which truncate the request

-

null

fallbackFormat

It is the return format when the object format specified on the API path doesn't exist. If the fallbackFormat doesn't exist, the default EOMDB format is returned

-

null

version

content version (default: -1)

-

-1

raw

boolean value to choose whether to get raw or resolved content (default: false)

-

false

showDtd

boolean value to choose whether to get inline dtd within an XML document (default: false)

-

false

token

API token

X

null
Return Type

-

Responses
Table 226. http response codes
Code Message Datatype

200

Object content as stream

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.21.5. getFormatBinary

GET /v3/object/{source}/content/{format}/binary

Gives the object binary format. No content parsing is done.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

format

the format or format alias to retrieve

X

null

source

the object to retrieve

X

null
Header Parameters
Name Description Required Default Pattern

Range

Request only part of an object. Bytes are numbered from 0.

-

null
Query Parameters
Name Description Required Default Pattern

maxSize

max object size in MB at which truncate the request

-

null

fallbackFormat

It is the return format when the object format specified on the API path doesn't exist. If the fallbackFormat doesn't exist, the default EOMDB format is returned

-

null

version

content version (default: -1)

-

-1

raw

boolean value to choose whether to get raw or resolved content (default: false)

-

false

showDtd

boolean value to choose whether to get inline dtd within an XML document (default: false)

-

false

token

API token

X

null
Return Type

-

Responses
Table 227. http response codes
Code Message Datatype

200

Object content as stream

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.21.6. getFormatDownload

GET /v3/object/{source}/content/{format}/download

Allow to download the object format

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null

format

the format or format alias to retrieve

X

null
Header Parameters
Name Description Required Default Pattern

Range

Request only part of an object. Bytes are numbered from 0.

-

null
Query Parameters
Name Description Required Default Pattern

fallbackFormat

It is the return format when the object format specified on the API path doesn't exist. If the fallbackFormat doesn't exist, the default EOMDB format is returned

-

null

version

content version (default: -1)

-

-1

raw

boolean value to choose whether to get raw or resolved content (default: false)

-

false

showDtd

boolean value to choose whether to get inline dtd within an XML document (default: false)

-

false

token

API token

X

null
Return Type

-

Responses
Table 228. http response codes
Code Message Datatype

200

Object content as stream

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.21.7. getObjectContentUpdated

GET /v3/object/{source}/content/updated

Gives the updated objectInfo, the last modification timestamp and content stream based on the given last modification timestamp

Description

content, object info and last modification timestamp are returned if the object (or objects it depends on) content modification time is greater than the given timestamp.

Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null
Header Parameters
Name Description Required Default Pattern

Range

Request only part of an object. Bytes are numbered from 0.

-

null
Query Parameters
Name Description Required Default Pattern

timestamp

last known modification timestamp (default: 0)

-

0

version

content version (default: -1)

-

-1

raw

boolean value to choose whether to get raw or resolved content (default: false)

-

false

showDtd

boolean value to choose whether to get inline dtd within an XML document (default: false)

-

false

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

-

Responses
Table 229. http response codes
Code Message Datatype

200

<pre>--Boundary_14_1261031547_1513241996471 X-Source: &quot;string&quot; X-Part: info Content-Type: application/json</pre><pre>{ &quot;result&quot;: { &quot;id&quot;: &quot;string&quot;, &quot;path&quot;: &quot;string&quot;, &quot;type&quot;: &quot;string&quot;, &quot;pstate&quot;: { &quot;uuid&quot;: &quot;string&quot;, &quot;suid&quot;: &quot;string&quot;, &quot;loid&quot;: &quot;string&quot;, &quot;retentionTime&quot;: 0, &quot;ucount&quot;: 0 }, &quot;uniquenessString&quot;: &quot;string&quot;, &quot;version&quot;: &quot;string&quot;, &quot;name&quot;: &quot;string&quot;, &quot;description&quot;: &quot;string&quot;, &quot;owner&quot;: &quot;string&quot;, &quot;creator&quot;: &quot;string&quot;, &quot;created&quot;: 0, &quot;lastModifier&quot;: &quot;string&quot;, &quot;modified&quot;: 0, &quot;locker&quot;: &quot;string&quot;, &quot;locked&quot;: 0, &quot;size&quot;: 0, &quot;statusInfo&quot;: { &quot;name&quot;: &quot;string&quot;, &quot;identifier&quot;: &quot;string&quot;, &quot;comment&quot;: &quot;string&quot;, &quot;assignedTo&quot;: [ &quot;string&quot; ] }, &quot;workFolder&quot;: &quot;string&quot;, &quot;channel&quot;: &quot;string&quot;, &quot;product&quot;: &quot;string&quot;, &quot;issueDate&quot;: &quot;string&quot;, &quot;edition&quot;: &quot;string&quot;, &quot;systemAttributes&quot;: {}, &quot;systemAttributesXml&quot;: &quot;string&quot;, &quot;attributes&quot;: {}, &quot;attributesXml&quot;: &quot;string&quot;, &quot;usageTicket&quot;: {}, &quot;usageTicketXml&quot;: &quot;string&quot;, &quot;virtualAttributes&quot;: {}, &quot;virtualAttributesXml&quot;: &quot;string&quot;, &quot;interfaceId&quot;: &quot;string&quot;, &quot;databaseId&quot;: {}, &quot;lastVersionModificationTime&quot;: 0, &quot;lastVersionModifier&quot;: &quot;string&quot;, &quot;bundle&quot;: { &quot;bundleInherit&quot;: &quot;string&quot;, &quot;bundleChild&quot;: true }, &quot;childrenCount&quot;: 0, &quot;webType&quot;: &quot;string&quot; }, &quot;statistics&quot;: { &quot;date&quot;: &quot;string&quot;, &quot;version&quot;: &quot;string&quot;, &quot;requestTime&quot;: &quot;string&quot; }, &quot;status&quot;: &quot;string&quot; } --Boundary_14_1261031547_1513241996471 X-Source: &quot;string&quot; X-Part: lastModificationTimestamp Content-Type: &quot;string&quot;</pre><pre>1510681575 --Boundary_14_1261031547_1513241996471 X-Source: &quot;string&quot; X-Part: content Content-Type: &quot;string&quot;</pre><pre>content --Boundary_14_1261031547_1513241996471--</pre>

<<>>

204

Object content not modified

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.21.8. getObjectFormatContentUpdated

GET /v3/object/{source}/content/{format}/updated

Gives the updated objectInfo, the last modification timestamp and format stream based on the given last modification timestamp

Description

format, object info and last modification timestamp are returned if the object (or objects it depends on) content modification time is greater than the given timestamp.

Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null

format

the format or format alias to retrieve

X

null
Header Parameters
Name Description Required Default Pattern

Range

Request only part of an object. Bytes are numbered from 0.

-

null
Query Parameters
Name Description Required Default Pattern

fallbackFormat

It is the return format when the object format specified on the API path doesn't exist. If the fallbackFormat doesn't exist, the default EOMDB format is returned

-

null

version

content version (default: -1)

-

-1

raw

boolean value to choose whether to get raw or resolved content (default: false)

-

false

showDtd

boolean value to choose whether to get inline dtd within an XML document (default: false)

-

false

timestamp

last known modification timestamp (default: 0)

-

0

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

-

Responses
Table 230. http response codes
Code Message Datatype

200

<pre>--Boundary_14_1261031547_1513241996471 X-Source: &quot;string&quot; X-Part: info Content-Type: application/json</pre><pre>{ &quot;result&quot;: { &quot;id&quot;: &quot;string&quot;, &quot;path&quot;: &quot;string&quot;, &quot;type&quot;: &quot;string&quot;, &quot;pstate&quot;: { &quot;uuid&quot;: &quot;string&quot;, &quot;suid&quot;: &quot;string&quot;, &quot;loid&quot;: &quot;string&quot;, &quot;retentionTime&quot;: 0, &quot;ucount&quot;: 0 }, &quot;uniquenessString&quot;: &quot;string&quot;, &quot;version&quot;: &quot;string&quot;, &quot;name&quot;: &quot;string&quot;, &quot;description&quot;: &quot;string&quot;, &quot;owner&quot;: &quot;string&quot;, &quot;creator&quot;: &quot;string&quot;, &quot;created&quot;: 0, &quot;lastModifier&quot;: &quot;string&quot;, &quot;modified&quot;: 0, &quot;locker&quot;: &quot;string&quot;, &quot;locked&quot;: 0, &quot;size&quot;: 0, &quot;statusInfo&quot;: { &quot;name&quot;: &quot;string&quot;, &quot;identifier&quot;: &quot;string&quot;, &quot;comment&quot;: &quot;string&quot;, &quot;assignedTo&quot;: [ &quot;string&quot; ] }, &quot;workFolder&quot;: &quot;string&quot;, &quot;channel&quot;: &quot;string&quot;, &quot;product&quot;: &quot;string&quot;, &quot;issueDate&quot;: &quot;string&quot;, &quot;edition&quot;: &quot;string&quot;, &quot;systemAttributes&quot;: {}, &quot;systemAttributesXml&quot;: &quot;string&quot;, &quot;attributes&quot;: {}, &quot;attributesXml&quot;: &quot;string&quot;, &quot;usageTicket&quot;: {}, &quot;usageTicketXml&quot;: &quot;string&quot;, &quot;virtualAttributes&quot;: {}, &quot;virtualAttributesXml&quot;: &quot;string&quot;, &quot;interfaceId&quot;: &quot;string&quot;, &quot;databaseId&quot;: {}, &quot;lastVersionModificationTime&quot;: 0, &quot;lastVersionModifier&quot;: &quot;string&quot;, &quot;bundle&quot;: { &quot;bundleInherit&quot;: &quot;string&quot;, &quot;bundleChild&quot;: true }, &quot;childrenCount&quot;: 0, &quot;webType&quot;: &quot;string&quot; }, &quot;statistics&quot;: { &quot;date&quot;: &quot;string&quot;, &quot;version&quot;: &quot;string&quot;, &quot;requestTime&quot;: &quot;string&quot; }, &quot;status&quot;: &quot;string&quot; } --Boundary_14_1261031547_1513241996471 X-Source: &quot;string&quot; X-Part: lastModificationTimestamp Content-Type: &quot;string&quot;</pre><pre>1510681575 --Boundary_14_1261031547_1513241996471 X-Source: &quot;string&quot; X-Part: content Content-Type: &quot;string&quot;</pre><pre>content --Boundary_14_1261031547_1513241996471--</pre>

<<>>

204

Format not modified

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.21.9. postContentList

POST /v3/object/content

Gives the content of every object in the request list

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectContentListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 231. http response codes
Code Message Datatype

200

<pre>--Boundary_14_1261031547_1513241996471 X-Source: &quot;source1&quot; X-Part: content Content-Type: &quot;string&quot;</pre><pre>content of source1 --Boundary_14_1261031547_1513241996471 X-Source: &quot;source2&quot; X-Part: content Content-Type: &quot;string&quot;</pre><pre>content of source2 --Boundary_14_1261031547_1513241996471 X-Part: errors Content-Type: application/json</pre><pre>[ { source: &quot;string&quot;, message: &quot;string&quot; } ] --Boundary_14_1261031547_1513241996471--</pre>

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.21.10. postContentListBinary

POST /v3/object/content/binary

Gives the binary content of every object in the request list. No content parsing is done.

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectBinaryContentListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 232. http response codes
Code Message Datatype

200

<pre>--Boundary_14_1261031547_1513241996471 X-Source: &quot;source1&quot; X-Part: content Content-Type: &quot;string&quot;</pre><pre>content of source1 --Boundary_14_1261031547_1513241996471 X-Source: &quot;source2&quot; X-Part: content Content-Type: &quot;string&quot;</pre><pre>content of source2 --Boundary_14_1261031547_1513241996471 X-Part: errors Content-Type: application/json</pre><pre>[ { source: &quot;string&quot;, message: &quot;string&quot; } ] --Boundary_14_1261031547_1513241996471--</pre>

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.21.11. putObjectContent

PUT /v3/object/{source}/content

Updates an object content

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to update

X

null
Body Parameter
Name Description Required Default Pattern

body

the content to write [object]

-
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

checkIn

specify if check-in should be invoked instead of performing a check_in action (default: true)

-

true

keepCheckedOut

specify the value of keepCheckedOut parameter during check-in operation (default: false)

-

false

unlock

if the option checkIn is set to false, this options dictates if the object is unlocked at the end of the operation (default: false)

-

false

newVersion

if the option checkIn is set to true, specify the value of newVersion parameter (default: false)

-

false

checkOut

specify if check-out should be executed (default: false)

-

false

checkOutClean

specify if clean check-out should be executed (default: false)

-

false

addContentItemsId

add id in content item if it is not present (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 233. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.21.12. toJson

GET /v3/object/{source}/content/json

Gives object in json format, when possible

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the source

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObject

Content Type

  • application/json

Responses
Table 234. http response codes
Code Message Datatype

200

successful operation

ResponseObject

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.21.13. updateContentAndShape

POST /v3/object/{source}/content/binary

Updates an object binary content. No content parsing is done.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to update

X

null
Form Parameter
Name Description Required Default Pattern

content

the content to write [file]

-

null

shapeRole

the shape role to write [file]

-

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

checkIn

specify if check-in should be invoked instead of performing a check_in action (default: true)

-

true

keepCheckedOut

specify the value of keepCheckedOut parameter during check-in operation (default: false)

-

false

unlock

if the option checkIn is set to false, this options dictates if the object is unlocked at the end of the operation (default: false)

-

false

newVersion

if the option checkIn is set to true, specify the value of newVersion parameter (default: false)

-

false

checkOut

specify if check-out should be executed (default: false)

-

false

checkOutClean

specify if clean check-out should be executed (default: false)

-

false

addContentItemsId

add id in content item if it is not present (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 235. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22. ObjectCorrelate

1.22.1. correlate

POST /v3/object/{source}/correlate

Correlate the source object to the specified target object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectCreateCorrelationOptions

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 236. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.2. correlateMany

POST /v3/object/{source}/correlate/many

Correlate the source object to the specified target objects

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectCreateCorrelationsOptions

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 237. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.3. getCorrelated

POST /v3/object/correlated

Gives information about object correlated for given objects. You can list an object’s correlated object by link name or all of them.

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

the objects to retrieve ObjectCorrelatedListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectCorrelatedBulkResponse

Content Type

  • application/json

Responses
Table 238. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatedBulkResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.4. getCorrelatedView

GET /v3/object/{source}/correlated/{linkName}/view

Gives information about object correlated for given object and applies the default view. You can list an object’s correlated object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null

linkName

the link name to find

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatedViewResponse

Content Type

  • application/json

Responses
Table 239. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatedViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.5. getCorrelatedView_1

GET /v3/object/{source}/correlated/{linkName}/view/{view}

Gives information about object correlated for given object and applies the specified view. You can list an object’s correlated object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null

linkName

the link name to find

X

null

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatedViewResponse

Content Type

  • application/json

Responses
Table 240. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatedViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.6. getCorrelated_2

GET /v3/object/{source}/correlated

Gives information about object correlated for given object. You can list an object’s correlated object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatedResponse

Content Type

  • application/json

Responses
Table 241. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatedResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.7. getCorrelated_3

GET /v3/object/{source}/correlated/view

Gives information about object correlated for given object and applies the default view. You can list an object’s correlated object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatedViewResponse

Content Type

  • application/json

Responses
Table 242. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatedViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.8. getCorrelated_4

GET /v3/object/{source}/correlated/view/{view}

Gives information about object correlated for given object and applies the specified view. You can list an object’s correlated object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatedViewResponse

Content Type

  • application/json

Responses
Table 243. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatedViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.9. getCorrelated_5

GET /v3/object/{source}/correlated/{linkName}

Gives information about object correlated for given object. You can list an object’s correlated object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null

linkName

the link name to find

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatedResponse

Content Type

  • application/json

Responses
Table 244. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatedResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.10. getCorrelating

POST /v3/object/correlating

Gives information about object correlating for given objects. You can list an object’s correlating object by link name or all of them.

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

the objects to retrieve ObjectCorrelatedListRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectCorrelatingBulkResponse

Content Type

  • application/json

Responses
Table 245. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatingBulkResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.11. getCorrelatingView

GET /v3/object/{source}/correlating/{linkName}/view

Gives information about object correlating for given object and applies the default view. You can list an object’s correlating object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null

linkName

the link name to find

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatingViewResponse

Content Type

  • application/json

Responses
Table 246. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatingViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.12. getCorrelatingView_6

GET /v3/object/{source}/correlating/{linkName}/view/{view}

Gives information about object correlating for given object and applies the specified view. You can list an object’s correlating object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null

linkName

the link name to find

X

null

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatingViewResponse

Content Type

  • application/json

Responses
Table 247. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatingViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.13. getCorrelating_7

GET /v3/object/{source}/correlating

Gives information about object correlating for given object. You can list an object’s correlating object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatingResponse

Content Type

  • application/json

Responses
Table 248. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatingResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.14. getCorrelating_8

GET /v3/object/{source}/correlating/view

Gives information about object correlating for given object and applies the default view. You can list an object’s correlating object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatingViewResponse

Content Type

  • application/json

Responses
Table 249. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatingViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.15. getCorrelating_9

GET /v3/object/{source}/correlating/view/{view}

Gives information about object correlating for given object and applies the specified view. You can list an object’s correlating object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatingViewResponse

Content Type

  • application/json

Responses
Table 250. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatingViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.16. getCorrelating_10

GET /v3/object/{source}/correlating/{linkName}

Gives information about object correlating for given object. You can list an object’s correlating object by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null

linkName

the link name to find

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelatingResponse

Content Type

  • application/json

Responses
Table 251. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelatingResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.17. getCorrelations

GET /v3/object/{source}/correlations

Gives information about correlated and correlating objects for given object. You can list an object’s correlations by link name or all of them.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelationResponse

Content Type

  • application/json

Responses
Table 252. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelationResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.22.18. uncorrelate

POST /v3/object/{source}/uncorrelate

Uncorrelate the source object from the specified correlated objects

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

UncorrelateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseUncorrelateResponse

Content Type

  • application/json

Responses
Table 253. http response codes
Code Message Datatype

200

successful operation

ResponseUncorrelateResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.23. ObjectCreate

1.23.1. createDirect

POST /v3/object/create/direct

Create an object with the given content

Description
Parameters
Form Parameter
Name Description Required Default Pattern

options

<pre>{ \\&quot;createMode\\&quot;: \\&quot;EXCEPTION

AUTO_RENAME

REPLACE

NEW_VERSION\\&quot;, \\&quot;path\\&quot;: \\&quot;string\\&quot;, \\&quot;type\\&quot;: \\&quot;string\\&quot;, \\&quot;containerSource\\&quot;: \\&quot;string\\&quot;, \\&quot;team\\&quot;: \\&quot;string\\&quot;, \\&quot;description\\&quot;: \\&quot;string\\&quot;, \\&quot;systemAttributes\\&quot;: \\&quot;string\\&quot;, \\&quot;attributes\\&quot;: \\&quot;string\\&quot;, \\&quot;status\\&quot;: \\&quot;string\\&quot;, \\&quot;shapeRole\\&quot;: \\&quot;string\\&quot;, \\&quot;databaseId\\&quot;: \\&quot;string\\&quot;, \\&quot;keepCheckedOut\\&quot;: true, \\&quot;options\\&quot;: { \\&quot;showPath\\&quot;: true, \\&quot;showAdditionalInfo\\&quot;: true, \\&quot;showSystemAttributes\\&quot;: true, \\&quot;showAttributes\\&quot;: true, \\&quot;showUsageTickets\\&quot;: true, \\&quot;showVirtualAttributes\\&quot;: true, \\&quot;showXml\\&quot;: true, \\&quot;useUnparsedXml\\&quot;: true } }</pre> [ref]

X

null

content

the content to write [file]
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 254. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If WorkFlow status cannot be found

<<>>
Samples

1.23.2. post

POST /v3/object/create

Create an object with the given content

Description
Parameters
Form Parameter
Name Description Required Default Pattern

options

<pre>{ \\&quot;name\\&quot;: \\&quot;string\\&quot;, \\&quot;folder\\&quot;: \\&quot;string\\&quot;, \\&quot;workFolder\\&quot;: \\&quot;string\\&quot;, \\&quot;product\\&quot;: \\&quot;string\\&quot;, \\&quot;edition\\&quot;: \\&quot;string\\&quot;, \\&quot;issueDate\\&quot;: \\&quot;string\\&quot;, \\&quot;team\\&quot;: \\&quot;string\\&quot;, \\&quot;type\\&quot;: \\&quot;string\\&quot;, \\&quot;application\\&quot;: \\&quot;string\\&quot;, \\&quot;systemAttributes\\&quot;: \\&quot;string\\&quot;, \\&quot;attributes\\&quot;: \\&quot;string\\&quot;, \\&quot;status\\&quot;: \\&quot;string\\&quot;, \\&quot;statusComment\\&quot;: \\&quot;string\\&quot;, \\&quot;shape\\&quot;: \\&quot;string\\&quot;, \\&quot;uniquenessString\\&quot;: \\&quot;string\\&quot;, \\&quot;timestamp\\&quot;: \\&quot;string\\&quot;, \\&quot;uuid\\&quot;: \\&quot;string\\&quot;, \\&quot;databaseId\\&quot;: \\&quot;string\\&quot;, \\&quot;options\\&quot;: { \\&quot;showAdditionalInfo\\&quot;: true, \\&quot;showPath\\&quot;: true, \\&quot;showSystemAttributes\\&quot;: true, \\&quot;showAttributes\\&quot;: true, \\&quot;showUsageTickets\\&quot;: true, \\&quot;showVirtualAttributes\\&quot;: true, \\&quot;showXml\\&quot;: true, \\&quot;checkIn\\&quot;: true, \\&quot;keepCheckedOut\\&quot;: true, \\&quot;createMode\\&quot;: \\&quot;EXCEPTION\\&quot;, \\&quot;useDefaultProduct\\&quot;: true, \\&quot;issueDateDefaultStrategy\\&quot;: \\&quot;CALENDAR\\&quot;, \\&quot;timeSuffix\\&quot;: true, \\&quot;webType\\&quot;: { \\&quot;showWebType\\&quot;: true, \\&quot;webProduct\\&quot;: \\&quot;string\\&quot;, } } }</pre> [ref]

X

null

content

the content to write [file]

-

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 255. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If WorkFlow status cannot be found

<<>>
Samples

1.23.3. postCreateTemporaryFile

POST /v3/object/create/temp

Create a temp file

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

TempFileRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 256. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.23.4. postFromDefaultTemplate

POST /v3/object/create/from/template

Create an object using the default template

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectCreateTemplateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 257. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found, if the Template or the WorkFlow status cannot be found

<<>>
Samples

1.23.5. postFromTemplate

POST /v3/object/create/from/template/{source}

Create an object using the given template

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the template to use

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectCreateTemplateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 258. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found, if the Template or the WorkFlow stautscannot be found

<<>>
Samples

1.23.6. postStoryFrom

POST /v3/object/create/story/from/{source}

Create a new story copying the structure from the given one

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the source from which copy the story structure

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectCreateStoryFromRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 259. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found, if the Story or the WorkFlow status cannot be found

<<>>
Samples

1.23.7. postTask

POST /v3/object/create/from/task/{source}

Create an object using the template specified in the task system attributes

Description

If no template is found in the task system attributes, the default one is used

Parameters
Path Parameters
Name Description Required Default Pattern

source

the task from which retrieve the template to use

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectCreateTemplateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 260. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found, if the Task or the WorkFlow status cannot be found

<<>>
Samples

1.23.8. postTopicFrom

POST /v3/object/create/topic/from/{source}

Create a new Topic with a TopicItem linked to the given source

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the topic source

X

null
Body Parameter
Name Description Required Default Pattern

body

CreateTopicFromRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopic

Content Type

  • application/json

Responses
Table 261. http response codes
Code Message Datatype

200

successful operation

ResponseTopic

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.23.9. postUrl

POST /v3/object/create/from/url

Create an object retrieving the content from the given url

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectCreateFromUrlRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 262. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If WorkFlow status cannot be found

<<>>
Samples

1.24. ObjectFormats

1.24.1. listFormats

GET /v3/object/{source}/formats/list

Lists an object’s formats

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object the formats are listed from

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseListFormatItem

Content Type

  • application/json

Responses
Table 263. http response codes
Code Message Datatype

200

successful operation

ResponseListFormatItem

400

Invalid data

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.25. ObjectFull

1.25.1. getFullObject

POST /v3/object/full

Returns the current objectInfo and the binary content of the specified version and format

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

FullObjectRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 264. http response codes
Code Message Datatype

200

<pre>--MULTIPART_BOUNDARY X-Source: SOURCE_ID X-Part: info Content-Type: application/json</pre><pre>OBJECT_INFO_JSON --MULTIPART_BOUNDARY X-Source: SOURCE_ID X-Part: content Content-Type: CONTENT_TYPE</pre><pre>BINARY_CONTENT --MULTIPART_BOUNDARY--</pre>

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.26. ObjectLink

1.26.1. createLink

POST /v3/object/{source}/link/{target}

Creates a link between two object.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

target

X

null
Body Parameter
Name Description Required Default Pattern

body

LinkBeanRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 265. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.26.2. createLink_1

POST /v3/object/{source}/links

Creates a link between a source object and one or more target objects.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

MultipleLinkBeanRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListError

Content Type

  • application/json

Responses
Table 266. http response codes
Code Message Datatype

200

successful operation

ResponseListError

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.26.3. getLinks

GET /v3/object/{source}/link

Gives information about object linked object for given source.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

type

the role type used as filter (default: *)

-

*

name

the role name used as filter (default: *)

-

*

bundle

gets all the children when the linked object is a bundle (default: false)

-

false

showSourceFormatContent

gets the source role content (default: false)

-

false

showTargetFormatContent

gets the target role content (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseListLinkResponse

Content Type

  • application/json

Responses
Table 267. http response codes
Code Message Datatype

200

successful operation

ResponseListLinkResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.26.4. getLinksFlat

GET /v3/object/{source}/links

Gives information about linked objects for given source.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

type

the role type used as filter (default: *)

-

*

name

the role name used as filter (default: *)

-

*

bundle

gets all the children when the linked object is a bundle (default: false)

-

false

showSourceFormatContent

gets the source role content (default: false)

-

false

showTargetFormatContent

gets the target role content (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseListLinksResponse

Content Type

  • application/json

Responses
Table 268. http response codes
Code Message Datatype

200

successful operation

ResponseListLinksResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.26.5. unlink

DELETE /v3/object/{source}/unlink

Delete a link between a source object and one or more target objects.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

MultipleLinkBeanRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListError

Content Type

  • application/json

Responses
Table 269. http response codes
Code Message Datatype

200

successful operation

ResponseListError

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.26.6. unlink_2

DELETE /v3/object/{source}/unlink/{target}

Delete a link between two objects.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

target

X

null
Body Parameter
Name Description Required Default Pattern

body

LinkBeanRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 270. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.27. ObjectMetadata

1.27.1. getMetadataAndDtd

GET /v3/object/metadata

Get metadata template(xml) and its dtd(json) filter by objectType, workfolder, contentType

Description
Parameters
Query Parameters
Name Description Required Default Pattern

objectType

object type

-

null

contentType

Content type(only for topicItem object

-

null

workfolder

Workfolder

-

null

token

API token

X

null
Return Type

ResponseMetadataTemplateStreamer

Content Type

  • multipart/mixed

Responses
Table 271. http response codes
Code Message Datatype

200

successful operation

ResponseMetadataTemplateStreamer

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.28. ObjectPermissions

1.28.1. addObjectPermissions

POST /v3/object/{source}/permissions

Add permissions to object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectPermissionAddRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 272. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.28.2. checkObjectPermission

GET /v3/object/{source}/permissions/check

Checks if the current user has specific permissions.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Query Parameters
Name Description Required Default Pattern

accessMask

X

null

token

API token

X

null
Return Type

ResponseBoolean

Content Type

  • application/json

Responses
Table 273. http response codes
Code Message Datatype

200

successful operation

ResponseBoolean

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.28.3. getObjectPermissions

GET /v3/object/{source}/permissions/list

Gives the permissions for a given object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponsePermissionResponse

Content Type

  • application/json

Responses
Table 274. http response codes
Code Message Datatype

200

successful operation

ResponsePermissionResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.28.4. listUserPermissionOnObject

GET /v3/object/{source}/permissions

Gives user’s permissions for a given object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

<pre>the source</pre> <pre>List of retuned permissions PERM_READ: Read (and execute) permission, PERM_WRITE: Write permission, PERM_MODIFY_CONTENT: Permission to modify the content of an object, PERM_MODIFY_STATUS: Permission to modify the status of an object, PERM_MODIFY_ATTRIB: Permission to change the attributes of an object (ObjectInfo data), PERM_MODIFY_ATTRIB_EX: Permission to change the extended attributes of an object (attributes), PERM_MODIFY_ATTRIB_SYS: Permission to change the system attributes of an object, PERM_DELETE: Permission to delete an object, PERM_MODIFY_PERM: Permission to modify the permissions of an object, PERM_LINK: Permission to link an object to another object, PERM_SEARCH: Permission to retrieve an object with a query, PERM_MOVE: Permission to move an object to another container, PERM_ADD: Permission to insert an object in a container, PERM_REMOVE: Permission to remove an object from a container, PERM_ADD_CONTAINER: Permission to insert a container in a container, PERM_REMOVE_CONTAINER: Permission to remove a container from a container, PERM_LIST: Permission to list a container, PERM_TRAVERSE: Permission to traverse a container, PERM_FULL: Full permissions, PERM_MODIFY: Permission to read, write and delete an object, PERM_MODIFY_ROLES: Permission to modify (add/remove) roles for an object, PERM_CONTAINER: Container permissions, PERM_READ_THRU_ALIAS: Permission to read an object through one of its aliases, PERM_READ_WRITE_ALIAS: Permission to write an object through one of its aliases, PERM_CONFIDENTIAL: Permission to view an object, PERM_READ_COMMENTS: Permission to read the comments on an object, PERM_WRITE_COMMENTS: Permission to comment an object, PERM_PRIVATE_COMMENTS: Permission to comment an object, PERM_FULL_COMMENTS: Permission to comment an object</pre>

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListEomPermissions

Content Type

  • application/json

Responses
Table 275. http response codes
Code Message Datatype

200

successful operation

ResponseListEomPermissions

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.28.5. removeObjectPermissions

DELETE /v3/object/{source}/permissions

Remove permissions from object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectPermissionRemoveRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 276. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.28.6. replaceObjectPermissions

PUT /v3/object/{source}/permissions/replace

replaces all kind of permissions(object and/or workflow and/or inherited)

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectPermissionReplaceRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 277. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.28.7. setObjectPermissions

PUT /v3/object/{source}/permissions

Set permissions to object, set flags to inheritance and propagate to children

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectPermissionSetRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 278. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.29. ObjectProperty

1.29.1. deleteProperty

DELETE /v3/object/{source}/property/{type}/{name}

Deletes the object’s property

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to which the property is attached

X

null

type

the property type

X

null

name

the property name

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 279. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.29.2. getProperties

GET /v3/object/{source}/property

Get object’s properties

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object which properties has to be retrieved

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectRoleList

Content Type

  • application/json

Responses
Table 280. http response codes
Code Message Datatype

200

successful operation

ResponseObjectRoleList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.29.3. getProperty

GET /v3/object/{source}/property/{type}/{name}

Get object’s properties

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object which properties has to be retrieved

X

null

type

the property type

X

null

name

the property name

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseInputStream

Content Type

  • application/octet-stream

Responses
Table 281. http response codes
Code Message Datatype

200

successful operation

ResponseInputStream

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.29.4. postProperty

POST /v3/object/{source}/property

Create a new property on the object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object on which create the property

X

null
Form Parameter
Name Description Required Default Pattern

options

<pre>{ \\&quot;type\\&quot;: \\&quot;string\\&quot;, \\&quot;name\\&quot;: \\&quot;string\\&quot;, \\&quot;forceSystemProperty\\&quot;: \\&quot;boolean\\&quot; }</pre> [ref]

-

null

content

the content to write [file]

-

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectRole

Content Type

  • application/json

Responses
Table 282. http response codes
Code Message Datatype

200

successful operation

ResponseObjectRole

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.29.5. putProperty

PUT /v3/object/{source}/property/{type}/{name}

Updates the object’s property content

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to which the property is attached

X

null

type

the property type

X

null

name

the property name

X

null
Body Parameter
Name Description Required Default Pattern

body

the content to write [object]

-
Query Parameters
Name Description Required Default Pattern

forceSystemProperty

force system property

-

false

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 283. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.30. ObjectRecyclebin

1.30.1. deleteRecycleBinEmpty

DELETE /v3/object/recyclebin

Empty the recycle bin

Description
Parameters
Query Parameters
Name Description Required Default Pattern

databaseId

the database identifier

-

null

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 284. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.30.2. getRecycleBin

GET /v3/object/recyclebin

List the recycle bin content

Description
Parameters
Query Parameters
Name Description Required Default Pattern

databaseId

the database identifier

-

null

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfoList

Content Type

  • application/json

Responses
Table 285. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.31. ObjectRelocation

1.31.1. correlationDwpRelocator

POST /v3/object/{source}/relocation/{target}/dwp/correlation

Drag and drop an object to the target object. If database id is null, default database id is used.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to be correlated to the target object

X

null

target

X

null
Body Parameter
Name Description Required Default Pattern

body

DwpCorrelationRelocationDragAndDropRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 286. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.31.2. correlationRelocator

POST /v3/object/{source}/relocation/{target}/correlation

Correlates an object to the target object. If database id is null, default database id is used.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to be correlated to the target object

X

null

target

X

null
Body Parameter
Name Description Required Default Pattern

body

CorrelationRelocationDragAndDropRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 287. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.31.3. correlationRelocatorMultipleSource

POST /v3/object/relocation/{target}/correlation

Correlates some objects to the target object. If database id is null, default database id is used.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

target

X

null
Body Parameter
Name Description Required Default Pattern

body

CorrelationsRelocationDragAndDropRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfoList

Content Type

  • application/json

Responses
Table 288. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.31.4. dragAndDrop

POST /v3/object/{source}/relocation/inner/{target}

Drag and drop an object into a story. If database id is null, default database id is used.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to dragAndDrop

X

null

target

X

null
Body Parameter
Name Description Required Default Pattern

body

StoryInnerRelocationDragAndDropRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 289. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.31.5. drawerRelocator

POST /v3/object/{source}/relocation/{target}/drawer

Inserts an object into a drawer. If database id is null, default database id is used.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to be inserted into the drawer

X

null

target

X

null
Body Parameter
Name Description Required Default Pattern

body

DrawersRelocationDragAndDropRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 290. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.31.6. objectsRelocator

POST /v3/object/{source}/relocation/{target}

Copy/move an object into a folder. If database id is null, default database id is used.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to copy/move

X

null

target

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectsRelocationDragAndDropRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 291. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.31.7. sendToProduction

POST /v3/object/relocation/sendtoproduction

Sent to production an object

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectRelocationSendToProductionRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseMapStringSendToProductionResponse

Content Type

  • application/json

Responses
Table 292. http response codes
Code Message Datatype

200

successful operation

ResponseMapStringSendToProductionResponse

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.31.8. topicItemAttachRelocator

POST /v3/object/{source}/relocation/{target}/topicitem/attach

Attaches an object to a topic item/subitem. If database id is null, default database id is used.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to be attached with a topic item/subitem

X

null

target

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicItemAttachRelocationDragAndDropRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicItem

Content Type

  • application/json

Responses
Table 293. http response codes
Code Message Datatype

200

successful operation

ResponseTopicItem

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.31.9. topicItemCorrelationRelocator

POST /v3/object/{source}/relocation/{target}/topicitem/correlate

Correlates an object to a topic item/subitem. If database id is null, default database id is used.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to be correlated with a topic item/subitem

X

null

target

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicItemCorrelateRelocationDragAndDropRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 294. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.31.10. topicItemCorrelationRelocatorMultipleSource

POST /v3/object/relocation/{target}/topicitem/correlate

Correlates some objects to a topic item/subitem. If database id is null, default database id is used.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

target

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicItemCorrelatesRelocationDragAndDropRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfoList

Content Type

  • application/json

Responses
Table 295. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfoList

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.32. ObjectRevive

1.32.1. revive

POST /v3/object/story/{source}/revive

Revive an object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to revive

X

null
Form Parameter
Name Description Required Default Pattern

options

<pre>{ \\&quot;application\\&quot;: \\&quot;string\\&quot;, \\&quot;databaseId\\&quot;: \\&quot;string\\&quot;, \\&quot;options\\&quot;: { \\&quot;showAdditionalInfo\\&quot;: boolean (default false), \\&quot;showPath\\&quot;: boolean (default false), \\&quot;showSystemAttributes\\&quot;: boolean (default true), \\&quot;showAttributes\\&quot;: boolean (default true), \\&quot;showUsageTickets\\&quot;: boolean (default true), \\&quot;showVirtualAttributes\\&quot;: boolean (default true), \\&quot;showXml\\&quot;: boolean (default false), \\&quot;resolutionMode\\&quot;: \\&quot;EXCEPTION (Default Value) \\&quot; - Other accepted values: REPLACE , NEW_VERSION(does'nt work on bundle revive), } }</pre> [ref]

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 296. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.33. ObjectStory

1.33.1. compare

GET /v3/object/story/{source}/compare/{from}/with/{to}

Compare two different story version

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the story to compare

X

null

from

the first version number of the story to compare

X

null

to

the second version number of the story to compare

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 297. http response codes
Code Message Datatype

200

Compared Story content as stream

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.33.2. getEditionsObject

GET /v3/object/story/{source}/editions

Retrieves the editions where the given story has been used

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Query Parameters
Name Description Required Default Pattern

channelName

the channel copy type used as filter

-

null

issueDate

the issueDate used as filter

-

null

token

API token

X

null
Return Type

ResponseObjectLinkedEditionsResponse

Content Type

  • application/json

Responses
Table 298. http response codes
Code Message Datatype

200

successful operation

ResponseObjectLinkedEditionsResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.33.3. getStory

GET /v3/object/story/{source}

Gives content for a given story

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the story to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

version

story version

-

null

spaces

If true it keeps the spaces between tags otherwise it removes them

-

true

raw

If true doesn't resolve entities inside dtd while parsing xml

-

true

cdata

If true retrieves contents with split CDATA

-

true

token

API token

X

null
Return Type

-

Responses
Table 299. http response codes
Code Message Datatype

200

Story content as stream

<<>>

400

Invalid data

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.33.4. getTopics

GET /v3/object/story/{source}/topics

Retrieves all topics in which the story has been linked to

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the story to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showCorrelates

shows correlated objects in the response (default: false)

-

false

showAttachment

shows attached object in the response (default: false)

-

false

limitToChildren

limit the read to the object's children (default: true)

-

true

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseTopicList

Content Type

  • application/json

Responses
Table 300. http response codes
Code Message Datatype

200

successful operation

ResponseTopicList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.33.5. linkToPage

PUT /v3/object/story/{source}/link/page/{pageSource}

Links a page to the story

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the story to retrieve

X

null

pageSource

the page to link

X

null
Body Parameter
Name Description Required Default Pattern

body

LinkToPageRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 301. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.33.6. post

POST /v3/object/story

Create a story with the given content

Description

This is identical to POST /v3/object/create but the given shape is then applied to the created story

Parameters
Form Parameter
Name Description Required Default Pattern

options

<pre>{ \\&quot;name\\&quot;: \\&quot;string\\&quot;, \\&quot;folder\\&quot;: \\&quot;string\\&quot;, \\&quot;workFolder\\&quot;: \\&quot;string\\&quot;, \\&quot;product\\&quot;: \\&quot;string\\&quot;, \\&quot;edition\\&quot;: \\&quot;string\\&quot;, \\&quot;issueDate\\&quot;: \\&quot;string\\&quot;, \\&quot;team\\&quot;: \\&quot;string\\&quot;, \\&quot;type\\&quot;: \\&quot;string\\&quot;, \\&quot;application\\&quot;: \\&quot;string\\&quot;, \\&quot;systemAttributes\\&quot;: \\&quot;string\\&quot;, \\&quot;attributes\\&quot;: \\&quot;string\\&quot;, \\&quot;status\\&quot;: \\&quot;string\\&quot;, \\&quot;statusComment\\&quot;: \\&quot;string\\&quot;, \\&quot;uniquenessString\\&quot;: \\&quot;string\\&quot;, \\&quot;timestamp\\&quot;: \\&quot;string\\&quot;, \\&quot;uuid\\&quot;: \\&quot;string\\&quot;, \\&quot;databaseId\\&quot;: \\&quot;string\\&quot;, \\&quot;options\\&quot;: { \\&quot;showAdditionalInfo\\&quot;: true, \\&quot;showPath\\&quot;: true, \\&quot;showSystemAttributes\\&quot;: true, \\&quot;showAttributes\\&quot;: true, \\&quot;showUsageTickets\\&quot;: true, \\&quot;showVirtualAttributes\\&quot;: true, \\&quot;showXml\\&quot;: true, \\&quot;checkIn\\&quot;: true, \\&quot;keepCheckedOut\\&quot;: true, \\&quot;createMode\\&quot;: \\&quot;EXCEPTION\\&quot;, \\&quot;useDefaultProduct\\&quot;: true, \\&quot;issueDateDefaultStrategy\\&quot;: \\&quot;CALENDAR\\&quot;, \\&quot;timeSuffix\\&quot;: true, \\&quot;checkInAction\\&quot;: true, \\&quot;webType\\&quot;: { \\&quot;showWebType\\&quot;: true, \\&quot;webProduct\\&quot;: \\&quot;string\\&quot;, } }, \\&quot;shape\\&quot;: \\&quot;string\\&quot;, \\&quot;task\\&quot;: \\&quot;string\\&quot; }</pre> [ref]

X

null

content

the content to write [file]

-

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 302. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.33.7. postChain

POST /v3/object/story/{source}/chain

Creates chained document

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

A story from wich create a chained document

X

null
Form Parameter
Name Description Required Default Pattern

options

<pre>{ \\&quot;workflow\\&quot;: \\&quot;string\\&quot;, \\&quot;chainTag\\&quot;: \\&quot;string\\&quot;, \\&quot;bodyContentItem\\&quot;: \\&quot;string\\&quot;, \\&quot;bodyFragment\\&quot;: \\&quot;string\\&quot;, \\&quot;options\\&quot;: { \\&quot;copyMetadata\\&quot;: true, \\&quot;mode\\&quot;: \\&quot;string\\&quot;, \\&quot;showAdditionalInfo\\&quot;: true, \\&quot;showPath\\&quot;: true, \\&quot;showSystemAttributes\\&quot;: true, \\&quot;showAttributes\\&quot;: true, \\&quot;showUsageTickets\\&quot;: true, \\&quot;showVirtualAttributes\\&quot;: true, \\&quot;showXml\\&quot;: true, \\&quot;webType\\&quot;: { \\&quot;showWebType\\&quot;: true, \\&quot;webProduct\\&quot;: \\&quot;string\\&quot;, } }, }</pre> [ref]

X

null

content

the content to write when mode options is chain and both chainTag and bodyContentItem are blank [file]

-

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 303. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.33.8. postFromDefaultTemplate

POST /v3/object/story/from/template

Create a story using the default template

Description

This is identical to POST /v3/object/create/from/template but the given shape is then applied to the created story

Parameters
Body Parameter
Name Description Required Default Pattern

body

StoryCreateTemplateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 304. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found, if the template cannot be found

<<>>
Samples

1.33.9. postFromTemplate

POST /v3/object/story/from/template/{source}

Create a story using the given template

Description

This is identical to POST /v3/object/create/from/template/{source} but the given shape is then applied to the created story

Parameters
Path Parameters
Name Description Required Default Pattern

source

the template to use

X

null
Body Parameter
Name Description Required Default Pattern

body

StoryCreateTemplateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 305. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found, if the template cannot be found

<<>>
Samples

1.33.10. upload

POST /v3/object/story/upload

Upload a story with the given content and related attachments

Description
Parameters
Form Parameter
Name Description Required Default Pattern

attachmentOptions

story attachment options to save <pre>[ { &quot;name&quot;: &quot;string&quot;, &quot;folder&quot;: &quot;string&quot;, &quot;workFolder&quot;: &quot;string&quot;, &quot;product&quot;: &quot;string&quot;, &quot;edition&quot;: &quot;string&quot;, &quot;issueDate&quot;: &quot;string&quot;, &quot;team&quot;: &quot;string&quot;, &quot;type&quot;: &quot;string&quot;, &quot;application&quot;: &quot;string&quot;, &quot;systemAttributes&quot;: &quot;string&quot;, &quot;attributes&quot;: &quot;string&quot;, &quot;status&quot;: &quot;string&quot;, &quot;statusComment&quot;: &quot;string&quot;, &quot;uniquenessString&quot;: &quot;string&quot;, &quot;timestamp&quot;: &quot;string&quot;, &quot;uuid&quot;: &quot;string&quot;, &quot;databaseId&quot;: &quot;string&quot;, &quot;options&quot;: { &quot;showAdditionalInfo&quot;: true, &quot;showPath&quot;: true, &quot;showSystemAttributes&quot;: true, &quot;showAttributes&quot;: true, &quot;showUsageTickets&quot;: true, &quot;showVirtualAttributes&quot;: true, &quot;showXml&quot;: true, &quot;checkIn&quot;: true, &quot;keepCheckedOut&quot;: true, &quot;createMode&quot;: &quot;EXCEPTION&quot;, &quot;useDefaultProduct&quot;: true, &quot;issueDateDefaultStrategy&quot;: &quot;CALENDAR&quot;, &quot;timeSuffix&quot;: true, &quot;checkInAction&quot;: true, &quot;webType&quot;: { &quot;showWebType&quot;: true, &quot;webProduct&quot;: &quot;string&quot;, } } } ] </pre> [ObjectCreateContentRequest]

X

null

attachment

story attachment contents to save [FormDataBodyPart]

X

null

options

<pre>{ \\&quot;name\\&quot;: \\&quot;string\\&quot;, \\&quot;folder\\&quot;: \\&quot;string\\&quot;, \\&quot;workFolder\\&quot;: \\&quot;string\\&quot;, \\&quot;product\\&quot;: \\&quot;string\\&quot;, \\&quot;edition\\&quot;: \\&quot;string\\&quot;, \\&quot;issueDate\\&quot;: \\&quot;string\\&quot;, \\&quot;team\\&quot;: \\&quot;string\\&quot;, \\&quot;type\\&quot;: \\&quot;string\\&quot;, \\&quot;application\\&quot;: \\&quot;string\\&quot;, \\&quot;systemAttributes\\&quot;: \\&quot;string\\&quot;, \\&quot;attributes\\&quot;: \\&quot;string\\&quot;, \\&quot;status\\&quot;: \\&quot;string\\&quot;, \\&quot;statusComment\\&quot;: \\&quot;string\\&quot;, \\&quot;uniquenessString\\&quot;: \\&quot;string\\&quot;, \\&quot;timestamp\\&quot;: \\&quot;string\\&quot;, \\&quot;uuid\\&quot;: \\&quot;string\\&quot;, \\&quot;databaseId\\&quot;: \\&quot;string\\&quot;, \\&quot;options\\&quot;: { \\&quot;showAdditionalInfo\\&quot;: true, \\&quot;showPath\\&quot;: true, \\&quot;showSystemAttributes\\&quot;: true, \\&quot;showAttributes\\&quot;: true, \\&quot;showUsageTickets\\&quot;: true, \\&quot;showVirtualAttributes\\&quot;: true, \\&quot;showXml\\&quot;: true, \\&quot;checkIn\\&quot;: true, \\&quot;keepCheckedOut\\&quot;: true, \\&quot;createMode\\&quot;: \\&quot;EXCEPTION\\&quot;, \\&quot;useDefaultProduct\\&quot;: true, \\&quot;issueDateDefaultStrategy\\&quot;: \\&quot;CALENDAR\\&quot;, \\&quot;timeSuffix\\&quot;: true, \\&quot;checkInAction\\&quot;: true, \\&quot;webType\\&quot;: { \\&quot;showWebType\\&quot;: true, \\&quot;webProduct\\&quot;: \\&quot;string\\&quot;, } }, \\&quot;shape\\&quot;: \\&quot;string\\&quot;, \\&quot;attachmentPlaceholders\\&quot;: { \\&quot;filename1\\&quot;: \\&quot;placeholder1\\&quot;, \\&quot;filename2\\&quot;: \\&quot;placeholder2\\&quot;, \\&quot;filename3\\&quot;: \\&quot;placeholder3\\&quot;, } }</pre> [ref]

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseStoryUploadResponse

Content Type

  • application/json

Responses
Table 306. http response codes
Code Message Datatype

200

successful operation

ResponseStoryUploadResponse

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.33.11. upload_1

PUT /v3/object/story/upload/{source}

Update a story with the given content and related attachments

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the story to update

X

null
Form Parameter
Name Description Required Default Pattern

attachmentOptions

story attachment options to save <pre>[ { &quot;name&quot;: &quot;string&quot;, &quot;folder&quot;: &quot;string&quot;, &quot;workFolder&quot;: &quot;string&quot;, &quot;product&quot;: &quot;string&quot;, &quot;edition&quot;: &quot;string&quot;, &quot;issueDate&quot;: &quot;string&quot;, &quot;team&quot;: &quot;string&quot;, &quot;type&quot;: &quot;string&quot;, &quot;application&quot;: &quot;string&quot;, &quot;systemAttributes&quot;: &quot;string&quot;, &quot;attributes&quot;: &quot;string&quot;, &quot;status&quot;: &quot;string&quot;, &quot;statusComment&quot;: &quot;string&quot;, &quot;uniquenessString&quot;: &quot;string&quot;, &quot;timestamp&quot;: &quot;string&quot;, &quot;uuid&quot;: &quot;string&quot;, &quot;databaseId&quot;: &quot;string&quot;, &quot;options&quot;: { &quot;showAdditionalInfo&quot;: true, &quot;showPath&quot;: true, &quot;showSystemAttributes&quot;: true, &quot;showAttributes&quot;: true, &quot;showUsageTickets&quot;: true, &quot;showVirtualAttributes&quot;: true, &quot;showXml&quot;: true, &quot;checkIn&quot;: true, &quot;keepCheckedOut&quot;: true, &quot;createMode&quot;: &quot;EXCEPTION&quot;, &quot;useDefaultProduct&quot;: true, &quot;issueDateDefaultStrategy&quot;: &quot;CALENDAR&quot;, &quot;timeSuffix&quot;: true, &quot;checkInAction&quot;: true, &quot;webType&quot;: { &quot;showWebType&quot;: true, &quot;webProduct&quot;: &quot;string&quot;, } } } ] </pre> [ObjectCreateContentRequest]

X

null

attachment

story attachment contents to save [FormDataBodyPart]

X

null

options

<pre>{ \\&quot;name\\&quot;: \\&quot;string\\&quot;, \\&quot;attributes\\&quot;: \\&quot;string\\&quot;, \\&quot;options\\&quot;: { \\&quot;showAdditionalInfo\\&quot;: true, \\&quot;showPath\\&quot;: true, \\&quot;showSystemAttributes\\&quot;: true, \\&quot;showAttributes\\&quot;: true, \\&quot;showUsageTickets\\&quot;: true, \\&quot;showVirtualAttributes\\&quot;: true, \\&quot;showXml\\&quot;: true, \\&quot;checkIn\\&quot;: true, \\&quot;keepCheckedOut\\&quot;: true, \\&quot;checkInAction\\&quot;: true, \\&quot;webType\\&quot;: { \\&quot;showWebType\\&quot;: true, \\&quot;webProduct\\&quot;: \\&quot;string\\&quot;, } }, \\&quot;attachmentPlaceholders\\&quot;: { \\&quot;filename1\\&quot;: \\&quot;placeholder1\\&quot;, \\&quot;filename2\\&quot;: \\&quot;placeholder2\\&quot;, \\&quot;filename3\\&quot;: \\&quot;placeholder3\\&quot;, } }</pre> [ref]

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseStoryUploadResponse

Content Type

  • application/json

Responses
Table 307. http response codes
Code Message Datatype

200

successful operation

ResponseStoryUploadResponse

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.34. ObjectTemplate

1.34.1. getDwpPath

GET /v3/object/template/dwp/path

Returns the list of paths allowed for the given channel and workFolder

Description
Parameters
Query Parameters
Name Description Required Default Pattern

channel

X

null

workFolder

X

null

token

API token

X

null
Return Type

ResponseListString

Content Type

  • application/json

Responses
Table 308. http response codes
Code Message Datatype

200

successful operation

ResponseListString

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.34.2. getInsertTemplates

GET /v3/object/template/listinsert

Returns the list of insertTemplates in the given dtx for the given type, linkType and channel

Description
Parameters
Query Parameters
Name Description Required Default Pattern

linkType

specify the link type for which the insert templates are needed

X

null

eomType

specify the type of the InsertInfo in the dtx for which the insert templates are needed

X

null

dtxPath

specify the path of the dtx file

X

null

databaseId

specify the database id

X

null

channel

specify the channel of the InsertInfo in the dtx for which the insert templates are needed

X

null

token

API token

X

null
Return Type

ResponseListInsertTemplate

Content Type

  • application/json

Responses
Table 309. http response codes
Code Message Datatype

200

successful operation

ResponseListInsertTemplate

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.34.3. post

POST /v3/object/template/dwp

Creates a DWP template

Description

Use GET /v3/object/template/dwp/path to get a valid list of DWP template path

Parameters
Body Parameter
Name Description Required Default Pattern

body

DwpTemplateCreateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 310. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.35. ObjectTopicitem

1.35.1. createTopicItem

POST /v3/object/topicitem

Creates a topic item

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

TaskCreateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicItemObjectInfo

Content Type

  • application/json

Responses
Table 311. http response codes
Code Message Datatype

200

successful operation

ResponseTopicItemObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.35.2. deleteTopicItem

DELETE /v3/object/topicitem/{topicItem}

Deletes a topic item

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topicItem

the topic item source

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 312. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.35.3. detach

DELETE /v3/object/topicitem/{topicItem}/detach/{attachment}

Remove attachment from topic item.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topicItem

the topic item source

X

null

attachment

any attachment

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 313. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.35.4. getCorrelation

GET /v3/object/topicitem/{topicItem}/correlations

Get correlations from topicItem and his attachment

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topicItem

the topicItem to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectCorrelationResponse

Content Type

  • application/json

Responses
Table 314. http response codes
Code Message Datatype

200

successful operation

ResponseObjectCorrelationResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.35.5. updateTopicItem

PUT /v3/object/topicitem/{topicItem}

Updates a topic item

Description
Parameters
Path Parameters
Name Description Required Default Pattern

topicItem

the topic item source

X

null
Body Parameter
Name Description Required Default Pattern

body

TopicItemUpdateRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTopicItemObjectInfo

Content Type

  • application/json

Responses
Table 315. http response codes
Code Message Datatype

200

successful operation

ResponseTopicItemObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.36. ObjectUsagetickets

1.36.1. deleteUsageTicket

DELETE /v3/object/{source}/tickets/{ticketType}/{position}

Deletes a usage ticket

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

ticketType

X

null

position

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 316. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.36.2. deleteUsageTicketType

DELETE /v3/object/{source}/tickets/{ticketType}

Deletes all usage tickets of the given type

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

ticketType

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 317. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.36.3. getUsageTicket

GET /v3/object/{source}/tickets

Reads all usage tickets

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseUsageTickets

Content Type

  • application/json

Responses
Table 318. http response codes
Code Message Datatype

200

successful operation

ResponseUsageTickets

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.36.4. getUsageTicketByType

GET /v3/object/{source}/tickets/{ticketType}

Reads all usage tickets of the given type

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

ticketType

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseUsageTickets

Content Type

  • application/json

Responses
Table 319. http response codes
Code Message Datatype

200

successful operation

ResponseUsageTickets

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.36.5. post

POST /v3/object/{source}/tickets/{ticketType}

Creates a usage ticket

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

ticketType

X

null
Body Parameter
Name Description Required Default Pattern

body

the content to write [object]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseInteger

Content Type

  • application/json

Responses
Table 320. http response codes
Code Message Datatype

200

successful operation

ResponseInteger

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.36.6. post_1

PUT /v3/object/{source}/tickets/{ticketType}/{position}

Updates a usage ticket

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null

ticketType

X

null

position

X

null
Body Parameter
Name Description Required Default Pattern

body

the content to write [object]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseInteger

Content Type

  • application/json

Responses
Table 321. http response codes
Code Message Datatype

200

successful operation

ResponseInteger

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.37. ObjectVersions

1.37.1. versionRestore

POST /v3/object/{source}/versions/6.2022.11-SNAPSHOT/restore

Restores a specific version

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the story from which to restore version

X

null

version

the version id, or index

X

null
Query Parameters
Name Description Required Default Pattern

isIndex

-

false

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showVersionWorkflowHistory

shows version workflow history information in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseVersionInfo

Content Type

  • application/json

Responses
Table 322. http response codes
Code Message Datatype

200

successful operation

ResponseVersionInfo

400

Invalid data

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.37.2. versionlist

GET /v3/object/{source}/versions/listold

Gives list of version info for a given story (the objectInfo id (loid,uuid) will be the version id)

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the story from which to retrieve the version list

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showVersionWorkflowHistory

shows version workflow history information in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseListVersionInfo

Content Type

  • application/json

Responses
Table 323. http response codes
Code Message Datatype

200

successful operation

ResponseListVersionInfo

400

Invalid data

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.37.3. versionlistWithContent

GET /v3/object/{source}/versions/list

Gives list of version info for a given story (the objectInfo id (loid,uuid) will be the version id)

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the story from which to retrieve the version list

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showVersionWorkflowHistory

shows version workflow history information in the response (default: false)

-

false

readContents

read XML contents (default: false)

-

false

showLastStatus

show last status for each version (default: false)

-

false

showAllVersions

show all versions, instead of ignoring checked-out ones (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseListVersionInfoAndContent

Content Type

  • application/json

Responses
Table 324. http response codes
Code Message Datatype

200

successful operation

ResponseListVersionInfoAndContent

400

Invalid data

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.37.4. versions

GET /v3/object/{source}/versions

Gives list of version info for a given story (the objectInfo id (loid,uuid) will be the source id)

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the story from which to retrieve the version list

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showVersionWorkflowHistory

shows version workflow history information in the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseListVersionInfo

Content Type

  • application/json

Responses
Table 325. http response codes
Code Message Datatype

200

successful operation

ResponseListVersionInfo

400

Invalid data

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.38. ObjectWorkflow

1.38.1. deleteStatus

DELETE /v3/object/{source}/workflow

Remove object workflow status

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 326. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.38.2. getListWorkFlowTask

GET /v3/object/{source}/workflow

lists the workflow status history of a given object

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

an object identifier (uuid, loid, path)

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListObjectWorkflowTask

Content Type

  • application/json

Responses
Table 327. http response codes
Code Message Datatype

200

successful operation

ResponseListObjectWorkflowTask

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.38.3. listWorkflowSteps

POST /v3/object/workflow

Gets the next workflow steps for a list of objects

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectWorkflowRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListObjectWorkflowDataBean

Content Type

  • application/json

Responses
Table 328. http response codes
Code Message Datatype

200

successful operation

ResponseListObjectWorkflowDataBean

401

Not authorized

<<>>
Samples

1.38.4. updateWorkflows

POST /v3/object/{source}/workflow

Updates workflow

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the source

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectWorkflowUpdateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 329. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>
Samples

1.39. PrimeService

1.39.1. revisionTrackingFinish

POST /v3/primeService/revisionTracking/finish

Finish revision tracking

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

<pre>{ &quot;url&quot; : &quot;METHODE_OBJECT_URL&quot;, &quot;deltaDom&quot; : &quot;DELTA_DOCUMENT_XML&quot;, &quot;saveRole&quot;: TRUE_OR_FALSE, &quot;saveContent&quot;: TRUE_OR_FALSE, &quot;checkin&quot;: TRUE_OR_FALSE, &quot;checkinKeepCheckedOut&quot;: TRUE_OR_FALSE }</pre> // Description: &quot;url&quot;: the object methode url, &quot;deltaDom&quot;: the document containing version differences and used for editing, &quot;saveRole&quot;: true: the revison document is saved inside its database role, false: no save is done(default: false), &quot;saveContent&quot;: true: the input &quot;deltaDom&quot; is saved inside the database, after processing(the object must be checked out), false: no save is done(default: false), &quot;checkin&quot;: true: an object checkin is done, false: no checkin is done(default: false), &quot;checkinKeepCheckedOut&quot;: true: an object checkin is done with the keepCheckedOut flag set to true, false: no checkin is done(default: false), when both &quot;checkin&quot; and &quot;checkinKeepCheckedOut&quot; are passed, &quot;checkinKeepCheckedOut&quot; is preferred. [object]

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 330. http response codes
Code Message Datatype

200

<pre>{ &quot;result&quot;: { &quot;currentDom&quot;: &quot;CURRENT_DOCUMENT_XML&quot; }, &quot;statistics&quot;: { …​ }, &quot;status&quot;: &quot;success&quot; } </pre> // Description: &quot;currentDom&quot;: the input &quot;deltaDom&quot; after processing (all version differences are removed).

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.39.2. revisionTrackingStart

POST /v3/primeService/revisionTracking/start

Start revision tracking

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

<pre>{ &quot;url&quot; : &quot;METHODE_OBJECT_URL&quot;, &quot;version&quot;: VERSION_ID, &quot;checkpoint&quot;: &quot;CHECKPOINT_ID&quot;, &quot;noNamespace&quot;: TRUE_OR_FALSE, &quot;currentDom&quot;: &quot;CURRENT_XML_DOCUMENT&quot; }</pre> // Description: &quot;url&quot;: the object methode url, &quot;version&quot;: version id(default: 0), &quot;checkpoint&quot;: checkpoint id(default &quot;&quot;), &quot;noNamespace&quot;: true: the element and attribute names used for revision tracking inside the returned &quot;deltaDom&quot; document start with &quot;v_&quot;, false: they start with &quot;v:&quot; and have a namespace(default: false), &quot;currentDom&quot;: current story content(optional) [object]

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 331. http response codes
Code Message Datatype

200

<pre>{ &quot;result&quot;: { &quot;deltaDom&quot;: &quot;DELTA_DOCUMENT_XML&quot;, &quot;history&quot;: [HISTORY_ARRAY], &quot;diffState&quot;: &quot;DIFF_STATE&quot;, &quot;deltaVersionsDom&quot;: &quot;DELTA_VERSIONS_DOCUMENT_XML&quot;, &quot;previousDom&quot;: &quot;PREVIOUS_DOCUMENT_XML&quot;, &quot;revisionDom&quot;: &quot;REVISION_DOCUMENT_XML&quot; }, &quot;statistics&quot;: { …​ }, &quot;status&quot;: &quot;success&quot; } </pre> // Description: &quot;deltaDom&quot;: the document containing version differences and to be used for editing, &quot;history&quot;: an array with useful data for each version, &quot;diffState&quot;, &quot;revisionDom&quot;, &quot;deltaVersionsDom&quot; and &quot;previousDom&quot; are data to be saved and passed back when calling &quot;revisionTracking/update&quot;, &quot;revisionDom&quot; may be absent.

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.39.3. revisionTrackingUpdate

POST /v3/primeService/revisionTracking/update

Update revision tracking

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

<pre>{ &quot;deltaDom&quot; : &quot;DELTA_DOCUMENT_XML&quot;, &quot;deltaVersionsDom&quot;: &quot;DELTA_VERSIONS_DOCUMENT_XML&quot;, &quot;diffState&quot;: &quot;DIFF_STATE&quot;, &quot;history&quot;: [HISTORY_ARRAY], &quot;previousDom&quot;: &quot;PREVIOUS_DOCUMENT_XML&quot;, &quot;revisionDom&quot;: &quot;REVISION_DOCUMENT_XML&quot; }</pre> // Description: &quot;deltaDom&quot;: the document containing version differences and used for editing, &quot;deltaVersionsDom&quot;, &quot;diffState&quot;, &quot;history&quot;, &quot;previousDom&quot; and &quot;revisionDom&quot; are data received when calling &quot;revisionTracking/start&quot;, &quot;revisionDom&quot; may be absent. [object]

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 332. http response codes
Code Message Datatype

200

<pre>{ &quot;result&quot;: { &quot;deltaDom&quot;: &quot;DELTA_DOCUMENT_XML&quot;, &quot;previousDom&quot;: &quot;PREVIOUS_DOCUMENT_XML&quot;, &quot;revisionDom&quot;: &quot;REVISION_DOCUMENT_XML&quot; }, &quot;statistics&quot;: { …​ }, &quot;status&quot;: &quot;success&quot; } </pre> // Description: &quot;deltaDom&quot;: the document containing version differences and used for editing, &quot;previousDom&quot; and &quot;revisionDom&quot; are data to be saved and passed back when calling again &quot;revisionTracking/update&quot;, &quot;revisionDom&quot; may be absent.

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.40. PrintService

1.40.1. createReportPdf

POST /v3/printService/createReportPdf

Creates a report PDF

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[object]

X
Query Parameters
Name Description Required Default Pattern

getPdf

return the PDF contents instead of the JSON response (default: true)

-

true

token

API token

X

null
Return Type

Response

Content Type

  • /

Responses
Table 333. http response codes
Code Message Datatype

200

successful operation

Response

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.40.2. createStoryPreview

POST /v3/printService/createStoryPreview

Creates a story preview

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[object]

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseMap

Content Type

  • application/json

Responses
Table 334. http response codes
Code Message Datatype

200

successful operation

ResponseMap

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.41. Query

1.41.1. candidate

POST /v3/query/candidate/{source}

Executes a candidate query

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query to execute

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryResponse

Content Type

  • application/json

Responses
Table 335. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If candidate query object cannot be found

<<>>
Samples

1.41.2. candidateView

POST /v3/query/candidate/{source}/view

Executes a candidate query and applies the default view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query to execute

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 336. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If candidate query object cannot be found

<<>>
Samples

1.41.3. candidateView_1

POST /v3/query/candidate/{source}/view/{view}

Executes a candidate query and applies the specified view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query to execute

X

null

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 337. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If candidate query object cannot be found

<<>>
Samples

1.41.4. execute

POST /v3/query/execute/{source}

Executes a query

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query to execute

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryResponse

Content Type

  • application/json

Responses
Table 338. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If query object cannot be found

<<>>
Samples

1.41.5. executeStored

POST /v3/query/stored/{id}

Executes a stored query

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

the id of the stored query to execute

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryResponse

Content Type

  • application/json

Responses
Table 339. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If query object cannot be found

<<>>
Samples

1.41.6. executeStoredView

POST /v3/query/stored/{id}/view

Executes a stored query and applies the default view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

the id of the stored query to execute

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 340. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If query object cannot be found

<<>>
Samples

1.41.7. executeStoredView_2

POST /v3/query/stored/{id}/view/{view}

Executes a stored query and applies the specified view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

id

the id of the stored query to execute

X

null

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 341. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If query object cannot be found

<<>>
Samples

1.41.8. executeView

POST /v3/query/execute/{source}/view

Executes a query and applies the default view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query to execute

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 342. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If query object cannot be found

<<>>
Samples

1.41.9. executeView_3

POST /v3/query/execute/{source}/view/{view}

Executes a query and applies the specified view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query to execute

X

null

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 343. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If query object cannot be found

<<>>
Samples

1.41.10. find

POST /v3/query/find

Executes the query string

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

QueryStringRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryResponse

Content Type

  • application/json

Responses
Table 344. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryResponse

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.41.11. findView

POST /v3/query/find/view

Executes the query string and applies the default view to result

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

QueryViewStringRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 345. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.41.12. findView_4

POST /v3/query/find/view/{view}

Executes the query string and applies the specified view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewStringRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 346. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.41.13. getQueryString

GET /v3/query/{source}

Gets the query string

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query to read

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseStreamingOutput

Content Type

  • application/octet-stream

Responses
Table 347. http response codes
Code Message Datatype

200

successful operation

ResponseStreamingOutput

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If query object cannot be found

<<>>
Samples

1.41.14. post

POST /v3/query

Creates a query with the given content

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

QueryCreateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 348. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If folder cannot be found

<<>>
Samples

1.41.15. setQueryString

PUT /v3/query/{source}

Gets the query string

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query to update

X

null
Body Parameter
Name Description Required Default Pattern

body

[object]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseStreamingOutput

Content Type

  • application/octet-stream

Responses
Table 349. http response codes
Code Message Datatype

200

successful operation

ResponseStreamingOutput

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If query object cannot be found

<<>>
Samples

1.42. QueryAlert

1.42.1. activateAlertQuery

PUT /v3/query/alert/{source}/activate

Activate specific alert query

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query alert to activate

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 350. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If alert query object cannot be found

<<>>
Samples

1.42.2. alertCandidate

POST /v3/query/alert/candidate/{source}

Executes an alert candidate query

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the alert query to execute

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryResponse

Content Type

  • application/json

Responses
Table 351. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If candidate query object cannot be found

<<>>
Samples

1.42.3. alertCandidateView

POST /v3/query/alert/candidate/{source}/view

Executes an alert candidate query and applies the default view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the alert query to execute

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 352. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If candidate query object cannot be found

<<>>
Samples

1.42.4. alertCandidateView_1

POST /v3/query/alert/candidate/{source}/view/{view}

Executes an alert candidate query and applies the specified view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the alert query to execute

X

null

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 353. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If candidate query object cannot be found

<<>>
Samples

1.42.5. alertFind

POST /v3/query/alert/find

Executes and activates the query string as an alert query

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

QueryViewStringRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryResponse

Content Type

  • application/json

Responses
Table 354. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryResponse

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.42.6. alertFindView

POST /v3/query/alert/find/view

Executes and activates the query string as an alert query and applies the default view to result

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

QueryViewStringRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 355. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.42.7. alertFindView_2

POST /v3/query/alert/find/view/{view}

Executes and activates the query string as an alert query and applies the specified view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewStringRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 356. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.42.8. deactivateAlertQuery

PUT /v3/query/alert/{source}/deactivate

Deactivate specific alert query

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query alert to deactivate

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 357. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If alert query object cannot be found

<<>>
Samples

1.42.9. executeAlert

POST /v3/query/alert/execute/{source}

Executes and activates an alert query

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query to execute

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryResponse

Content Type

  • application/json

Responses
Table 358. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If query object cannot be found

<<>>
Samples

1.42.10. executeViewAlert

POST /v3/query/alert/execute/{source}/view

Executes and activates an alert query and applies the default view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query to execute

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 359. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If query object cannot be found

<<>>
Samples

1.42.11. executeViewAlert_3

POST /v3/query/alert/execute/{source}/view/{view}

Executes and activates an alert query and applies the specified view to result

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the query to execute

X

null

view

the view to apply

X

null
Body Parameter
Name Description Required Default Pattern

body

QueryViewRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectQueryViewResponse

Content Type

  • application/json

Responses
Table 360. http response codes
Code Message Datatype

200

successful operation

ResponseObjectQueryViewResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If query object cannot be found

<<>>
Samples

1.42.12. listActivatedAlertQuery

GET /v3/query/alert/active

Get List of activated alert queries

Description
Parameters
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

-

false

showPath

-

false

showUri

shows the uri in the response (default: false)

-

false

showSystemAttributes

-

true

showAttributes

-

false

showUsageTickets

-

false

showVirtualAttributes

-

false

showXml

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

-

true

showContent

-

false

showUniquenessString

shows Uniqueness string (default: false)

-

false

prefill

return a preview of the query result (default: true)

-

true

token

API token

X

null
Return Type

ResponseListQueryObjectInfo

Content Type

  • application/json

Responses
Table 361. http response codes
Code Message Datatype

200

successful operation

ResponseListQueryObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.42.13. post

POST /v3/query/alert

Creates an alert query with the given content

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

AlertQueryCreateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 362. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

If WorkFlow status cannot be found

<<>>
Samples

1.43. ServiceExternal

1.43.1. deleteExternal

DELETE /v3/service/external/{target}/{endpoint}

Proxies a DELETE request

Description

Response is in the standard MRAS format

Parameters
Path Parameters
Name Description Required Default Pattern

target

a proxy target defined in restserver.config

X

null

endpoint

additional path and/or query param to append to the target as defined in restserver.config

X

null

/.*/
Body Parameter
Name Description Required Default Pattern

body

request body [ByteArray]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 363. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>
Samples

1.43.2. deleteLegacyExternal

DELETE /v3/service/external/legacy/{target}/{endpoint}

Proxies a DELETE request

Description

Response is leaved as the target service one

Parameters
Path Parameters
Name Description Required Default Pattern

target

a proxy target defined in restserver.config

X

null

endpoint

additional path and/or query param to append to the target as defined in restserver.config

X

null

/.*/
Body Parameter
Name Description Required Default Pattern

body

request body [ByteArray]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 364. http response codes
Code Message Datatype

401

Not authorized

<<>>
Samples

1.43.3. getExternal

GET /v3/service/external/{target}/{endpoint}

Proxies a GET request

Description

Response is in the standard MRAS format

Parameters
Path Parameters
Name Description Required Default Pattern

target

a proxy target defined in restserver.config

X

null

endpoint

additional path and/or query param to append to the target as defined in restserver.config

X

null

/.*/
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 365. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>
Samples

1.43.4. getLegacyExternal

GET /v3/service/external/legacy/{target}/{endpoint}

Proxies a GET request

Description

Response is leaved as the target service one

Parameters
Path Parameters
Name Description Required Default Pattern

target

a proxy target defined in restserver.config

X

null

endpoint

additional path and/or query param to append to the target as defined in restserver.config

X

null

/.*/
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 366. http response codes
Code Message Datatype

401

Not authorized

<<>>
Samples

1.43.5. postExternal

POST /v3/service/external/{target}/{endpoint}

Proxies a POST request

Description

Response is in the standard MRAS format

Parameters
Path Parameters
Name Description Required Default Pattern

target

a proxy target defined in restserver.config

X

null

endpoint

additional path and/or query param to append to the target as defined in restserver.config

X

null

/.*/
Body Parameter
Name Description Required Default Pattern

body

request body [ByteArray]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 367. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>
Samples

1.43.6. postExternalWithoutEndpoint

POST /v3/service/external/{target}

Proxies a POST request without endpoint. The endpoint is configured in the target attribute

Description

Response is in the standard MRAS format

Parameters
Path Parameters
Name Description Required Default Pattern

target

a proxy target defined in restserver.config

X

null
Body Parameter
Name Description Required Default Pattern

body

request body [ByteArray]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 368. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>
Samples

1.43.7. postLegacyExternal

POST /v3/service/external/legacy/{target}/{endpoint}

Proxies a POST request

Description

Response is leaved as the target service one

Parameters
Path Parameters
Name Description Required Default Pattern

target

a proxy target defined in restserver.config

X

null

endpoint

additional path and/or query param to append to the target as defined in restserver.config

X

null

/.*/
Body Parameter
Name Description Required Default Pattern

body

request body [ByteArray]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 369. http response codes
Code Message Datatype

401

Not authorized

<<>>
Samples

1.43.8. putExternal

PUT /v3/service/external/{target}/{endpoint}

Proxies a PUT request

Description

Response is in the standard MRAS format

Parameters
Path Parameters
Name Description Required Default Pattern

target

a proxy target defined in restserver.config

X

null

endpoint

additional path and/or query param to append to the target as defined in restserver.config

X

null

/.*/
Body Parameter
Name Description Required Default Pattern

body

request body [ByteArray]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 370. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>
Samples

1.43.9. putLegacyExternal

PUT /v3/service/external/legacy/{target}/{endpoint}

Proxies a PUT request

Description

Response is leaved as the target service one

Parameters
Path Parameters
Name Description Required Default Pattern

target

a proxy target defined in restserver.config

X

null

endpoint

additional path and/or query param to append to the target as defined in restserver.config

X

null

/.*/
Body Parameter
Name Description Required Default Pattern

body

request body [ByteArray]

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 371. http response codes
Code Message Datatype

401

Not authorized

<<>>
Samples

1.44. ServiceImageServer

1.44.1. getProcessXml

GET /v3/service/imageServer

Retrieve information about the service and its status

Description
Parameters
Query Parameters
Name Description Required Default Pattern

op

Type of the servlet operation. The only accepted value is info

-

info

module

the name of the module/engine requested

-

null

process

The processing engine to be used. This value must be name of one of the configured engines. Default value is output-correction

-

output-correction

uri

ImageServer uri

X

null

token

API token

X

null
Return Type

-

Responses
Table 372. http response codes
Code Message Datatype

200

response from imagesServer

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.44.2. proxyImageServerWithBody

POST /v3/service/imageServer/{source}

Send information to the service on what image to be processed and how to process it

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the object to process

X

null
Body Parameter
Name Description Required Default Pattern

body

[object]

-
Query Parameters
Name Description Required Default Pattern

uri

ImageServer uri

X

null

token

API token

X

null
Return Type

-

Responses
Table 373. http response codes
Code Message Datatype

200

response from imagesServer

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.45. ServiceRepository

1.45.1. executeRequest

POST /v3/service/repository

Executes a session request

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

RepositoryRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 374. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.45.2. executeRequestJson

POST /v3/service/repository/json

Executes a session request

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

RepositoryRequestJSON

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObject

Content Type

  • application/json

Responses
Table 375. http response codes
Code Message Datatype

200

successful operation

ResponseObject

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.46. ServiceXsl

1.46.1. xslTrasformationNew

POST /v3/service/xsl/emXslTrasformation

Apply a XSL transformation to the given xml string. The XSL to apply is on methode filesystem

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

XslTransformRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObject

Content Type

  • application/octet-stream

Responses
Table 376. http response codes
Code Message Datatype

200

successful operation

ResponseObject

400

Invalid data

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.47. Shape

1.47.1. applyShape

PUT /v3/shape/{source}/story/{story}

Apply the specified shape to the given story

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the shape to apply

X

null

story

the story

X

null
Body Parameter
Name Description Required Default Pattern

body

ApplyShapeRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseString

Content Type

  • application/json

Responses
Table 377. http response codes
Code Message Datatype

200

successful operation

ResponseString

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found, if the story or the shape cannot be found

<<>>
Samples

1.47.2. getShape

GET /v3/shape/story/{story}

Returns info on the shape applied to the given story. If the story has no shapes, the single boolean noPageLinked is returned

Description
Parameters
Path Parameters
Name Description Required Default Pattern

story

the story

X

null
Query Parameters
Name Description Required Default Pattern

channel

-

null

workFolder

workFolder, used to select a page accessories path when there is not a shape source

-

null

color

color, used to select a page accessories path when there is not a shape source

-

null

showTemplates

returns the template content and the list of templates (default: false)

-

null

format

returns the templates only for this list of formats, if showTemplates is true (default: all) [String]

-

null

token

API token

X

null
Return Type

ResponseObjectShapeDataBean

Content Type

  • application/json

Responses
Table 378. http response codes
Code Message Datatype

200

successful operation

ResponseObjectShapeDataBean

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found, if the storycannot be found

<<>>
Samples

1.48. Task

1.48.1. attach

POST /v3/task/{source}/attach/{sourceAttach}

Get task info with the default view applied

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the task to attach to

X

null

sourceAttach

the object to attach to the task

X

null
Query Parameters
Name Description Required Default Pattern

moveCorrelations

-

true

token

API token

X

null
Return Type

ResponseBoolean

Content Type

  • application/json

Responses
Table 379. http response codes
Code Message Datatype

200

successful operation

ResponseBoolean

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.2. detach

POST /v3/task/{source}/detach

Get task info with the default view applied

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the task to attach to

X

null
Query Parameters
Name Description Required Default Pattern

moveCorrelations

-

true

token

API token

X

null
Return Type

ResponseBoolean

Content Type

  • application/json

Responses
Table 380. http response codes
Code Message Datatype

200

successful operation

ResponseBoolean

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.3. get

GET /v3/task/{source}

Get task info

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the task to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showCorrelated

add correlated object to the response (default: false)

-

false

showAttachments

add attachments to the response (default: false)

-

false

showTopic

add related topic to the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseTaskObjectInfo

Content Type

  • application/json

Responses
Table 381. http response codes
Code Message Datatype

200

successful operation

ResponseTaskObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.4. get_1

GET /v3/task/{source}/view

Get task info with the default view applied

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the task to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showCorrelated

add correlated object to the response (default: false)

-

false

showAttachments

add attachments to the response (default: false)

-

false

showTopic

add related topic to the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseTaskObjectViewInfo

Content Type

  • application/json

Responses
Table 382. http response codes
Code Message Datatype

200

successful operation

ResponseTaskObjectViewInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.5. get_2

GET /v3/task/{source}/view/{view}

Get task info with the default view applied

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the task to retrieve

X

null

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showCorrelated

add correlated object to the response (default: false)

-

false

showAttachments

add attachments to the response (default: false)

-

false

showTopic

add related topic to the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseTaskObjectViewInfo

Content Type

  • application/json

Responses
Table 383. http response codes
Code Message Datatype

200

successful operation

ResponseTaskObjectViewInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.6. incoming

GET /v3/task/incoming

List incoming user tasks

Description
Parameters
Query Parameters
Name Description Required Default Pattern

limit

limit the resolved elements (default: 20)

-

20

excludeTypes

list of excluded task type [String]

-

null

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showCorrelated

add correlated object to the response (default: false)

-

false

showAttachments

add attachments to the response (default: false)

-

false

showTopic

add related topic to the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

databaseId

filter the task list on a specified database

-

null

token

API token

X

null
Return Type

ResponseListObjectInfo

Content Type

  • application/json

Responses
Table 384. http response codes
Code Message Datatype

200

successful operation

ResponseListObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.7. incoming_3

GET /v3/task/incoming/view

List incoming user tasks

Description
Parameters
Query Parameters
Name Description Required Default Pattern

limit

limit the resolved elements (default: 20)

-

20

excludeTypes

list of excluded task type [String]

-

null

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showCorrelated

add correlated object to the response (default: false)

-

false

showAttachments

add attachments to the response (default: false)

-

false

showTopic

add related topic to the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

databaseId

filter the task list on a specified database

-

null

token

API token

X

null
Return Type

ResponseObjectViewList

Content Type

  • application/json

Responses
Table 385. http response codes
Code Message Datatype

200

successful operation

ResponseObjectViewList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.8. incoming_4

GET /v3/task/incoming/view/{view}

List incoming user tasks

Description
Parameters
Path Parameters
Name Description Required Default Pattern

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

limit

limit the resolved elements (default: 20)

-

20

excludeTypes

list of excluded task type [String]

-

null

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showCorrelated

add correlated object to the response (default: false)

-

false

showAttachments

add attachments to the response (default: false)

-

false

showTopic

add related topic to the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

databaseId

filter the task list on a specified database

-

null

token

API token

X

null
Return Type

ResponseObjectViewList

Content Type

  • application/json

Responses
Table 386. http response codes
Code Message Datatype

200

successful operation

ResponseObjectViewList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.9. outgoing

GET /v3/task/outgoing

List outgoing user tasks

Description
Parameters
Query Parameters
Name Description Required Default Pattern

limit

limit the resolved elements (default: 20)

-

20

excludeTypes

list of excluded task type [String]

-

null

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showCorrelated

add correlated object to the response (default: false)

-

false

showAttachments

add attachments to the response (default: false)

-

false

showTopic

add related topic to the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

databaseId

filter the task list on a specified database

-

null

token

API token

X

null
Return Type

ResponseListObjectInfo

Content Type

  • application/json

Responses
Table 387. http response codes
Code Message Datatype

200

successful operation

ResponseListObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.10. outgoing_5

GET /v3/task/outgoing/view

List outgoing user tasks

Description
Parameters
Query Parameters
Name Description Required Default Pattern

limit

limit the resolved elements (default: 20)

-

20

excludeTypes

list of excluded task type [String]

-

null

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showCorrelated

add correlated object to the response (default: false)

-

false

showAttachments

add attachments to the response (default: false)

-

false

showTopic

add related topic to the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

databaseId

filter the task list on a specified database

-

null

token

API token

X

null
Return Type

ResponseObjectViewList

Content Type

  • application/json

Responses
Table 388. http response codes
Code Message Datatype

200

successful operation

ResponseObjectViewList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.11. outgoing_6

GET /v3/task/outgoing/view/{view}

List outgoing user tasks

Description
Parameters
Path Parameters
Name Description Required Default Pattern

view

the view to apply

X

null
Query Parameters
Name Description Required Default Pattern

limit

limit the resolved elements (default: 20)

-

20

excludeTypes

list of excluded task type [String]

-

null

sortBy

property to use for sorting

-

null

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showPath

shows the file system path in the response (default: false)

-

false

showUri

shows the uri in the response (default: false)

-

false

widthUnit

specify the unit type (default: PIXEL)

-

PIXEL

viewPath

-

/

viewDatabaseId

specify the database id where to locate the column catalog configuration

-

null

showCorrelated

add correlated object to the response (default: false)

-

false

showAttachments

add attachments to the response (default: false)

-

false

showTopic

add related topic to the response (default: false)

-

false

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

databaseId

filter the task list on a specified database

-

null

token

API token

X

null
Return Type

ResponseObjectViewList

Content Type

  • application/json

Responses
Table 389. http response codes
Code Message Datatype

200

successful operation

ResponseObjectViewList

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.12. taskDetails

POST /v3/task

List task details

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectTaskRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTaskObjectInfoDetails

Content Type

  • application/json

Responses
Table 390. http response codes
Code Message Datatype

200

successful operation

ResponseTaskObjectInfoDetails

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.48.13. update

POST /v3/task/{source}/update

Update task info

Description
Parameters
Path Parameters
Name Description Required Default Pattern

source

the task to be updated

X

null
Body Parameter
Name Description Required Default Pattern

body

TaskUpdateRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseTaskUpdateResponse

Content Type

  • application/json

Responses
Table 391. http response codes
Code Message Datatype

200

successful operation

ResponseTaskUpdateResponse

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.49. User

1.49.1. createUser

POST /v3/user

Creates a user. If databaseId is specified, the user is created only in the specified database. Otherwise, the user is created on all configured and connected databases.

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

UserCreateRequest

X
Return Type

ResponseUserCreateResponse

Content Type

  • application/json

Responses
Table 392. http response codes
Code Message Datatype

200

successful operation

ResponseUserCreateResponse

403

Permission denied

<<>>

500

Generic error

<<>>
Samples

1.49.2. deleteSessionParam

DELETE /v3/user/sessionparams

Set user session params

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

[string]

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 393. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.49.3. deleteUser

DELETE /v3/user

Deletes a user from the specified database. If the database id is null, the user is deleted from the default database.

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

UserDeleteRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 394. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

403

Permission denied

<<>>

404

User not found

<<>>
Samples

1.49.4. deleteUserFromAllDatabases

DELETE /v3/user/alldatabases

Deletes a user from all configured and connected databases.

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

UserDeleteBaseRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListUserError

Content Type

  • application/json

Responses
Table 395. http response codes
Code Message Datatype

200

successful operation

ResponseListUserError

403

Permission denied

<<>>

404

User not found

<<>>
Samples

1.49.5. getAvatar

GET /v3/user/avatar

Return logged user avatar

Description
Parameters
Query Parameters
Name Description Required Default Pattern

maxSize

max object size in MB at which truncate the request

-

null

token

API token

X

null
Return Type

ResponseObjectStreamer

Content Type

  • application/octet-stream

Responses
Table 396. http response codes
Code Message Datatype

200

successful operation

ResponseObjectStreamer

401

Not authorized

<<>>

404

Avatar not found

<<>>
Samples

1.49.6. getAvatar_1

GET /v3/user/{name}/avatar

Return user avatar

Description
Parameters
Path Parameters
Name Description Required Default Pattern

name

X

null
Query Parameters
Name Description Required Default Pattern

maxSize

max object size in MB at which truncate the request

-

null

token

API token

X

null
Return Type

ResponseObjectStreamer

Content Type

  • application/octet-stream

Responses
Table 397. http response codes
Code Message Datatype

200

successful operation

ResponseObjectStreamer

401

Not authorized

<<>>

404

Avatar not found

<<>>
Samples

1.49.7. getConfiguration

POST /v3/user/configuration

Reads the content of every configuration files in the request list

Description

Returns the first file found searching following the order: user configuration folder, user groups configuration folder, system configuration folder

Parameters
Body Parameter
Name Description Required Default Pattern

body

UserConfigurationRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

-

Responses
Table 398. http response codes
Code Message Datatype

200

<pre>--Boundary_14_1261031547_1513241996471 X-Source: &quot;file1&quot; X-Part: content Content-Type: &quot;string&quot;</pre><pre>content of file1 --Boundary_14_1261031547_1513241996471 X-Source: &quot;file2&quot; X-Part: content Content-Type: &quot;string&quot;</pre><pre>content of file2 --Boundary_14_1261031547_1513241996471 X-Part: errors Content-Type: application/json</pre><pre>[ { file: &quot;string&quot;, message: &quot;string&quot; } ] --Boundary_14_1261031547_1513241996471--</pre>

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.49.8. getConfiguration_2

GET /v3/user/configuration/{file}

Reads user configuration file content

Description

Returns the first file found searching following the order: user configuration folder, user groups configuration folder, system configuration folder

Parameters
Path Parameters
Name Description Required Default Pattern

file

the configuration to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

databaseId

database id to use

-

null

raw

raw or resolved file in response (default: false)

-

false

showDtd

boolean value to choose whether to get inline dtd within an XML document (default: false)

-

false

showJson

xml configuration file will be converted in json format (default: false)

-

false

token

API token

X

null
Return Type

-

Responses
Table 399. http response codes
Code Message Datatype

200

Object content as stream

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.49.9. getExternalId

GET /v3/user/extid/{name}/{databaseId}

Gets user external id.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

name

X

null

databaseId

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseUserExternalId

Content Type

  • application/json

Responses
Table 400. http response codes
Code Message Datatype

200

successful operation

ResponseUserExternalId
Samples

1.49.10. getHierarchyConfiguration

GET /v3/user/configuration/{file}/hierarchy

Reads user configuration file hierarchy and returns content of all found files

Description

Searched position: user configuration folder, user groups configuration folder, system configuration folder

Parameters
Path Parameters
Name Description Required Default Pattern

file

the configuration to retrieve

X

null
Query Parameters
Name Description Required Default Pattern

databaseId

database id to use

-

null

raw

raw or resolved file in response (default: false)

-

false

showDtd

boolean value to choose whether to get inline dtd within an XML document (default: false)

-

false

showJson

xml configuration file will be converted in json format (default: false)

-

false

token

API token

X

null
Return Type

-

Responses
Table 401. http response codes
Code Message Datatype

200

<pre>--Boundary_14_1261031547_1513241996471 X-Source: &quot;file1&quot; X-Part: user Content-Type: &quot;string&quot;</pre><pre>content of file in user configuration folder --Boundary_14_1261031547_1513241996471 X-Source: &quot;file2&quot; X-Part: group Content-Type: &quot;string&quot;</pre><pre>content of file in group configuration folder --Boundary_14_1261031547_1513241996471 X-Source: &quot;source2&quot; X-Part: system Content-Type: &quot;string&quot;</pre><pre>content of file in system configuration folder --Boundary_14_1261031547_1513241996471 X-Part: errors Content-Type: application/json</pre><pre>[ { file: &quot;string&quot;, message: &quot;string&quot; } ] --Boundary_14_1261031547_1513241996471--</pre>

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.49.11. getInfo

GET /v3/user

Return logged user’s information

Description
Parameters
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showGroups

shows user's groups information in the response (default: false)

-

false

databaseId

the databaseId to use (default: the main databaseId)

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 402. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.49.12. getPrivileges

GET /v3/user/privileges

Return user’s privileges

Description
Parameters
Query Parameters
Name Description Required Default Pattern

applicationId

filter privileges by application id specified

-

null

token

API token

X

null
Return Type

ResponsePrivileges

Content Type

  • application/json

Responses
Table 403. http response codes
Code Message Datatype

200

successful operation

ResponsePrivileges

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.49.13. getSessionParam

GET /v3/user/sessionparams

Get user session params

Description
Parameters
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseSessionParam

Content Type

  • application/json

Responses
Table 404. http response codes
Code Message Datatype

200

successful operation

ResponseSessionParam

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.49.14. getUserInfo

GET /v3/user/{name}

Return specified user’s information

Description
Parameters
Path Parameters
Name Description Required Default Pattern

name

X

null
Query Parameters
Name Description Required Default Pattern

showAdditionalInfo

shows additional information in the response (default: false)

-

false

showSystemAttributes

shows the system attributes in the response (default: true)

-

true

showAttributes

shows the attributes in the response (default: true)

-

true

showUsageTickets

shows the usage tickets in the response (default: true)

-

true

showVirtualAttributes

shows the virtual attributes in the response (default: true)

-

true

showXml

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

-

false

useUnparsedXml

do not parse/serialize XML if 'showXml' is true (default: false)

-

false

showJson

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

-

true

showUniquenessString

shows Uniqueness string (default: false)

-

false

showGroups

shows user's groups information in the response (default: false)

-

false

databaseId

the databaseId to use (default: the main databaseId)

-

null

showWebType

shows the web type (default: false)

-

false

webProduct

the web product to use to search for web type

-

null

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 405. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.49.15. postAvatar

POST /v3/user/avatar

Uploads avatar picture

Description
Parameters
Form Parameter
Name Description Required Default Pattern

file

[file]

X

null
Query Parameters
Name Description Required Default Pattern

username

-

myself

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • /

Responses
Table 406. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>
Samples

1.49.16. postConfiguration

POST /v3/user/configuration/{filename}

Creates user configuration file content

Description
Parameters
Path Parameters
Name Description Required Default Pattern

filename

It contains the full (with extension) configuration file name to create

X

null
Form Parameter
Name Description Required Default Pattern

options

<pre>{ \\&quot;databaseId\\&quot;: \\&quot;string\\&quot;, \\&quot;options\\&quot;: { \\&quot;createMode\\&quot;: \\&quot;EXCEPTION (default), other value [REPLACE, AUTO_RENAME, NEW_VERSION]\\&quot; } }</pre> [ref]

X

null

content

the content to write [file]

-

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 407. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.49.17. putConfiguration

PUT /v3/user/configuration/{filename}

Updates user configuration file content

Description
Parameters
Path Parameters
Name Description Required Default Pattern

filename

It contains the full (with extension) configuration file name to create/update

X

null
Form Parameter
Name Description Required Default Pattern

options

<pre>{ \\&quot;databaseId\\&quot;: \\&quot;string\\&quot;, \\&quot;options\\&quot;: { \\&quot;createMode\\&quot;: \\&quot;EXCEPTION (default), other value [REPLACE, AUTO_RENAME, NEW_VERSION]\\&quot; \\&quot;forceCreate\\&quot;: \\&quot;boolean\\&quot; if true, the configuration file will be created if doesn't exists } }</pre> [ref]

X

null

content

the content to write [file]

-

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 408. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.49.18. putDisable

PUT /v3/user/{name}/disable

Disable user

Description

Can be used only by administrators

Parameters
Path Parameters
Name Description Required Default Pattern

name

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseBaseObjectInfo

Content Type

  • application/json

Responses
Table 409. http response codes
Code Message Datatype

200

successful operation

ResponseBaseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

User not found

<<>>
Samples

1.49.19. putEnable

PUT /v3/user/{name}/enable

Enable user

Description

Can be used only by administrators

Parameters
Path Parameters
Name Description Required Default Pattern

name

X

null
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseBaseObjectInfo

Content Type

  • application/json

Responses
Table 410. http response codes
Code Message Datatype

200

successful operation

ResponseBaseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

User not found

<<>>
Samples

1.49.20. putMetadata

PUT /v3/user/{name}/metadata

Updates user Metadata and System Attributes

Description
Parameters
Path Parameters
Name Description Required Default Pattern

name

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectMetadataRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 411. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>

404

User not found

<<>>
Samples

1.49.21. putMyselfMetadata

PUT /v3/user/metadata

Updates logged user Metadata and System Attributes

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectMetadataRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseObjectInfo

Content Type

  • application/json

Responses
Table 412. http response codes
Code Message Datatype

200

successful operation

ResponseObjectInfo

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.49.22. setExternalId

POST /v3/user/extid

Sets user external id. If database id is null, the user external id will be set in all configured and connected databases. Otherwise, the user external id will be set only in the specified database.

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

UserExternalIdRequest

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseUserExternalIdResponse

Content Type

  • application/json

Responses
Table 413. http response codes
Code Message Datatype

200

successful operation

ResponseUserExternalIdResponse
Samples

1.49.23. setSessionParam

POST /v3/user/sessionparams

Set user session params

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

SessionParam

X
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseVoid

Content Type

  • application/json

Responses
Table 414. http response codes
Code Message Datatype

200

successful operation

ResponseVoid

401

Not authorized

<<>>

403

Forbidden

<<>>

404

Object not found

<<>>
Samples

1.49.24. setUserInfo

POST /v3/user/{name}/profile

Set user information. If required, database id must be set at the body of the request. If database id is NOT set, the user attributes will be set in all configured and connected databases. Otherwise, the user attributes will be set only in the specified database.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

name

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectNode

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ObjectNode

Content Type

  • application/json

Responses
Table 415. http response codes
Code Message Datatype

200

successful operation

ObjectNode

401

Not authorized

<<>>

403

Forbidden

<<>>
Samples

1.49.25. updateUserByAdmin

PUT /v3/user/admin/{name}

Sets the security and/or default team for the user.

Description
Parameters
Path Parameters
Name Description Required Default Pattern

name

userName

X

null
Body Parameter
Name Description Required Default Pattern

body

ObjectUserInfoRequest

-
Return Type

ResponseUserUpdateResponse

Content Type

  • application/json

Responses
Table 416. http response codes
Code Message Datatype

200

successful operation

ResponseUserUpdateResponse

400

Invalid user security

<<>>

401

Not authorized

<<>>

403

Forbidden

<<>>

404

User not found Default team not found

<<>>
Samples

1.49.26. updateUserGroups

PUT /v3/user/{name}/groups

Adds/Removes an user to the list groups in input

Description
Parameters
Path Parameters
Name Description Required Default Pattern

name

X

null
Body Parameter
Name Description Required Default Pattern

body

UserGroupsUpdateRequest

X
Return Type

ResponseUserCreateResponse

Content Type

  • application/json

Responses
Table 417. http response codes
Code Message Datatype

200

successful operation

ResponseUserCreateResponse

403

Permission denied

<<>>

404

Object not found

<<>>

500

Generic error

<<>>
Samples

1.49.27. updateUserPassword

PUT /v3/user/password

Sets the password to the logged user.

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

ObjectUserChangePasswordRequest

-
Return Type

ResponseListUserError

Content Type

  • application/json

Responses
Table 418. http response codes
Code Message Datatype

200

successful operation

ResponseListUserError

401

Not authorized

<<>>

403

Forbidden

<<>>

404

User not found

<<>>
Samples

1.50. WorkflowSteps

1.50.1. listWorkflowSteps

POST /v3/workflow/steps

Gets the steps of a workflow allowed for a list of objects

Description
Parameters
Body Parameter
Name Description Required Default Pattern

body

WorkflowStepsRequest

-
Query Parameters
Name Description Required Default Pattern

token

API token

X

null
Return Type

ResponseListWorkflowStepListBean

Content Type

  • application/json

Responses
Table 419. http response codes
Code Message Datatype

200

successful operation

ResponseListWorkflowStepListBean

400

Invalid parameters

<<>>

401

Not authorized

<<>>
Samples

2. Models

2.1. AddDividerRequest

Field Name Required Type Description Format

name

String

the divider name.

color

String

the divider color in hexadecimal form (ff0000).

position

Integer

int32

2.2. AggregationConnectionInfo

Field Name Required Type Description Format

id

String

mainDatabaseId

String

mainConnectionId

String

databases

List of [string]

siblings

List of [string]

default

Boolean

2.3. AlertQueryCreateRequest

Field Name Required Type Description Format

query

X

String

query string to create

temporary

Boolean

specifies if the query string will be saved as temporary query, false as default

folder

X

Object

name

X

String

query name

description

String

query description

systemAttributes

X

Object

options

ObjectCreateQueryOptions

active

Boolean

specifies if the query will be activated, false as default

2.4. AliasIndexInfo

Field Name Required Type Description Format

name

String

indexes

List of IndexInfo

2.5. ApplyShapeRequest

Field Name Required Type Description Format

channel

X

Object

checkinAction

Boolean

true if the check in action should be executed, false otherwise

pglContentId

String

a PGL content id to be used for creating the story shape. By default the entire shape file is used

linkToPgl

Boolean

the created story should be linked to the shape PGL (true) or not (false, default)

modifyStoryContent

Boolean

true if the story content should be modified with the shape PGL (true) or not (false, default)

2.6. Attachment

Field Name Required Type Description Format

info

ObjectInfo

correlates

List of CorrelationObjectInfo

2.7. AttachmentInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

info

ObjectInfo

placeholder

String

2.8. BaseObjectInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

2.9. BinderFile

Field Name Required Type Description Format

id

String

content

String

name

String

type

String

icon

String

path

String

disabled

Boolean

selected

Boolean

alert

Boolean

2.10. BinderListResponse

Field Name Required Type Description Format

settings

BinderSettings

fileset

List of BinderFile

2.11. BinderSettings

Field Name Required Type Description Format

id

Object

issueDate

String

subfolder

String

workfolder

String

2.12. BundleInfo

Field Name Required Type Description Format

bundleInherit

String

bundleChild

Boolean

2.13. BundleObjectViewInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

path

String

uri

String

lastVersionModificationTime

Long

last content modification time

int64

lastVersionModifier

String

last user that modified the content

bundle

BundleInfo

childrenCount

Integer

int32

fields

List of ObjectViewField

columns

List of ObjectViewField

2.14. CacheInfo

Field Name Required Type Description Format

type

String

cache

List of [object]

timestamp

Long

int64

2.15. CacheInfoCommand

Field Name Required Type Description Format

type

String

cache

List of Command

timestamp

Long

int64

2.16. CacheInfoGroup

Field Name Required Type Description Format

type

String

cache

List of Group

timestamp

Long

int64

2.17. CacheInfoJob

Field Name Required Type Description Format

type

String

cache

List of Job

timestamp

Long

int64

2.18. CacheInfoObjectType

Field Name Required Type Description Format

type

String

cache

List of ObjectType

timestamp

Long

int64

2.19. CacheInfoSystemCacheItem

Field Name Required Type Description Format

type

String

cache

List of [object]

timestamp

Long

int64

2.20. CacheInfoUser

Field Name Required Type Description Format

type

String

cache

List of User

timestamp

Long

int64

2.21. CacheInfoWorkflow

Field Name Required Type Description Format

type

String

cache

List of Workflow

timestamp

Long

int64

2.22. Calendar

Field Name Required Type Description Format

id

String

name

String

icon

String

color

String

url

String

private

Boolean

2.23. ChannelCopyRequest

Field Name Required Type Description Format

channel

X

Object

inheritFrom

Object

actions

List of ContentItemAction

options

StoryCreateOptions

2.24. ChannelCopyResponse

Field Name Required Type Description Format

objectInfo

ObjectInfo

errors

List of Error

2.25. CheckpointRequest

Field Name Required Type Description Format

source

X

String

an object identifier (loid, uuid or path)

comment

String

2.26. CobaltFieldContent

Field Name Required Type Description Format

fileName

String

mimeType

String

updatedBy

CobaltFieldUser

2.27. CobaltFieldFiles

Field Name Required Type Description Format

content

CobaltFieldContent

updateTime

String

size

Integer

int32

data

String
Field Name Required Type Description Format

image

List of CobaltFieldImage

2.29. CobaltFieldImage

Field Name Required Type Description Format

targetId

String

metadata

CobaltFieldMetadata

key

Long

int64

maxItems

Integer

int32
Field Name Required Type Description Format

hyperlink

CobaltFieldHyperlink

system

CobaltFieldSystem

2.31. CobaltFieldMetadata

Field Name Required Type Description Format

metadataType

String

baseType

String

type

String

2.32. CobaltFieldSys

Field Name Required Type Description Format

kind

String

baseType

String

type

String

creationTime

String

createdBy

CobaltFieldUser

updateTime

String

updatedBy

CobaltFieldUser

2.33. CobaltFieldSystem

Field Name Required Type Description Format

mainPicture

CobaltFieldImage

key

Long

int64

maxItems

Integer

int32

2.34. CobaltFieldUser

Field Name Required Type Description Format

userId

String

userName

String

2.35. CobaltResponse

Field Name Required Type Description Format

dataType

String

id

String

version

String

timestamp

String

foreingId

String

title

String

description

String

summary

String

authors

List of [string]

sys

CobaltFieldSys

attributes

Map of [string]

files

CobaltFieldFiles

links

CobaltFieldLinks

contentLength

Integer

int32

lastModified

Integer

int32

etag

String

picture

String

parent

String

cobaltError

Error

2.36. CollageConfig

Field Name Required Type Description Format

templates

List of CollageTemplate

2.37. CollageTemplate

Field Name Required Type Description Format

name

String

width

String

height

String

boxWidth

String

boxHeight

String

backgroundColor

String

fileType

String

colorType

String

resolution

String

ptUnit

String

images

List of CollageTemplateImage

2.38. CollageTemplateImage

Field Name Required Type Description Format

name

String

width

String

height

String

fileType

String

x

String

y

String

2.39. Color

Field Name Required Type Description Format

name

String

attributes

Map of [string]

2.40. ColumnCatalogsConfig

Field Name Required Type Description Format

type

String

Enum: USER, GROUP, DEFAULT, APPLICATION, ALL,

path

String

content

String

2.41. ColumnRule

Field Name Required Type Description Format

name

String

paddingBottom

String

paddingTop

String

2.42. Command

Field Name Required Type Description Format

id

Object

databaseId

String

endPoint

String

arguments

String

workingDirectory

String

timeout

Integer

int32

name

String

2.43. ConfigurationMultipartStreamer

Field Name Required Type Description Format

boundary

String

2.44. ConnectionData

Field Name Required Type Description Format

connectionId

String

databaseId

Object

version

String

main

Boolean

primary

Boolean

connected

Boolean

name

String

description

String

configLoaded

Boolean

baseUri

String

properties

Map of [string]

lastConnectionAttempt

Date

date-time

2.45. ConnectionsInfo

Field Name Required Type Description Format

aggregations

List of AggregationConnectionInfo

databases

List of DatabaseConnectionInfo

2.46. ContainerObjectInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

path

String

uri

String

lastVersionModificationTime

Long

last content modification time

int64

lastVersionModifier

String

last user that modified the content

virtualId

String

contentError

Boolean

2.47. ContentItemAction

Field Name Required Type Description Format

name

String

id

String

action

String

Enum: COPY, INHERIT, EXCLUDE, MASTER,

2.48. ContentItemBean

Field Name Required Type Description Format

name

String

type

String

xp

String

xpBlock

String

cssSelector

String

content

String

resLimits

String

xmlOrder

String

ext

String

cssSelectors

List of ContentItemCssSelectorBean

limits

List of ContentItemLimitsBean

sources

List of ContentItemSourceBean

items

List of ContentItemBean

2.49. ContentItemCssSelectorBean

Field Name Required Type Description Format

type

String

value

String

2.50. ContentItemLimitsBean

Field Name Required Type Description Format

channel

String

charLimits

String

2.51. ContentItemSourceBean

Field Name Required Type Description Format

xp

String

type

String

element

String

2.52. ContentRange

Field Name Required Type Description Format

start

Integer

int32

end

Integer

int32

size

Integer

int32

2.53. CorrelatedBean

Field Name Required Type Description Format

sourceLinkName

X

String

source link name

targetLinkName

X

String

target link name

targetObject

X

Object

2.54. Correlation

Field Name Required Type Description Format

objectLoid

String

objectNsame

String

2.55. CorrelationObjectInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

path

String

uri

String

lastVersionModificationTime

Long

last content modification time

int64

lastVersionModifier

String

last user that modified the content

bundle

BundleInfo

childrenCount

Integer

int32

correlationName

String

correlationType

String

correlationDescription

String

linkName

String

reverseLinkName

String

2.56. CorrelationRelocationDragAndDropRequest

Field Name Required Type Description Format

databaseId

Object

team

String

The team parameter is used to set/get user team value when a Send to Production or a Drag and Drop operation is called.

options

DefaultConflictResolutionOptions

corrSourceLinkName

String

The link name from source object as a string.

corrTargetLinkName

String

The link that will be used on target object as a string.

corrComment

String

The comment associated with the correlated link.

2.57. CorrelationsRelocationDragAndDropRequest

Field Name Required Type Description Format

databaseId

Object

team

String

The team parameter is used to set/get user team value when a Send to Production or a Drag and Drop operation is called.

options

DefaultConflictResolutionOptions

corrSourceLinkName

String

The link name from source object as a string.

corrTargetLinkName

String

The link that will be used on target object as a string.

corrComment

String

The comment associated with the correlated link.

sources

X

List of [string]

list of sources (loid, uuid or path)

2.58. CreateTopicFromRequest

Field Name Required Type Description Format

channel

Object

issueDate

String

team

String

application

X

String

systemAttributes

Object

attributes

Object

status

String

format is Workflow/WorkFlowStep

statusComment

String

uniquenessString

String

name

X

String

databaseId

Object

workFolder

String

a workfolder

folder

String

a folder identifier (path, uuid or loid)

timestamp

Long

specify the timestamp to be used in usage ticket, if not specified current time is used

int64

uuid

String

the uuid to assign to the new object

options

ObjectCreateOptions

description

String

the topic summary

template

String

a template source identifier (loid, uuid or path)

topicCreateOptions

TopicCreateOptions

2.59. DatabaseConnectionInfo

Field Name Required Type Description Format

databaseId

String

name

String

id

String

description

String

reachable

Boolean

lastConnectionAttempt

Date

date-time

defaultRepository

String

repositories

List of [string]

default

Boolean

2.60. DatabaseIndexes

Field Name Required Type Description Format

databaseId

Object

indexes

List of IndexInfo

aliases

List of AliasIndexInfo

2.61. DefaultConflictResolutionOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

resolutionMode

String

specify the conflict resolution mode (default: INCREMENTAL_RENAMING)

Enum: INCREMENTAL_RENAMING, EXCEPTION, REPLACE, NEW_VERSION,

maxAttempts

Integer

maximum number of attempts to perform for INCREMENTAL_RENAMING (default: 50)

int32

webType

WebTypeOptions

2.62. DividerObjectInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

path

String

uri

String

lastVersionModificationTime

Long

last content modification time

int64

lastVersionModifier

String

last user that modified the content

virtualId

String

contentError

Boolean

font

Font

color

String

2.63. Drawer

Field Name Required Type Description Format

info

FileSystemObjectInfo

items

List of Shortcut

errors

List of Error

2.64. DrawerShowOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

showItems

Boolean

shows the items in the drawer (default: false)

webType

WebTypeOptions

2.65. DrawersRelocationDragAndDropRequest

Field Name Required Type Description Format

databaseId

Object

team

String

The team parameter is used to set/get user team value when a Send to Production or a Drag and Drop operation is called.

options

DefaultConflictResolutionOptions

2.66. DropCap

Field Name Required Type Description Format

name

String

cssStyleString

String

cssStyle

Map of [string]

2.67. DwpCorrelationRelocationDragAndDropRequest

Field Name Required Type Description Format

databaseId

Object

options

DefaultConflictResolutionOptions

2.68. DwpTemplateCreateRequest

Field Name Required Type Description Format

folder

X

String

a folder identifier (loid, uuid or path)

name

X

String

workFolder

X

String

channel

X

Object

pageTemplateName

X

String

options

FileSystemShowOptions

2.69. ElementHighLight

Field Name Required Type Description Format

name

String

attributes

Map of [string]

2.70. EmptyTopicCreateRequest

Field Name Required Type Description Format

channel

Object

issueDate

String

team

String

application

X

String

systemAttributes

Object

attributes

Object

status

String

format is Workflow/WorkFlowStep

statusComment

String

uniquenessString

String

name

X

String

databaseId

Object

workFolder

String

a workfolder

folder

String

a folder identifier (path, uuid or loid)

timestamp

Long

specify the timestamp to be used in usage ticket, if not specified current time is used

int64

uuid

String

the uuid to assign to the new object

options

ObjectCreateOptions

description

String

the topic summary

2.71. EmptyTopicPlanCreateRequest

Field Name Required Type Description Format

channel

Object

issueDate

String

team

String

application

X

String

systemAttributes

Object

attributes

Object

status

String

format is Workflow/WorkFlowStep

statusComment

String

uniquenessString

String

name

X

String

databaseId

Object

workFolder

String

a workfolder

folder

String

a folder identifier (path, uuid or loid)

timestamp

Long

specify the timestamp to be used in usage ticket, if not specified current time is used

int64

uuid

String

the uuid to assign to the new object

options

ObjectCreateOptions

type

String

topicPlanCreateOptions

TopicCreateOptions

2.72. Error

Field Name Required Type Description Format

source

String

error

String

Enum: AUTHENTICATION, AGGREGATION_AUTHENTICATION, CONNECTION, ERROR, INVALID_DATA, UNSUPPORTED_OPERATION, PERMISSION_DENIED, REPOSITORY, UPDATE_NOT_ALLOWED, MISSING_PRIVILEGES, OBJECT_NOT_FOUND, OBJECT_TYPE_INVALID, OBJECT_LOCKED, OBJECT_LOCKED_BY_ME, OBJECT_NOT_LOCKED, OBJECT_ALREADY_EXISTS, OBJECT_ALREADY_LINKED, OBJECT_MALFORMED, OBJECT_NOT_LINKED, OBJECT_NOT_CHECKED_OUT, PASSWORD_NOT_MATCH, PASSWORD_OLD_INCORRECT, PASSWORD_POLICY_NOT_MATCH, LOGON_NOT_ALLOWED, PAGE_LINK_NOT_FOUND, DTD_LOADING, INVALID_WORKFOLDER, MAX_REQUESTS_EXCEEDED, MAX_SIZE_EXCEEDED, UNKNOWN_ERROR, OBJECT_CANNOT_TRANSFORM, CONTENT_CHANGED, EXTENSION_ALREADY_OWNED, INVALID_ATTRIBUTES, INVALID_LINK, INVALID_NAME, INVALID_PASSWORD, INVALID_PRINCIPAL, INVALID_STATUS, INVALID_STATUS_DATA, INVALID_STATUS_NOT_COMPLIANT, INVALID_SYSTEM_ATTRIBUTES, INVALID_TICKET_DATA, INVALID_TYPE, INVALID_URI, LICENSE_ERROR, MAILBOX_ERROR, OLD_ATTRIBUTES, TASK_CONSTRAINT_ERROR, TICKET_NOT_FOUND, TYPE_NOT_FOUND, CONSTRAINT_ERROR, REQUEST_FILENAME, COBALT_ERROR, DEFAULT_TEAM_NO_AVAILABLE, DEFAULT_TEAM_DOES_NOT_EXIST, SIMULTANEOUS_REQUEST, EXTERNAL_PROXY_TIMEOUT, USER_SECURITY_NOT_FOUND,

message

String

2.73. ErrorDatabaseId

Field Name Required Type Description Format

databaseId

Object

message

String

2.74. ErrorList

Field Name Required Type Description Format

errors

List of Error

2.75. FileObjectInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

path

String

uri

String

lastVersionModificationTime

Long

last content modification time

int64

lastVersionModifier

String

last user that modified the content

2.76. FileSystemObjectInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

path

String

uri

String

2.77. FileSystemObjectListRequest

Field Name Required Type Description Format

sources

X

List of [string]

list of sources (loid, uuid or path)

2.78. FileSystemShowOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

createMode

String

specify the creation mode (default: EXCEPTION)

Enum: EXCEPTION, AUTO_RENAME, REPLACE, NEW_VERSION,

timeSuffix

Boolean

specify if a time suffix should be added to the object name (default: false)

webType

WebTypeOptions

2.79. FixedFolderViewListParams

Field Name Required Type Description Format

limit

Integer

int32

filter

X

String

excludeFolders

Boolean

showHidden

Boolean

sortBy

String

viewPath

String

sortViewBy

List of QuerySort

list of fields used to order result based on the applyed view

databaseId

Object

2.80. FixedFolderViewListRequest

Field Name Required Type Description Format

params

FixedFolderViewListParams

options

FolderViewOptions

2.81. FolderCreateRequest

Field Name Required Type Description Format

parent

Object

name

X

String

the name of the folder to be created. It may be a subpath of parent or a full path if parent is null.

temporary

Boolean

set the folder to be temporary (default: false)

skipErrorIfAlreadyExist

Boolean

skip errors in response if the folder already exists (default: false)

options

FolderViewOptions

2.82. FolderInfoList

Field Name Required Type Description Format

folder

ObjectInfo

parent

ObjectInfo

items

List of ObjectInfo

errors

List of Error

2.83. FolderViewInfoList

Field Name Required Type Description Format

folder

ObjectInfo

parent

ObjectInfo

items

List of [object]

errors

List of Error

selectedView

ObjectView

views

List of ObjectView

columns

List of ObjectListHeaderInfoBean

fields

List of ObjectListHeaderInfoBean

2.84. FolderViewListParams

Field Name Required Type Description Format

limit

Integer

int32

filter

X

String

excludeFolders

Boolean

showHidden

Boolean

sortBy

String

viewPath

String

sortViewBy

List of QuerySort

list of fields used to order result based on the applyed view

2.85. FolderViewListRequest

Field Name Required Type Description Format

params

FolderViewListParams

options

FolderViewOptions

2.86. FolderViewOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: true)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showParent

Boolean

shows the parent info in the response (default: true)

propagateShowOptionsToFolderAndParent

Boolean

propagates the bundle list options to the 'folder' and 'parent' sections also (default: false)

widthUnit

String

specify the unit type (default: PIXEL)

Enum: PIXEL, PERCENT,

viewPath

String

webType

WebTypeOptions

2.87. Font

Field Name Required Type Description Format

bold

Boolean

color

String

faceName

String

italic

Boolean

lineThrough

Boolean

size

Integer

int32

underline

Boolean

2.88. FootNotes

Field Name Required Type Description Format

maxHeight

String

notes

List of Note

2.89. Format

Field Name Required Type Description Format

name

String

type

String

cssFile

String

cssSwing

String

templateFile

String

templateContent

String

template

String

hrefTagWizard

String

description

String

favourite

Boolean

justification

String

copyfit

String

height

String

marginBottomMin

String

marginBottomMax

String

flex

String

autofitStep

String

runaround

String

enlarge

String

textWrap

String

storyName

String

compensate

String

columnCount

String

borderPosition

String

styleSheets

List of StyleSheet

templates

List of Template

markups

List of Markup

columnRule

ColumnRule

default

Boolean

2.90. FormatInfo

Field Name Required Type Description Format

type

String

size

Long

int64

attributes

String

uri

String

2.91. FormatItem

Field Name Required Type Description Format

id

Object

formatInfo

FormatInfo

2.92. FormatType

Field Name Required Type Description Format

name

String

aliases

List of [string]

mime

String

description

String

extensions

List of [string]

2.93. FullObjectRequest

Field Name Required Type Description Format

source

Object

version

Integer

the unique id of the version to be read (default: -1 for current version)

int32

format

String

the format (name or alias) to be read (default: the main format)

readContent

Boolean

reads the object binary content (default: true)

readShapeRole

Boolean

reads the Xsmile::Shape (PGX) role (default: false)

minimalSourceObject

Boolean

returns a minimal object info for the starting object (default: false).

options

FileSystemShowOptions

2.94. GetCrossReferenceRequest

Field Name Required Type Description Format

xpath

X

String

the xpath where to search candidate cross reference

sources

X

List of [string]

list of sources (loid, uuid or path)

2.95. GetCrossReferenceResponse

Field Name Required Type Description Format

items

List of GetCrossReferenceResponseItems

errors

List of Error

2.96. GetCrossReferenceResponseItems

Field Name Required Type Description Format

content

String

index

Integer

int32

pstate

PersistentState

path

String

2.97. Group

Field Name Required Type Description Format

id

Object

loid

String

databaseId

String

name

String

description

String

ucount

Integer

int32

owner

String

creator

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

systemAttributesXml

String

attributesXml

String

virtualAttributesXml

String

configFolder

String

type

String

categories

List of [string]

users

List of [string]

2.98. GroupCreateRequest

Field Name Required Type Description Format

databaseId

Object

name

String

categories

List of [string]

users

List of [string]

permissions

List of Permission

description

String

showUsers

Boolean

2.99. GroupUpdateRequest

Field Name Required Type Description Format

databaseId

Object

name

String

addedUsers

List of [string]

removedUsers

List of [string]

permissions

List of Permission

description

String

showUsers

Boolean

2.100. IndexInfo

Field Name Required Type Description Format

indexName

String

backendIndex

String

altBackendIndex

String

indexRootPath

String

2.101. InheritanceOptions

Field Name Required Type Description Format

allowInheritanceFromParent

Boolean

flag to allow inheritance from parent

allowPropagateToChildren

Boolean

flag to allow propagate to children

propagateNow

Boolean

propagate to children(action)

resetPermissionInheritanceFlags

Boolean

if true reset all flags inheritance

2.102. InsertTemplate

Field Name Required Type Description Format

id

String

name

String

2.103. ItemHighLight

Field Name Required Type Description Format

color

String

name

String

xstyleAttributes

Map of [string]

element

ElementHighLight

2.104. Job

Field Name Required Type Description Format

id

Object

databaseId

String

command

String

arguments

String

timeout

Integer

int32

startDate

Integer

int32

otherDates

List of [integer]

int32

endDate

Integer

int32

repetitionTime

Integer

int32

priority

Integer

int32

runAs

String

userPassword

String

queue

String

destroy

Boolean

nextExecution

Integer

int32

lastExecution

Integer

int32

lastMessage

String

lastResult

Integer

int32

name

String

2.105. LinkBeanRequest

Field Name Required Type Description Format

sourceRoleType

X

String

sourceRoleName

X

String

targetRoleType

X

String

targetRoleName

X

String

2.106. LinkInfo

Field Name Required Type Description Format

sourceRoleType

String

sourceRoleName

String

targetRoleType

String

targetRoleName

String

sourceFormatContent

Object

targetFormatContent

Object

sourceFormatContentXml

String

targetFormatContentXml

String

2.107. LinkResponse

Field Name Required Type Description Format

role

LinkInfo

linkedObject

LinkedObjectInfo

2.108. LinkToPageRequest

Field Name Required Type Description Format

linkName

String

the link name

checkinAction

Boolean

true to perform a check in action, false otherwie (defalut: false)

2.109. LinkedObjectInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

path

String

uri

String

lastVersionModificationTime

Long

last content modification time

int64

lastVersionModifier

String

last user that modified the content

bundle

BundleInfo

childrenCount

Integer

int32

items

List of LinkedObjectInfo

2.110. LinksResponse

Field Name Required Type Description Format

role

LinkInfo

linkedObject

ObjectInfo

2.111. ListItems

Field Name Required Type Description Format

name

String

favorite

Boolean

cssStyleAtributes

Map of [string]

bullet

Map of [string]

default

Boolean

listItems

List of ListItems

2.112. LiveBlogCreateTemplateRequest

Field Name Required Type Description Format

channel

Object

issueDate

String

team

String

application

X

String

systemAttributes

Object

attributes

Object

status

String

format is Workflow/WorkFlowStep

statusComment

String

uniquenessString

String

name

X

String

databaseId

Object

workFolder

String

a workfolder

folder

String

a folder identifier (path, uuid or loid)

timestamp

Long

specify the timestamp to be used in usage ticket, if not specified current time is used

int64

uuid

String

the uuid to assign to the new object

options

ObjectCreateOptions

subject

String

the liveblog subject

moderated

Boolean

true if the liveblog is moderated, false if not (default: false)

objectCreateStoryFromOptions

ObjectCreateFromTemplateOptions

2.113. LiveBlogPostListResponse

Field Name Required Type Description Format

items

List of CobaltResponse

2.114. LiveBlogSearchRequest

Field Name Required Type Description Format

limit

Integer

number of post to retrieve (default: 20)

int32

type

List of [string]

the filter to apply to property type

status

List of [string]

the filter to apply to property status

Enum:

subject

List of [string]

the filter to apply to property subject

filter

Map of [string]

the filter to apply to metadata

sources

List of [object]

the sources on which apply the filter

2.115. LoginCopyRequest

Field Name Required Type Description Format

token

X

String

applicationId

X

String

deviceId

String

2.116. LoginInfo

Field Name Required Type Description Format

token

Token

username

String

connectionId

String

userInfo

ObjectInfo

aggregation

Boolean

applicationId

String

connections

List of ConnectionData

sessionParam

SessionParam

privileges

Privileges

name

String

2.117. LoginOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

loadConfig

Boolean

load and resolve user configuration (default: true)

showUserInfo

Boolean

show user info (default: false)

showGroups

Boolean

if showUserInfo is set to true, shows also user's groups information in the response (default: true)

showPrivileges

Boolean

show user privileges (default: false)

databaseId

Object

showConfiguredConnections

Boolean

if set to true, shows also the list of all the configured databases and aggregations

webType

WebTypeOptions

2.118. LoginRequest

Field Name Required Type Description Format

applicationId

X

String

the applicationId

connectionId

X

String

the connectionId to connect to

password

X

String

deviceId

String

catalogConfigName

String

captchaValue

String

the user captcha response (validated only if captha check is configured)

options

LoginOptions

username

X

String

position

PositionData

2.119. LoginResponse

Field Name Required Type Description Format

token

Token

username

String

connectionId

String

userInfo

ObjectInfo

aggregation

Boolean

applicationId

String

connections

List of ConnectionData

sessionParam

SessionParam

privileges

Privileges

configuredConnections

ConnectionsInfo

name

String

2.120. MailListRequest

Field Name Required Type Description Format

sources

X

List of [string]

list of sources (loid, uuid or path)

2.121. MailMessageRequest

Field Name Required Type Description Format

recipients

X

List of [string]

mail recipients

attachments

List of [object]

mail attachments

priority

Integer

mail priority(0=LOW, 1=NORMAL, 2=HIGHT (default = 1)

int32

subject

X

String

mail subject

body

X

String

mail body

2.122. Markup

Field Name Required Type Description Format

name

String

hrefTagWizard

String

styleSheets

List of StyleSheet

2.123. MarkupBean

Field Name Required Type Description Format

name

String

hrefTagWizard

String

styleSheets

List of [string]

2.124. MetadataTemplateStreamer

Field Name Required Type Description Format

boundary

String

2.125. MoveConflictResolutionOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

resolutionMode

String

conflict resolution mode (EXCEPTION, AUTO_RENAME, REPLACE, default: EXCEPTION)

Enum: EXCEPTION, AUTO_RENAME, REPLACE,

maxAttempts

Integer

maximum number of attempts to perform for AUTO_RENAME (default: 50)

int32

webType

WebTypeOptions

2.126. MultipleLinkBeanRequest

Field Name Required Type Description Format

sourceRoleType

X

String

sourceRoleName

X

String

targetRoleType

X

String

targetRoleName

X

String

target

X

Object

2.127. Note

Field Name Required Type Description Format

noteName

String

xstyle

Map of [string]

sstyle

Map of [string]

xstyleString

String

sstyleString

String

2.128. ObjectAccessMaskRequest

Field Name Required Type Description Format

options

ShowOptions

sources

X

List of [string]

list of sources (loid, uuid or path)

user

List of [string]

username

2.129. ObjectActionResponse

Field Name Required Type Description Format

id

String

action

String

message

String

redirect

Boolean

2.130. ObjectAttributesMultipleBulkBean

Field Name Required Type Description Format

source

X

Object

attributes

Object

merge

Boolean

if set to false metadata are overwritten (default: true)

2.131. ObjectAttributesMultipleBulkRequest

Field Name Required Type Description Format

items

List of ObjectAttributesMultipleBulkBean

2.132. ObjectAttributesSingleBulkRequest

Field Name Required Type Description Format

sources

X

List of [string]

list of sources (loid, uuid or path)

attributes

Object

merge

Boolean

if set to false metadata are overwritten (default: true)

2.133. ObjectBinaryContentListRequest

Field Name Required Type Description Format

sources

X

List of ReadBinaryBean

options

ObjectContentListOptions

2.134. ObjectBinderRequest

Field Name Required Type Description Format

databaseId

Object

workFolder

String

workFolder

product

String

product

edition

String

edition

channel

Object

team

String

team

issueDate

String

issue date

insert

String

insert

supportedTypes

X

List of [string]

list of supportedTypes

2.135. ObjectCollaboratorsRequest

Field Name Required Type Description Format

collaborators

X

List of [string]

a list of principal

2.136. ObjectContentListOptions

Field Name Required Type Description Format

maxSize

Float

max object size in MB at which truncate the request

float

2.137. ObjectContentListRequest

Field Name Required Type Description Format

sources

X

List of ReadBean

options

ObjectContentListOptions

2.138. ObjectCopyRequest

Field Name Required Type Description Format

folder

X

String

a folder identifier (path, uuid or loid)

name

String

the target object name (default: source name)

cloneAttributes

Boolean

clone source attributes (default: false)

cloneOwnerTeam

Boolean

clone source owner team (default: false)

clonePermissions

Boolean

clone source object permissions (default: false)

cloneShapeRole

Boolean

clone source shape role (default: false)

cloneStatus

Boolean

clone source status, but only if status field is null (default: false)

addToStoryFamily

Boolean

add target object to source story family (default: false)

renameChildren

Boolean

rename children inside a compound story (default: true)

status

String

the status to be set non target object (default: see cloneStatus field)

options

DefaultConflictResolutionOptions

2.139. ObjectCorrelatedBulkResponse

Field Name Required Type Description Format

items

List of ObjectCorrelatedResponse

errors

List of Error

2.140. ObjectCorrelatedListRequest

Field Name Required Type Description Format

options

ObjectViewOptions

sources

X

List of [string]

list of sources (loid, uuid or path)

inlineErrors

Boolean

returns an empty OBjectInfo in case of error, instead of a separate error item (default: false)

linkName

String

the link name to find

2.141. ObjectCorrelatedResponse

Field Name Required Type Description Format

info

ObjectInfo

correlated

List of CorrelationObjectInfo

2.142. ObjectCorrelatedViewResponse

Field Name Required Type Description Format

info

ObjectInfo

correlated

ObjectViewList

2.143. ObjectCorrelatingBulkResponse

Field Name Required Type Description Format

items

List of ObjectCorrelatingResponse

errors

List of Error

2.144. ObjectCorrelatingResponse

Field Name Required Type Description Format

info

ObjectInfo

correlating

List of CorrelationObjectInfo

2.145. ObjectCorrelatingViewResponse

Field Name Required Type Description Format

info

ObjectInfo

correlating

ObjectViewList

2.146. ObjectCorrelationResponse

Field Name Required Type Description Format

info

ObjectInfo

correlated

List of CorrelationObjectInfo

correlating

List of CorrelationObjectInfo

2.147. ObjectCreateCorrelationOptions

Field Name Required Type Description Format

sourceLinkName

String

targetLinkName

String

comment

String

targetSource

X

Object

2.148. ObjectCreateCorrelationsOptions

Field Name Required Type Description Format

sourceLinkName

String

targetLinkName

String

comment

String

targetObjects

X

List of [object]

2.149. ObjectCreateFromTemplateOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

checkIn

Boolean

specify if check-in should be invoked instead of performing a check_in action (default: true)

keepCheckedOut

Boolean

specify the value of keepCheckedOut parameter during check-in operation (default: false)

unlock

Boolean

if the option checkIn is set to false, this options dictates if the object is unlocked at the end of the operation (default: false)

newVersion

Boolean

if the option checkIn is set to true, specify the value of newVersion parameter (default: false)

createMode

String

specify the creation mode (default: EXCEPTION)

Enum: EXCEPTION, AUTO_RENAME, REPLACE, NEW_VERSION,

useDefaultProduct

Boolean

specify if default product should be used (default: true)

issueDateDefaultStrategy

String

specify how the IssueDate should be calculated: CALENDAR get the issue date from the default calendar, STANDING removes the issue date, NONE does nothing (default: NONE)

Enum: CALENDAR, STANDING, NONE,

timeSuffix

Boolean

specify if a time suffix should be added to the object name (default: false)

addContentItemsId

Boolean

add id in content item if it is not present (default: false)

mergeSystemAttributes

Boolean

specify if sytem attributes should be merged with template ones (default: true)

mergeAttributes

Boolean

specify if attributes should be merged with template ones (default: true)

webType

WebTypeOptions

2.150. ObjectCreateFromUrlRequest

Field Name Required Type Description Format

channel

Object

issueDate

String

team

String

application

X

String

systemAttributes

Object

attributes

Object

status

String

format is Workflow/WorkFlowStep

statusComment

String

uniquenessString

String

name

X

String

databaseId

Object

workFolder

String

a workfolder

folder

String

a folder identifier (path, uuid or loid)

timestamp

Long

specify the timestamp to be used in usage ticket, if not specified current time is used

int64

uuid

String

the uuid to assign to the new object

options

ObjectCreateOptions

type

String

url

X

String

url

2.151. ObjectCreateOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

checkIn

Boolean

specify if check-in should be invoked instead of performing a check_in action (default: true)

keepCheckedOut

Boolean

specify the value of keepCheckedOut parameter during check-in operation (default: false)

unlock

Boolean

if the option checkIn is set to false, this options dictates if the object is unlocked at the end of the operation (default: false)

newVersion

Boolean

if the option checkIn is set to true, specify the value of newVersion parameter (default: false)

createMode

String

specify the creation mode (default: EXCEPTION)

Enum: EXCEPTION, AUTO_RENAME, REPLACE, NEW_VERSION,

useDefaultProduct

Boolean

specify if default product should be used (default: true)

issueDateDefaultStrategy

String

specify how the IssueDate should be calculated: CALENDAR get the issue date from the default calendar, STANDING removes the issue date, NONE does nothing (default: NONE)

Enum: CALENDAR, STANDING, NONE,

timeSuffix

Boolean

specify if a time suffix should be added to the object name (default: false)

addContentItemsId

Boolean

add id in content item if it is not present (default: false)

webType

WebTypeOptions

2.152. ObjectCreateQueryOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

createMode

String

specify the creation mode (default: EXCEPTION)

Enum: EXCEPTION, AUTO_RENAME, REPLACE,

webType

WebTypeOptions

2.153. ObjectCreateStoryFromOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

checkIn

Boolean

specify if check-in should be invoked instead of performing a check_in action (default: true)

keepCheckedOut

Boolean

specify the value of keepCheckedOut parameter during check-in operation (default: false)

unlock

Boolean

if the option checkIn is set to false, this options dictates if the object is unlocked at the end of the operation (default: false)

newVersion

Boolean

if the option checkIn is set to true, specify the value of newVersion parameter (default: false)

createMode

String

specify the creation mode (default: EXCEPTION)

Enum: EXCEPTION, AUTO_RENAME, REPLACE, NEW_VERSION,

useDefaultProduct

Boolean

specify if default product should be used (default: true)

issueDateDefaultStrategy

String

specify how the IssueDate should be calculated: CALENDAR get the issue date from the default calendar, STANDING removes the issue date, NONE does nothing (default: NONE)

Enum: CALENDAR, STANDING, NONE,

timeSuffix

Boolean

specify if a time suffix should be added to the object name (default: false)

addContentItemsId

Boolean

add id in content item if it is not present (default: false)

mergeSystemAttributes

Boolean

specify if sytem attributes should be merged with template ones (default: true)

mergeAttributes

Boolean

specify if attributes should be merged with template ones (default: true)

processSmartChars

Boolean

process autoCorrect smartChars from XsmileKbd.cfg file (true, default) or not (false)

webType

WebTypeOptions

2.154. ObjectCreateStoryFromRequest

Field Name Required Type Description Format

channel

Object

issueDate

String

team

String

application

X

String

systemAttributes

Object

attributes

Object

status

String

format is Workflow/WorkFlowStep

statusComment

String

uniquenessString

String

name

X

String

databaseId

Object

workFolder

String

a workfolder

folder

String

a folder identifier (path, uuid or loid)

timestamp

Long

specify the timestamp to be used in usage ticket, if not specified current time is used

int64

uuid

String

the uuid to assign to the new object

options

ObjectCreateOptions

startSubstitutionFrom

String

an xpath query to indicate where to start the substitution (default: //doc/story)

template

String

a template source identifier (loid, uuid or path)

type

String

objectCreateStoryFromOptions

ObjectCreateStoryFromOptions

2.155. ObjectCreateTemplateRequest

Field Name Required Type Description Format

channel

Object

issueDate

String

team

String

application

X

String

systemAttributes

Object

attributes

Object

status

String

format is Workflow/WorkFlowStep

statusComment

String

uniquenessString

String

name

X

String

databaseId

Object

workFolder

String

a workfolder

folder

String

a folder identifier (path, uuid or loid)

timestamp

Long

specify the timestamp to be used in usage ticket, if not specified current time is used

int64

uuid

String

the uuid to assign to the new object

options

ObjectCreateOptions

type

String

the object type

objectCreateStoryFromOptions

ObjectCreateFromTemplateOptions

2.156. ObjectDrawerAddItemRequest

Field Name Required Type Description Format

position

Integer

indicates the position where add the item. if position is null or 0, the item is added in first position if position is greater than the cardinality (maximum size) it throws an error if position is greater than the number of the current elements, it is added at the end if position is >=0 and < number of the current elements, the item is added in the position. After the insertion, if the number of elements is greater than the drawer capacity, the last item is removed.

int32

2.157. ObjectDrawerAutomaticCreateRequest

Field Name Required Type Description Format

options

DrawerShowOptions

description

String

a description

team

String

name

String

folder

X

String

a folder identifier (path, uuid or loid)

systemAttributes

Object

attributes

Object

maxCardinality

Integer

maximum number of items in the drawer

int32

query

X

String

query used to populate the drawer

2.158. ObjectDrawerManualCreateRequest

Field Name Required Type Description Format

options

DrawerShowOptions

description

String

a description

team

String

name

String

folder

X

String

a folder identifier (path, uuid or loid)

systemAttributes

Object

attributes

Object

maxCardinality

Integer

maximum number of items in the drawer

int32

items

List of [string]

list of sources (loid, uuid or path)

2.159. ObjectDrawerUpdateRequest

Field Name Required Type Description Format

options

DrawerShowOptions

description

String

a description

team

String

2.160. ObjectFireEventRequest

Field Name Required Type Description Format

containers

X

List of [object]

list of containers of the objects subjected to the event

items

X

List of [object]

list of items subjected to the event

event

X

String

The event description

viewMask

X

Integer

View filter on the containers

int32

uri

X

String

The event domain

extraData

X

String

Additional data

2.161. ObjectInfo

Field Name Required Type Description Format

name

String

permissions

Integer

int32

id

Object

type

String

size

Long

int64

attributes

Object

channel

Object

owner

String

version

String

description

String

databaseId

Object

product

String

usageTicket

Object

workFolder

String

issueDate

String

systemAttributes

Object

virtualAttributes

Object

created

Long

int64

creator

String

locker

String

ownerTeam

String

lastModifier

String

locked

Long

int64

statusInfo

StatusInfo

edition

String

attributesXml

String

modified

Long

int64

webType

String

pstate

PersistentState

interfaceId

String

minimalInfo

Boolean

creatorTeam

String

usageTicketXml

String

systemAttributesXml

String

virtualAttributesXml

String

uniquenessString

String

2.162. ObjectInfoList

Field Name Required Type Description Format

items

List of ObjectInfo

errors

List of Error

2.163. ObjectInfoListRequest

Field Name Required Type Description Format

options

ObjectViewOptions

sources

X

List of [string]

list of sources (loid, uuid or path)

inlineErrors

Boolean

returns an empty OBjectInfo in case of error, instead of a separate error item (default: false)

2.164. ObjectInfoListUpdatedRequest

Field Name Required Type Description Format

sources

X

List of UpdatedBean

options

FileSystemShowOptions

2.165. ObjectLinkedEditionsResponse

Field Name Required Type Description Format

size

Integer

int32

editions

List of ObjectInfo

2.166. ObjectListHeaderInfoBean

Field Name Required Type Description Format

id

String

type

String

name

String

style

String

width

String

height

String

priority

Integer

int32

eomType

String

sources

List of [string]

sortType

String

2.167. ObjectListInfoBean

Field Name Required Type Description Format

id

String

userId

String

userType

String

connectionName

String

title

String

size

Long

int64

flags

Long

int64

parentId

String

type

String

total

Long

int64

2.168. ObjectListRequest

Field Name Required Type Description Format

options

ShowOptions

sources

X

List of [string]

list of sources (loid, uuid or path)

2.169. ObjectListUpdatedResponse

Field Name Required Type Description Format

items

List of ObjectInfo

errors

List of Error

unchanged

List of [string]

2.170. ObjectMetadataOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

merge

Boolean

if set to false metadata and system attributes are overwritten (default: true)

ignoreLock

Boolean

tell if the method must ignore the lock phase (default: true)

webType

WebTypeOptions

2.171. ObjectMetadataRequest

Field Name Required Type Description Format

systemAttributes

Object

attributes

Object

databaseId

Object

options

ObjectMetadataOptions

2.172. ObjectMoveRequest

Field Name Required Type Description Format

folder

X

String

a folder identifier (path, uuid or loid)

name

String

the target object name (default: source name)

options

MoveConflictResolutionOptions

2.173. ObjectNode

Field Name Required Type Description Format

nodeType

String

Enum: ARRAY, BINARY, BOOLEAN, MISSING, NULL, NUMBER, OBJECT, POJO, STRING,

array

Boolean

null

Boolean

float

Boolean

number

Boolean

object

Boolean

containerNode

Boolean

valueNode

Boolean

missingNode

Boolean

boolean

Boolean

bigInteger

Boolean

binary

Boolean

bigDecimal

Boolean

short

Boolean

integralNumber

Boolean

pojo

Boolean

double

Boolean

int

Boolean

long

Boolean

textual

Boolean

floatingPointNumber

Boolean

2.174. ObjectPermission

Field Name Required Type Description Format

allow

Boolean

type

String

principal

String

accessMask

Integer

int32

permissions

List of [string]

Enum:

group

Boolean

2.175. ObjectPermissionAddRequest

Field Name Required Type Description Format

addPermissions

List of ObjectPermissionRequest

List of permissions to add

2.176. ObjectPermissionRemoveRequest

Field Name Required Type Description Format

removePermissions

X

List of ObjectPermissionRequest

List of permissions to remove

2.177. ObjectPermissionReplaceRequest

Field Name Required Type Description Format

replacePermissionOptions

ReplacePermissionOptions

setPermissions

List of ObjectPermissionRequest

List of permissions to set

2.178. ObjectPermissionRequest

Field Name Required Type Description Format

allow

Boolean

allow (default: true)

group

Boolean

group (default: false)

type

X

String

(PERM_TYPE_WORKFLOW

PERM_TYPE_OBJECT

PERM_TYPE_INHERITED)

Enum: PERM_TYPE_WORKFLOW, PERM_TYPE_OBJECT, PERM_TYPE_INHERITED,

principal

X

String

accessMask

X

Integer

int32

permissions

List of [string]

2.179. ObjectPermissionSetRequest

Field Name Required Type Description Format

inheritanceOptions

InheritanceOptions

setPermissions

List of ObjectPermissionRequest

List of permissions to set

2.180. ObjectQueryResponse

Field Name Required Type Description Format

title

String

limit

Integer

int32

size

Integer

int32

total

Integer

int32

queryInfo

QueryObjectInfo

queryString

String

items

List of ObjectInfo

extraResultInfo

Object

warnings

List of QueryWarning

extraItemsInfo

List of QueryResponseItemExtraInfo

2.181. ObjectQueryViewResponse

Field Name Required Type Description Format

title

String

limit

Integer

int32

size

Integer

int32

total

Integer

int32

queryInfo

QueryObjectInfo

queryString

String

items

List of ObjectInfo

extraResultInfo

Object

warnings

List of QueryWarning

extraItemsInfo

List of QueryResponseItemExtraInfo

selectedView

ObjectView

views

List of ObjectView

columns

List of ObjectListHeaderInfoBean

fields

List of ObjectListHeaderInfoBean

2.182. ObjectRelocationSendToProductionRequest

Field Name Required Type Description Format

databaseId

Object

workFolder

X

String

The target workfolder.

channel

Object

issueDate

String

The issue date of the object to be relocated with the format YYYYMMDD. This will update metadata.

insert

String

The insert parameter is used to set/get section value on system attributes when a Send to Production operation is called.

team

String

The team parameter is used to set/get user team value when a Send to Production or a Drag and Drop operation is called.

applicationId

String

The application id parameter is used to calculate workfolder and basefolder in specific situations. Usually, passing null is enough for most cases.

name

String

The name of the target object.

options

DefaultConflictResolutionOptions

sendToProductionOptions

SendToProductionOptions

sources

X

List of [string]

list of sources (loid, uuid or path)

2.183. ObjectRenameRequest

Field Name Required Type Description Format

name

X

String

2.184. ObjectRestoreListRequest

Field Name Required Type Description Format

sources

String

an object identifier (path or loid)

2.185. ObjectRole

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

pstate

PersistentState

type

String

name

String

2.186. ObjectRoleList

Field Name Required Type Description Format

items

List of ObjectRole

errors

List of Error

2.187. ObjectShapeDataBean

Field Name Required Type Description Format

pgx

PglBean

pageLinked

PglPageBean

contentItems

List of ContentItemBean

formats

List of PrintFormatBean

contentItemsError

String

formatsError

String

info

ShapeInfoBean

noPageLinked

Boolean

pageAccessoriesFound

Boolean

pageAccessoriesFilePath

String

pgxShapeItems

List of PglItemBean

2.188. ObjectStatusInfo

Field Name Required Type Description Format

name

String

identifier

String

comment

String

assignedTo

List of [string]

2.189. ObjectStatusRequest

Field Name Required Type Description Format

status

X

String

workflow status and step, format is Workflow/WorkFlowStep

comment

String

the status comment

skipWorkflow

Boolean

ignore workflow and force set status name (true) or do normal workflow (false, default)

2.190. ObjectSystemAttributesMultipleBulkBean

Field Name Required Type Description Format

source

X

Object

systemAttributes

Object

merge

Boolean

if set to false system attributes are overwritten (default: true)

2.191. ObjectSystemAttributesMultipleBulkRequest

Field Name Required Type Description Format

items

List of ObjectSystemAttributesMultipleBulkBean

2.192. ObjectSystemAttributesSingleBulkRequest

Field Name Required Type Description Format

sources

X

List of [string]

list of sources (loid, uuid or path)

systemAttributes

Object

merge

Boolean

if set to false metadata are overwritten (default: true)

2.193. ObjectTaskRequest

Field Name Required Type Description Format

options

ShowOptions

sources

X

List of [string]

list of sources (loid, uuid or path)

2.194. ObjectType

Field Name Required Type Description Format

databaseId

String

type

String

defaultExtension

String

ownedExtension

String

baseTypeName

String

description

String

defaultFormat

String

formats

List of FormatType

actions

List of ObjectTypeAction

2.195. ObjectTypeAction

Field Name Required Type Description Format

name

String

description

String

category

String

commandName

String

arguments

String

abortOnFailure

Boolean

2.196. ObjectUpdateRequest

Field Name Required Type Description Format

owner

String

A string containing the owner

description

String

A string containing the description

suid

String

A string containing the suid

uuid

String

A string containing the uuid

ownerTeam

String

A string containing the owner team

2.197. ObjectUpdatedMultipartStreamer

Field Name Required Type Description Format

boundary

String

2.198. ObjectUserChangePasswordRequest

Field Name Required Type Description Format

databaseId

Object

oldPassword

X

String

Old user password.

newPassword

X

String

New user password.

confirmPassword

X

String

Confirm new user password.

2.199. ObjectUserInfoRequest

Field Name Required Type Description Format

defaultTeam

String

Group name for user's default team. Null value will skip the update. Any other value will be accepted given the group exists.

userSecurity

String

The security mechanism to be applied to a user. Allowed values: USER_SECURITY_DEFAULT USER_SECURITY_INTERNAL USER_SECURITY_PLATFORM USER_SECURITY_LDAP USER_SECURITY_SSO USER_SECURITY_INTERNAL_SSO USER_SECURITY_LDAP_SSO Null value will skip the update. Any other value will throw an exception.

databaseId

Object

fullName

String

The user full name. Null value will skip the update. Any other value is accepted.

description

String

The user description. Null value will skip the update. Any other value is accepted.

password

String

The password. Blank value will skip the update.

options

UserOptions

2.200. ObjectView

Field Name Required Type Description Format

id

String

name

String

type

String

Enum: LIST, THUMBNAIL,

2.201. ObjectViewField

Field Name Required Type Description Format

name

String

value

Object

rawValue

Object

type

Integer

int32

style

String

id

String

priority

Integer

int32

eomType

String

sortType

String

2.202. ObjectViewList

Field Name Required Type Description Format

items

List of [object]

errors

List of Error

selectedView

ObjectView

views

List of ObjectView

columns

List of ObjectListHeaderInfoBean

fields

List of ObjectListHeaderInfoBean

2.203. ObjectViewOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

widthUnit

String

specify the unit type (default: PIXEL)

Enum: PIXEL, PERCENT,

viewPath

String

path view (default: '/')

viewDatabaseId

Object

webType

WebTypeOptions

2.204. ObjectWorkflowBean

Field Name Required Type Description Format

name

String

steps

List of WorkflowStepInfoBean

default

Boolean

2.205. ObjectWorkflowDataBean

Field Name Required Type Description Format

info

ObjectInfo

workflows

List of ObjectWorkflowBean

taskInfo

TaskObjectInfo

correlations

List of Correlation

2.206. ObjectWorkflowRequest

Field Name Required Type Description Format

sources

X

List of [string]

list of objects (loid, uuid or path) the next worflow steps are to be retrieved for

common

Boolean

list common steps only (true, default) or list all steps (false)

info

Boolean

return an object (true, default) or not (false)

allowedOnly

Boolean

return allowed workflows only (true) or not (false, default)

compliantOnly

Boolean

return compliant workflows only (true) or not (false, default)

2.207. ObjectWorkflowTask

Field Name Required Type Description Format

creator

String

created

Integer

int32

taskInfo

TaskInfo

2.208. ObjectWorkflowUpdateAssignment

Field Name Required Type Description Format

assignees

List of [string]

list of assignees

priority

Integer

priority, 0 as default

int32

dueDate

String

due date

correlations

List of [object]

list of correlations

name

String

task name

2.209. ObjectWorkflowUpdateRequest

Field Name Required Type Description Format

name

String

object name. If it's not blank, is different from current name and the object is not a subtype of task, it's used to rename the object

status

X

ObjectWorkflowUpdateStatus

assignment

ObjectWorkflowUpdateAssignment

2.210. ObjectWorkflowUpdateStatus

Field Name Required Type Description Format

remove

Boolean

if true the workflow status is removed, false as default

name

String

the workflow status name

comment

String

comment

2.211. ObjectsDragAndDropOptions

Field Name Required Type Description Format

keepAcopy

Boolean

Keep a copy of the source object

silent

Boolean

Avoid the automatic rename

2.212. ObjectsRelocationDragAndDropRequest

Field Name Required Type Description Format

databaseId

Object

workFolder

X

String

The target workfolder.

channel

Object

issueDate

String

The issue date of the object to be relocated with the format YYYYMMDD. This will update metadata.

insert

String

The insert parameter is used to set/get section value on system attributes when a Send to Production operation is called.

team

String

The team parameter is used to set/get user team value when a Send to Production or a Drag and Drop operation is called.

applicationId

String

The application id parameter is used to calculate workfolder and basefolder in specific situations. Usually, passing null is enough for most cases.

name

String

The name of the target object.

options

DefaultConflictResolutionOptions

dragAndDropOptions

ObjectsDragAndDropOptions

2.213. OpenDocumentInfo

Field Name Required Type Description Format

locked

Boolean

objectInfo

ObjectInfo

content

String

shapeRole

String

links

List of OpenDocumentLink

channelCopies

List of OpenDocumentInfo

errorMessage

String

maxDepth

Boolean
Field Name Required Type Description Format

linkInfo

LinkInfo

linkedObject

OpenDocumentInfo

errorMessage

String

2.215. OpenDocumentOptions

Field Name Required Type Description Format

source

Object

lockObject

Boolean

locks the object (default: false)

ignoreLocked

Boolean

when 'lockObject' is true, continues even if the object is already locked (default: false)

ignoreLinked

Boolean

ignore backward links on source object (default: false)

continueOnError

Boolean

continues in case of errors following links or reading contents (default: true)

readContents

Boolean

reads the object contents (XML only) (default: false)

readShapeRole

Boolean

reads the Xsmile::Shape (PGX) role (default: false)

readPasteboard

Boolean

read XML contents for objects from a DWP/DWC pasteboard (default: false)

roleType

String

the links role type (default: *)

roleName

String

the links role name (default: *)

inheritanceChannels

List of [string]

the inheritance channels for choosing a channel copy

linkDepth

Integer

sets the recursion depth limit (excluded) in following links (default: -1, meaning unspecified)

int32

mergePrpEditions

Boolean

linked editions' contents are merged inside a product(PRP)'s content (default: true)

versionNumber

Integer

the version to be used for reading the content of the first object (default: -1, meaning curent version)

int32

ignoreInheritanceChannels

Boolean

reads unconditionally the XML content of a channel copy, instead of checking inheritance channels (default: false)

minimalSourceObject

Boolean

returns a minimal object info for the starting object (default: false)

noSourceContent

Boolean

never read the content of the starting object (default: false)

firstLevelLimit

Integer

the maximum number of complete object infos returned for the list of objects at depth 1 (default: 0, meaning all). The rest is returned with a minimal info

int32

openMaster

Boolean

start the open document from the compound story master, but lock the input source, if 'lockObject' is true (default: false)

2.216. OpenDocumentResponse

Field Name Required Type Description Format

mergedPrpEditions

Boolean

openDocumentInfo

OpenDocumentInfo

2.217. OpenDocumentsRequest

Field Name Required Type Description Format

sources

X

List of [object]

a list of the identifiers (path, uuid or loid) of objects to be opened

options

OpenDocumentOptions

2.218. PageAccessoriesFromPathRequest

Field Name Required Type Description Format

path

String

path

databaseId

Object

options

ShapeTemplateShowOptions

2.219. PageAccessoriesRequest

Field Name Required Type Description Format

workFolder

String

workFolder

color

String

color

editInContainer

Boolean

editInContainer

product

String

product

edition

String

edition

channel

Object

options

ShapeTemplateShowOptions

2.220. PageAccessoriesResponse

Field Name Required Type Description Format

footNotes

FootNotes

dropCaps

List of DropCap

listItems

List of ListItems

textHighlights

List of ItemHighLight

colors

List of Color

formats

List of Format

2.221. Permission

Field Name Required Type Description Format

allow

Boolean

principalName

PrincipalName

accessMask

Integer

int32

type

String

Enum: PERM_TYPE_WORKFLOW, PERM_TYPE_OBJECT, PERM_TYPE_INHERITED,

permissions

List of [string]

Enum:

2.222. PermissionResponse

Field Name Required Type Description Format

allowInheritanceFromParent

Boolean

allowPropagateToChildren

Boolean

permissions

List of ObjectPermission

2.223. PersistentState

Field Name Required Type Description Format

uuid

String

suid

String

loid

String

retentionTime

Integer

int32

ucount

Integer

int32

2.224. PglBean

Field Name Required Type Description Format

uuid

String

channel

String

sref

String

hrefAux

String

xml

String

pgxContent

PglContentBean

shapes

Map of ShapeBean

2.225. PglContentBean

Field Name Required Type Description Format

id

String

type

String

name

String

href

String

storyType

String

items

List of PglItemBean

2.226. PglItemBean

Field Name Required Type Description Format

id

String

type

String

contentType

String

format

String

sref

String

idx

String

template

String

xml

String

css

String

markup

String

2.227. PglPageBean

Field Name Required Type Description Format

name

String

type

String

2.228. PositionData

Field Name Required Type Description Format

latitude

String

longitude

String

positionName

String

positionAddress

String

2.229. PrincipalBean

Field Name Required Type Description Format

name

String

description

String

configFolder

String

profileFolder

String

ucount

Integer

int32

2.230. PrincipalList

Field Name Required Type Description Format

count

Integer

int32

principals

List of PrincipalBean

2.231. PrincipalName

Field Name Required Type Description Format

name

String

group

Boolean

2.232. PrintFormatBean

Field Name Required Type Description Format

name

String

type

String

cssFile

String

cssSwing

String

templateFile

String

templateContent

String

template

String

hrefTagWizard

String

description

String

justification

String

copyfit

String

height

String

marginBottomMin

String

marginBottomMax

String

flex

String

autofitStep

String

runaround

String

enlarge

String

textWrap

String

storyname

String

compenstate

String

styleSheets

List of StyleSheetBean

markups

List of MarkupBean

templates

List of TemplateBean

default

Boolean

favourite

Boolean

2.233. Privilege

Field Name Required Type Description Format

name

String

enabled

Boolean

description

String

origin

String

Enum: USER, GROUP, SYSTEM, EOM_SYSTEM,

2.234. Privileges

Field Name Required Type Description Format

user

String

group

String

system

String

values

List of Privilege

2.235. QueryCreateRequest

Field Name Required Type Description Format

query

X

String

query string to create

temporary

Boolean

specifies if the query string will be saved as temporary query, false as default

folder

X

Object

name

X

String

query name

description

String

query description

systemAttributes

X

Object

options

ObjectCreateQueryOptions

2.236. QueryObjectInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

active

Boolean

secondaryIndexQueries

List of ObjectInfo

2.237. QueryOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

showPath

Boolean

showUri

Boolean

shows the uri in the response (default: false)

showSystemAttributes

Boolean

showAttributes

Boolean

showUsageTickets

Boolean

showVirtualAttributes

Boolean

showXml

Boolean

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

showContent

Boolean

showUniquenessString

Boolean

shows Uniqueness string (default: false)

prefill

Boolean

return a preview of the query result (default: true)

webType

WebTypeOptions

2.238. QueryRequest

Field Name Required Type Description Format

databaseId

Object

limit

Integer

specify the max number of resolved items returned (default: 200). For example if limit is 10 and the query returns 100 items, the first 10 items will be entirely resolved and for the other 90 items there will be only a minimal set of informations (pstate, id, databaseId).

int32

variables

Map of QueryVariables

key-property map of dynamic variables resolved in query string, the property value should be an array of string or a string

context

String

a context identifier (uuid, loid or path)

sortBy

List of QuerySort

list of fields used to order result

options

QueryOptions

2.239. QueryResponseItemExtraInfo

Field Name Required Type Description Format

match

QueryResponseItemMatch

sortValues

List of [string]

id

String

2.240. QueryResponseItemMatch

Field Name Required Type Description Format

relevance

Integer

int32

words

List of [string]

2.241. QuerySort

Field Name Required Type Description Format

field

String

field name

type

String

order type (ASCENDING, DESCENDING, NASCENDING, NDESCENDING)

Enum: ASCENDING, DESCENDING, NASCENDING, NDESCENDING,

2.242. QueryStringRequest

Field Name Required Type Description Format

databaseId

Object

limit

Integer

specify the max number of resolved items returned (default: 200). For example if limit is 10 and the query returns 100 items, the first 10 items will be entirely resolved and for the other 90 items there will be only a minimal set of informations (pstate, id, databaseId).

int32

variables

Map of QueryVariables

key-property map of dynamic variables resolved in query string, the property value should be an array of string or a string

context

String

a context identifier (uuid, loid or path)

sortBy

List of QuerySort

list of fields used to order result

options

QueryOptions

query

X

String

query string to execute as escaped xml string

temporary

Boolean

specifies if the query string will be saved as temporary query

2.243. QueryVariables

Field Name Required Type Description Format

values

List of [string]

2.244. QueryViewOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

showPath

Boolean

showUri

Boolean

shows the uri in the response (default: false)

showSystemAttributes

Boolean

showAttributes

Boolean

showUsageTickets

Boolean

showVirtualAttributes

Boolean

showXml

Boolean

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

showContent

Boolean

showUniquenessString

Boolean

shows Uniqueness string (default: false)

prefill

Boolean

return a preview of the query result (default: true)

widthUnit

String

specify the page width unit (default: PIXEL)

Enum: PIXEL, PERCENT,

viewPath

String

path view (default: '/')

webType

WebTypeOptions

2.245. QueryViewRequest

Field Name Required Type Description Format

databaseId

Object

limit

Integer

specify the max number of resolved items returned (default: 200). For example if limit is 10 and the query returns 100 items, the first 10 items will be entirely resolved and for the other 90 items there will be only a minimal set of informations (pstate, id, databaseId).

int32

variables

Map of QueryVariables

key-property map of dynamic variables resolved in query string, the property value should be an array of string or a string

context

String

a context identifier (uuid, loid or path)

sortBy

List of QuerySort

list of fields used to order result

options

QueryViewOptions

sortViewBy

List of QuerySort

list of fields used to order result based on the applyed view

2.246. QueryViewStringRequest

Field Name Required Type Description Format

databaseId

Object

limit

Integer

specify the max number of resolved items returned (default: 200). For example if limit is 10 and the query returns 100 items, the first 10 items will be entirely resolved and for the other 90 items there will be only a minimal set of informations (pstate, id, databaseId).

int32

variables

Map of QueryVariables

key-property map of dynamic variables resolved in query string, the property value should be an array of string or a string

context

String

a context identifier (uuid, loid or path)

sortBy

List of QuerySort

list of fields used to order result

options

QueryViewOptions

sortViewBy

List of QuerySort

list of fields used to order result based on the applyed view

query

X

String

query string to execute as escaped xml string

temporary

Boolean

specifies if the query string will be saved as temporary query

2.247. QueryWarning

Field Name Required Type Description Format

code

Integer

int32

message

String

2.248. ReadBean

Field Name Required Type Description Format

version

Integer

content version (default: -1)

int32

raw

Boolean

boolean value to choose whether to get raw or resolved content (default: false)

showDtd

Boolean

boolean value to choose whether to get inline dtd within an XML document (default: false)

range

ContentRange

source

X

String

an object identifier (path, uuid or loid)

format

String

the format or format alias to retrieve (default: null)

2.249. ReadBinaryBean

Field Name Required Type Description Format

version

Integer

content version (default: -1)

int32

source

X

String

an object identifier (path, uuid or loid)

format

String

the format or format alias to retrieve (default: null)

2.250. ReplacePermissionOptions

Field Name Required Type Description Format

objectType

X

Boolean

flag to replace the permissions of the objects. If true replace permissions of objects

workflowType

X

Boolean

flag to replace the permissions of the workflow.If true replace permissions of workflow

inheritedType

X

Boolean

flag to replace the permissions of the inherited. If true replace permissions of inherited

2.251. RepositoryRequest

Field Name Required Type Description Format

databaseId

String

the database id where execute the request

request

X

String

the request to execute

input

String

the request input, if any

2.252. RepositoryRequestJSON

Field Name Required Type Description Format

databaseId

String

the database id where execute the request

request

X

String

the request to execute

input

String

the request input, if any

2.253. Response

Field Name Required Type Description Format

result

Object

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.254. ResponseBaseObjectInfo

Field Name Required Type Description Format

result

BaseObjectInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.255. ResponseBinderListResponse

Field Name Required Type Description Format

result

BinderListResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.256. ResponseBoolean

Field Name Required Type Description Format

result

Boolean

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.257. ResponseBundleObjectViewInfo

Field Name Required Type Description Format

result

BundleObjectViewInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.258. ResponseByte[]

Field Name Required Type Description Format

result

List of [ByteArray]

byte

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.259. ResponseCacheInfoCommand

Field Name Required Type Description Format

result

CacheInfoCommand

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.260. ResponseCacheInfoGroup

Field Name Required Type Description Format

result

CacheInfoGroup

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.261. ResponseCacheInfoJob

Field Name Required Type Description Format

result

CacheInfoJob

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.262. ResponseCacheInfoObjectType

Field Name Required Type Description Format

result

CacheInfoObjectType

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.263. ResponseCacheInfoUser

Field Name Required Type Description Format

result

CacheInfoUser

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.264. ResponseCacheInfoWorkflow

Field Name Required Type Description Format

result

CacheInfoWorkflow

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.265. ResponseChannelCopyResponse

Field Name Required Type Description Format

result

ChannelCopyResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.266. ResponseCobaltResponse

Field Name Required Type Description Format

result

CobaltResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.267. ResponseCollageConfig

Field Name Required Type Description Format

result

CollageConfig

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.268. ResponseConfigurationMultipartStreamer

Field Name Required Type Description Format

result

ConfigurationMultipartStreamer

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.269. ResponseConnectionsInfo

Field Name Required Type Description Format

result

ConnectionsInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.270. ResponseDividerObjectInfo

Field Name Required Type Description Format

result

DividerObjectInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.271. ResponseDrawer

Field Name Required Type Description Format

result

Drawer

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.272. ResponseErrorList

Field Name Required Type Description Format

result

ErrorList

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.273. ResponseFileObjectInfo

Field Name Required Type Description Format

result

FileObjectInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.274. ResponseFolderInfoList

Field Name Required Type Description Format

result

FolderInfoList

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.275. ResponseFolderViewInfoList

Field Name Required Type Description Format

result

FolderViewInfoList

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.276. ResponseGetCrossReferenceResponse

Field Name Required Type Description Format

result

GetCrossReferenceResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.277. ResponseGroup

Field Name Required Type Description Format

result

Group

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.278. ResponseInputStream

Field Name Required Type Description Format

result

Object

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.279. ResponseInteger

Field Name Required Type Description Format

result

Integer

int32

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.280. ResponseListCacheInfoSystemCacheItem

Field Name Required Type Description Format

result

List of CacheInfoSystemCacheItem

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.281. ResponseListColumnCatalogsConfig

Field Name Required Type Description Format

result

List of ColumnCatalogsConfig

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.282. ResponseListContentItemAction

Field Name Required Type Description Format

result

List of ContentItemAction

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.283. ResponseListDatabaseIndexes

Field Name Required Type Description Format

result

List of DatabaseIndexes

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.284. ResponseListDrawer

Field Name Required Type Description Format

result

List of Drawer

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.285. ResponseListEomPermissions

Field Name Required Type Description Format

result

List of [string]

Enum:

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.286. ResponseListError

Field Name Required Type Description Format

result

List of Error

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.287. ResponseListErrorDatabaseId

Field Name Required Type Description Format

result

List of ErrorDatabaseId

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.288. ResponseListFormatItem

Field Name Required Type Description Format

result

List of FormatItem

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.289. ResponseListInsertTemplate

Field Name Required Type Description Format

result

List of InsertTemplate

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.290. ResponseListLinkResponse

Field Name Required Type Description Format

result

List of LinkResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.291. ResponseListLinksResponse

Field Name Required Type Description Format

result

List of LinksResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.292. ResponseListObjectInfo

Field Name Required Type Description Format

result

List of ObjectInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.293. ResponseListObjectWorkflowDataBean

Field Name Required Type Description Format

result

List of ObjectWorkflowDataBean

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.294. ResponseListObjectWorkflowTask

Field Name Required Type Description Format

result

List of ObjectWorkflowTask

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.295. ResponseListQueryObjectInfo

Field Name Required Type Description Format

result

List of QueryObjectInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.296. ResponseListShapeTemplatesResponse

Field Name Required Type Description Format

result

List of ShapeTemplatesResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.297. ResponseListString

Field Name Required Type Description Format

result

List of [string]

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.298. ResponseListUserError

Field Name Required Type Description Format

result

List of UserError

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.299. ResponseListVersionInfo

Field Name Required Type Description Format

result

List of VersionInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.300. ResponseListVersionInfoAndContent

Field Name Required Type Description Format

result

List of VersionInfoAndContent

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.301. ResponseListWorkflowStepListBean

Field Name Required Type Description Format

result

List of WorkflowStepListBean

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.302. ResponseLiveBlogPostListResponse

Field Name Required Type Description Format

result

LiveBlogPostListResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.303. ResponseLockContentItemBean

Field Name Required Type Description Format

result

Object

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.304. ResponseLoginInfo

Field Name Required Type Description Format

result

LoginInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.305. ResponseLoginResponse

Field Name Required Type Description Format

result

LoginResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.306. ResponseLong

Field Name Required Type Description Format

result

Long

int64

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.307. ResponseLong[]

Field Name Required Type Description Format

result

List of [long]

int64

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.308. ResponseMap

Field Name Required Type Description Format

result

Map of [object]

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.309. ResponseMapDatabaseIdListCacheInfoSystemCacheItem

Field Name Required Type Description Format

result

Map of [array]

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.310. ResponseMapDatabaseIdMapSystemCachesLong

Field Name Required Type Description Format

result

Map of [map]

int64

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.311. ResponseMapStringObject

Field Name Required Type Description Format

result

Map of [object]

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.312. ResponseMapStringSendToProductionResponse

Field Name Required Type Description Format

result

Map of SendToProductionResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.313. ResponseMapSystemCachesLong

Field Name Required Type Description Format

result

Map of [long]

int64

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.314. ResponseMetadataTemplateStreamer

Field Name Required Type Description Format

result

MetadataTemplateStreamer

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.315. ResponseObject

Field Name Required Type Description Format

result

Object

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.316. ResponseObjectActionResponse

Field Name Required Type Description Format

result

ObjectActionResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.317. ResponseObjectCorrelatedBulkResponse

Field Name Required Type Description Format

result

ObjectCorrelatedBulkResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.318. ResponseObjectCorrelatedResponse

Field Name Required Type Description Format

result

ObjectCorrelatedResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.319. ResponseObjectCorrelatedViewResponse

Field Name Required Type Description Format

result

ObjectCorrelatedViewResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.320. ResponseObjectCorrelatingBulkResponse

Field Name Required Type Description Format

result

ObjectCorrelatingBulkResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.321. ResponseObjectCorrelatingResponse

Field Name Required Type Description Format

result

ObjectCorrelatingResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.322. ResponseObjectCorrelatingViewResponse

Field Name Required Type Description Format

result

ObjectCorrelatingViewResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.323. ResponseObjectCorrelationResponse

Field Name Required Type Description Format

result

ObjectCorrelationResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.324. ResponseObjectInfo

Field Name Required Type Description Format

result

ObjectInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.325. ResponseObjectInfoList

Field Name Required Type Description Format

result

ObjectInfoList

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.326. ResponseObjectLinkedEditionsResponse

Field Name Required Type Description Format

result

ObjectLinkedEditionsResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.327. ResponseObjectListUpdatedResponse

Field Name Required Type Description Format

result

ObjectListUpdatedResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.328. ResponseObjectQueryResponse

Field Name Required Type Description Format

result

ObjectQueryResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.329. ResponseObjectQueryViewResponse

Field Name Required Type Description Format

result

ObjectQueryViewResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.330. ResponseObjectRole

Field Name Required Type Description Format

result

ObjectRole

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.331. ResponseObjectRoleList

Field Name Required Type Description Format

result

ObjectRoleList

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.332. ResponseObjectShapeDataBean

Field Name Required Type Description Format

result

ObjectShapeDataBean

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.333. ResponseObjectStreamer

Field Name Required Type Description Format

result

Object

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.334. ResponseObjectUpdatedMultipartStreamer

Field Name Required Type Description Format

result

ObjectUpdatedMultipartStreamer

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.335. ResponseObjectViewList

Field Name Required Type Description Format

result

ObjectViewList

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.336. ResponseOpenDocumentResponse

Field Name Required Type Description Format

result

OpenDocumentResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.337. ResponseOpenDocumentResponse[]

Field Name Required Type Description Format

result

List of OpenDocumentResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.338. ResponsePageAccessoriesResponse

Field Name Required Type Description Format

result

PageAccessoriesResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.339. ResponsePermissionResponse

Field Name Required Type Description Format

result

PermissionResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.340. ResponsePrivileges

Field Name Required Type Description Format

result

Privileges

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.341. ResponseSessionParam

Field Name Required Type Description Format

result

SessionParam

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.342. ResponseSetCrossReferenceResponseBean

Field Name Required Type Description Format

result

SetCrossReferenceResponseBean

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.343. ResponseStoryFamilyResponse

Field Name Required Type Description Format

result

StoryFamilyResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.344. ResponseStoryUploadResponse

Field Name Required Type Description Format

result

StoryUploadResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.345. ResponseStreamingOutput

Field Name Required Type Description Format

result

Object

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.346. ResponseString

Field Name Required Type Description Format

result

String

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.347. ResponseTaskObjectInfo

Field Name Required Type Description Format

result

TaskObjectInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.348. ResponseTaskObjectInfoDetails

Field Name Required Type Description Format

result

TaskObjectInfoDetails

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.349. ResponseTaskObjectViewInfo

Field Name Required Type Description Format

result

TaskObjectViewInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.350. ResponseTaskUpdateResponse

Field Name Required Type Description Format

result

TaskUpdateResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.351. ResponseTopic

Field Name Required Type Description Format

result

Topic

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.352. ResponseTopicItem

Field Name Required Type Description Format

result

TopicItem

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.353. ResponseTopicItemObjectInfo

Field Name Required Type Description Format

result

TopicItemObjectInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.354. ResponseTopicList

Field Name Required Type Description Format

result

TopicList

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.355. ResponseTopicMoveResponse

Field Name Required Type Description Format

result

TopicMoveResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.356. ResponseTopicPlan

Field Name Required Type Description Format

result

TopicPlan

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.357. ResponseTopicSubItem

Field Name Required Type Description Format

result

TopicSubItem

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.358. ResponseUncorrelateResponse

Field Name Required Type Description Format

result

UncorrelateResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.359. ResponseUsageTickets

Field Name Required Type Description Format

result

Object

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.360. ResponseUserCreateResponse

Field Name Required Type Description Format

result

UserCreateResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.361. ResponseUserExternalId

Field Name Required Type Description Format

result

UserExternalId

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.362. ResponseUserExternalIdResponse

Field Name Required Type Description Format

result

UserExternalIdResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.363. ResponseUserUpdateResponse

Field Name Required Type Description Format

result

UserUpdateResponse

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.364. ResponseVersionInfo

Field Name Required Type Description Format

result

VersionInfo

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.365. ResponseVoid

Field Name Required Type Description Format

result

Object

statistics

Statistics

status

String

&quot;error&quot; if status code >= 400, &quot;success&quot; otherwise

2.366. ResultStatus

Field Name Required Type Description Format

success

Boolean

errorMessage

String

2.367. SendToProductionOptions

Field Name Required Type Description Format

keepAcopy

Boolean

copy the source object (default: false)

copyWorkflowStatus

Boolean

copy status from source object to the new one (default: false)

propagateWorkFolder

Boolean

propagate WorkFolder to children (default: true)

propagateIssueDate

Boolean

propagate IssueDate to children (default: true)

propagateChannel

Boolean

propagate Channel and Insert to children (default: true). If true, channel parameter is mandatory

setOnlySystemAttributes

Boolean

set only system attribute (default: false)

setProductionData

Boolean

set production data (default: true)

applySourceWorkflowStatus

Boolean

Apply Source Workflow Status (default: false)

ignoreCorrelation

Boolean

Ignore Correlation (default: false)

ignoreStatus

Boolean

Ignore workflow status (default: false)

showItems

Boolean

Show all relocated items (default: false)

2.368. SendToProductionResponse

Field Name Required Type Description Format

info

FileObjectInfo

items

List of FileObjectInfo

errors

List of Error

2.369. SessionParam

Field Name Required Type Description Format

params

Map of [string]

user session params

2.370. SetCrossReferenceRequest

Field Name Required Type Description Format

xpath

X

String

the xpath where to search candidate cross reference

index

X

Integer

index of the xpath

int32

2.371. SetCrossReferenceResponseBean

Field Name Required Type Description Format

idAttribute

String

2.372. SetStatusRequest

Field Name Required Type Description Format

status

X

String

workflow status

comment

String

comment

priority

Integer

priority(0=LOW, 1=NORMAL, 2=HIGH, default = 1)

int32

dueDate

String

due date UTC, in the YYYYMMDDHHMMSS format

assignedTo

List of [string]

assignees (user or group) names

2.373. ShapeBean

Field Name Required Type Description Format

id

String

iref

String

elementName

String

type

String

x

Double

double

y

Double

double

width

Double

double

height

Double

double

xtransform

String

xml

String

copyfit

String

2.374. ShapeInfoBean

Field Name Required Type Description Format

loid

Object

type

String

2.375. ShapeItem

Field Name Required Type Description Format

path

String

info

FileSystemObjectInfo

2.376. ShapeTemplateFilter

Field Name Required Type Description Format

title

String

values

List of [string]

2.377. ShapeTemplateItem

Field Name Required Type Description Format

shapes

List of ShapeItem

default

Boolean

resolved

Boolean

name

String

dir

String

2.378. ShapeTemplateShowOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

listAllShapes

Boolean

if false, the shapes are listed according to the dir parameter. If true, lists all the shapes for all the directories found in configuration (default: false)

webType

WebTypeOptions

2.379. ShapeTemplatesListBaseRequest

Field Name Required Type Description Format

dir

String

used to specify the shape template dir to resolve. If not specified and listAllShapes options is false, it falls back either on the default directory if exists, or on the first directory found in the configured shape-templates directories.

product

String

product

edition

String

edition

channel

Object

options

ShapeTemplateShowOptions

2.380. ShapeTemplatesListRequest

Field Name Required Type Description Format

dir

String

used to specify the shape template dir to resolve. If not specified and listAllShapes options is false, it falls back either on the default directory if exists, or on the first directory found in the configured shape-templates directories.

product

String

product

edition

String

edition

channel

Object

options

ShapeTemplateShowOptions

databaseId

X

Object

team

String

team

type

String

used to match the type attribute on the configured shape-templates directories

workFolder

String

workFolder

issueDate

String

issueDate

insert

String

insert

siteName

String

siteName

sectionPath

String

sectionPath

attributes

Object

2.381. ShapeTemplatesResponse

Field Name Required Type Description Format

items

List of ShapeTemplateItem

shapeTemplatesAttributes

Map of [string]

filters

List of ShapeTemplateFilter

2.382. Shortcut

Field Name Required Type Description Format

shortcut

ObjectInfo

file

ObjectInfo

2.383. ShowOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showCorrelated

Boolean

add correlated object to the response (default: false)

showAttachments

Boolean

add attachments to the response (default: false)

showTopic

Boolean

add related topic to the response (default: false)

webType

WebTypeOptions

2.384. Statistics

Field Name Required Type Description Format

date

String

version

String

requestTime

String

2.385. StatusInfo

Field Name Required Type Description Format

name

String

identifier

String

comment

String

assignedTo

List of [string]

2.386. StoryCreateOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

checkIn

Boolean

specify if check-in should be invoked instead of performing a check_in action (default: true)

keepCheckedOut

Boolean

specify the value of keepCheckedOut parameter during check-in operation (default: false)

unlock

Boolean

if the option checkIn is set to false, this options dictates if the object is unlocked at the end of the operation (default: false)

newVersion

Boolean

if the option checkIn is set to true, specify the value of newVersion parameter (default: false)

createMode

String

specify the creation mode (default: EXCEPTION)

Enum: EXCEPTION, AUTO_RENAME, REPLACE, NEW_VERSION,

useDefaultProduct

Boolean

specify if default product should be used (default: true)

issueDateDefaultStrategy

String

specify how the IssueDate should be calculated: CALENDAR get the issue date from the default calendar, STANDING removes the issue date, NONE does nothing (default: NONE)

Enum: CALENDAR, STANDING, NONE,

timeSuffix

Boolean

specify if a time suffix should be added to the object name (default: false)

addContentItemsId

Boolean

add id in content item if it is not present (default: false)

mergeSystemAttributes

Boolean

specify if sytem attributes should be merged with template ones (default: true)

mergeAttributes

Boolean

specify if attributes should be merged with template ones (default: true)

checkInAction

Boolean

specify if check-in action should be executed after the shape is applied (default: false)

webType

WebTypeOptions

2.387. StoryCreateTemplateRequest

Field Name Required Type Description Format

channel

Object

issueDate

String

team

String

application

X

String

systemAttributes

Object

attributes

Object

status

String

format is Workflow/WorkFlowStep

statusComment

String

uniquenessString

String

name

X

String

databaseId

Object

workFolder

String

a workfolder

folder

String

a folder identifier (path, uuid or loid)

timestamp

Long

specify the timestamp to be used in usage ticket, if not specified current time is used

int64

uuid

String

the uuid to assign to the new object

options

ObjectCreateOptions

shape

String

the shape to apply (loid, uuid or path)

pglContentId

String

a PGL content id to be used for creating the story shape. By default the entire shape file is used

linkToPgl

Boolean

the created story should be linked to the shape PGL (true) or not (false, default)

type

String

should be subtype of either EOM::Story or EOM::CompoundStory

task

String

a task to which attach the created story (loid, uuid or path)

storyCreateOptions

StoryCreateOptions

objectCreateStoryFromOptions

ObjectCreateFromTemplateOptions

2.388. StoryFamilyResponse

Field Name Required Type Description Format

items

List of ObjectInfo

errors

List of Error

2.389. StoryInnerRelocationDragAndDropRequest

Field Name Required Type Description Format

databaseId

Object

team

String

The team parameter is used to set/get user team value when a Send to Production or a Drag and Drop operation is called.

options

DefaultConflictResolutionOptions

action

String

Action to perform (replace, add, insert). Used by targetListType = STORY_INNER_OBJECTS.

contentItemId

String

Content Item ID, Used by targetListType = STORY_INNER_OBJECTS.

placeHolderInsertInfo

String

Key of the place holder of the InsertInfo. Used by targetListType = STORY_INNER_OBJECTS.

contentItemRelativePos

BigDecimal

Position relative to the contentItemId. Used by targetListType = STORY_INNER_OBJECTS.

textPos

BigDecimal

Position into text. Used by targetListType = STORY_INNER_OBJECTS.

2.390. StoryUploadResponse

Field Name Required Type Description Format

story

ObjectInfo

attachments

List of AttachmentInfo

errors

List of Error

2.391. StyleSheet

Field Name Required Type Description Format

cssFile

String

cssSwing

String

name

String

default

Boolean

2.392. StyleSheetBean

Field Name Required Type Description Format

cssFile

String

cssSwing

String

name

String

default

Boolean

2.393. TaskCreateRequest

Field Name Required Type Description Format

attributes

Object

dueDate

Integer

It is a date in timestamp format (in seconds)

int32

channel

Object

assignees

List of [string]

priority

String

Enum: TASK_PRIORITY_LOW, TASK_PRIORITY_NORMAL, TASK_PRIORITY_HIGH,

customPriority

String

occupation

String

comment

String

author

String

workFolder

String

issueDate

String

template

String

options

FileSystemShowOptions

taskStatus

String

Enum: TASK_STATUS_NOT_STARTED, TASK_STATUS_IN_PROGRESS, TASK_STATUS_COMPLETED, TASK_STATUS_DEFERRED,

shape

String

databaseId

Object

name

X

String

contentType

X

String

attachment

Object

2.394. TaskInfo

Field Name Required Type Description Format

id

String

userId

String

assigned_to

PrincipalList

due_date

Integer

int32

completed_by

String

completed

Integer

int32

status

String

priority

String

comment

String

source_status_info

ObjectStatusInfo

referee

String

task_flags

Integer

int32

statusId

Integer

int32

priorityId

Integer

int32

dueDateStr

String

subject

String

2.395. TaskObjectInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

dueDate

Integer

int32

completedBy

String

completed

Integer

int32

status

String

priority

String

comment

String

referee

String

taskFlags

Integer

int32

statusId

Integer

int32

priorityId

Integer

int32

shape

String

shapePageLinked

String

assignees

List of [string]

correlated

List of CorrelationObjectInfo

attachments

List of ObjectInfo

topic

ObjectInfo

2.396. TaskObjectInfoDetails

Field Name Required Type Description Format

items

List of TaskObjectInfo

errors

List of Error

2.397. TaskObjectViewInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

dueDate

Integer

int32

completedBy

String

completed

Integer

int32

status

String

priority

String

comment

String

referee

String

taskFlags

Integer

int32

statusId

Integer

int32

priorityId

Integer

int32

shape

String

shapePageLinked

String

assignees

List of [string]

correlated

List of CorrelationObjectInfo

attachments

List of ObjectInfo

topic

ObjectInfo

fields

List of ObjectViewField

columns

List of ObjectViewField

2.398. TaskUpdateRequest

Field Name Required Type Description Format

taskStatus

Integer

task status (0 = NOT_STARTED, 1 = IN_PROGRESS, 2 = COMPLETED, 3 = DEFERRED)

int32

comment

String

comment

priority

Integer

priority(0=LOW, 1=NORMAL, 2=HIGH)

int32

dueDate

String

due date UTC, in the YYYYMMDDHHMMSS format

startDate

String

start date UTC, in the YYYYMMDDHHMMSS format

endDate

String

end date UTC, in the YYYYMMDDHHMMSS format

plannedEffort

Integer

planned effort, in seconds

int32

actualEffort

Integer

actual effort, in seconds

int32

completionPercentage

Integer

completion percentage

int32

attachedObjects

List of [object]

attachments

assignedTo

List of [string]

assignees (users or groups names)

2.399. TaskUpdateResponse

Field Name Required Type Description Format

taskStatus

ResultStatus

comment

ResultStatus

priority

ResultStatus

dueDate

ResultStatus

startDate

ResultStatus

endDate

ResultStatus

plannedEffort

ResultStatus

actualEffort

ResultStatus

completionPercentage

ResultStatus

attachedObjects

List of ResultStatus

assignedTo

List of ResultStatus

2.400. TempFileRequest

Field Name Required Type Description Format

filename

String

filename, if blank will be generate automatically

databaseId

Object

2.401. Template

Field Name Required Type Description Format

name

String

path

String

content

String

default

Boolean

2.402. TemplateBean

Field Name Required Type Description Format

name

String

templateContent

String

default

Boolean

templatePath

String

2.403. Token

Field Name Required Type Description Format

value

String

crypto

String

2.404. Topic

Field Name Required Type Description Format

info

ContainerObjectInfo

items

List of TopicItem

correlates

List of CorrelationObjectInfo

2.405. TopicAddRequest

Field Name Required Type Description Format

position

Integer

int32

options

FileSystemShowOptions

2.406. TopicCreateOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showPath

Boolean

shows the file system path in the response (default: false)

showUri

Boolean

shows the uri in the response (default: false)

checkIn

Boolean

specify if check-in should be invoked instead of performing a check_in action (default: true)

keepCheckedOut

Boolean

specify the value of keepCheckedOut parameter during check-in operation (default: false)

unlock

Boolean

if the option checkIn is set to false, this options dictates if the object is unlocked at the end of the operation (default: false)

newVersion

Boolean

if the option checkIn is set to true, specify the value of newVersion parameter (default: false)

createMode

String

specify the creation mode (default: EXCEPTION)

Enum: EXCEPTION, AUTO_RENAME, REPLACE, NEW_VERSION,

useDefaultProduct

Boolean

specify if default product should be used (default: true)

issueDateDefaultStrategy

String

specify how the IssueDate should be calculated: CALENDAR get the issue date from the default calendar, STANDING removes the issue date, NONE does nothing (default: NONE)

Enum: CALENDAR, STANDING, NONE,

timeSuffix

Boolean

specify if a time suffix should be added to the object name (default: false)

addContentItemsId

Boolean

add id in content item if it is not present (default: false)

generateTaskNames

Boolean

rename task within template incrementally using the topic name (default: false)

webType

WebTypeOptions

2.407. TopicCreateRequest

Field Name Required Type Description Format

channel

Object

issueDate

String

team

String

application

X

String

systemAttributes

Object

attributes

Object

status

String

format is Workflow/WorkFlowStep

statusComment

String

uniquenessString

String

name

X

String

databaseId

Object

workFolder

String

a workfolder

folder

String

a folder identifier (path, uuid or loid)

timestamp

Long

specify the timestamp to be used in usage ticket, if not specified current time is used

int64

uuid

String

the uuid to assign to the new object

options

ObjectCreateOptions

description

String

the topic summary

topicCreateOptions

TopicCreateOptions

2.408. TopicItem

Field Name Required Type Description Format

id

String

contentType

String

info

ContainerObjectInfo

attachment

Attachment

correlates

List of CorrelationObjectInfo

items

List of TopicSubItem

2.409. TopicItemAttachDragAndDropOptions

Field Name Required Type Description Format

replaceAttachedObject

Boolean

It replaces the attached object.

updateProductionInfoToTopicItem

Boolean

It sets the object's production info to TopicItem.

checkCompatibleType

Boolean

If true, it checks if the source object type is compatible with the target object type. True as default

2.410. TopicItemAttachRelocationDragAndDropRequest

Field Name Required Type Description Format

databaseId

Object

team

String

The team parameter is used to set/get user team value when a Send to Production or a Drag and Drop operation is called.

options

DefaultConflictResolutionOptions

showCorrelates

Boolean

shows correlated objects in the response (default: false)

showAttachment

Boolean

shows attached object in the response (default: true)

topic

X

Object

dragAndDropOptions

TopicItemAttachDragAndDropOptions

2.411. TopicItemCorrelateRelocationDragAndDropRequest

Field Name Required Type Description Format

databaseId

Object

team

String

The team parameter is used to set/get user team value when a Send to Production or a Drag and Drop operation is called.

options

DefaultConflictResolutionOptions

topic

X

Object

corrSourceLinkName

String

The link name from source object as a string.

corrTargetLinkName

String

The link that will be used on target object as a string.

corrComment

String

The comment associated with the correlated link.

2.412. TopicItemCorrelatesRelocationDragAndDropRequest

Field Name Required Type Description Format

databaseId

Object

team

String

The team parameter is used to set/get user team value when a Send to Production or a Drag and Drop operation is called.

options

DefaultConflictResolutionOptions

topic

X

Object

corrSourceLinkName

String

The link name from source object as a string.

corrTargetLinkName

String

The link that will be used on target object as a string.

corrComment

String

The comment associated with the correlated link.

sources

X

List of [string]

list of sources (loid, uuid or path)

2.413. TopicItemCreateRequest

Field Name Required Type Description Format

attributes

Object

dueDate

Integer

It is a date in timestamp format (in seconds)

int32

channel

Object

assignees

List of [string]

priority

String

Enum: TASK_PRIORITY_LOW, TASK_PRIORITY_NORMAL, TASK_PRIORITY_HIGH,

customPriority

String

occupation

String

comment

String

author

String

workFolder

String

issueDate

String

template

String

options

FileSystemShowOptions

taskStatus

String

Enum: TASK_STATUS_NOT_STARTED, TASK_STATUS_IN_PROGRESS, TASK_STATUS_COMPLETED, TASK_STATUS_DEFERRED,

shape

String

databaseId

Object

name

X

String

contentType

X

String

position

Integer

int32

attachment

Object

2.414. TopicItemMove

Field Name Required Type Description Format

id

String

the topic identifier (path, uuid or loid)

virtualId

X

String

items

List of TopicSubItemMove

2.415. TopicItemObjectInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

path

String

uri

String

lastVersionModificationTime

Long

last content modification time

int64

lastVersionModifier

String

last user that modified the content

virtualId

String

contentError

Boolean

dueDate

Integer

int32

occupation

String

comment

String

assignees

List of [string]

priority

String

Enum: TASK_PRIORITY_LOW, TASK_PRIORITY_NORMAL, TASK_PRIORITY_HIGH,

customPriority

String

shape

String

shapePageLinked

String

taskFlags

Integer

int32

referee

String

status

String

completedBy

String

completed

Integer

int32

sourceStatusName

String

sourceStatusIdentifier

String

2.416. TopicItemUpdateRequest

Field Name Required Type Description Format

attributes

Object

dueDate

Integer

It is a date in timestamp format (in seconds)

int32

channel

Object

assignees

List of [string]

priority

String

Enum: TASK_PRIORITY_LOW, TASK_PRIORITY_NORMAL, TASK_PRIORITY_HIGH,

customPriority

String

occupation

String

comment

String

author

String

workFolder

String

issueDate

String

template

String

options

FileSystemShowOptions

taskStatus

String

Enum: TASK_STATUS_NOT_STARTED, TASK_STATUS_IN_PROGRESS, TASK_STATUS_COMPLETED, TASK_STATUS_DEFERRED,

shape

String

name

String

contentType

String

2.417. TopicList

Field Name Required Type Description Format

items

List of Topic

2.418. TopicMove

Field Name Required Type Description Format

id

X

String

the topic identifier (path, uuid or loid)

items

List of TopicItemMove

2.419. TopicMoveOperation

Field Name Required Type Description Format

id

String

the moved object identifier (path, uuid or loid)

virtualId

X

String

from

X

String

the source object identifier (path, uuid or loid)

to

X

String

the target object identifier (path, uuid or loid)

2.420. TopicMoveRequest

Field Name Required Type Description Format

topicPlan

TopicPlanMove

topics

X

List of TopicMove

operations

List of TopicMoveOperation

2.421. TopicMoveResponse

Field Name Required Type Description Format

topicPlan

TopicPlanMove

topics

List of TopicMove

2.422. TopicPlan

Field Name Required Type Description Format

info

ContainerObjectInfo

items

List of Topic

2.423. TopicPlanCreateRequest

Field Name Required Type Description Format

channel

Object

issueDate

String

team

String

application

X

String

systemAttributes

Object

attributes

Object

status

String

format is Workflow/WorkFlowStep

statusComment

String

uniquenessString

String

name

X

String

databaseId

Object

workFolder

String

a workfolder

folder

String

a folder identifier (path, uuid or loid)

timestamp

Long

specify the timestamp to be used in usage ticket, if not specified current time is used

int64

uuid

String

the uuid to assign to the new object

options

ObjectCreateOptions

type

String

topicPlanCreateOptions

TopicCreateOptions

2.424. TopicPlanItemMove

Field Name Required Type Description Format

id

String

the topic identifier (path, uuid or loid), not required if it's a divider

virtualId

X

String

2.425. TopicPlanMove

Field Name Required Type Description Format

id

X

String

the topic plan identifier (path, uuid or loid)

items

List of TopicPlanItemMove

2.426. TopicSubItem

Field Name Required Type Description Format

id

String

contentType

String

info

ContainerObjectInfo

attachment

Attachment

correlates

List of CorrelationObjectInfo

items

List of TopicSubItem

2.427. TopicSubItemMove

Field Name Required Type Description Format

id

String

the topic identifier (path, uuid or loid)

virtualId

X

String

2.428. TopicUpdateRequest

Field Name Required Type Description Format

renameIfDuplicatedName

Boolean

if the topic already exists , specify if must to be renamed(false as default).

title

String

description

String

issueDate

String

2.429. UncorrelateRequest

Field Name Required Type Description Format

correlated

X

List of CorrelatedBean

correlated objects

2.430. UncorrelateResponse

Field Name Required Type Description Format

successCount

Integer

int32

uncorrelated

List of ResultStatus

2.431. UpdateDividerRequest

Field Name Required Type Description Format

name

String

the divider name.

color

String

the divider color in hexadecimal form (ff0000).

2.432. UpdatedBean

Field Name Required Type Description Format

source

X

String

an object identifier (path, uuid or loid)

ucount

X

Long

int64

2.433. User

Field Name Required Type Description Format

id

Object

name

String

fullName

String

description

String

databaseId

String

ucount

Integer

int32

lastLoggedOn

Integer

int32

homePath

String

disabled

Boolean

role

String

twitter

String

facebook

String

phoneNumber

String

mobileNumber

String

statusMessage

String

workDir

String

location

String

initials

String

signature

String

siteconfig

String

status

String

homeEmail

String

businessEmail

String

relevance

Integer

int32

configFolder

String

groupConfigFolder

String

systemUser

Boolean

defaultTeam

String

userSecurity

String

calendars

List of Calendar

groups

List of [string]

systemAttributesXml

String

attributesXml

String

virtualAttributesXml

String

externalId

String

2.434. UserConfigurationOptions

Field Name Required Type Description Format

raw

Boolean

raw or resolved file in response (default: false)

showDtd

Boolean

boolean value to choose whether to get inline dtd within an XML document (default: false)

showJson

Boolean

xml configuration file will be converted in json format (default: false)

2.435. UserConfigurationRequest

Field Name Required Type Description Format

databaseId

Object

files

X

List of [string]

options

UserConfigurationOptions

2.436. UserCreateRequest

Field Name Required Type Description Format

databaseId

Object

name

X

String

user name

attributesXml

String

xml attributes

systemAttributesXml

String

xml system attributes

description

String

description

fullName

String

full name

homePath

String

home folder path

disabled

Boolean

if true the user will be created disabled. Default value false

password

String

password to set to the user

groups

List of [string]

groups to set to the user

options

UserOptions

2.437. UserCreateResponse

Field Name Required Type Description Format

user

UserObjectInfo

errors

List of UserError

2.438. UserDeleteBaseRequest

Field Name Required Type Description Format

userName

X

String

The name of the user to be deleted.

2.439. UserDeleteRequest

Field Name Required Type Description Format

userName

X

String

The name of the user to be deleted.

databaseId

Object

2.440. UserError

Field Name Required Type Description Format

code

String

message

String

field

String

2.441. UserExternalId

Field Name Required Type Description Format

id

String

name

X

String

The user name.

extid

String

The user external id. This field is required only when setting the user external id.

2.442. UserExternalIdRequest

Field Name Required Type Description Format

databaseId

Object

userExternalId

X

UserExternalId

2.443. UserExternalIdResponse

Field Name Required Type Description Format

userExternalId

UserExternalId

errors

List of UserError

2.444. UserGroupsUpdateRequest

Field Name Required Type Description Format

databaseId

Object

addedGroups

List of [string]

groups to set to the user

removedGroups

List of [string]

groups to remove to the user

options

UserOptions

2.445. UserObjectInfo

Field Name Required Type Description Format

id

String

an object identifier (path, uuid or loid)

type

String

pstate

PersistentState

uniquenessString

String

version

String

name

String

description

String

owner

String

creator

String

ownerTeam

String

creatorTeam

String

created

Long

int64

lastModifier

String

modified

Long

int64

locker

String

locked

Long

int64

size

Long

int64

statusInfo

StatusInfo

workFolder

String

channel

Object

product

String

issueDate

String

edition

String

systemAttributes

Object

systemAttributesXml

String

attributes

Object

attributesXml

String

usageTicket

Object

usageTicketXml

String

virtualAttributes

Object

virtualAttributesXml

String

interfaceId

String

databaseId

Object

minimalInfo

Boolean

permissions

Integer

int32

webType

String

homePath

String

fullName

String

lastLoggedOn

Integer

int32

disabled

Boolean

workPath

String

groups

List of ObjectInfo

userSecurity

String

defaultTeam

String

2.446. UserOptions

Field Name Required Type Description Format

showAdditionalInfo

Boolean

shows additional information in the response (default: false)

showSystemAttributes

Boolean

shows the system attributes in the response (default: true)

showAttributes

Boolean

shows the attributes in the response (default: true)

showUsageTickets

Boolean

shows the usage tickets in the response (default: true)

showVirtualAttributes

Boolean

shows the virtual attributes in the response (default: true)

showXml

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in xml format if their are shown in the response (default: false)

useUnparsedXml

Boolean

do not parse/serialize XML if 'showXml' is true (default: false)

showJson

Boolean

shows system attributes, attributes, usage tickets and virtual attributes in Json format if their are shown in the response (default: true)

showUniquenessString

Boolean

shows Uniqueness string (default: false)

showGroups

Boolean

shows user's groups information in the response (default: false)

databaseId

Object

webType

WebTypeOptions

2.447. UserUpdateResponse

Field Name Required Type Description Format

userError

List of UserError

user

ObjectInfo

2.448. VersionInfo

Field Name Required Type Description Format

action

String

comment

String

defaultFormat

String

objectInfo

ObjectInfo

number

Integer

int32

versionWorkflowHistory

List of VersionWorkflowBean

2.449. VersionInfoAndContent

Field Name Required Type Description Format

action

String

comment

String

defaultFormat

String

objectInfo

ObjectInfo

number

Integer

int32

versionWorkflowHistory

List of VersionWorkflowBean

lastStatusInfo

StatusInfo

content

String

2.450. VersionWorkflowBean

Field Name Required Type Description Format

creator

String

workflow

String

identifier

String

timestamp

Integer

int32

2.451. WebChannelCopyRequest

Field Name Required Type Description Format

channel

X

Object

options

StoryCreateOptions

2.452. WebTypeOptions

Field Name Required Type Description Format

showWebType

Boolean

webProduct

String

2.453. Workflow

Field Name Required Type Description Format

id

Object

databaseId

String

name

String

infoName

String

steps

List of WorkflowStepInfoBean

systemAttributes

String

2.454. WorkflowStepInfoBean

Field Name Required Type Description Format

color

String

workflowName

String

name

String

description

String

disable

Boolean

disableReasons

List of [string]

2.455. WorkflowStepListBean

Field Name Required Type Description Format

info

ObjectListInfoBean

steps

List of WorkflowStepInfoBean

2.456. WorkflowStepsRequest

Field Name Required Type Description Format

workflowId

String

a workflow identifier ([DBID$]LOID)

objects

List of [string]

list of objects (loid, uuid or path) the worflow must be evaluated for

common

Boolean

list common steps only (true) or list all steps (false, default)

info

Boolean

return an object (true) or not (false, default)

2.457. XslTransformRequest

Field Name Required Type Description Format

databaseId

Object

encoding

X

String

encoding to use

xml

X

String

xml to transform

xslPath

X

String

xsl path

xslTransformerClass

String

xsl transformer class