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