The Application-Layer REST API documentation

This document describes the REST API and resources provided by the Application-Layer server. The REST APIs are for developers who want to integrate the Application-Layer into their application and for administrators who want to script interactions with the Application-Layer server.

The Application-Layer REST APIs provide access to resources via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is XML or JSON. Some resources provide the formats atom or html. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE.

Because the REST API is based on open standards, you can use any web development language to access the API.

image

Getting started

URIs for a Application-Layer REST API resource have the following structure:

http(s)://host:port/nscalealinst1/rest/service/resource-name

Port
Number Description
8080 for unsecure http port
8443 for secure https port
Instance
Name Description
nscalealinst1 the default application-layer instance
anyname a secondary logical instance
Core Services
Name Description
authoritymanagement Interface to provide the authority management functionality
configuration Interface to provide the configuration functionality
masterdata Interface to provide the masterdata functionality
messaging Interface to provide the messaging functionality
repository Interface to provide the repository functionality
usermanagement Interface to provide the user management functionality
workflow Interface to provide the workflow functionality

REST URIs

This following documention is automatically generated.
Base REST URI: http://hostname:8080/nscalealinst1/rest

Resources

/authoritymanagement/roles

Resource for roles in the application layer. You can get system or document-area roles.

Methods

GET

Get system roles.

available response representations:

/authoritymanagement/roles/docarea/{docarea}/name/{name}

Resource for roles in the application layer. You can get system or document-area roles.

resource-wide template parameters
parameter value description

name

string

the name of the role

docarea

string

the name of the document area

Methods

GET

Get a role with a specific name for a specific document area.

available response representations:

/authoritymanagement/roles/docarea/{docarea}/principal/{id}

Resource for roles in the application layer. You can get system or document-area roles.

resource-wide template parameters
parameter value description

id

string

the id of a principal

docarea

string

the name of the document area

Methods

GET

Get the roles of a specific document area and a specific user.

available response representations:

/authoritymanagement/roles/docarea/{docarea}

Resource for roles in the application layer. You can get system or document-area roles.

resource-wide template parameters
parameter value description

docarea

string

list of docarea roles

Methods

GET

Get the roles of a specific document area.

available response representations:

/collaboration/calendars?query

Methods

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

POST

acceptable request representations:

available response representations:

/collaboration/calendars//detect/{id}

resource-wide template parameters
parameter value description

id

string

Methods

PUT

/collaboration/calendars/propdefs/name/{name}

resource-wide template parameters
parameter value description

name

string

Methods

/collaboration/calendars/ics?query

Methods

GET

request query parameters
parameter value description

query

string

available response representations:

/collaboration/calendars/uid/{uid}

resource-wide template parameters
parameter value description

uid

string

Methods

GET

available response representations:

DELETE

/collaboration/calendars/id/{id}

resource-wide template parameters
parameter value description

id

string

Methods

GET

available response representations:

GET

available response representations:

DELETE

/collaboration/calendars/propdefs

Methods

/collaboration/calendars/aggregate?query

Methods

GET

request query parameters
parameter value description

query

string

available response representations:

/collaboration/teamspaces

Methods

GET

Gets teamspace group ids of current user, that is all teamspace groups which are active and where the current user is member of.

available response representations:

POST

Creates a group which acts as a teamspace and adds the creator to the group if the creator belongs to the domain of the teamspace. A teamspace group can be used to share resources for all users of the group by using the principal folder of the group.
When the creator of the group belongs to the domain of the group he also automatically gets competence LocalGroupAdmin for the teamspace group, so he can add and remove members and add and remove competences from/to the teamspace group. Note however, that membership as well as permissions need a relogin to take effect.

Required permissions: TeamspaceAdmin on domain of created teamspace group.

acceptable request representations:

available response representations:

/collaboration/teamspaces/domain/{domain}

resource-wide template parameters
parameter value description

domain

string

the name of the domain

Methods

GET

Gets available teamspace group ids of given domain. Available are all teamspace groups where the current user is member of or has LocalGroupAdmin competences for. Also, for a TeamspaceAdmin, all teamspace groups are available.

available response representations:

/collaboration/teamspaces/id/{id}

resource-wide template parameters
parameter value description

id

string

Methods

GET

Gets the teamspace with given id.

available response representations:

DELETE

Drops teamspace group with given id, which means, all members are removed from this group except current user, the group is set inactive and no longer marked as teamspace group.

PUT

Updates a teamspace group. The display name will be transferred to the personal (group) folder.

Required permissions: TeamspaceAdmin on domain of created teamspace group or competence LocalGroupAdmin for the group.

acceptable request representations:

/collaboration/teamspaces/id/{id}/groupadmin

resource-wide template parameters
parameter value description

id

string

the teamspace id

Methods

POST

Adds the teamspace admin competences to a specified organizational positions.

acceptable request representations:

DELETE

Removes the teamspace admin competences from specified organizational positions.

acceptable request representations:

/collaboration/teamspaces/docarea/{docarea}

resource-wide template parameters
parameter value description

docarea

string

the name document area

Methods

GET

Gets the resource keys of all principal folders of teamspace groups of current user which belong to given document area, that is all teamspace groups which are active and where the current user is member of.

available response representations:

/configuration/commonsetting

Methods

/configuration/dictionary?locales

Methods

GET

Gets the superposed dictionary of specified languages. The last list entry specifies the locale of the dictionary.

Example query parameter: locales=en_US,de

request query parameters
parameter value description

locales

string

list of locale names (f.e. en_US,de )

response header parameters
parameter value description

Last-Modified

string

Modification date.

available response representations:

/configuration/docarea/{docarea}/fulltextsetting

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Gets document area-specific fulltext configuration for specified document area.

response header parameters
parameter value description

Last-Modified

string

Modification date.

available response representations:

/configuration/docarea/{docarea}/layoutnames

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Gets a list of mapped layout-names from all available workflow process definitions contained by the specified document area.

available response representations:

/configuration/docarea/{docarea}/layoutnames/name/{name}

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

name

string

unique name of the workflow process definition

docarea

string

the name of the document area

Methods

GET

Get mapped layout-name from given process definition name.

available response representations:

/configuration/docarea/{docarea}/layouts

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Gets a list of all available layouts contained by the specified document area.

available response representations:

/configuration/docarea/{docarea}/layouts/name/{name}/clienttype/{clienttype}/layouttype/{layouttype}

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

clienttype

string

client type

name

string

area-wide unique name

docarea

string

the name of the document area

layouttype

string

layout type

Methods

GET

Gets a layout specified by a layout name, a client type (Cockpit, Web,...) and the layout type.

response header parameters
parameter value description

Last-Modified

string

Modification date.

available response representations:

/configuration/docarea/{docarea}/masterdatascopes

resource-wide template parameters
parameter value description

docarea

string

the areaname

Methods

GET

Gets the masterdata scope specified by its name and the name of the document area the masterdata scope belongs to.

Required permissions: none.

available response representations:

/configuration/docarea/{docarea}/masterdatascopes/scope/{scope}

resource-wide template parameters
parameter value description

docarea

string

the areaname

scope

string

the masterdata scope name

docarea

string

the areaname

Methods

GET

Gets the masterdata scope specified by its name and the name of the document area the masterdata scope belongs to.

available response representations:

/configuration/docarea/{docarea}/objectclasses

resource-wide template parameters
parameter value description

docarea

string

name of a valid document area

Methods

GET

Gets an object class specified by name.

available response representations:

/configuration/docarea/{docarea}/objectclasses/name/{name}

resource-wide template parameters
parameter value description

docarea

string

name of a valid document area

name

string

the name of the object class as ObjectclassName

docarea

string

name of a valid document area

Methods

GET

Gets all object classes contained by the specified document area.

available response representations:

/configuration/docarea/{docarea}/processdefinitions?evaluatestart

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Retrieves the names of all available processes. The optional parameter 'evaluatestart' is used to check whether the current principal has start permissions for a process. If not, the process won't be listed in the result.

request query parameters
parameter value description

evaluatestart

boolean

Default: false

optional parameter, used to verify start permissions for every process; possible values are "true" (start permissions will be evaluated) or "false" ( start permissions won't be evaluated / works as default )

available response representations:

/configuration/docarea/{docarea}/processdefinitions/mobile?evaluatestart

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

the name of the document area

Methods

GET

Retrieves the names of all processes with a mobile layout configured.

request query parameters
parameter value description

evaluatestart

boolean

Default: false

optional parameter, used to verify start permissions for every process; possible values are "true" (start permissions will be evaluated) or "false" (default / start permissions won't be evaluated)

available response representations:

/configuration/docarea/{docarea}/processdefinitions/metadata

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Retrieves the metadata for all available processes.

available response representations:

/configuration/docarea/{docarea}/processdefinitions/metadata/mobile

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

the name of the document area

Methods

GET

Retrieve the metadata for all processes with a mobile layout configured.

available response representations:

/configuration/docarea/{docarea}/processdefinitions/metadata/processdefinition/{name}

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

name

string

the name of the process whose metadata shall be retrieved

docarea

string

the name of the document area

Methods

GET

Retrieves the metadata for a specific process identified by its name.

available response representations:

/configuration/docarea/{docarea}/propertydefinitions

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Gets a list of all available property definitions contained by the specified document area.

available response representations:

/configuration/docarea/{docarea}/propertydefinitions/masterdata

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

the name of the document area

Methods

GET

Gets a list of all available masterdata property definitions contained by all masterdata scopes of the specified document area.

available response representations:

/configuration/docarea/{docarea}/propertydefinitions/indexing?usagecategory

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

Methods

GET

Gets a list of all available indexing property definitions contained by the specified document area.

request query parameters
parameter value description

usagecategory

string

available response representations:

/configuration/docarea/{docarea}/propertydefinitions/computed?usagecategory

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

Methods

GET

Gets a list of all available computed indexing property definitions contained by the specified document area.

request query parameters
parameter value description

usagecategory

string

available response representations:

/configuration/docarea/{docarea}/propertydefinitions/formatted

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

the name of the requested document area

Methods

GET

Gets a list of all available formatted indexing property definitions contained by the specified document area.

available response representations:

/configuration/docarea/{docarea}/propertydefinitions/fulltext

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

the name of the document area

Methods

GET

Gets all property definitions for fulltext for the specified document area.

available response representations:

/configuration/docarea/{docarea}/propertydefinitions/name/{name}

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

name

string

docarea

string

Methods

GET

available response representations:

/configuration/docarea/{docarea}/valuesets

resource-wide template parameters
parameter value description

docarea

string

the document areaname

Methods

GET

Gets a value set specified by a value set name.

Required permissions: none.

available response representations:

/configuration/docarea/{docarea}/valuesets/name/{name}

resource-wide template parameters
parameter value description

docarea

string

the document areaname

name

string

name of value set

docarea

string

Methods

GET

Gets a value set specified by a value set name.

Required permissions: none.

available response representations:

/configuration/docarea/{docarea}/workflowstarttemplates?associated

resource-wide template parameters
parameter value description

docarea

string

name of considered document area

Methods

GET

Gets a list of all workflow start templates which have been configured in given document area.

request query parameters
parameter value description

associated

string

show only the workflow start templates associated to the current user

available response representations:

/configuration/globalclientsetting

Methods

GET

Gets all global client settings, stored in application layer.

available response representations:

POST

Adds new global client settings.

acceptable request representations:

PUT

Update existing global client settings.

acceptable request representations:

DELETE

Deletes list of global client settings.

acceptable request representations:

/configuration/globalclientsetting/{id}

resource-wide template parameters
parameter value description

id

string

Methods

GET

Gets the global client setting identified by clientId.

available response representations:

GET

Gets the global client setting identified by clientId as plain text.

available response representations:

POST

Adds global client setting by given id. The value is plain text.

acceptable request representations:

PUT

Updates global client setting by given id. The value is plain text.

acceptable request representations:

DELETE

Deletes global client setting by given id.

/configuration/sysinfo

Get system informations. SystemInfo datatype schema:

Methods

GET

Get system informations as plain text.

available response representations:

GET

Get system informations.

available response representations:

/ical/{docarea}?cmd

resource-wide template parameters
parameter value description

docarea

string

Methods

GET

request query parameters
parameter value description

cmd

string

available response representations:

/login?appid

The login resource for the Application Layer server. Not really required. Every REST call requires HTTP authentication.

Supported HTTP authentications:

Useful for debugging reasons, a failed login request will send a response with debugging message.

Methods

GET

Login method for Application Layer server.

request query parameters
parameter value description

appid

string

optional: client App-ID

available response representations:

GET

Login method for Application Layer server.

request query parameters
parameter value description

appid

string

optional: client App-ID

available response representations:

GET

Login method for Application Layer server.

Alternative this method can be used to retrieve information about an authenticated principal.

request query parameters
parameter value description

appid

string

optional: client App-ID

available response representations:

/login/loginform

The login resource for the Application Layer server. Not really required. Every REST call requires HTTP authentication.

Supported HTTP authentications:

Useful for debugging reasons, a failed login request will send a response with debugging message.

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

/logout

The logout resource for the Application Layer server. Destroys the session object.

For simple clients like cURL, you can use the query parameter 'autoclose' to destroy the session.

Methods

GET

Logout from Application Layer. Destroy session object.

available response representations:

GET

Logout from Application Layer. Destroy session object.

available response representations:

GET

Logout from Application Layer. Destroy session object.

available response representations:

/masterdata/docarea/{docarea}/scope/{scope}

resource-wide template parameters
parameter value description

scope

string

the name of the masterdata scope

docarea

string

the name of the document area

Methods

POST

Adds a new entry to the specified masterdata scope with given properties. This method required an auto-generated masterdata key. Note that the masterdata scope must permit writing access in order that the call succeeds.

acceptable request representations:

available response representations:

GET

Performs a masterdata search. The specified query defines the results.

request query parameters
parameter value description

query

string

nql-query

available response representations:

/masterdata/docarea/{docarea}/scope/{scope}/id/{id}

resource-wide template parameters
parameter value description

scope

string

the name of the masterdata scope

docarea

string

the name of the document area

scope

string

the name of the masterdate scope

id

string

the id of the primary key

docarea

string

the name of the document area

Methods

HEAD

Checks if the specified masterdata entry exists.

available response representations:

POST

Adds masterdata properties with the specified masterdata key. Note that the masterdata scope must permit writing access in order that the call succeeds.

acceptable request representations:

available response representations:

PUT

Updates the masterdata entry specified by its key with given properties. Note that the masterdata scope must permit writing access in order that the call succeeds.

acceptable request representations:

GET

Gets the specified properties of the masterdata entry specified by its key.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned (otherwise all properties)

available response representations:

DELETE

Deletes the masterdata entry specified by its key. Note that the masterdata scope must permit writing access in order that the call succeeds.

/masterdata/docarea/{docarea}/scope/{scope}/aggregate?query

resource-wide template parameters
parameter value description

scope

string

the name of the masterdata scope

docarea

string

the name of the document area

scope

string

docarea

string

Methods

GET

request query parameters
parameter value description

query

string

available response representations:

/messaging/docarea/{docarea}/messages?type &agent &linktypes

Add, edit or delete subscriptions. This class is only a pre-release version, not officially released.

resource-wide template parameters
parameter value description

docarea

string

Methods

GET

Gets feed for given area name. Retrieves the subscribed repository resource of the current user.

request query parameters
parameter value description

type

string

agent

string

linktypes

string

available response representations:

GET

request query parameters
parameter value description

type

string

available response representations:

/messaging/docarea/{docarea}/settings

Get, update or delete personal settings for the messaging (rss) service.

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Retrieves the personal common message settings.

available response representations:

PUT

Sets a new common message setting for the signed in user.

acceptable request representations:

DELETE

Deletes the personal common message setting. If the personal common message setting is deleted the global common message settings are used.

acceptable request representations:

/messaging/docarea/{docarea}/settings/workflow

Get, update or delete personal settings for the messaging (rss) service.

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

the name of the document area

Methods

GET

Retrieves the personal workflow message setting.

available response representations:

PUT

Sets a new workflow message setting for the signed in user.

acceptable request representations:

DELETE

Deletes the personal workflow message setting. If the personal workflow message setting is deleted the global workflow message settings are used.

/messaging/docarea/{docarea}/settings/resource

Get, update or delete personal settings for the messaging (rss) service.

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

the name of the document area

Methods

GET

Retrieves the personal resource message setting.

available response representations:

PUT

Sets a new resource message setting for the signed in user.

acceptable request representations:

DELETE

Deletes the personal resource message setting. If the personal resource message setting is deleted the global resource message settings are used.

/messaging/docarea/{docarea}/subscription/resource?properties

Add, edit or delete repository resource subscriptions. This class is only a pre-release version, not officially released.

resource-wide template parameters
parameter value description

docarea

string

Methods

GET

Retrieves the subscribed repository resource of the current user.

request query parameters
parameter value description

properties

string

optional query parameter, see the rss manual for further information

available response representations:

GET

Retrieves the subscribed repository resource of the current user.

request query parameters
parameter value description

properties

string

available response representations:

/messaging/docarea/{docarea}/subscription/resource/{id}

Add, edit or delete repository resource subscriptions. This class is only a pre-release version, not officially released.

resource-wide template parameters
parameter value description

docarea

string

id

string

resource id of the resource, that shall be unsubscribed

docarea

string

the name of the document area

Methods

PUT

Adds repository resources to the subscription of the current user.

DELETE

Removes repository resources from the subscription of the current user.

/messaging/docarea/{docarea}/subscription/workflowinstance

Add, edit or delete repository resource subscriptions. This class is only a pre-release version, not officially released.

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Retrieves the subscribed workflows of the current user.

available response representations:

/messaging/docarea/{docarea}/subscription/workflowinstance/{id}

Add, edit or delete repository resource subscriptions. This class is only a pre-release version, not officially released.

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

id

string

the workflow instance id of the workflow, that shall be added

docarea

string

the name of the document area

Methods

DELETE

Removes workflows from the subscription of the current user.

PUT

Adds workflows to the subscription of the current user.

/messaging/messages?type

Methods

GET

Retrieves document area independent messages.

request query parameters
parameter value description

type

string

available response representations:

GET

Retrieves document area independent messages as an atom feed.

request query parameters
parameter value description

type

string

agent

string

linktypes

string

available response representations:

/messaging/settings

Get, update or delete personal settings for document area independent messages.

Methods

GET

Retrieves the personal, document area independent common message settings.

available response representations:

PUT

Sets a new document area independent common message setting for the signed in user.

acceptable request representations:

DELETE

Deletes the personal, document area independent common message setting. If the personal common message setting is deleted the global common message settings are used.

acceptable request representations:

/messaging/settings/principal

Get, update or delete personal settings for document area independent messages.

Methods

GET

Retrieves the personal principal message settings.

available response representations:

PUT

Sets a new principal message setting for the signed in user.

acceptable request representations:

DELETE

Deletes the principal message setting. If the principal message setting is deleted the global principal message settings are used.

acceptable request representations:

/messaging/subscription/principal

Add and remove principal subscriptions.

Methods

PUT

Establishes a subscription for the caller. Repository-, Workflow- and Collaboration-Messages will be fetched.

DELETE

Removes the subscription of the caller.

/monitoring/connectedusers

URI to handle connected users.

Methods

GET

Gets information about the currently connected users.

Required permissions: MonitoringAdmin.

available response representations:

GET

Gets information about the currently connected users.

Required permissions: MonitoringAdmin.

available response representations:

/monitoring/connectedusers/invalidate?reason &sessioncache

URI to handle connected users.

Methods

PUT

Invalidates the session with given id, which means given session throws an error when it is used furthermore. Note that using this method is an inappropriate try to reduce the session cache as an invalidated session still is part of the session cache (it is automatically removed not before about 12 hours later). The method returns the ids of sessions which were successfully invalidated.

request query parameters
parameter value description

reason

string

sessioncache

boolean

acceptable request representations:

available response representations:

PUT

Invalidates the session with given id, which means given session throws an error when it is used furthermore. Note that using this method is an inappropriate try to reduce the session cache as an invalidated session still is part of the session cache (it is automatically removed not before about 12 hours later). The method returns the ids of sessions which were successfully invalidated.

request query parameters
parameter value description

reason

string

sessioncache

boolean

acceptable request representations:

available response representations:

/monitoring/connectedusers/{id}

URI to handle connected users.

resource-wide template parameters
parameter value description

id

int

Methods

DELETE

Invalidates the session with given id, which means given session throws an error when it is used furthermore. Note that using this method is an inappropriate try to reduce the session cache as an invalidated session still is part of the session cache (it is automatically removed not before about 12 hours later). The method returns 200 if the session was successfully invalidated, else 404 (e.g. because a session with given id does not exist).

available response representations:

/monitoring/invokemethod/{method}

resource-wide template parameters
parameter value description

method

string

Methods

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

PUT

acceptable request representations:

available response representations:

/overview

Simple HTML represented overview esource.

Methods

GET

Gets an overview of important nscale services.

available response representations:

/repository/doc/{id}?properties

URI to get, update and delete properties of one document.

resource-wide template parameters
parameter value description

id

string

resource id of the document

Methods

GET

Retrieves a specific set of properties for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

GET

Retrieves a specific set of properties for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

GET

Retrieves a specific set of properties for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

PUT

Update document properties. The property objectclass can be changed only if the list contains only one element.

acceptable request representations:

PUT

Updates the properties *and* the content of a specific resource.

The first multipart entry must be documentmetadata (application/xml or application/json). The second multipart entry (or n entries for multi-content items) is the content of the document.

acceptable request representations:

DELETE

Delete folder.

/repository/doc/{id}/publish?duration

URI to get, update and delete properties of one document.

resource-wide template parameters
parameter value description

id

string

resource id of the document

id

string

the document resource id

Methods

POST

Publishes the content of the document identified by given document key. The generated uuid allows users to read the content of the document without validating any permissions. The access is restricted to the given duration, specified in hours.

request query parameters
parameter value description

duration

int

Default: 168

time in hours

acceptable request representations:

available response representations:

POST

Publishes the content of the document identified by given document key. The generated uuid allows users to read the content of the document without validating any permissions. The access is restricted to the given duration, specified in hours.

acceptable request representations:

available response representations:

/repository/doc/{id}/content

Representation of one content item of a document.

resource-wide template parameters
parameter value description

id

string

id of the requested contentitem

Methods

PUT

Updates the text content resource.

request header parameters
parameter value description

Content-Type

string

GET

Retrieve content (as single document, or zip for multipart/mixed

available response representations:

/repository/doc/{id}/contentitem/{index}

Representation of one content item of a document.

resource-wide template parameters
parameter value description

index

int

id

string

Methods

HEAD

Get metadata of extended content stream.

response header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

Content-Type

string

Content type.

Content-Length

long

Content length of content item.

Last-Modified

string

Modification date.

available response representations:

GET

Get the whole extended content of any kind of resource in the repository.

request query parameters
parameter value description

showError

boolean

useContentLength

boolean

response header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

Content-Type

string

Content type.

Last-Modified

string

Modification date.

available response representations:

/repository/doc/{id}/contentitems

Representation of the content items of a document.

resource-wide template parameters
parameter value description

id

string

resource id of the document

Methods

GET

Retrieves the extended content metadata of the requested resource. Also includes the metadatas of the extended content items of this extended content metadata.

available response representations:

GET

Retrieves the extended content metadata of the requested resource. Also includes the metadatas of the extended content items of this extended content metadata.

available response representations:

GET

Retrieves the extended content metadata of the requested resource. Also includes the metadatas of the extended content items of this extended content metadata.

available response representations:

PUT

Updates the extended content of a specific resource.

acceptable request representations:

/repository/doc/{id}/extensions/{type}?properties

Representation of extensions types of a document.

resource-wide template parameters
parameter value description

id

string

type

string

Methods

GET

Retrieves all extensions of given type for the requested resource. An extension can be an annotation, a note, a rendition or a virtual rendition. Notes can be retrieved for folders, documents or links. Annotations, renditions or virtual renditions can be retrieved for documents.

request query parameters
parameter value description

properties

string

properties to be retrieved for the extensions

available response representations:

GET

Retrieves all extensions of given type for the requested resource. An extension can be an annotation, a note, a rendition or a virtual rendition. Notes can be retrieved for folders, documents or links. Annotations, renditions or virtual renditions can be retrieved for documents.

request query parameters
parameter value description

properties

string

properties to be retrieved for the extensions

available response representations:

GET

Retrieves all extensions of given type for the requested resource. An extension can be an annotation, a note, a rendition or a virtual rendition. Notes can be retrieved for folders, documents or links. Annotations, renditions or virtual renditions can be retrieved for documents.

request query parameters
parameter value description

properties

string

properties to be retrieved for the extensions

available response representations:

POST

Creates an extension of given type. An extension can be an annotation, a note, or a rendition. Notes can be created for folders, documents or links. Annotations or renditions can be created for documents.

acceptable request representations:

response header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

available response representations:

PUT

Create or update text content of extension. Only notes are supported here.

acceptable request representations:

available response representations:

/repository/doc/{id}/thumbnail?create

Thumbnail rendition.

resource-wide template parameters
parameter value description

id

string

resource id of the requested resource

Methods

GET

Gets the thumbnail renditions for specified document and optionally creates one, if none exists.

request query parameters
parameter value description

create

boolean

indication whether to create a thumbnail rendition if none exists

available response representations:

/repository/doc/{id}/versions?properties

Retrieves the version history of a specific document. The list entries are sorted chronologically which means the first version is the first entry in the list. This method allows to specify which properties are to be returned.

resource-wide template parameters
parameter value description

id

string

resource id of requested document

Methods

GET

Gets version history of a specific document.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

GET

Gets version history of a specific document.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

GET

Gets version history of a specific document.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

/repository/docarea/{docarea}/personal

Resource for personal/private folder.

resource-wide template parameters
parameter value description

docarea

string

the name of a document area

Methods

GET

Retrieves the personal/private folder of current user in given document area. The access on a principal folder and its content is restricted to its owner, so it can be used to store personal or private resources.

available response representations:

GET

Retrieves the personal/private folder of current user in given document area. The access on a principal folder and its content is restricted to its owner, so it can be used to store personal or private resources.

available response representations:

GET

Retrieves the personal/private folder of current user in given document area. The access on a principal folder and its content is restricted to its owner, so it can be used to store personal or private resources.

available response representations:

/repository/docarea/{docarea}/personal/domain/{name}

Resource for personal/private folder.

resource-wide template parameters
parameter value description

docarea

string

the name of a document area

name

string

name of the domain

docarea

string

the name of a document area

Methods

GET

Returns indication whether at least one resource exists in a personal/private folder for given principal (user, position or group) in given document area.

available response representations:

/repository/docarea/{docarea}/personal/pid/{id}

Resource for personal/private folder.

resource-wide template parameters
parameter value description

docarea

string

the name of a document area

id

string

the principal id

docarea

string

the name of a document area

Methods

GET

Retrieves the personal/private folder of given principal (user, position or group) in given document area. The access on a principal folder and its content is restricted to its owner, so it can be used to store personal or private resources. and writing access .

available response representations:

/repository/docarea/{docarea}/root

Representation of root folder of one document area.

resource-wide template parameters
parameter value description

docarea

string

name of the requested document area

Methods

GET

Retrieves the root folder, that is, the entry point, of a specific document area.

available response representations:

GET

Retrieves the root folder, that is, the entry point, of a specific document area.

available response representations:

GET

Retrieves the root folder, that is, the entry point, of a specific document area.

available response representations:

/repository/docareas

Provides a list of document areas the current user can access. A user has access to a document area, if he is member of a domain, which is associated with the document area.

Methods

GET

Get list of accessible document areas as plain text.

available response representations:

GET

Get list of accessible document areas as XML.

available response representations:

GET

Get list of accessible document areas as HTML.

available response representations:

/repository/folder/{id}?properties

URI to get, update and delete properties of one folder.

resource-wide template parameters
parameter value description

id

string

Methods

GET

Retrieves a specific set of properties for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

GET

Retrieves a specific set of properties for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

GET

Retrieves a specific set of properties for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

PUT

Update folder properties. The property objectclass can be changed only if the list contains only one element.

acceptable request representations:

DELETE

Delete folder.

/repository/folder/{id}/publish?duration &read &write

URI to get, update and delete properties of one folder.

resource-wide template parameters
parameter value description

id

string

id

string

Methods

POST

Publishes the folder identified by given folder key. The access is restricted to the given permissions, e.g. to a specific duration, specified in hours. The generated token allows users to authenticate as guest of inviting principal, identified by given host principal.

request query parameters
parameter value description

duration

int

Default: 168

read

string

Default: 1

write

string

Default: 0

acceptable request representations:

available response representations:

POST

Publishes the folder identified by given folder key. The access is restricted to the given permissions, e.g. to a specific duration, specified in hours. The generated token allows users to authenticate as guest of inviting principal, identified by given host principal.

acceptable request representations:

available response representations:

/repository/folder/{id}/children?properties &sortorder &pagesize &pagenumber &resultcount &hidden

Gets the (direct) children of the specified folder, filtered by the condition of the searchControl, the delete state, the visibility rules and the user's permissions. The method allows to specify which properties are to be returned.

resource-wide template parameters
parameter value description

id

string

resource id of requested folder

Methods

GET

Gets the direct children of the specified folder as plain text.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false, values: on/off, true/false, 1/0)

hidden

string

indication whether hidden resources are returned (default false, values: on/off, true/false, 1/0)

available response representations:

GET

Gets the direct children of the specified folder as XML or JSON.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false, values: on/off, true/false, 1/0)

hidden

string

indication whether hidden resources are returned (default false, values: on/off, true/false, 1/0)

available response representations:

GET

Gets the direct children of the specified folder as HTML.

request query parameters
parameter value description

properties

string

Default: displayname,identifier,resourcetype,lastmodifieddate,creatorcommonname,objectclass,contentlength,contenttype,contentitemcount

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false, values: on/off, true/false, 1/0)

hidden

string

indication whether hidden resources are returned (default false, values: on/off, true/false, 1/0)

available response representations:

/repository/folder/{id}/children/filter?properties &sortorder &pagesize &pagenumber &filter &resultcount &hidden &scope

Gets the (direct) children of the specified folder, filtered by the condition of the searchControl, the delete state, the visibility rules and the user's permissions. The method allows to specify which properties are to be returned.

resource-wide template parameters
parameter value description

id

string

resource id of requested folder

id

string

resource id of requested folder

Methods

GET

Gets the filtered children of the specified folder as XML or JSON.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

filter

string

string condition ( NQL syntax )

resultcount

string

indication, whether result count of the search is returned (default false, values: on/off, true/false, 1/0)

hidden

string

indication whether hidden resources are returned (default false, values: on/off, true/false, 1/0)

scope

int

Default: 1

search scope ( 1 = one-level, 2 = subtree ), default is one-level

available response representations:

/repository/folder/{id}/children/document?properties &sortorder &pagesize &pagenumber &resultcount &hidden

URI to list children (documents only) and create documents of the specified folder.

resource-wide template parameters
parameter value description

id

string

Methods

GET

Gets the (direct) document-type children of the specified folder, filtered by the condition of the searchControl, the delete state, the visibility rules and the user's permissions. The method allows to specify which properties are to be returned.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false)

hidden

string

indication whether hidden resources are returned (default false)

available response representations:

GET

Gets the (direct) document-type children of the specified folder, filtered by the condition of the searchControl, the delete state, the visibility rules and the user's permissions. The method allows to specify which properties are to be returned.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false)

hidden

string

indication whether hidden resources are returned (default false)

available response representations:

GET

Gets the (direct) document-type children of the specified folder, filtered by the condition of the searchControl, the delete state, the visibility rules and the user's permissions. The method allows to specify which properties are to be returned.

request query parameters
parameter value description

properties

string

Default: displayname,identifier,resourcetype,lastmodifieddate,creatorcommonname,objectclass,contentlength,contenttype,contentitemcount

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false)

hidden

string

indication whether hidden resources are returned (default false)

available response representations:

POST

Creates a document in a parent folder. The parent folder must exist, in order that the document can be created. The document has no content.

request query parameters
parameter value description

lock

boolean

archived

boolean

acceptable request representations:

response header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

available response representations:

POST

Creates a document in a parent folder. The parent folder must exist, in order that the document can be created. The first multipart entry must be documentmetadata (application/xml or application/json). The second multipart entry (or n entries for multi-content items) is the content of the document.

request query parameters
parameter value description

lock

boolean

archived

boolean

acceptable request representations:

response header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

available response representations:

POST

Creates a document in a parent folder. The parent folder must exist, in order that the document can be created.

Note that this POST request does not allow multi-content items. You can only set the displayname property. This function is intended for browsers and not for normal applications.

request query parameters
parameter value description

lock

boolean

archived

boolean

acceptable request representations:

response header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

available response representations:

/repository/folder/{id}/children/folder?properties &sortorder &pagesize &pagenumber &resultcount &hidden

URI to list children (folders only) and create subfolder of the specified folder.

resource-wide template parameters
parameter value description

id

string

resource id of requested folder

Methods

GET

Gets the (direct) folder-type children of the specified folder, filtered by the condition of the searchControl, the delete state, the visibility rules and the user's permissions. The method allows to specify which properties are to be returned.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false)

hidden

string

indication whether hidden resources are returned (default false)

available response representations:

GET

Gets the (direct) folder-type children of the specified folder, filtered by the condition of the searchControl, the delete state, the visibility rules and the user's permissions. The method allows to specify which properties are to be returned.

request query parameters
parameter value description

properties

string

Default: displayname,identifier,resourcetype,lastmodifieddate,creatorcommonname,objectclass,contentlength,contenttype,contentitemcount

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false)

hidden

string

indication whether hidden resources are returned (default false)

available response representations:

POST

Create a folder.

request query parameters
parameter value description

objectclass

string

the object class name

lock

boolean

additionally lock the created folder?

acceptable request representations:

response header parameters
parameter value description

Location

anyURI

The URI where the created folder is accessible.

available response representations:

POST

Create a folder.

acceptable request representations:

response header parameters
parameter value description

Location

anyURI

The URI where the created folder is accessible.

available response representations:

GET

Gets the (direct) folder-type children of the specified folder, filtered by the condition of the searchControl, the delete state, the visibility rules and the user's permissions. The method allows to specify which properties are to be returned.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false)

hidden

string

indication whether hidden resources are returned (default false)

available response representations:

/repository/folder/{id}/children/link?properties &sortorder &pagesize &pagenumber &resultcount &hidden

URI to list children (links only) and create links of the specified folder.

resource-wide template parameters
parameter value description

id

string

resource id of requested folder

Methods

GET

Gets the (direct) link-type children of the specified folder, filtered by the condition of the searchControl, the delete state, the visibility rules and the user's permissions. The method allows to specify which properties are to be returned.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false)

hidden

string

indication whether hidden resources are returned (default false)

available response representations:

GET

Gets the (direct) link-type children of the specified folder, filtered by the condition of the searchControl, the delete state, the visibility rules and the user's permissions. The method allows to specify which properties are to be returned.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false)

hidden

string

indication whether hidden resources are returned (default false)

available response representations:

GET

Gets the (direct) link-type children of the specified folder, filtered by the condition of the searchControl, the delete state, the visibility rules and the user's permissions. The method allows to specify which properties are to be returned.

request query parameters
parameter value description

properties

string

Default: displayname,identifier,resourcetype,lastmodifieddate,creatorcommonname,objectclass,contentlength,contenttype,contentitemcount

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

resultcount

string

indication, whether result count of the search is returned (default false)

hidden

string

indication whether hidden resources are returned (default false)

available response representations:

/repository/folder/{id}/children/link/{refid}?objectclass

URI to list children (links only) and create links of the specified folder.

resource-wide template parameters
parameter value description

id

string

resource id of requested folder

id

string

resource id of parent folder

refid

string

the id of the referenced resource

Methods

Create a link.

request query parameters
parameter value description

objectclass

string

the object class name

acceptable request representations:

response header parameters
parameter value description

Location

anyURI

The URI where the created link is accessible.

available response representations:

/repository/folder/{id}/extensions/{type}?properties

resource-wide template parameters
parameter value description

id

string

the resource id of the owner resource (folder)

type

string

the type of the extension, only notes are permitted

Methods

GET

Retrieves all extensions of requested resource. For folders only notes can be retrieved.

request query parameters
parameter value description

properties

string

a set of properties separated by comma, that shall be retrieved

available response representations:

GET

Retrieves all extensions of requested resource. For folders only notes can be retrieved.

request query parameters
parameter value description

properties

string

a set of properties separated by comma, that shall be retrieved

available response representations:

POST

Creates an extension on a specific folder. Extension on folders may only be of type note.

acceptable request representations:

response header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

available response representations:

/repository/folder/{id}/opensearch?query &fulltextQuery &webdav &useNDF

resource-wide template parameters
parameter value description

id

string

Methods

GET

Open search implementation (experimental).

request query parameters
parameter value description

query

string

fulltextQuery

string

webdav

boolean

Default: true

useNDF

boolean

available response representations:

/repository/folder/{id}/opensearch/osdx

resource-wide template parameters
parameter value description

id

string

id

string

the resource id.

Methods

GET

Get OSDX file.

available response representations:

/repository/folder/{id}/search?query &fulltextQuery

Searches the document area for certain resource items, starting with the resource represented by resourceKey. The whole information that controls the search is provided as two strings. The results are filtered by the condition contained in query, the delete state, the visibility rules, the user's permissions, *AND* the fulltextQuery. The method allows to specify which properties are to be returned; this may include such properties as fulltext score or abstract.

Required permissions: ReadProperties on each element of the returned results or ScenarioManagerAdmin if returned resource is of type folder.

Example:


  String query = "select displayname, objectclass " +
                 "where ( creator = %currentUserPrincipalId ) " +
                 "orderby creationdate scope subtree";
   
 

resource-wide template parameters
parameter value description

id

string

Methods

GET

Searches the document area for certain resource items.

request query parameters
parameter value description

query

string

string in nscale Query Language with information equivalent to a SearchControl object. Parses the query and delegates to search(ResourceKey key, SearchControl sc, String fulltextQuery) . For exact query syntax see additional remarks in StringCondition.

fulltextQuery

string

String containing the fulltext query

available response representations:

GET

Searches the document area for certain resource items.

request query parameters
parameter value description

query

string

string in nscale Query Language with information equivalent to a SearchControl object. Parses the query and delegates to search(ResourceKey key, SearchControl sc, String fulltextQuery) . For exact query syntax see additional remarks in StringCondition.

fulltextQuery

string

String containing the fulltext query

delimiter

string

Default: ;

CSV delimiter (default is ; )

available response representations:

GET

Searches the document area for certain resource items.

request query parameters
parameter value description

query

string

string in nscale Query Language with information equivalent to a SearchControl object. Parses the query and delegates to search(ResourceKey key, SearchControl sc, String fulltextQuery) . For exact query syntax see additional remarks in StringCondition.

fulltextQuery

string

String containing the fulltext query

available response representations:

GET

Searches the document area for certain resource items.

request query parameters
parameter value description

query

string

fulltextQuery

string

available response representations:

GET

Searches the document area for certain resource items.

request query parameters
parameter value description

query

string

fulltextQuery

string

available response representations:

POST

acceptable request representations:

available response representations:

/repository/folder/{id}/search/aggregate?query

TODO

resource-wide template parameters
parameter value description

id

string

Methods

GET

Searches the document area for certain resource items.

request query parameters
parameter value description

query

string

available response representations:

GET

Searches the document area for certain resource items.

request query parameters
parameter value description

query

string

available response representations:

GET

Searches the document area for certain resource items.

request query parameters
parameter value description

query

string

available response representations:

/repository/folder/{id}/searchcontent?query &multi

Search and retrieve the document area for a certain resource, starting with the resource represented by resourceKey. The result are filtered by the condition contained in query, the delete state, the visibility rules, the user's permissions.

Required permissions: ReadProperties on each element of the returned results or ScenarioManagerAdmin if returned resource is of type folder.

Example:


  String query = "where identifier = 24320 scope subtree";
   
 

resource-wide template parameters
parameter value description

id

string

Methods

GET

Searches the document area for certain resource items. Result: content as stream, otherwise error 404 (not found), or error 412 (precondition failed).

request query parameters
parameter value description

query

string

multi

string

available response representations:

/repository/folder/{id}/searchversions?query &multi

Search documents including their versions.

resource-wide template parameters
parameter value description

id

string

Methods

GET

Searches the document area for certain resource items included the versions of the items. Result: content as stream, otherwise error 404 (not found), or error 412 (precondition failed).

request query parameters
parameter value description

query

string

multi

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

/repository/folder/{id}/searchversions//content?query &multi

Search documents including their versions.

resource-wide template parameters
parameter value description

id

string

id

string

Methods

GET

Searches the document area for a certain source item with a certain version and return it as binary file.

request query parameters
parameter value description

query

string

multi

string

available response representations:

/repository/folder/{id}/searchversions/aggregate?query

resource-wide template parameters
parameter value description

id

string

Methods

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

/repository/link/{id}?properties

URI to get, update and delete properties of one link.

resource-wide template parameters
parameter value description

id

string

the resource id of the link that shall be deleted

Methods

GET

Retrieves a specific set of properties for the requested link.

request query parameters
parameter value description

properties

string

a set of properties, that should be returned

available response representations:

GET

Retrieves a specific set of properties for the requested link.

request query parameters
parameter value description

properties

string

a set of properties, that should be returned

available response representations:

Updates the properties of a link.

request query parameters
parameter value description

objectclass

string

the name of the new objectclass

acceptable request representations:

Deletes a link.

/repository/link/{id}/resource?properties

Resolves the resource referenced by the link.

Required permissions: ReadProperties on object class of linkResourceKey and either ReadProperties on object class of found resource or ScenarioManagerAdmin if found resource is a folder.

resource-wide template parameters
parameter value description

id

string

the resource id of the specific link

Methods

Resolves the resource referenced by the link.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

/repository/note/{id}

URI to get content of a note or to append content to a existing note

resource-wide template parameters
parameter value description

id

string

the resource id of a note, whose content shall be updated

Methods

HEAD

Gets header information of a notes extended content.

response header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

Content-Type

string

Content type.

Content-Length

long

Content length of content item.

Last-Modified

string

Modification date.

available response representations:

GET

Gets the whole extended content of a note.

response header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

Content-Type

string

Content type.

Last-Modified

string

Modification date.

available response representations:

GET

available response representations:

GET

available response representations:

PUT

Appends content to an existing note.

acceptable request representations:

available response representations:

PUT

Appends content to an existing note.

acceptable request representations:

available response representations:

/repository/public/{id}

This resource does not requires HTTP authentication.

resource-wide template parameters
parameter value description

id

string

Methods

/repository/public/{id}/content

This resource does not requires HTTP authentication.

resource-wide template parameters
parameter value description

id

string

id

string

Methods

HEAD

available response representations:

GET

available response representations:

/repository/published

Methods

GET

Gets the published documents of all document areas.

available response representations:

/repository/published/{id}

resource-wide template parameters
parameter value description

id

string

document published id

Methods

DELETE

Revokes access on the content of a document which has been published before.

/repository/published/docarea/{docarea}

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Gets the published documents of given document area.

available response representations:

/repository/res/{id}

URI to get, update and delete properties of one resource.

resource-wide template parameters
parameter value description

id

string

resource id of the requested resource

Methods

HEAD

Checks that a specified resource exists. The result depends on the existence and the visibility of the resource. Returns response status 200 (ok) or 404 (not found).

available response representations:

GET

Retrieves a specific set of properties for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

request query parameters
parameter value description

properties

string

available response representations:

GET

Retrieves a specific set of properties for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

GET

Retrieves a specific set of properties for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

available response representations:

PUT

Updates properties of the specified resource. The property objectclass can be changed only if the list contains only one element.

acceptable request representations:

DELETE

Delete resource.

request query parameters
parameter value description

type

string

optional: specifies the deletion policy (DeleteLogical, DeleteStateAware or DeletePhysical)

/repository/res/{id}/ancestors?properties

Retrieves the ancestor-parent resources with specified properties, defining the path to the document area in top down order (i.e. from root to parent folder of the specified resource).

resource-wide template parameters
parameter value description

id

string

resource id of requested resource

Methods

GET

Retrieves the ancestor-parent keys as text.

request query parameters
parameter value description

properties

string

properties to return

available response representations:

GET

Retrieves the ancestor-parent keys as application/xml or application/json.

request query parameters
parameter value description

properties

string

properties to return

available response representations:

GET

Retrieves the ancestor-parent keys as html.

request query parameters
parameter value description

properties

string

properties to return

available response representations:

/repository/res/{id}/command

Simple commands (operations) on repository service.

Methods

/repository/res/{id}/command/applyFolderTemplate?foldertemplate

Simple commands (operations) on repository service.

resource-wide template parameters
parameter value description

id

string

Methods

PUT

request query parameters
parameter value description

foldertemplate

string

/repository/res/{id}/command/unlock

Simple commands (operations) on repository service.

resource-wide template parameters
parameter value description

id

string

resource id of the requested resource

Methods

PUT

Unlocks a previously locked resource. Only the user, who locked the resource, is able to unlock it. A user with admin permissions is always allowed to break the lock.

/repository/res/{id}/command/undelete

Simple commands (operations) on repository service.

resource-wide template parameters
parameter value description

id

string

resource id of the requested resource

Methods

PUT

Undeletes a previously logically deleted resource. It is not possible to undelete a physically deleted resource. The resource is only visible to users with special permission UNDELETE for a document area. If the resource is of type folder, the whole subtree is undeleted.

/repository/res/{id}/command/unarchive

Simple commands (operations) on repository service.

resource-wide template parameters
parameter value description

id

string

resource id of the requested resource

Methods

PUT

Unarchives a specific folder which means the life cycle state of the folder is reset to indexed. This method succeeds on an archived folder whose parent folder is still indexed. Resources in the subtree of the folder remain unaffected.

/repository/res/{id}/command/lock

Simple commands (operations) on repository service.

resource-wide template parameters
parameter value description

id

string

resource id of the requested resource

Methods

PUT

Locks the specified resource. The kind of lock is shallow (i.e. no deep lock).

/repository/res/{id}/command/finalize

Simple commands (operations) on repository service.

resource-wide template parameters
parameter value description

id

string

resource id of the requested resource

Methods

PUT

Finalizes a specific resource. This method succeeds if all required pre-conditions are met, e.g. all mandatory properties are set. Otherwise an exception is thrown.

/repository/res/{id}/command/unfinalize?children

Simple commands (operations) on repository service.

resource-wide template parameters
parameter value description

id

string

resource id of the requested resource

Methods

PUT

Unfinalizes a specific resource, that is, alters its state from finalized to indexed.

request query parameters
parameter value description

children

boolean

shall children also be unfinalized?

/repository/res/{id}/command/archive

Simple commands (operations) on repository service.

resource-wide template parameters
parameter value description

id

string

resource id of the requested resource

Methods

PUT

Archives a specific resource. This method succeeds if all required pre-conditions are met, e.g. all mandatory properties are set.

/repository/res/{id}/command/move/{to}?objectclass

Simple commands (operations) on repository service.

resource-wide template parameters
parameter value description

id

string

resource id of the requested resource

to

string

resource id specifying the target folder

Methods

PUT

Moves a folder, document or link to the specified target folder, identified by the target folder key.

request query parameters
parameter value description

objectclass

string

new object class of moved resource

response header parameters
parameter value description

Location

anyURI

The URI where the new folder is accessible.

available response representations:

/repository/res/{id}/command/copy/{to}?objectclass

Simple commands (operations) on repository service.

resource-wide template parameters
parameter value description

id

string

resource id of the requested resource

to

string

resource id specifying the target folder

Methods

PUT

Copies a folder, document or link to the specified target folder, identified by the target folder key.

request query parameters
parameter value description

objectclass

string

new object class of copied resource

response header parameters
parameter value description

Location

anyURI

The URI where the new folder is accessible.

available response representations:

/repository/res/{id}/links?properties

Finds all links pointing to the specified resource, identified by resource key. This method filters all links according to the user's permissions.

Required permissions: ReadProperties on link class(es) of found link(s) and either ReadProperties on object class of resourceKey or ScenarioManagerAdmin if resource is a folder.

resource-wide template parameters
parameter value description

id

string

the resource id of the specific resource

Methods

GET

Finds all links pointing to the specified resource, identified by resource key.

request query parameters
parameter value description

properties

string

a set of properties, that should be returned

available response representations:

GET

Finds all links pointing to the specified resource, identified by resource key.

request query parameters
parameter value description

properties

string

a set of properties, that should be returned

available response representations:

/repository/res/{id}/parent

URI to access parent of a resource.

resource-wide template parameters
parameter value description

id

string

Methods

GET

Get the parent folder of the given resource.

available response representations:

GET

Get the parent folder of the given resource.

available response representations:

GET

Get the parent folder of the given resource.

available response representations:

/repository/res/{id}/property/{property}

Representation of single property of a document.

resource-wide template parameters
parameter value description

property

string

specifies the property that should be returned

id

string

resource id of the requested resource

Methods

GET

Retrieves one property for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

available response representations:

GET

Retrieves one property for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

available response representations:

GET

Retrieves one property for the requested resource. A resource can be a folder, document, link, or an extension, that is, an annotation, a note, rendition or a virtual rendition.

available response representations:

/rss/{docarea}?cmd &ps &filter &pagenumber &pagesize &sortorder &scope &folderidentifier &folderkey &ftquery &lang &resources &resourcekeys &transient &allps &glbl &host &port &hidden &instancetype &agent &linktypes

Old deprecated version of RSS Feed URL.

resource-wide template parameters
parameter value description

docarea

string

Methods

GET

Old deprecated version of RSS Feed URL. Use 'differences' of 'state' sub-resource instead.

request query parameters
parameter value description

cmd

string

ps

string

filter

string

pagenumber

int

pagesize

int

sortorder

string

scope

string

folderidentifier

long

folderkey

string

ftquery

string

lang

string

resources

string

resourcekeys

string

transient

boolean

allps

boolean

glbl

boolean

host

string

port

int

hidden

string

instancetype

string

agent

string

linktypes

string

available response representations:

/rss/{docarea}/redirect

Old deprecated version of RSS Feed URL.

resource-wide template parameters
parameter value description

docarea

string

docarea

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

/rss/{docarea}/differences?lang &agent &linktypes

Old deprecated version of RSS Feed URL.

resource-wide template parameters
parameter value description

docarea

string

docarea

string

Methods

GET

Gets every message of the current user of a specific document area.

request query parameters
parameter value description

lang

string

agent

string

linktypes

string

available response representations:

/rss/{docarea}/state?ps &filter &pagenumber &pagesize &sortorder &scope &folderidentifier &folderkey &ftquery &lang &agent &linktypes

Old deprecated version of RSS Feed URL.

resource-wide template parameters
parameter value description

docarea

string

docarea

string

Methods

GET

Gets and converts search results. The search results are converted to an atom feed.

request query parameters
parameter value description

ps

string

filter

string

pagenumber

int

pagesize

int

sortorder

string

scope

string

folderidentifier

long

folderkey

string

ftquery

string

lang

string

agent

string

linktypes

string

available response representations:

/rss/{docarea}/removers?id &lang

Old deprecated version of RSS Feed URL.

resource-wide template parameters
parameter value description

docarea

string

docarea

string

Methods

GET

request query parameters
parameter value description

id

string

lang

string

available response representations:

/rss/{docarea}/wfstate?ps &filter &pagenumber &pagesize &sortorder &ftquery &lang &instancetype &hidden &agent &linktypes

Old deprecated version of RSS Feed URL.

resource-wide template parameters
parameter value description

docarea

string

docarea

string

Methods

GET

request query parameters
parameter value description

ps

string

filter

string

pagenumber

int

pagesize

int

sortorder

string

ftquery

string

lang

string

instancetype

string

hidden

string

agent

string

linktypes

string

available response representations:

/rss/{docarea}/removewf?id &lang

Old deprecated version of RSS Feed URL.

resource-wide template parameters
parameter value description

docarea

string

docarea

string

Methods

GET

request query parameters
parameter value description

id

string

lang

string

available response representations:

/rss/{docarea}/parameters

Old deprecated version of RSS Feed URL.

resource-wide template parameters
parameter value description

docarea

string

docarea

string

Methods

GET

available response representations:

POST

acceptable request representations:

available response representations:

/script?script

The script resource for the Application Layer server.

Supported script languages:

Methods

GET

request query parameters
parameter value description

script

string

Default: bsh

available response representations:

POST

acceptable request representations:

available response representations:

/script/{name}

The script resource for the Application Layer server.

Supported script languages:

resource-wide template parameters
parameter value description

name

string

Methods

PUT

Sample:

    curl -i --basic --user admin:admin  -X PUT  http://localhost:8080/nscalealinst1/rest/script/javascript.txt 
            -H "Content-Type: text/plain"
            --data "var x = session.getConfigurationService().getRenditionServerSettings(); x;"
    

acceptable request representations:

available response representations:

/test

Resource for testing post or put requests.

Methods

GET

Get a HTML form to test post request content.

available response representations:

POST

Resource that handles post request from html form.

acceptable request representations:

available response representations:

/test/docarea/{docarea}?type &contenttype &accepttype &content

Resource for testing post or put requests.

resource-wide template parameters
parameter value description

docarea

string

Methods

GET

Result from root resource test.

request query parameters
parameter value description

type

string

contenttype

string

accepttype

string

Default:

content

string

available response representations:

PUT

Test put request for json/xml content.

request query parameters
parameter value description

type

string

acceptable request representations:

available response representations:

/usermanagement

Methods

/usermanagement/search?domains &types &fulltextQuery &pagenumber &pagesize

Methods

GET

Searches the visible domains for certain principals which are matching the given fulltext query. The results are filtered by the given principal types, that are users, positions or groups. Visible are all domains which are associated to document areas where the logged in user's domain is also associated to and all domains where the logged in user owns domain admin permissions.

Required permissions: none.

 Example:
  usermanagement/search ? domains=nscale & types=USER,GROUP & filltextQuery=DER*
 

request query parameters
parameter value description

domains

string

the names of the domains, the users are associated to as a comma-seperated list of {@link String}s

types

string

the principal entity types as comma-seperated list of the values (USER, POSITION, GROUP)

fulltextQuery

string

the fulltext query

pagenumber

int

Default: -1

pagenumber of the results

pagesize

int

Default: -1

number of hits per page

available response representations:

/usermanagement/nqlsearch?query

Methods

GET

Searches for principals or principal info, controlled by the specified query. The whole information that controls the search is provided as a string in nscale Query Language. The query allows to specify which properties are to be returned and the results are filtered by its condition. The one-level search scope (default) results in a search for principals (users, positions and groups), while a sub-tree search scope initiates a search for principal info (user info and group info).

Required permissions: none.

 Example:
  usermanagement/nqlsearch?query=select commonname, emails where type = $user order by name
 

request query parameters
parameter value description

query

string

string in nscale Query Language with information equivalent to a SearchControl object; parses the query and delegates to search(SearchControl searchControl); for exact query syntax see additional remarks in StringCondition

available response representations:

/usermanagement/nqlsearch/aggregate?query

Methods

GET

request query parameters
parameter value description

query

string

available response representations:

/usermanagement/filteredsearch?properties &sortorder &pagesize &pagenumber &filter &resultcount &scope

Methods

GET

Searches for principals or principal info, controlled by the specified filter query. The one-level search scope (default) results in a search for principals (users, positions and groups), while a sub-tree search scope initiates a search for principal info (user info and group info).

Required permissions: none.

 Example:
 /usermanagement/filteredsearch.xml?properties=type,commonname&filter=domainname='nscale'&sortorder=principalid
 

request query parameters
parameter value description

properties

string

specifies the set of properties that should be returned

sortorder

string

sets the sort order of the search result items (list: +property1,-property2)

pagesize

int

Default: -1

the maximum size of the resulting objects (default is page size 1000)

pagenumber

int

Default: -1

the page number (default is page 1)

filter

string

string condition ( NQL syntax )

resultcount

string

indication, whether result count of the search is returned (default false, values: on/off, true/false, 1/0)

scope

int

Default: 1

search scope ( 1 = one-level, 2 = subtree ), default is one-level

available response representations:

/usermanagement/docarea/{docarea}/orgentities

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Returns all org entities associated to domains referring to a given document area.

available response representations:

/usermanagement/domain

Provides a list of domains the current user can access.

Methods

GET

Get list of accessible domains as plain text.

available response representations:

GET

Get list of accessible domains as XML.

available response representations:

/usermanagement/domain/{domain}/groups?pagesize &pagenumber

resource-wide template parameters
parameter value description

domain

string

the name of the domain

Methods

GET

Gets a page of groups of a specified domain.

request query parameters
parameter value description

pagesize

int

Default: 100

the maximum size of the resulting objects

pagenumber

int

Default: -1

the page number (default is 1)

available response representations:

GET

Gets a page of groups of a specified domain.

request query parameters
parameter value description

pagesize

int

Default: 100

the maximum size of the resulting objects

pagenumber

int

Default: -1

the page number (default is 1)

available response representations:

/usermanagement/domain/{domain}/groups/{name}

resource-wide template parameters
parameter value description

domain

string

the name of the domain

domain

string

the name of the domain

name

string

the name of the group

Methods

GET

Gets a group specified by domain and login name.

available response representations:

/usermanagement/domain/{domain}/positions?pagesize &pagenumber

resource-wide template parameters
parameter value description

domain

string

the unique domain name

Methods

GET

Gets a page of positions of a specified domain.

request query parameters
parameter value description

pagesize

int

Default: 100

the maximum size of the resulting objects

pagenumber

int

Default: -1

the page number (default is 1)

available response representations:

GET

Gets a page of positions of a specified domain.

request query parameters
parameter value description

pagesize

int

Default: 100

the maximum size of the resulting objects

pagenumber

int

Default: -1

the page number (default is 1)

available response representations:

/usermanagement/domain/{domain}/positions/{name}

resource-wide template parameters
parameter value description

domain

string

the unique domain name

domain

string

the unique domain name

name

string

name of the position

Methods

GET

Gets a position specified by name and domain name.

available response representations:

/usermanagement/domain/{domain}/users?pagesize &pagenumber

resource-wide template parameters
parameter value description

domain

string

the domain name

Methods

GET

Gets a page of users of a specified domain.

request query parameters
parameter value description

pagesize

int

Default: 100

the maximum size of the resulting objects

pagenumber

int

Default: -1

the page number (default is 1)

available response representations:

GET

Gets a page of users of a specified domain.

request query parameters
parameter value description

pagesize

int

Default: 100

the maximum size of the resulting objects

pagenumber

int

Default: -1

the page number (default is 1)

available response representations:

/usermanagement/domain/{domain}/users/{name}

resource-wide template parameters
parameter value description

domain

string

the domain name

domain

string

the unique domain name

name

string

login name of the user

Methods

GET

Gets a user specified by domain and login name.

available response representations:

GET

Gets a user specified by domain and login name.

available response representations:

/usermanagement/principal/{id}

resource-wide template parameters
parameter value description

id

string

the id of a principal

Methods

GET

Gets all additional properties of a specified principal.

available response representations:

/usermanagement/principal/{id}/userinfo/photo

resource-wide template parameters
parameter value description

id

string

the id of a principal

id

string

the principal id of the user

Methods

GET

Retrieves the photo of a given principal identified by its principal id.

available response representations:

/usermanagement/principal/{id}/authid/{authid}

resource-wide template parameters
parameter value description

id

string

the id of a principal

id

string

authid

string

Methods

HEAD

available response representations:

GET

available response representations:

PUT

acceptable request representations:

DELETE

available response representations:

/usermanagement/principal/{id}/members

resource-wide template parameters
parameter value description

id

string

the id of a principal

id

string

the principal id of a group or a position

Methods

PUT

Gets the principal ids of members, that is positions and/or groups, of a specified group.

acceptable request representations:

DELETE

Removes from specified group the specified positions and groups as members.

acceptable request representations:

GET

Gets all members of a specific group or position.

available response representations:

/usermanagement/principal/{id}/positions

resource-wide template parameters
parameter value description

id

string

the id of a principal

id

string

the id of a principal

Methods

GET

Gets the position ids of the specified user; the first position of the list is the default position.

available response representations:

/usermanagement/principal/{id}/authid/type/{type}

resource-wide template parameters
parameter value description

id

string

the id of a principal

id

string

type

string

Methods

DELETE

available response representations:

/usermanagement/principal/{id}/membership

resource-wide template parameters
parameter value description

id

string

the id of a principal

id

string

the principal id of a position or group whose membership shall be retrieved

Methods

GET

Gets a list of groups a position or group is member of, identified by its principal id.

available response representations:

/usermanagement/principal/{id}/authid

resource-wide template parameters
parameter value description

id

string

the id of a principal

id

string

Methods

POST

acceptable request representations:

available response representations:

/usermanagement/principal/{id}/userinfo

resource-wide template parameters
parameter value description

id

string

the id of a principal

id

string

the principal id of the user

Methods

GET

Retrieves the user info of a given principal identified by its principal id.

available response representations:

/usermanagement/principal/{id}/property/{property}

resource-wide template parameters
parameter value description

id

string

the id of a principal

property

string

the name of the additional property

id

string

the id of a principal

Methods

GET

Gets the value of a specified additional property of a specified principal.

available response representations:

GET

Gets the value of a specified additional property of a specified principal.

available response representations:

PUT

Sets an additional property of a specified principal. Property type must be blob.

acceptable request representations:

PUT

Sets an additional property of a specified principal as binary.

acceptable request representations:

/workflow/docarea/{docarea}/process/{id}

URI for manipulating workflow processes.

resource-wide template parameters
parameter value description

id

string

the workflow instance id of the process

docarea

string

the name of the document area

Methods

HEAD

Checks whether a specific process exists or not. Returns response status 200 (ok) or 404 (not found).

available response representations:

GET

Retrieves a specific set of workflow properties for the requested process.

Required permissions: none.

request query parameters
parameter value description

properties

string

available response representations:

GET

Retrieves a specific set of workflow properties for the requested process.

Required permissions: none.

request query parameters
parameter value description

properties

string

a set of properties, that shall be retrieved, separated by comma

available response representations:

GET

Retrieves a specific set of workflow properties for the requested process.

Required permissions: none.

request query parameters
parameter value description

properties

string

available response representations:

PUT

Updates workflow properties of a specific process.

acceptable request representations:

/workflow/docarea/{docarea}/process/{id}/resume

URI for manipulating workflow processes.

resource-wide template parameters
parameter value description

id

string

the workflow instance id of the process

docarea

string

the name of the document area

id

string

the workflow instance id of the suspended process

docarea

string

the name of the document area

Methods

PUT

Resumes the execution of the specified process. Only a suspended instance can be resumed.

Required permissions:
For a process, Resume permissions for the workflow process definition.

/workflow/docarea/{docarea}/process/{id}/suspend

URI for manipulating workflow processes.

resource-wide template parameters
parameter value description

id

string

the workflow instance id of the process

docarea

string

the name of the document area

id

string

the workflow instance id of the specific process

docarea

string

the name of the document area

Methods

PUT

Suspends the execution of the specified process.

Required permissions:
For a process, Suspend permissions for the workflow process definition.

/workflow/docarea/{docarea}/process/{id}/unlock

URI for manipulating workflow processes.

resource-wide template parameters
parameter value description

id

string

the workflow instance id of the process

docarea

string

the name of the document area

id

string

docarea

string

Methods

PUT

/workflow/docarea/{docarea}/process/{id}/lock

URI for manipulating workflow processes.

resource-wide template parameters
parameter value description

id

string

the workflow instance id of the process

docarea

string

the name of the document area

id

string

docarea

string

Methods

PUT

/workflow/docarea/{docarea}/process/{id}/reset

URI for manipulating workflow processes.

resource-wide template parameters
parameter value description

id

string

the workflow instance id of the process

docarea

string

the name of the document area

id

string

the workflow instance id of the specific process

docarea

string

the name of the document area

Methods

PUT

Resets the specified process part(s) by deleting the error message(s) of the hung process part(s), enabling the process part(s) to continue running asynchronously, and update the given properties.

Required permissions: Reset permissions for the workflow process definition

acceptable request representations:

/workflow/docarea/{docarea}/process/{id}/end

URI for manipulating workflow processes.

resource-wide template parameters
parameter value description

id

string

the workflow instance id of the process

docarea

string

the name of the document area

id

string

the workflow instance id of the process, that shall be ended

docarea

string

the name of the document area

Methods

PUT

Ends the specific process (instance) while updating its properties, if delivered a non-empty list of properties.

Required permissions:
For a process, End permissions for the workflow process definition or Withdraw permissions for the workflow process definition if the current user has started this process instance.

acceptable request representations:

/workflow/docarea/{docarea}/process/{id}/tasks?properties

URI for manipulating workflow processes.

resource-wide template parameters
parameter value description

id

string

the workflow instance id of the process

docarea

string

the name of the document area

id

string

the workflow instance id of the process, whose tasks shall be retrieved

docarea

string

the name of the document area

Methods

GET

Retrieves unfinished tasks for a specific process.

request query parameters
parameter value description

properties

string

a set of properties, that shall be retrieved, separated by comma

available response representations:

GET

Retrieves unfinished tasks for a specific process.

request query parameters
parameter value description

properties

string

a set of properties, that shall be retrieved, separated by comma

available response representations:

GET

Retrieves unfinished tasks for a specific process.

request query parameters
parameter value description

properties

string

a set of properties, that shall be retrieved, separated by comma

available response representations:

/workflow/docarea/{docarea}/processes?properties

URI to retrieve all unfinished processes of the current principal.

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Retrieves all unfinished processes of the authenticated principal.

request query parameters
parameter value description

properties

string

a set of properties, that shall be returned, separated by comma

available response representations:

GET

Retrieves all unfinished processes of the authenticated principal.

request query parameters
parameter value description

properties

string

a set of properties, that shall be returned, separated by comma

available response representations:

GET

Retrieves all unfinished processes of the authenticated principal.

request query parameters
parameter value description

properties

string

available response representations:

POST

Starts a process (instance) of a specified xml workflow process.

Required permissions: Start permissions for the workflow process definition;
if creatorPositionId is not null, it is checked that it either is a position of the current user, or a position the current user is proxy of, and the permissions are checked for this position; if creatorPositionId is null, the permissions are checked for the current user, that is, if any of his positions has the required permissions (not considering positions the user is proxy of).

request query parameters
parameter value description

creator

string

the principal id that acts as creator of the process, if 'null' the current user will be taken

processkey

boolean

Default: false

{@link boolean}-value indicating whether the process key (true) or the start task key (false, default) shall be retrieved

acceptable request representations:

available response representations:

/workflow/docarea/{docarea}/processes/search?query

URI to retrieve all unfinished processes of the current principal.

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

Methods

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

/workflow/docarea/{docarea}/processes/search/aggregate?query

URI to retrieve all unfinished processes of the current principal.

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

Methods

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

/workflow/docarea/{docarea}/task/{id}

URI for manipulating workflow tasks.

resource-wide template parameters
parameter value description

id

string

docarea

string

Methods

HEAD

Checks whether a specific task exists or not. Returns response status 200 (ok) or 404 (not found).

available response representations:

GET

Retrieves a specific set of workflow properties for the requested task.

Required permissions: none.

request query parameters
parameter value description

properties

string

available response representations:

GET

Retrieves a specific set of workflow properties for the requested task.

Required permissions: none.

request query parameters
parameter value description

properties

string

a set of properties, that shall be retrieved, separated by comma

available response representations:

GET

Retrieves a specific set of workflow properties for the requested task.

Required permissions: none.

request query parameters
parameter value description

properties

string

available response representations:

PUT

Updates properties of a specific task, process or node (instance).

Required permissions:
For a process, WriteProperties permissions for the workflow process definition.
For a task, it is checked that the specified task is assigned either to a position of the current user, or a position the current user is proxy of. If not, an AccessDeniedException is thrown. If the assigned position is valid, the permissions are checked for this position, if required.

acceptable request representations:

/workflow/docarea/{docarea}/task/{id}/resume

URI for manipulating workflow tasks.

resource-wide template parameters
parameter value description

id

string

docarea

string

id

string

the workflow instance id of the suspended task

docarea

string

the name of the document area

Methods

PUT

Resumes the execution of the specified task. Only a suspended instance can be resumed.

Required permissions:
For a task, it is checked that the specified task is assigned either to a position of the current user, or a position the current user is proxy of. If not, an AccessDeniedException is thrown. If the assigned position is valid, the permissions are checked for this position, if required.

/workflow/docarea/{docarea}/task/{id}/suspend

URI for manipulating workflow tasks.

resource-wide template parameters
parameter value description

id

string

docarea

string

id

string

the workflow instance id of the specific task

docarea

string

the name of the document area

Methods

PUT

Suspends the execution of the specified task.

Required permissions:
For a task, it is checked that the specified task is assigned either to a position of the current user, or a position the current user is proxy of. If not, an AccessDeniedException is thrown. If the assigned position is valid, the permissions are checked for this position, if required.

/workflow/docarea/{docarea}/task/{id}/start

URI for manipulating workflow tasks.

resource-wide template parameters
parameter value description

id

string

docarea

string

id

string

the workflow instance id of a specific task

docarea

string

the name of the document area

Methods

PUT

Starts the specified task (instance) and updates properties, if a non-empty list of properties is supplied.

Required permissions: none, *BUT*
it is checked that the specified task is assigned either to a position of the current user, or a position the current user is proxy of. If not, an AccessDeniedException is thrown.

acceptable request representations:

/workflow/docarea/{docarea}/task/{id}/exists

URI for manipulating workflow tasks.

resource-wide template parameters
parameter value description

id

string

docarea

string

id

string

the workflow instance id of the specific process

docarea

string

the name of the document area

Methods

HEAD

Checks that a specified workflow instance, that is task, exists. The result depends on the existence and the visibility of the instance.

Required permissions: none.

available response representations:

available response representations:

/workflow/docarea/{docarea}/task/{id}/assignpooled

URI for manipulating workflow tasks.

resource-wide template parameters
parameter value description

id

string

docarea

string

id

string

docarea

string

Methods

PUT

Assigns a task to a pool of specified positions or groups, so a user owning or being proxy of one of the specified positions or being in one of the specified groups, can choose to perform the task.

Required permissions: none.

acceptable request representations:

/workflow/docarea/{docarea}/task/{id}/end

URI for manipulating workflow tasks.

resource-wide template parameters
parameter value description

id

string

docarea

string

id

string

the workflow instance id of the task, that shall be ended

docarea

string

the name of the document area

Methods

PUT

Ends the specified task (instance) while updating its properties, if delivered a non-empty list of properties.

Required permissions:
To end a task, it is checked that the specified task is assigned either to a position of the current user, or a position the current user is proxy of. If not, an AccessDeniedException is thrown. If the assigned position is valid, the permissions are checked for this position, if required.

acceptable request representations:

/workflow/docarea/{docarea}/task/{id}/assign?position

URI for manipulating workflow tasks.

resource-wide template parameters
parameter value description

id

string

docarea

string

id

string

docarea

string

Methods

PUT

Assigns one or more positions to a specific task.

Required permissions: none.

request query parameters
parameter value description

position

string

/workflow/docarea/{docarea}/tasks?type &properties &sortorder

URI for retrieving information about workflow tasks.

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

Methods

GET

Retrieves all tasks for a specific user. With the optional parameter 'type', it is possible to receive only tasks of that specific type.

request query parameters
parameter value description

type

string

the process type, for example resubmission or sendmessage

properties

string

a comma-separated list of properties

sortorder

string

sets the sort order of the search result items

available response representations:

/workflow/docarea/{docarea}/tasks/search?query

URI for retrieving information about workflow tasks.

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

Methods

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

/workflow/docarea/{docarea}/tasks/search/aggregate?query

URI for retrieving information about workflow tasks.

resource-wide template parameters
parameter value description

docarea

string

the name of the document area

docarea

string

Methods

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

GET

request query parameters
parameter value description

query

string

available response representations:

Representations

application/xml (ns3:properties)

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

text/html

application/xhtml+xml

application/xml (ns3:properties)

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

text/plain

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

multipart/mixed (ns3:documentmetadata)

Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:documentmetadata xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <objectclassname>D1</objectclassname>
    <properties>
        <property name="displayname">
            <string>displayname-value</string>
        </property>
        <property name="name">
            <string>name-value</string>
        </property>
    </properties>
    <contentproperties>
        <contentproperty name="displayName">
            <string>displayname-value</string>
        </contentproperty>
        <contentproperty name="contentType">
            <string>text/plain; charset="iso-8859-1"</string>
        </contentproperty>
    </contentproperties>
    <contentitemproperties>
        <contentitemproperty>
            <property name="displayName">
                <string>displayname-value</string>
            </property>
            <property name="contentType">
                <string>text/plain; charset="iso-8859-1"</string>
            </property>
            <property name="lastModified">
                <datetime>2021-01-15T21:12:32.758+01:00</datetime>
            </property>
        </contentitemproperty>
    </contentitemproperties>
</ns2:documentmetadata>

XML Schema

Source: schema.xsd

<xs:element name="documentmetadata" type="tns:documentmetadata"/>

application/xml, application/json (ns3:resourcekey)

the resourcekey of the created resource
XML Schema

Source: schema.xsd

<xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0" maxOccurs="unbounded"/>
header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

text/plain

application/json

application/xml

application/atom+xml

application/json

application/xml

application/xml (ns3:resourceresult)

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

application/json (ns3:resourceresult)

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/plain

text/html

application/xhtml+xml

*/*

application/xml, application/json (ns3:principalentitylist)

Example
    
JSON:
{
  "users" : null,
  "groups" : null,
  "positions" : [ {
    "principalId" : "principalId",
    "name" : "gruppe",
    "domainName" : "domainName",
    "commonName" : "commonName",
    "email" : "email",
    "description" : "description",
    "active" : true,
    "activationDate" : null,
    "deactivationDate" : null,
    "deactivationReason" : "none",
    "lastModified" : 1610741552775,
    "default_" : false,
    "userId" : "principalId"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:principalentitylist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <positions>
        <position>
            <principalid>principalId</principalid>
            <name>gruppe</name>
            <domainname>domainName</domainname>
            <commonname>commonName</commonname>
            <email>email</email>
            <description>description</description>
            <active>true</active>
            <deactivationreason>none</deactivationreason>
            <lastmodified>2021-01-15T21:12:32.775+01:00</lastmodified>
            <default>false</default>
            <userid>principalId</userid>
        </position>
    </positions>
</ns2:principalentitylist>

XML Schema

Source: schema.xsd

<xs:element name="principalentitylist" type="tns:principalentitylist"/>

text/html

application/xhtml+xml

application/xml, application/json (ns3:position)

Example
        
JSON:
{
  "principalId" : "principalId",
  "name" : "gruppe",
  "domainName" : "domainName",
  "commonName" : "commonName",
  "email" : "email",
  "description" : "description",
  "active" : true,
  "activationDate" : null,
  "deactivationDate" : null,
  "deactivationReason" : "none",
  "lastModified" : 1610741552775,
  "default_" : false,
  "userId" : "principalId"
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:position xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <principalid>principalId</principalid>
    <name>gruppe</name>
    <domainname>domainName</domainname>
    <commonname>commonName</commonname>
    <email>email</email>
    <description>description</description>
    <active>true</active>
    <deactivationreason>none</deactivationreason>
    <lastmodified>2021-01-15T21:12:32.775+01:00</lastmodified>
    <default>false</default>
    <userid>principalId</userid>
</ns2:position>

    

XML Schema

Source: schema.xsd

<xs:element name="position" type="tns:position"/><xs:element name="position" type="xs:int" minOccurs="0"/><xs:element name="position" type="tns:position" minOccurs="0" maxOccurs="unbounded"/>

application/xml (ns3:calendarresult)

XML Schema

Source: schema.xsd

<xs:element name="calendarresult" type="tns:calendarresult"/>

application/json (ns3:calendarresult)

XML Schema

Source: schema.xsd

<xs:element name="calendarresult" type="tns:calendarresult"/>

text/calendar

application/xml (ns3:properties)

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml

application/json

application/xml (ns3:calendarpropertydefinition)

XML Schema

Source: schema.xsd

<xs:element name="calendarpropertydefinition" type="tns:calendarpropertydefinition"/>

application/json (ns3:calendarpropertydefinition)

XML Schema

Source: schema.xsd

<xs:element name="calendarpropertydefinition" type="tns:calendarpropertydefinition"/>

text/calendar

application/xml (ns3:calendars)

XML Schema

Source: schema.xsd

<xs:element name="calendars" type="tns:calendars"/><xs:element name="calendars" type="tns:calendar" maxOccurs="unbounded"/>

application/json (ns3:calendars)

XML Schema

Source: schema.xsd

<xs:element name="calendars" type="tns:calendars"/><xs:element name="calendars" type="tns:calendar" maxOccurs="unbounded"/>

application/xml (ns3:calendar)

XML Schema

Source: schema.xsd

<xs:element name="calendar" type="tns:calendar"/>

application/json (ns3:calendar)

XML Schema

Source: schema.xsd

<xs:element name="calendar" type="tns:calendar"/>

text/calendar

application/xml (ns3:properties)

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml (ns3:calendarpropertydefinitions)

XML Schema

Source: schema.xsd

<xs:element name="calendarpropertydefinitions" type="tns:calendarpropertydefinitions"/><xs:element name="calendarpropertydefinitions" type="tns:calendarpropertydefinition" maxOccurs="unbounded"/>

application/json (ns3:calendarpropertydefinitions)

XML Schema

Source: schema.xsd

<xs:element name="calendarpropertydefinitions" type="tns:calendarpropertydefinitions"/><xs:element name="calendarpropertydefinitions" type="tns:calendarpropertydefinition" maxOccurs="unbounded"/>

application/xml (ns3:calendarresult)

XML Schema

Source: schema.xsd

<xs:element name="calendarresult" type="tns:calendarresult"/>

application/json (ns3:calendarresult)

XML Schema

Source: schema.xsd

<xs:element name="calendarresult" type="tns:calendarresult"/>

application/xml, application/json (ns3:resourcekeylist)

Example
    
JSON:
{
  "resourceKeys" : [ {
    "id" : "DA$NOTSET$3$2$NOTSET",
    "areaName" : "MyDocAreaName",
    "type" : "DOCUMENT"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourcekeylist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <resourcekey id="DA$NOTSET$3$2$NOTSET">
        <areaname>MyDocAreaName</areaname>
        <type>DOCUMENT</type>
    </resourcekey>
</ns2:resourcekeylist>

XML Schema

Source: schema.xsd

<xs:element name="resourcekeylist" type="tns:resourcekeylist"/>

application/xml, application/json (ns3:objectclasslist)

XML Schema

Source: schema.xsd

<xs:element name="objectclasslist" type="tns:objectclasslist"/>

application/xml, application/json (ns3:objectclasses)

XML Schema

Source:

application/xml, application/json (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

*/*

*/*

application/xml (ns3:authid)

XML Schema

Source: schema.xsd

<xs:element name="authid" type="tns:authid"/><xs:element name="authid" type="tns:authidex" minOccurs="0" maxOccurs="unbounded"/>

application/json (ns3:authid)

XML Schema

Source: schema.xsd

<xs:element name="authid" type="tns:authid"/><xs:element name="authid" type="tns:authidex" minOccurs="0" maxOccurs="unbounded"/>

application/xml (ns3:authid)

XML Schema

Source: schema.xsd

<xs:element name="authid" type="tns:authid"/><xs:element name="authid" type="tns:authidex" minOccurs="0" maxOccurs="unbounded"/>

application/json (ns3:authid)

XML Schema

Source: schema.xsd

<xs:element name="authid" type="tns:authid"/><xs:element name="authid" type="tns:authidex" minOccurs="0" maxOccurs="unbounded"/>

*/*

application/xml (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/json (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/json (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/json (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml, application/json (ns3:stringlist)

Example
        
JSON:
{
  "elements" : [ "8a8116b3-33d5ee05-0133-d5efbf76-000b", "8a8116b3-33d5ee05-0133-d5efbfca-000d" ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:stringlist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <string>8a8116b3-33d5ee05-0133-d5efbf76-000b</string>
    <string>8a8116b3-33d5ee05-0133-d5efbfca-000d</string>
</ns2:stringlist>

    

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml (ns3:authidlist)

XML Schema

Source: schema.xsd

<xs:element name="authidlist" type="tns:authidlist"/>

application/json (ns3:authidlist)

XML Schema

Source: schema.xsd

<xs:element name="authidlist" type="tns:authidlist"/>

*/*

application/xml (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/json (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml (ns3:authidlist)

XML Schema

Source: schema.xsd

<xs:element name="authidlist" type="tns:authidlist"/>

application/json (ns3:authidlist)

XML Schema

Source: schema.xsd

<xs:element name="authidlist" type="tns:authidlist"/>

application/xml (ns3:authid)

XML Schema

Source: schema.xsd

<xs:element name="authid" type="tns:authid"/><xs:element name="authid" type="tns:authidex" minOccurs="0" maxOccurs="unbounded"/>

application/json (ns3:authid)

XML Schema

Source: schema.xsd

<xs:element name="authid" type="tns:authid"/><xs:element name="authid" type="tns:authidex" minOccurs="0" maxOccurs="unbounded"/>

application/xml (ns3:authidex)

XML Schema

Source: schema.xsd

<xs:element name="authidex" type="tns:authidex"/>

application/json (ns3:authidex)

XML Schema

Source: schema.xsd

<xs:element name="authidex" type="tns:authidex"/>

application/xml, application/json (ns3:userinfo)

Example
        
JSON:
{
  "principalId" : "8a8116ca-38ec5ddf-0138-ec5e8d47-0010",
  "name" : "exampleUser",
  "domainName" : "nscale",
  "commonName" : "Example User",
  "description" : "User for REST examples",
  "active" : true,
  "activationDate" : null,
  "deactivationDate" : null,
  "deactivationReason" : "",
  "lastModified" : 1610741552776,
  "source" : "null/null",
  "changePasswordAllowed" : true,
  "mustChangePassword" : true,
  "imported" : false,
  "synchronized_" : false,
  "passwordExpirationDate" : null,
  "userInfoId" : "8a8116ca-39007916-0139-007b6b8b-0010",
  "honorificTitle" : "Dr.",
  "firstName" : "Example",
  "lastName" : "User",
  "additionalFirstNames" : [ "illustration", "prototype", "sample" ],
  "lastNameSuffix" : "stereotype",
  "initials" : "EU",
  "office" : "Exampleoffice",
  "nickNames" : [ "Exi", "Illu", "Prot" ],
  "photo" : null,
  "birthday" : null,
  "anniversary" : null,
  "gender" : "Female",
  "addresses" : null,
  "phones" : null,
  "emails" : [ "example@user.de" ],
  "instantMessaging" : [ "icq: 283735237" ],
  "languages" : [ "de" ],
  "timeZone" : "CET",
  "x" : null,
  "y" : null,
  "titles" : [ "Dr", "Prof", "Fanboy" ],
  "roles" : [ "Mediator" ],
  "logo" : null,
  "organizations" : [ "Org1", "ExampleOrg" ],
  "categories" : [ "Cat1", "ExampleCat" ],
  "relationships" : [ {
    "referencedUserId" : "8a8116ca-39007916-0139-007b6b8b-0010",
    "relationType" : "Friend",
    "note" : "A friend of mine"
  } ],
  "note" : "an example user",
  "url" : "www.exampleuser.co.uk",
  "licensePlate" : null,
  "sound" : null,
  "publicKey" : null,
  "default_" : true
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:userinfo xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <principalid>8a8116ca-38ec5ddf-0138-ec5e8d47-0010</principalid>
    <name>exampleUser</name>
    <domainname>nscale</domainname>
    <commonname>Example User</commonname>
    <description>User for REST examples</description>
    <active>true</active>
    <deactivationreason></deactivationreason>
    <lastmodified>2021-01-15T21:12:32.776+01:00</lastmodified>
    <source>null/null</source>
    <changepasswordallowed>true</changepasswordallowed>
    <mustchangepassword>true</mustchangepassword>
    <imported>false</imported>
    <synchronized>false</synchronized>
    <userinfoid>8a8116ca-39007916-0139-007b6b8b-0010</userinfoid>
    <honorifictitle>Dr.</honorifictitle>
    <firstname>Example</firstname>
    <lastname>User</lastname>
    <additionalfirstnames>illustration</additionalfirstnames>
    <additionalfirstnames>prototype</additionalfirstnames>
    <additionalfirstnames>sample</additionalfirstnames>
    <lastnamesuffix>stereotype</lastnamesuffix>
    <initials>EU</initials>
    <office>Exampleoffice</office>
    <nicknames>Exi</nicknames>
    <nicknames>Illu</nicknames>
    <nicknames>Prot</nicknames>
    <gender>Female</gender>
    <emails>example@user.de</emails>
    <instantmessaging>icq: 283735237</instantmessaging>
    <languages>de</languages>
    <timezone>CET</timezone>
    <titles>Dr</titles>
    <titles>Prof</titles>
    <titles>Fanboy</titles>
    <roles>Mediator</roles>
    <organizations>Org1</organizations>
    <organizations>ExampleOrg</organizations>
    <categories>Cat1</categories>
    <categories>ExampleCat</categories>
    <relationships>
        <referenceduserid>8a8116ca-39007916-0139-007b6b8b-0010</referenceduserid>
        <relationtype>Friend</relationtype>
        <note>A friend of mine</note>
    </relationships>
    <note>an example user</note>
    <url>www.exampleuser.co.uk</url>
    <default>true</default>
</ns2:userinfo>

    

XML Schema

Source: schema.xsd

<xs:element name="userinfo" type="tns:userinfo"/>

application/xml, application/json (ns3:property)

Example
        
JSON:
{
  "name" : "name",
  "value" : "aXxcs=="
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:property name="name" xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <string>aXxcs==</string>
</ns2:property>

    

XML Schema

Source: schema.xsd

<xs:element name="property" type="tns:property"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="xs:string" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>

application/octet-stream

application/xml (ns3:property)

Example
        
JSON:
{
  "name" : "name",
  "value" : "aXxcs=="
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:property name="name" xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <string>aXxcs==</string>
</ns2:property>

    

XML Schema

Source: schema.xsd

<xs:element name="property" type="tns:property"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="xs:string" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>

application/json (ns3:property)

Example
        
JSON:
{
  "name" : "name",
  "value" : "aXxcs=="
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:property name="name" xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <string>aXxcs==</string>
</ns2:property>

    

XML Schema

Source: schema.xsd

<xs:element name="property" type="tns:property"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="xs:string" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>

application/octet-stream

text/plain

application/xml, application/json (ns3:contentmetadata)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "itemCount" : 1,
  "contentType" : "text/plain",
  "length" : 4712,
  "contentItems" : [ {
    "index" : 0,
    "properties" : [ {
      "name" : "displayName",
      "value" : "displayname-value"
    }, {
      "name" : "contentType",
      "value" : "text/plain; charset=\"iso-8859-1\""
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:contentmetadata id="Docs$NOTSET$2$1$NOTSET" xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <itemcount>1</itemcount>
    <contenttype>text/plain</contenttype>
    <length>4712</length>
    <contentitems>
        <contentitem index="0">
            <properties>
                <property name="displayName">
                    <string>displayname-value</string>
                </property>
                <property name="contentType">
                    <string>text/plain; charset="iso-8859-1"</string>
                </property>
            </properties>
        </contentitem>
    </contentitems>
</ns2:contentmetadata>

XML Schema

Source: schema.xsd

<xs:element name="contentmetadata" type="tns:contentmetadata"/>

text/html

application/xhtml+xml

multipart/mixed (ns3:documentmetadata)

Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:documentmetadata xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <objectclassname>D1</objectclassname>
    <properties>
        <property name="displayname">
            <string>displayname-value</string>
        </property>
        <property name="name">
            <string>name-value</string>
        </property>
    </properties>
    <contentproperties>
        <contentproperty name="displayName">
            <string>displayname-value</string>
        </contentproperty>
        <contentproperty name="contentType">
            <string>text/plain; charset="iso-8859-1"</string>
        </contentproperty>
    </contentproperties>
    <contentitemproperties>
        <contentitemproperty>
            <property name="displayName">
                <string>displayname-value</string>
            </property>
            <property name="contentType">
                <string>text/plain; charset="iso-8859-1"</string>
            </property>
            <property name="lastModified">
                <datetime>2021-01-15T21:12:32.758+01:00</datetime>
            </property>
        </contentitemproperty>
    </contentitemproperties>
</ns2:documentmetadata>

XML Schema

Source: schema.xsd

<xs:element name="documentmetadata" type="tns:documentmetadata"/>

text/plain

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

application/xml (ns3:documentmetadata)

Example
    
JSON:
{
  "objectclassname" : "D1",
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ],
  "contentProperties" : [ {
    "name" : "displayName",
    "value" : "displayname-value"
  }, {
    "name" : "contentType",
    "value" : "text/plain; charset=\"iso-8859-1\""
  } ],
  "contentItemProperties" : [ {
    "properties" : [ {
      "name" : "displayName",
      "value" : "displayname-value"
    }, {
      "name" : "contentType",
      "value" : "text/plain; charset=\"iso-8859-1\""
    }, {
      "name" : "lastModified",
      "value" : 1610741552758
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:documentmetadata xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <objectclassname>D1</objectclassname>
    <properties>
        <property name="displayname">
            <string>displayname-value</string>
        </property>
        <property name="name">
            <string>name-value</string>
        </property>
    </properties>
    <contentproperties>
        <contentproperty name="displayName">
            <string>displayname-value</string>
        </contentproperty>
        <contentproperty name="contentType">
            <string>text/plain; charset="iso-8859-1"</string>
        </contentproperty>
    </contentproperties>
    <contentitemproperties>
        <contentitemproperty>
            <property name="displayName">
                <string>displayname-value</string>
            </property>
            <property name="contentType">
                <string>text/plain; charset="iso-8859-1"</string>
            </property>
            <property name="lastModified">
                <datetime>2021-01-15T21:12:32.758+01:00</datetime>
            </property>
        </contentitemproperty>
    </contentitemproperties>
</ns2:documentmetadata>

XML Schema

Source: schema.xsd

<xs:element name="documentmetadata" type="tns:documentmetadata"/>

application/json (ns3:documentmetadata)

Example
    
JSON:
{
  "objectclassname" : "D1",
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ],
  "contentProperties" : [ {
    "name" : "displayName",
    "value" : "displayname-value"
  }, {
    "name" : "contentType",
    "value" : "text/plain; charset=\"iso-8859-1\""
  } ],
  "contentItemProperties" : [ {
    "properties" : [ {
      "name" : "displayName",
      "value" : "displayname-value"
    }, {
      "name" : "contentType",
      "value" : "text/plain; charset=\"iso-8859-1\""
    }, {
      "name" : "lastModified",
      "value" : 1610741552758
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:documentmetadata xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <objectclassname>D1</objectclassname>
    <properties>
        <property name="displayname">
            <string>displayname-value</string>
        </property>
        <property name="name">
            <string>name-value</string>
        </property>
    </properties>
    <contentproperties>
        <contentproperty name="displayName">
            <string>displayname-value</string>
        </contentproperty>
        <contentproperty name="contentType">
            <string>text/plain; charset="iso-8859-1"</string>
        </contentproperty>
    </contentproperties>
    <contentitemproperties>
        <contentitemproperty>
            <property name="displayName">
                <string>displayname-value</string>
            </property>
            <property name="contentType">
                <string>text/plain; charset="iso-8859-1"</string>
            </property>
            <property name="lastModified">
                <datetime>2021-01-15T21:12:32.758+01:00</datetime>
            </property>
        </contentitemproperty>
    </contentitemproperties>
</ns2:documentmetadata>

XML Schema

Source: schema.xsd

<xs:element name="documentmetadata" type="tns:documentmetadata"/>

application/xml, application/json (ns3:resourcekey)

the resourcekey of the created resource
XML Schema

Source: schema.xsd

<xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0" maxOccurs="unbounded"/>
header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

multipart/mixed (ns3:documentmetadata)

Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:documentmetadata xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <objectclassname>D1</objectclassname>
    <properties>
        <property name="displayname">
            <string>displayname-value</string>
        </property>
        <property name="name">
            <string>name-value</string>
        </property>
    </properties>
    <contentproperties>
        <contentproperty name="displayName">
            <string>displayname-value</string>
        </contentproperty>
        <contentproperty name="contentType">
            <string>text/plain; charset="iso-8859-1"</string>
        </contentproperty>
    </contentproperties>
    <contentitemproperties>
        <contentitemproperty>
            <property name="displayName">
                <string>displayname-value</string>
            </property>
            <property name="contentType">
                <string>text/plain; charset="iso-8859-1"</string>
            </property>
            <property name="lastModified">
                <datetime>2021-01-15T21:12:32.758+01:00</datetime>
            </property>
        </contentitemproperty>
    </contentitemproperties>
</ns2:documentmetadata>

XML Schema

Source: schema.xsd

<xs:element name="documentmetadata" type="tns:documentmetadata"/>

application/xml, application/json (ns3:resourcekey)

the resourcekey of the created resource
XML Schema

Source: schema.xsd

<xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0" maxOccurs="unbounded"/>
header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

multipart/form-data

multipart/form-data

text/plain

application/xml, application/json (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

text/html

application/xhtml+xml

application/xml (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

multipart/mixed (ns3:documentmetadata)

Example
    <?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:documentmetadata xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <objectclassname>D1</objectclassname>
    <properties>
        <property name="displayname">
            <string>displayname-value</string>
        </property>
        <property name="name">
            <string>name-value</string>
        </property>
    </properties>
    <contentproperties>
        <contentproperty name="displayName">
            <string>displayname-value</string>
        </contentproperty>
        <contentproperty name="contentType">
            <string>text/plain; charset="iso-8859-1"</string>
        </contentproperty>
    </contentproperties>
    <contentitemproperties>
        <contentitemproperty>
            <property name="displayName">
                <string>displayname-value</string>
            </property>
            <property name="contentType">
                <string>text/plain; charset="iso-8859-1"</string>
            </property>
            <property name="lastModified">
                <datetime>2021-01-15T21:12:32.758+01:00</datetime>
            </property>
        </contentitemproperty>
    </contentitemproperties>
</ns2:documentmetadata>

XML Schema

Source: schema.xsd

<xs:element name="documentmetadata" type="tns:documentmetadata"/>

*/*

*/*

application/x-www-form-urlencoded

*/*

none

text/plain

text/html

application/xhtml+xml

application/atom+xml

multipart/mixed

*/*

text/plain

*/*

text/plain

text/html

application/xhtml+xml

*/*

application/json (ns3:sessioninfo)

XML Schema

Source: schema.xsd

<xs:element name="sessioninfo" type="tns:sessioninfo"/><xs:element name="sessioninfo" type="tns:sessioninfo" minOccurs="0" maxOccurs="unbounded"/>

application/xml (ns3:sessioninfolist)

XML Schema

Source: schema.xsd

<xs:element name="sessioninfolist" type="tns:sessioninfolist"/>

application/json

application/json

application/xml (ns3:intlist)

XML Schema

Source: schema.xsd

<xs:element name="intlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="int" type="xs:int" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml (ns3:intlist)

XML Schema

Source: schema.xsd

<xs:element name="intlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="int" type="xs:int" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

*/*

application/xml (ns3:principalentityresult)

XML Schema

Source: schema.xsd

<xs:element name="principalentityresult" type="tns:principalentityresult"/>

application/json (ns3:principalentityresult)

XML Schema

Source: schema.xsd

<xs:element name="principalentityresult" type="tns:principalentityresult"/>

application/xml (ns3:principalentityresult)

XML Schema

Source: schema.xsd

<xs:element name="principalentityresult" type="tns:principalentityresult"/>

application/json (ns3:principalentityresult)

XML Schema

Source: schema.xsd

<xs:element name="principalentityresult" type="tns:principalentityresult"/>

application/xml (ns3:principalentityresult)

XML Schema

Source: schema.xsd

<xs:element name="principalentityresult" type="tns:principalentityresult"/>

application/json (ns3:principalentityresult)

XML Schema

Source: schema.xsd

<xs:element name="principalentityresult" type="tns:principalentityresult"/>

application/xml (ns3:principalentityresult)

XML Schema

Source: schema.xsd

<xs:element name="principalentityresult" type="tns:principalentityresult"/>

application/json (ns3:principalentityresult)

XML Schema

Source: schema.xsd

<xs:element name="principalentityresult" type="tns:principalentityresult"/>

application/xml, application/json (ns3:fulltextdocumentareasetting)

Example
    
JSON:
{
  "documentAreaName" : "MyDocAreaName",
  "repositoryIndexed" : true,
  "workflowIndexed" : true,
  "notesIndexed" : true,
  "indexedIndexingPropertyNames" : [ "property1", "property2" ],
  "lastModified" : 1610741552760
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:fulltextdocumentareasetting xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <documentAreaName>MyDocAreaName</documentAreaName>
    <repositoryIndexed>true</repositoryIndexed>
    <workflowIndexed>true</workflowIndexed>
    <notesIndexed>true</notesIndexed>
    <indexedindexingpropertynames>
        <property>property1</property>
        <property>property2</property>
    </indexedindexingpropertynames>
    <lastmodified>2021-01-15T21:12:32.760+01:00</lastmodified>
</ns2:fulltextdocumentareasetting>

XML Schema

Source: schema.xsd

<xs:element name="fulltextdocumentareasetting" type="tns:fulltextdocumentareasetting"/>
header parameters
parameter value description

Last-Modified

string

Modification date.

*/*

text/plain

application/xml, application/json (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

text/html

application/xhtml+xml

application/xml (ns3:properties)

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

Checks that a specified resource exists.

Resource not found.

application/xml (ns3:stringlist)

Example
        
JSON:
{
  "elements" : [ "8a8116b3-33d5ee05-0133-d5efbf76-000b", "8a8116b3-33d5ee05-0133-d5efbfca-000d" ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:stringlist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <string>8a8116b3-33d5ee05-0133-d5efbf76-000b</string>
    <string>8a8116b3-33d5ee05-0133-d5efbfca-000d</string>
</ns2:stringlist>

    

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/json (ns3:stringlist)

Example
        
JSON:
{
  "elements" : [ "8a8116b3-33d5ee05-0133-d5efbf76-000b", "8a8116b3-33d5ee05-0133-d5efbfca-000d" ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:stringlist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <string>8a8116b3-33d5ee05-0133-d5efbf76-000b</string>
    <string>8a8116b3-33d5ee05-0133-d5efbfca-000d</string>
</ns2:stringlist>

    

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml, application/json (ns3:principalentitylist)

XML Schema

Source: schema.xsd

<xs:element name="principalentitylist" type="tns:principalentitylist"/>

text/calendar

text/vcard

application/xml, application/json (ns3:workflowstarttemplatelist)

XML Schema

Source: schema.xsd

<xs:element name="workflowstarttemplatelist" type="tns:workflowstarttemplatelist"/>

application/atom+xml

*/*

text/plain

application/xml, application/json (ns3:domain)

Example
    
JSON:
{
  "domains" : [ {
    "domainName" : "nscale",
    "displayNameId" : "displayId",
    "descriptionId" : "descriptionId",
    "system" : false,
    "ldapServiceName" : "ldapServiceName",
    "gssRealmName" : "gssRealmName",
    "authenticationType" : "INTERN",
    "clientAuthenticationEnabled" : false,
    "userManagementRealmName" : "userManagementRealmName",
    "windowsPrincipalPrefix" : "CT",
    "knmSettingName" : null,
    "lastModified" : null,
    "synchronized" : false,
    "default" : false,
    "protected" : false
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:domains xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <domain domainname="nscale">
        <displaynameid>displayId</displaynameid>
        <descriptionid>descriptionId</descriptionid>
        <system>false</system>
        <default>false</default>
        <ldapServiceName>ldapServiceName</ldapServiceName>
        <gssRealmName>gssRealmName</gssRealmName>
        <authenticationtype>INTERN</authenticationtype>
        <protected>false</protected>
        <synchronized>false</synchronized>
        <clientauthenticationenabled>false</clientauthenticationenabled>
        <usermanagementrealmname>userManagementRealmName</usermanagementrealmname>
        <windowsprincipalprefix>CT</windowsprincipalprefix>
    </domain>
</ns2:domains>

XML Schema

Source: schema.xsd

<xs:element name="domain" type="tns:domain"/><xs:element name="domain" type="tns:domain" maxOccurs="unbounded"/>

text/plain

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

application/xml, application/json (ns3:principalentitylist)

Example
    
JSON:
{
  "users" : [ {
    "principalId" : "principalId",
    "name" : "gruppe",
    "domainName" : "domainName",
    "commonName" : "commonName",
    "email" : "email",
    "description" : "description",
    "active" : true,
    "activationDate" : null,
    "deactivationDate" : null,
    "deactivationReason" : "none",
    "lastModified" : 1610741552775,
    "changePasswordAllowed" : true,
    "mustChangePassword" : false,
    "passwordNeverExpires" : true,
    "imported" : false,
    "synchronized_" : true,
    "passwordExpirationDate" : null
  } ],
  "groups" : null,
  "positions" : null
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:principalentitylist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <users>
        <user>
            <principalid>principalId</principalid>
            <name>gruppe</name>
            <domainname>domainName</domainname>
            <commonname>commonName</commonname>
            <email>email</email>
            <description>description</description>
            <active>true</active>
            <deactivationreason>none</deactivationreason>
            <lastmodified>2021-01-15T21:12:32.775+01:00</lastmodified>
            <changepasswordallowed>true</changepasswordallowed>
            <mustchangepassword>false</mustchangepassword>
            <passwordneverexpires>true</passwordneverexpires>
            <imported>false</imported>
            <synchronized>true</synchronized>
        </user>
    </users>
</ns2:principalentitylist>

XML Schema

Source: schema.xsd

<xs:element name="principalentitylist" type="tns:principalentitylist"/>

text/html

application/xhtml+xml

application/xml, application/json (ns3:user)

Example
        
JSON:
{
  "principalId" : "principalId",
  "name" : "gruppe",
  "domainName" : "domainName",
  "commonName" : "commonName",
  "email" : "email",
  "description" : "description",
  "active" : true,
  "activationDate" : null,
  "deactivationDate" : null,
  "deactivationReason" : "none",
  "lastModified" : 1610741552775,
  "changePasswordAllowed" : true,
  "mustChangePassword" : false,
  "passwordNeverExpires" : true,
  "imported" : false,
  "synchronized_" : true,
  "passwordExpirationDate" : null
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:user xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <principalid>principalId</principalid>
    <name>gruppe</name>
    <domainname>domainName</domainname>
    <commonname>commonName</commonname>
    <email>email</email>
    <description>description</description>
    <active>true</active>
    <deactivationreason>none</deactivationreason>
    <lastmodified>2021-01-15T21:12:32.775+01:00</lastmodified>
    <changepasswordallowed>true</changepasswordallowed>
    <mustchangepassword>false</mustchangepassword>
    <passwordneverexpires>true</passwordneverexpires>
    <imported>false</imported>
    <synchronized>true</synchronized>
</ns2:user>

    

XML Schema

Source: schema.xsd

<xs:element name="user" type="tns:user"/><xs:element name="user" type="tns:user" minOccurs="0" maxOccurs="unbounded"/>

text/vcard

application/xml, application/json (ns3:masterdatascopes)

Example
    
JSON:
{
  "masterdatascopes" : [ {
    "name" : "scopename1",
    "displayNameId" : "displayNameId",
    "descriptionId" : "descriptionId",
    "lastModified" : 1610741552781,
    "ownerDocumentAreaName" : "ownerDocumentAreaName",
    "baseTableName" : "baseTableName",
    "writable" : false,
    "generateKey" : false,
    "catalog" : "catalog",
    "schema" : "schema",
    "group" : "group"
  }, {
    "name" : "scopename2",
    "displayNameId" : "displayNameId",
    "descriptionId" : "descriptionId",
    "lastModified" : 1610741552781,
    "ownerDocumentAreaName" : "ownerDocumentAreaName",
    "baseTableName" : "baseTableName",
    "writable" : false,
    "generateKey" : false,
    "catalog" : "catalog",
    "schema" : "schema",
    "group" : "group"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:masterdatascopes xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <masterdatascope name="scopename1">
        <displaynameid>displayNameId</displaynameid>
        <descriptionid>descriptionId</descriptionid>
        <lastmodified>2021-01-15T21:12:32.781+01:00</lastmodified>
        <ownerdocumentareaname>ownerDocumentAreaName</ownerdocumentareaname>
        <basetablename>baseTableName</basetablename>
        <writable>false</writable>
        <generatekey>false</generatekey>
        <catalog>catalog</catalog>
        <schema>schema</schema>
        <group>group</group>
    </masterdatascope>
    <masterdatascope name="scopename2">
        <displaynameid>displayNameId</displaynameid>
        <descriptionid>descriptionId</descriptionid>
        <lastmodified>2021-01-15T21:12:32.781+01:00</lastmodified>
        <ownerdocumentareaname>ownerDocumentAreaName</ownerdocumentareaname>
        <basetablename>baseTableName</basetablename>
        <writable>false</writable>
        <generatekey>false</generatekey>
        <catalog>catalog</catalog>
        <schema>schema</schema>
        <group>group</group>
    </masterdatascope>
</ns2:masterdatascopes>

XML Schema

Source: schema.xsd

<xs:element name="masterdatascopes" type="tns:masterdatascopes"/>

application/xml, application/json (ns3:masterdatascope)

Example
        
JSON:
{
  "name" : "scopename1",
  "displayNameId" : "displayNameId",
  "descriptionId" : "descriptionId",
  "lastModified" : 1610741552781,
  "ownerDocumentAreaName" : "ownerDocumentAreaName",
  "baseTableName" : "baseTableName",
  "writable" : false,
  "generateKey" : false,
  "catalog" : "catalog",
  "schema" : "schema",
  "group" : "group"
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:masterdatascope name="scopename1" xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <displaynameid>displayNameId</displaynameid>
    <descriptionid>descriptionId</descriptionid>
    <lastmodified>2021-01-15T21:12:32.781+01:00</lastmodified>
    <ownerdocumentareaname>ownerDocumentAreaName</ownerdocumentareaname>
    <basetablename>baseTableName</basetablename>
    <writable>false</writable>
    <generatekey>false</generatekey>
    <catalog>catalog</catalog>
    <schema>schema</schema>
    <group>group</group>
</ns2:masterdatascope>

    

XML Schema

Source: schema.xsd

<xs:element name="masterdatascope" type="tns:masterdatascope"/><xs:element name="masterdatascope" type="tns:masterdatascope" maxOccurs="unbounded"/>

*/*

text/plain

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

text/html

application/xhtml+xml

application/x-www-form-urlencoded

text/html

text/plain

text/html

application/xhtml+xml

application/xml

application/json

text/yaml

text/plain

application/xml

application/json

application/xml, application/json (ns3:propertydefinitions)

Example
    
JSON:
{
  "indexingPropertyDefinitions" : [ {
    "name" : "displayname",
    "type" : "AreaQualifiedIdentifierType",
    "displayNameId" : "displayname",
    "descriptionId" : "the displayname",
    "typeDetails" : {
      "systemPropertyOnly" : false,
      "length" : 100,
      "doubleScale" : 0,
      "doublePrecision" : 0
    },
    "usageCategory" : "REPOSITORY",
    "multiValueScope" : null,
    "propertyStateDescription" : {
      "protected_" : false,
      "selectable" : true,
      "searchable" : true,
      "sortable" : true,
      "headerState" : 1,
      "mandatory" : true,
      "free" : true,
      "newVersion" : true,
      "pdfaXmpState" : "None",
      "audited" : false
    },
    "group" : null,
    "columnName" : "DISPLAY_NAME",
    "tableName" : "RPRES",
    "keyColumnName" : "ID",
    "indexingReferenceKey" : null,
    "masterdataReference" : null,
    "system" : false,
    "virtual" : false,
    "originalClassName" : "String",
    "originalAttributeName" : "displayname",
    "transmitPolicy" : "DOWN",
    "lastModified" : 1610741552774
  } ],
  "formattedIndexingPropertyDefinitions" : [ {
    "name" : "defaultprocessdisplayname",
    "type" : "AreaQualifiedIdentifierType",
    "displayNameId" : "defaultprocessdisplayname",
    "descriptionId" : "the default process displayname",
    "typeDetails" : {
      "systemPropertyOnly" : false,
      "length" : 100,
      "doubleScale" : 0,
      "doublePrecision" : 0
    },
    "usageCategory" : "WORKFLOW",
    "multiValueScope" : null,
    "propertyStateDescription" : {
      "protected_" : false,
      "selectable" : true,
      "searchable" : true,
      "sortable" : true,
      "headerState" : 1,
      "mandatory" : true,
      "free" : true,
      "newVersion" : true,
      "pdfaXmpState" : "None",
      "audited" : false
    },
    "group" : "displayname",
    "system" : false,
    "queryOperand" : "queryOperand",
    "lastModified" : 1610741552772
  } ],
  "computedIndexingPropertyDefinitions" : [ {
    "name" : "creatorcommonname",
    "type" : "AreaQualifiedIdentifierType",
    "displayNameId" : "creatorcommonname",
    "descriptionId" : "name of the creator",
    "typeDetails" : {
      "systemPropertyOnly" : false,
      "length" : 100,
      "doubleScale" : 0,
      "doublePrecision" : 0
    },
    "usageCategory" : "REPOSITORY",
    "multiValueScope" : null,
    "propertyStateDescription" : {
      "protected_" : false,
      "selectable" : true,
      "searchable" : true,
      "sortable" : true,
      "headerState" : 1,
      "mandatory" : true,
      "free" : true,
      "newVersion" : true,
      "pdfaXmpState" : "None",
      "audited" : false
    },
    "group" : "creatorcommonname",
    "necessaryIndexingProperties" : [ "creator" ]
  } ],
  "fulltextPropertyDefinitions" : [ {
    "name" : "abstract",
    "type" : "AreaQualifiedIdentifierType",
    "displayNameId" : "abstract",
    "descriptionId" : "the abstract of a indexed resource",
    "typeDetails" : {
      "systemPropertyOnly" : false,
      "length" : 100,
      "doubleScale" : 0,
      "doublePrecision" : 0
    }
  } ],
  "masterdataPropertyDefinitions" : [ {
    "name" : "masterdataproperty",
    "type" : "AreaQualifiedIdentifierType",
    "displayNameId" : "masterdataproperty",
    "descriptionId" : "a masterdata property",
    "typeDetails" : {
      "systemPropertyOnly" : false,
      "length" : 100,
      "doubleScale" : 0,
      "doublePrecision" : 0
    },
    "masterdataScopeName" : "MasterdataScope",
    "columnName" : "MD_COL",
    "keyProperty" : false,
    "lastModified" : 1610741552774
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:propertydefinitions xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <indexingpropertydefinitions>
        <indexingpropertydefinition>
            <name>displayname</name>
            <type>AreaQualifiedIdentifierType</type>
            <displaynameid>displayname</displaynameid>
            <descriptionid>the displayname</descriptionid>
            <typedetails>
                <systempropertyonly>false</systempropertyonly>
                <length>100</length>
                <doublescale>0</doublescale>
                <doubleprecision>0</doubleprecision>
            </typedetails>
            <usagecategory>REPOSITORY</usagecategory>
            <propertystatedescription>
                <protected>false</protected>
                <selectable>true</selectable>
                <searchable>true</searchable>
                <sortable>true</sortable>
                <headerstate>1</headerstate>
                <mandatory>true</mandatory>
                <free>true</free>
                <newversion>true</newversion>
                <pdfaxmpstate>None</pdfaxmpstate>
                <audited>false</audited>
            </propertystatedescription>
            <columnname>DISPLAY_NAME</columnname>
            <tablename>RPRES</tablename>
            <keycolumnname>ID</keycolumnname>
            <system>false</system>
            <virtual>false</virtual>
            <originalclassname>String</originalclassname>
            <originalattributename>displayname</originalattributename>
            <transmitpolicy>DOWN</transmitpolicy>
            <lastmodified>2021-01-15T21:12:32.774+01:00</lastmodified>
        </indexingpropertydefinition>
    </indexingpropertydefinitions>
    <formattedindexingpropertydefinitions>
        <formattedindexingpropertydefinition>
            <name>defaultprocessdisplayname</name>
            <type>AreaQualifiedIdentifierType</type>
            <displaynameid>defaultprocessdisplayname</displaynameid>
            <descriptionid>the default process displayname</descriptionid>
            <typedetails>
                <systempropertyonly>false</systempropertyonly>
                <length>100</length>
                <doublescale>0</doublescale>
                <doubleprecision>0</doubleprecision>
            </typedetails>
            <usagecategory>WORKFLOW</usagecategory>
            <propertystatedescription>
                <protected>false</protected>
                <selectable>true</selectable>
                <searchable>true</searchable>
                <sortable>true</sortable>
                <headerstate>1</headerstate>
                <mandatory>true</mandatory>
                <free>true</free>
                <newversion>true</newversion>
                <pdfaxmpstate>None</pdfaxmpstate>
                <audited>false</audited>
            </propertystatedescription>
            <group>displayname</group>
            <system>false</system>
            <queryoperand>queryOperand</queryoperand>
            <lastmodified>2021-01-15T21:12:32.772+01:00</lastmodified>
        </formattedindexingpropertydefinition>
    </formattedindexingpropertydefinitions>
    <computedindexingpropertydefinitions>
        <computedindexingpropertydefinition>
            <name>creatorcommonname</name>
            <type>AreaQualifiedIdentifierType</type>
            <displaynameid>creatorcommonname</displaynameid>
            <descriptionid>name of the creator</descriptionid>
            <typedetails>
                <systempropertyonly>false</systempropertyonly>
                <length>100</length>
                <doublescale>0</doublescale>
                <doubleprecision>0</doubleprecision>
            </typedetails>
            <usagecategory>REPOSITORY</usagecategory>
            <propertystatedescription>
                <protected>false</protected>
                <selectable>true</selectable>
                <searchable>true</searchable>
                <sortable>true</sortable>
                <headerstate>1</headerstate>
                <mandatory>true</mandatory>
                <free>true</free>
                <newversion>true</newversion>
                <pdfaxmpstate>None</pdfaxmpstate>
                <audited>false</audited>
            </propertystatedescription>
            <group>creatorcommonname</group>
            <necessaryindexingproperties>
                <propertyname>creator</propertyname>
            </necessaryindexingproperties>
        </computedindexingpropertydefinition>
    </computedindexingpropertydefinitions>
    <fulltextpropertydefinitions>
        <fulltextpropertydefinition>
            <name>abstract</name>
            <type>AreaQualifiedIdentifierType</type>
            <displaynameid>abstract</displaynameid>
            <descriptionid>the abstract of a indexed resource</descriptionid>
            <typedetails>
                <systempropertyonly>false</systempropertyonly>
                <length>100</length>
                <doublescale>0</doublescale>
                <doubleprecision>0</doubleprecision>
            </typedetails>
        </fulltextpropertydefinition>
    </fulltextpropertydefinitions>
    <masterdatapropertydefinitions>
        <masterdatapropertydefinition>
            <name>masterdataproperty</name>
            <type>AreaQualifiedIdentifierType</type>
            <displaynameid>masterdataproperty</displaynameid>
            <descriptionid>a masterdata property</descriptionid>
            <typedetails>
                <systempropertyonly>false</systempropertyonly>
                <length>100</length>
                <doublescale>0</doublescale>
                <doubleprecision>0</doubleprecision>
            </typedetails>
            <masterdatascopename>MasterdataScope</masterdatascopename>
            <columnname>MD_COL</columnname>
            <keyproperty>false</keyproperty>
            <lastmodified>2021-01-15T21:12:32.774+01:00</lastmodified>
        </masterdatapropertydefinition>
    </masterdatapropertydefinitions>
</ns2:propertydefinitions>

XML Schema

Source: schema.xsd

<xs:element name="propertydefinitions" type="tns:propertydefinitions"/>

application/xml, application/json (ns3:propertydefinitions)

Example
        
JSON:
{
  "indexingPropertyDefinitions" : null,
  "formattedIndexingPropertyDefinitions" : null,
  "computedIndexingPropertyDefinitions" : null,
  "fulltextPropertyDefinitions" : null,
  "masterdataPropertyDefinitions" : [ {
    "name" : "masterdataproperty",
    "type" : "AreaQualifiedIdentifierType",
    "displayNameId" : "masterdataproperty",
    "descriptionId" : "a masterdata property",
    "typeDetails" : {
      "systemPropertyOnly" : false,
      "length" : 100,
      "doubleScale" : 0,
      "doublePrecision" : 0
    },
    "masterdataScopeName" : "MasterdataScope",
    "columnName" : "MD_COL",
    "keyProperty" : false,
    "lastModified" : 1610741552774
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:propertydefinitions xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <masterdatapropertydefinitions>
        <masterdatapropertydefinition>
            <name>masterdataproperty</name>
            <type>AreaQualifiedIdentifierType</type>
            <displaynameid>masterdataproperty</displaynameid>
            <descriptionid>a masterdata property</descriptionid>
            <typedetails>
                <systempropertyonly>false</systempropertyonly>
                <length>100</length>
                <doublescale>0</doublescale>
                <doubleprecision>0</doubleprecision>
            </typedetails>
            <masterdatascopename>MasterdataScope</masterdatascopename>
            <columnname>MD_COL</columnname>
            <keyproperty>false</keyproperty>
            <lastmodified>2021-01-15T21:12:32.774+01:00</lastmodified>
        </masterdatapropertydefinition>
    </masterdatapropertydefinitions>
</ns2:propertydefinitions>

    

XML Schema

Source: schema.xsd

<xs:element name="propertydefinitions" type="tns:propertydefinitions"/>

application/xml, application/json (ns3:propertydefinitions)

Example
        
JSON:
{
  "indexingPropertyDefinitions" : [ {
    "name" : "displayname",
    "type" : "AreaQualifiedIdentifierType",
    "displayNameId" : "displayname",
    "descriptionId" : "the displayname",
    "typeDetails" : {
      "systemPropertyOnly" : false,
      "length" : 100,
      "doubleScale" : 0,
      "doublePrecision" : 0
    },
    "usageCategory" : "REPOSITORY",
    "multiValueScope" : null,
    "propertyStateDescription" : {
      "protected_" : false,
      "selectable" : true,
      "searchable" : true,
      "sortable" : true,
      "headerState" : 1,
      "mandatory" : true,
      "free" : true,
      "newVersion" : true,
      "pdfaXmpState" : "None",
      "audited" : false
    },
    "group" : null,
    "columnName" : "DISPLAY_NAME",
    "tableName" : "RPRES",
    "keyColumnName" : "ID",
    "indexingReferenceKey" : null,
    "masterdataReference" : null,
    "system" : false,
    "virtual" : false,
    "originalClassName" : "String",
    "originalAttributeName" : "displayname",
    "transmitPolicy" : "DOWN",
    "lastModified" : 1610741552774
  } ],
  "formattedIndexingPropertyDefinitions" : null,
  "computedIndexingPropertyDefinitions" : null,
  "fulltextPropertyDefinitions" : null,
  "masterdataPropertyDefinitions" : null
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:propertydefinitions xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <indexingpropertydefinitions>
        <indexingpropertydefinition>
            <name>displayname</name>
            <type>AreaQualifiedIdentifierType</type>
            <displaynameid>displayname</displaynameid>
            <descriptionid>the displayname</descriptionid>
            <typedetails>
                <systempropertyonly>false</systempropertyonly>
                <length>100</length>
                <doublescale>0</doublescale>
                <doubleprecision>0</doubleprecision>
            </typedetails>
            <usagecategory>REPOSITORY</usagecategory>
            <propertystatedescription>
                <protected>false</protected>
                <selectable>true</selectable>
                <searchable>true</searchable>
                <sortable>true</sortable>
                <headerstate>1</headerstate>
                <mandatory>true</mandatory>
                <free>true</free>
                <newversion>true</newversion>
                <pdfaxmpstate>None</pdfaxmpstate>
                <audited>false</audited>
            </propertystatedescription>
            <columnname>DISPLAY_NAME</columnname>
            <tablename>RPRES</tablename>
            <keycolumnname>ID</keycolumnname>
            <system>false</system>
            <virtual>false</virtual>
            <originalclassname>String</originalclassname>
            <originalattributename>displayname</originalattributename>
            <transmitpolicy>DOWN</transmitpolicy>
            <lastmodified>2021-01-15T21:12:32.774+01:00</lastmodified>
        </indexingpropertydefinition>
    </indexingpropertydefinitions>
</ns2:propertydefinitions>

    

XML Schema

Source: schema.xsd

<xs:element name="propertydefinitions" type="tns:propertydefinitions"/>

application/xml, application/json (ns3:propertydefinitions)

Example
        
JSON:
{
  "indexingPropertyDefinitions" : null,
  "formattedIndexingPropertyDefinitions" : null,
  "computedIndexingPropertyDefinitions" : [ {
    "name" : "creatorcommonname",
    "type" : "AreaQualifiedIdentifierType",
    "displayNameId" : "creatorcommonname",
    "descriptionId" : "name of the creator",
    "typeDetails" : {
      "systemPropertyOnly" : false,
      "length" : 100,
      "doubleScale" : 0,
      "doublePrecision" : 0
    },
    "usageCategory" : "REPOSITORY",
    "multiValueScope" : null,
    "propertyStateDescription" : {
      "protected_" : false,
      "selectable" : true,
      "searchable" : true,
      "sortable" : true,
      "headerState" : 1,
      "mandatory" : true,
      "free" : true,
      "newVersion" : true,
      "pdfaXmpState" : "None",
      "audited" : false
    },
    "group" : "creatorcommonname",
    "necessaryIndexingProperties" : [ "creator" ]
  } ],
  "fulltextPropertyDefinitions" : null,
  "masterdataPropertyDefinitions" : null
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:propertydefinitions xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <computedindexingpropertydefinitions>
        <computedindexingpropertydefinition>
            <name>creatorcommonname</name>
            <type>AreaQualifiedIdentifierType</type>
            <displaynameid>creatorcommonname</displaynameid>
            <descriptionid>name of the creator</descriptionid>
            <typedetails>
                <systempropertyonly>false</systempropertyonly>
                <length>100</length>
                <doublescale>0</doublescale>
                <doubleprecision>0</doubleprecision>
            </typedetails>
            <usagecategory>REPOSITORY</usagecategory>
            <propertystatedescription>
                <protected>false</protected>
                <selectable>true</selectable>
                <searchable>true</searchable>
                <sortable>true</sortable>
                <headerstate>1</headerstate>
                <mandatory>true</mandatory>
                <free>true</free>
                <newversion>true</newversion>
                <pdfaxmpstate>None</pdfaxmpstate>
                <audited>false</audited>
            </propertystatedescription>
            <group>creatorcommonname</group>
            <necessaryindexingproperties>
                <propertyname>creator</propertyname>
            </necessaryindexingproperties>
        </computedindexingpropertydefinition>
    </computedindexingpropertydefinitions>
</ns2:propertydefinitions>

    

XML Schema

Source: schema.xsd

<xs:element name="propertydefinitions" type="tns:propertydefinitions"/>

application/xml, application/json (ns3:propertydefinitions)

Example
        
JSON:
{
  "indexingPropertyDefinitions" : null,
  "formattedIndexingPropertyDefinitions" : [ {
    "name" : "defaultprocessdisplayname",
    "type" : "AreaQualifiedIdentifierType",
    "displayNameId" : "defaultprocessdisplayname",
    "descriptionId" : "the default process displayname",
    "typeDetails" : {
      "systemPropertyOnly" : false,
      "length" : 100,
      "doubleScale" : 0,
      "doublePrecision" : 0
    },
    "usageCategory" : "WORKFLOW",
    "multiValueScope" : null,
    "propertyStateDescription" : {
      "protected_" : false,
      "selectable" : true,
      "searchable" : true,
      "sortable" : true,
      "headerState" : 1,
      "mandatory" : true,
      "free" : true,
      "newVersion" : true,
      "pdfaXmpState" : "None",
      "audited" : false
    },
    "group" : "displayname",
    "system" : false,
    "queryOperand" : "queryOperand",
    "lastModified" : 1610741552774
  } ],
  "computedIndexingPropertyDefinitions" : null,
  "fulltextPropertyDefinitions" : null,
  "masterdataPropertyDefinitions" : null
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:propertydefinitions xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <formattedindexingpropertydefinitions>
        <formattedindexingpropertydefinition>
            <name>defaultprocessdisplayname</name>
            <type>AreaQualifiedIdentifierType</type>
            <displaynameid>defaultprocessdisplayname</displaynameid>
            <descriptionid>the default process displayname</descriptionid>
            <typedetails>
                <systempropertyonly>false</systempropertyonly>
                <length>100</length>
                <doublescale>0</doublescale>
                <doubleprecision>0</doubleprecision>
            </typedetails>
            <usagecategory>WORKFLOW</usagecategory>
            <propertystatedescription>
                <protected>false</protected>
                <selectable>true</selectable>
                <searchable>true</searchable>
                <sortable>true</sortable>
                <headerstate>1</headerstate>
                <mandatory>true</mandatory>
                <free>true</free>
                <newversion>true</newversion>
                <pdfaxmpstate>None</pdfaxmpstate>
                <audited>false</audited>
            </propertystatedescription>
            <group>displayname</group>
            <system>false</system>
            <queryoperand>queryOperand</queryoperand>
            <lastmodified>2021-01-15T21:12:32.774+01:00</lastmodified>
        </formattedindexingpropertydefinition>
    </formattedindexingpropertydefinitions>
</ns2:propertydefinitions>

    

XML Schema

Source: schema.xsd

<xs:element name="propertydefinitions" type="tns:propertydefinitions"/>

application/xml, application/json (ns3:propertydefinitions)

Example
        
JSON:
{
  "indexingPropertyDefinitions" : null,
  "formattedIndexingPropertyDefinitions" : null,
  "computedIndexingPropertyDefinitions" : null,
  "fulltextPropertyDefinitions" : [ {
    "name" : "abstract",
    "type" : "AreaQualifiedIdentifierType",
    "displayNameId" : "abstract",
    "descriptionId" : "the abstract of a indexed resource",
    "typeDetails" : {
      "systemPropertyOnly" : false,
      "length" : 100,
      "doubleScale" : 0,
      "doublePrecision" : 0
    }
  } ],
  "masterdataPropertyDefinitions" : null
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:propertydefinitions xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <fulltextpropertydefinitions>
        <fulltextpropertydefinition>
            <name>abstract</name>
            <type>AreaQualifiedIdentifierType</type>
            <displaynameid>abstract</displaynameid>
            <descriptionid>the abstract of a indexed resource</descriptionid>
            <typedetails>
                <systempropertyonly>false</systempropertyonly>
                <length>100</length>
                <doublescale>0</doublescale>
                <doubleprecision>0</doubleprecision>
            </typedetails>
        </fulltextpropertydefinition>
    </fulltextpropertydefinitions>
</ns2:propertydefinitions>

    

XML Schema

Source: schema.xsd

<xs:element name="propertydefinitions" type="tns:propertydefinitions"/>

application/json

application/xml

*/*

text/plain

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

application/xml (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml, application/json (ns3:workflowinstancekeylist)

Example
    
JSON:
{
  "workflowInstanceKeys" : [ {
    "id" : "DA$NOTSET$1$NOTSET$NOTSET$1",
    "documentAreaName" : "MyDocAreaName",
    "instanceType" : "PROCESS_ID"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:workflowinstancekeylist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <workflowinstancekey id="DA$NOTSET$1$NOTSET$NOTSET$1">
        <areaname>MyDocAreaName</areaname>
        <type>PROCESS_ID</type>
    </workflowinstancekey>
</ns2:workflowinstancekeylist>

XML Schema

Source: schema.xsd

<xs:element name="workflowinstancekeylist" type="tns:workflowinstancekeylist"/>

application/xml, application/json (ns3:principalentitylist)

Example
    
JSON:
{
  "users" : null,
  "groups" : [ {
    "principalId" : "principalId",
    "name" : "gruppe",
    "domainName" : "domainName",
    "commonName" : "commonName",
    "email" : "email",
    "description" : "description",
    "active" : true,
    "activationDate" : null,
    "deactivationDate" : null,
    "deactivationReason" : "none",
    "lastModified" : 1610741552775,
    "imported" : false,
    "synchronized_" : false
  } ],
  "positions" : null
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:principalentitylist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <groups>
        <group>
            <principalid>principalId</principalid>
            <name>gruppe</name>
            <domainname>domainName</domainname>
            <commonname>commonName</commonname>
            <email>email</email>
            <description>description</description>
            <active>true</active>
            <deactivationreason>none</deactivationreason>
            <lastmodified>2021-01-15T21:12:32.775+01:00</lastmodified>
            <imported>false</imported>
            <synchronized>false</synchronized>
        </group>
    </groups>
</ns2:principalentitylist>

XML Schema

Source: schema.xsd

<xs:element name="principalentitylist" type="tns:principalentitylist"/>

text/html

application/xhtml+xml

application/xml, application/json (ns3:group)

Example
        
JSON:
{
  "principalId" : "principalId",
  "name" : "gruppe",
  "domainName" : "domainName",
  "commonName" : "commonName",
  "email" : "email",
  "description" : "description",
  "active" : true,
  "activationDate" : null,
  "deactivationDate" : null,
  "deactivationReason" : "none",
  "lastModified" : 1610741552775,
  "imported" : false,
  "synchronized_" : false
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:group xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <principalid>principalId</principalid>
    <name>gruppe</name>
    <domainname>domainName</domainname>
    <commonname>commonName</commonname>
    <email>email</email>
    <description>description</description>
    <active>true</active>
    <deactivationreason>none</deactivationreason>
    <lastmodified>2021-01-15T21:12:32.775+01:00</lastmodified>
    <imported>false</imported>
    <synchronized>false</synchronized>
</ns2:group>

    

XML Schema

Source: schema.xsd

<xs:element name="group" type="tns:group"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="tns:group" minOccurs="0" maxOccurs="unbounded"/>

application/xml, application/json (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml (ns3:group)

XML Schema

Source: schema.xsd

<xs:element name="group" type="tns:group"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="tns:group" minOccurs="0" maxOccurs="unbounded"/>

application/json (ns3:group)

XML Schema

Source: schema.xsd

<xs:element name="group" type="tns:group"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="tns:group" minOccurs="0" maxOccurs="unbounded"/>

application/xml, application/json (ns3:group)

Example
    
JSON:
{
  "principalId" : "principalId",
  "name" : "gruppe",
  "domainName" : "domainName",
  "commonName" : "commonName",
  "email" : "email",
  "description" : "description",
  "active" : true,
  "activationDate" : null,
  "deactivationDate" : null,
  "deactivationReason" : "none",
  "lastModified" : 1610741552775,
  "imported" : false,
  "synchronized_" : false
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:group xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <principalid>principalId</principalid>
    <name>gruppe</name>
    <domainname>domainName</domainname>
    <commonname>commonName</commonname>
    <email>email</email>
    <description>description</description>
    <active>true</active>
    <deactivationreason>none</deactivationreason>
    <lastmodified>2021-01-15T21:12:32.775+01:00</lastmodified>
    <imported>false</imported>
    <synchronized>false</synchronized>
</ns2:group>

XML Schema

Source: schema.xsd

<xs:element name="group" type="tns:group"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="tns:group" minOccurs="0" maxOccurs="unbounded"/>

application/xml, application/json (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml, application/json (ns3:group)

Example
        
JSON:
{
  "principalId" : "principalId",
  "name" : "gruppe",
  "domainName" : "domainName",
  "commonName" : "commonName",
  "email" : "email",
  "description" : "description",
  "active" : true,
  "activationDate" : null,
  "deactivationDate" : null,
  "deactivationReason" : "none",
  "lastModified" : 1610741552775,
  "imported" : false,
  "synchronized_" : false
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:group xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <principalid>principalId</principalid>
    <name>gruppe</name>
    <domainname>domainName</domainname>
    <commonname>commonName</commonname>
    <email>email</email>
    <description>description</description>
    <active>true</active>
    <deactivationreason>none</deactivationreason>
    <lastmodified>2021-01-15T21:12:32.775+01:00</lastmodified>
    <imported>false</imported>
    <synchronized>false</synchronized>
</ns2:group>

    

XML Schema

Source: schema.xsd

<xs:element name="group" type="tns:group"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="tns:group" minOccurs="0" maxOccurs="unbounded"/>

application/xml (ns3:group)

XML Schema

Source: schema.xsd

<xs:element name="group" type="tns:group"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="tns:group" minOccurs="0" maxOccurs="unbounded"/>

application/json (ns3:group)

XML Schema

Source: schema.xsd

<xs:element name="group" type="tns:group"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="xs:string" minOccurs="0"/><xs:element name="group" type="tns:group" minOccurs="0" maxOccurs="unbounded"/>

application/xml (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/json (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/json (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml, application/json (ns3:resourcekeylist)

Example
        
JSON:
{
  "resourceKeys" : [ {
    "id" : "DA$NOTSET$3$2$NOTSET",
    "areaName" : "MyDocAreaName",
    "type" : "DOCUMENT"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourcekeylist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <resourcekey id="DA$NOTSET$3$2$NOTSET">
        <areaname>MyDocAreaName</areaname>
        <type>DOCUMENT</type>
    </resourcekey>
</ns2:resourcekeylist>

    

XML Schema

Source: schema.xsd

<xs:element name="resourcekeylist" type="tns:resourcekeylist"/>

text/html

application/xhtml+xml

application/x-www-form-urlencoded

text/plain

text/html

application/json

text/plain

application/json

text/plain

text/plain

application/xml (ns3:property)

XML Schema

Source: schema.xsd

<xs:element name="property" type="tns:property"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="xs:string" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>

application/json (ns3:property)

XML Schema

Source: schema.xsd

<xs:element name="property" type="tns:property"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="xs:string" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>

text/html

application/xhtml+xml

application/xml, application/json (ns3:tasklayoutnameslist)

Example
    
JSON:
{
  "taskLayoutNames" : [ {
    "processName" : "Resubmission",
    "mappedLayoutNames" : [ {
      "task" : "Resubmission",
      "layoutNames" : [ {
        "name" : "default_viewresubmission_indexmask",
        "clientType" : "COCKPIT",
        "layoutType" : "WORKFLOW_INDEXING"
      } ]
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:tasklayoutnameslist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <tasklayoutnames>
        <processname>Resubmission</processname>
        <mappedlayoutnames>
            <mappedlayoutname task="Resubmission">
                <layoutnames>
                    <layoutname name="default_viewresubmission_indexmask">
                        <clienttype>COCKPIT</clienttype>
                        <layouttype>WORKFLOW_INDEXING</layouttype>
                    </layoutname>
                </layoutnames>
            </mappedlayoutname>
        </mappedlayoutnames>
    </tasklayoutnames>
</ns2:tasklayoutnameslist>

XML Schema

Source: schema.xsd

<xs:element name="tasklayoutnameslist" type="tns:tasklayoutnameslist"/>

application/xml, application/json (ns3:tasklayoutnames)

Example
        
JSON:
{
  "processName" : "Resubmission",
  "mappedLayoutNames" : [ {
    "task" : "Resubmission",
    "layoutNames" : [ {
      "name" : "default_viewresubmission_indexmask",
      "clientType" : "COCKPIT",
      "layoutType" : "WORKFLOW_INDEXING"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:tasklayoutnames xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <processname>Resubmission</processname>
    <mappedlayoutnames>
        <mappedlayoutname task="Resubmission">
            <layoutnames>
                <layoutname name="default_viewresubmission_indexmask">
                    <clienttype>COCKPIT</clienttype>
                    <layouttype>WORKFLOW_INDEXING</layouttype>
                </layoutname>
            </layoutnames>
        </mappedlayoutname>
    </mappedlayoutnames>
</ns2:tasklayoutnames>

    

XML Schema

Source: schema.xsd

<xs:element name="tasklayoutnames" type="tns:tasklayoutnames"/><xs:element name="tasklayoutnames" type="tns:tasklayoutnames" minOccurs="0" maxOccurs="unbounded"/>

application/xml, application/json (ns3:layouts)

Example
    
JSON:
{
  "layouts" : [ {
    "layoutName" : {
      "name" : "default_viewresubmission_indexmask",
      "clientType" : "COCKPIT",
      "layoutType" : "WORKFLOW_INDEXING"
    },
    "layoutMetadata" : {
      "layoutName" : {
        "name" : "default_viewresubmission_indexmask",
        "clientType" : "COCKPIT",
        "layoutType" : "WORKFLOW_INDEXING"
      },
      "masterdataScopeName" : "masterdatascope",
      "lastModified" : 1610741552766,
      "displayNameId" : "resubmission indexmask",
      "searchTemplate" : {
        "searchTemplateType" : "BasicSearchTemplate",
        "searchName" : {
          "name" : "default_viewresubmission_indexmask",
          "clientType" : "COCKPIT",
          "layoutType" : "WORKFLOW_INDEXING"
        },
        "hitlistName" : {
          "name" : "default_viewresubmission_indexmask",
          "clientType" : "COCKPIT",
          "layoutType" : "WORKFLOW_INDEXING"
        },
        "includeSubFolders" : true,
        "findFolders" : false,
        "findDocuments" : true,
        "findLinks" : false,
        "replacementForNavigation" : false,
        "showSearchCriteria" : false,
        "searchScopeDocumentArea" : false
      },
      "versionCreator" : "-2",
      "versionComment" : "this is an example for Rest-Layouts",
      "version" : 1,
      "assignable" : false,
      "propertiesUsed" : [ "resubmissionsubject", "resubmissionrecipientid", "resubmissionresubmissiondate", "processinitiator" ],
      "valueSetsUsed" : [ ],
      "layoutsUsed" : [ {
        "name" : "default_viewresubmission_indexmask",
        "clientType" : "COCKPIT",
        "layoutType" : "WORKFLOW_INDEXING"
      } ],
      "packetsUsed" : [ ],
      "embeddedLayoutTypes" : [ ]
    },
    "layoutData" : {
      "layoutName" : {
        "name" : "default_viewresubmission_indexmask",
        "clientType" : "COCKPIT",
        "layoutType" : "WORKFLOW_INDEXING"
      },
      "blobEntries" : [ {
        "key" : "key",
        "data" : "ZGF0YQ=="
      } ]
    },
    "masterdataScopeName" : "masterdatascope"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:layouts xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <layout>
        <layoutname name="default_viewresubmission_indexmask">
            <clienttype>COCKPIT</clienttype>
            <layouttype>WORKFLOW_INDEXING</layouttype>
        </layoutname>
        <layoutmetadata>
            <layoutname name="default_viewresubmission_indexmask">
                <clienttype>COCKPIT</clienttype>
                <layouttype>WORKFLOW_INDEXING</layouttype>
            </layoutname>
            <masterdatascopename>masterdatascope</masterdatascopename>
            <lastModified>2021-01-15T21:12:32.766+01:00</lastModified>
            <displaynameid>resubmission indexmask</displaynameid>
            <searchtemplate>
                <searchTemplateType>BasicSearchTemplate</searchTemplateType>
                <searchname name="default_viewresubmission_indexmask">
                    <clienttype>COCKPIT</clienttype>
                    <layouttype>WORKFLOW_INDEXING</layouttype>
                </searchname>
                <hitlistname name="default_viewresubmission_indexmask">
                    <clienttype>COCKPIT</clienttype>
                    <layouttype>WORKFLOW_INDEXING</layouttype>
                </hitlistname>
                <includesubfolders>true</includesubfolders>
                <findfolders>false</findfolders>
                <finddocuments>true</finddocuments>
                <findlinks>false</findlinks>
                <replacementfornavigation>false</replacementfornavigation>
                <showsearchcriteria>false</showsearchcriteria>
                <searchscopedocumentarea>false</searchscopedocumentarea>
            </searchtemplate>
            <versionCreator>-2</versionCreator>
            <versionComment>this is an example for Rest-Layouts</versionComment>
            <version>1</version>
            <assignable>false</assignable>
            <propertiesused>
                <string>resubmissionsubject</string>
                <string>resubmissionrecipientid</string>
                <string>resubmissionresubmissiondate</string>
                <string>processinitiator</string>
            </propertiesused>
            <valuesetsused/>
            <layoutsused>
                <layout name="default_viewresubmission_indexmask">
                    <clienttype>COCKPIT</clienttype>
                    <layouttype>WORKFLOW_INDEXING</layouttype>
                </layout>
            </layoutsused>
            <packetsused/>
            <embeddedLayoutTypes/>
        </layoutmetadata>
        <layoutdata>
            <layoutname name="default_viewresubmission_indexmask">
                <clienttype>COCKPIT</clienttype>
                <layouttype>WORKFLOW_INDEXING</layouttype>
            </layoutname>
            <blobentries>
                <blobentry key="key">
                    <data>ZGF0YQ==</data>
                </blobentry>
            </blobentries>
        </layoutdata>
        <masterdatascopename>masterdatascope</masterdatascopename>
    </layout>
</ns2:layouts>

XML Schema

Source: schema.xsd

<xs:element name="layouts" type="tns:layouts"/>

application/xml, application/json (ns3:layout)

Example
        
JSON:
{
  "layoutName" : {
    "name" : "default_viewresubmission_indexmask",
    "clientType" : "COCKPIT",
    "layoutType" : "WORKFLOW_INDEXING"
  },
  "layoutMetadata" : {
    "layoutName" : {
      "name" : "default_viewresubmission_indexmask",
      "clientType" : "COCKPIT",
      "layoutType" : "WORKFLOW_INDEXING"
    },
    "masterdataScopeName" : "masterdatascope",
    "lastModified" : 1610741552766,
    "displayNameId" : "resubmission indexmask",
    "searchTemplate" : {
      "searchTemplateType" : "BasicSearchTemplate",
      "searchName" : {
        "name" : "default_viewresubmission_indexmask",
        "clientType" : "COCKPIT",
        "layoutType" : "WORKFLOW_INDEXING"
      },
      "hitlistName" : {
        "name" : "default_viewresubmission_indexmask",
        "clientType" : "COCKPIT",
        "layoutType" : "WORKFLOW_INDEXING"
      },
      "includeSubFolders" : true,
      "findFolders" : false,
      "findDocuments" : true,
      "findLinks" : false,
      "replacementForNavigation" : false,
      "showSearchCriteria" : false,
      "searchScopeDocumentArea" : false
    },
    "versionCreator" : "-2",
    "versionComment" : "this is an example for Rest-Layouts",
    "version" : 1,
    "assignable" : false,
    "propertiesUsed" : [ "resubmissionsubject", "resubmissionrecipientid", "resubmissionresubmissiondate", "processinitiator" ],
    "valueSetsUsed" : [ ],
    "layoutsUsed" : [ {
      "name" : "default_viewresubmission_indexmask",
      "clientType" : "COCKPIT",
      "layoutType" : "WORKFLOW_INDEXING"
    } ],
    "packetsUsed" : [ ],
    "embeddedLayoutTypes" : [ ]
  },
  "layoutData" : {
    "layoutName" : {
      "name" : "default_viewresubmission_indexmask",
      "clientType" : "COCKPIT",
      "layoutType" : "WORKFLOW_INDEXING"
    },
    "blobEntries" : [ {
      "key" : "key",
      "data" : "ZGF0YQ=="
    } ]
  },
  "masterdataScopeName" : "masterdatascope"
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:layout xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <layoutname name="default_viewresubmission_indexmask">
        <clienttype>COCKPIT</clienttype>
        <layouttype>WORKFLOW_INDEXING</layouttype>
    </layoutname>
    <layoutmetadata>
        <layoutname name="default_viewresubmission_indexmask">
            <clienttype>COCKPIT</clienttype>
            <layouttype>WORKFLOW_INDEXING</layouttype>
        </layoutname>
        <masterdatascopename>masterdatascope</masterdatascopename>
        <lastModified>2021-01-15T21:12:32.766+01:00</lastModified>
        <displaynameid>resubmission indexmask</displaynameid>
        <searchtemplate>
            <searchTemplateType>BasicSearchTemplate</searchTemplateType>
            <searchname name="default_viewresubmission_indexmask">
                <clienttype>COCKPIT</clienttype>
                <layouttype>WORKFLOW_INDEXING</layouttype>
            </searchname>
            <hitlistname name="default_viewresubmission_indexmask">
                <clienttype>COCKPIT</clienttype>
                <layouttype>WORKFLOW_INDEXING</layouttype>
            </hitlistname>
            <includesubfolders>true</includesubfolders>
            <findfolders>false</findfolders>
            <finddocuments>true</finddocuments>
            <findlinks>false</findlinks>
            <replacementfornavigation>false</replacementfornavigation>
            <showsearchcriteria>false</showsearchcriteria>
            <searchscopedocumentarea>false</searchscopedocumentarea>
        </searchtemplate>
        <versionCreator>-2</versionCreator>
        <versionComment>this is an example for Rest-Layouts</versionComment>
        <version>1</version>
        <assignable>false</assignable>
        <propertiesused>
            <string>resubmissionsubject</string>
            <string>resubmissionrecipientid</string>
            <string>resubmissionresubmissiondate</string>
            <string>processinitiator</string>
        </propertiesused>
        <valuesetsused/>
        <layoutsused>
            <layout name="default_viewresubmission_indexmask">
                <clienttype>COCKPIT</clienttype>
                <layouttype>WORKFLOW_INDEXING</layouttype>
            </layout>
        </layoutsused>
        <packetsused/>
        <embeddedLayoutTypes/>
    </layoutmetadata>
    <layoutdata>
        <layoutname name="default_viewresubmission_indexmask">
            <clienttype>COCKPIT</clienttype>
            <layouttype>WORKFLOW_INDEXING</layouttype>
        </layoutname>
        <blobentries>
            <blobentry key="key">
                <data>ZGF0YQ==</data>
            </blobentry>
        </blobentries>
    </layoutdata>
    <masterdatascopename>masterdatascope</masterdatascopename>
</ns2:layout>

    

XML Schema

Source: schema.xsd

<xs:element name="layout" type="tns:layout"/><xs:element name="layout" type="tns:layoutname" minOccurs="0" maxOccurs="unbounded"/><xs:element name="layout" type="tns:layout" minOccurs="0" maxOccurs="unbounded"/>
header parameters
parameter value description

Last-Modified

string

Modification date.

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/plain

application/xml, application/json (ns3:docareas)

Example
    
JSON:
{
  "docAreas" : [ {
    "areaName" : "MyDocAreaName",
    "displayNameId" : "displayId",
    "descriptionId" : "descriptionId",
    "lockOwner" : "lockOwner",
    "rootFolderId" : "-1",
    "personalFolderId" : "DA$NOTSET$2$1$NOTSET"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:docareas xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <docarea areaname="MyDocAreaName">
        <displaynameid>displayId</displaynameid>
        <descriptionid>descriptionId</descriptionid>
        <lockowner>lockOwner</lockowner>
        <rootfolderid>-1</rootfolderid>
        <personalfolderid>DA$NOTSET$2$1$NOTSET</personalfolderid>
    </docarea>
</ns2:docareas>

XML Schema

Source: schema.xsd

<xs:element name="docareas" type="tns:docareas"/>

text/html

application/xhtml+xml

text/plain

application/xml, application/json (ns3:resourcekey)

Example
    
JSON:
{
  "id" : "DA$NOTSET$3$2$NOTSET",
  "areaName" : "MyDocAreaName",
  "type" : "DOCUMENT"
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourcekey id="DA$NOTSET$3$2$NOTSET" xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <areaname>MyDocAreaName</areaname>
    <type>DOCUMENT</type>
</ns2:resourcekey>

XML Schema

Source: schema.xsd

<xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0" maxOccurs="unbounded"/>

text/html

application/xhtml+xml

application/xml (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/json (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml, application/json (ns3:resourcekey)

Example
        
JSON:
{
  "id" : "DA$NOTSET$3$2$NOTSET",
  "areaName" : "MyDocAreaName",
  "type" : "DOCUMENT"
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourcekey id="DA$NOTSET$3$2$NOTSET" xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <areaname>MyDocAreaName</areaname>
    <type>DOCUMENT</type>
</ns2:resourcekey>

    

XML Schema

Source: schema.xsd

<xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0" maxOccurs="unbounded"/>

text/plain

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

multipart/mixed

multipart/mixed (ns3:resourcekey)

the resourcekey of the created resource
XML Schema

Source: schema.xsd

<xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0" maxOccurs="unbounded"/>
header parameters
parameter value description

Location

anyURI

The URI where the created document is accessible.

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

application/xml (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml, application/json (ns3:resourcekey)

the resourcekey of the created resource
XML Schema

Source: schema.xsd

<xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0" maxOccurs="unbounded"/>
header parameters
parameter value description

Location

anyURI

The URI where the created folder is accessible.

application/x-www-form-urlencoded

text/plain

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

text/plain

application/xml (ns3:resourceresult)

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

application/json (ns3:resourceresult)

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

text/plain

text/html

application/xhtml+xml

application/xml, application/json (ns3:authenticationinfo)

Example
    
JSON:
{
  "sessionPermissions" : {
    "folderPermissions" : [ {
      "customPermissions" : null,
      "areaName" : null,
      "objectclassName" : null,
      "readProperties" : false,
      "writeProperties" : false,
      "changeObjectclass" : false,
      "readNote" : false,
      "writeNote" : false,
      "lock" : false,
      "delete" : false,
      "finalize" : false,
      "archive" : false,
      "move" : false,
      "deleteNote" : false,
      "createFolder" : false,
      "createDocument" : false,
      "createLink" : false
    } ],
    "documentPermissions" : [ {
      "customPermissions" : null,
      "areaName" : null,
      "objectclassName" : null,
      "readProperties" : false,
      "writeProperties" : false,
      "changeObjectclass" : false,
      "readNote" : false,
      "writeNote" : false,
      "lock" : false,
      "delete" : false,
      "finalize" : false,
      "archive" : false,
      "move" : false,
      "deleteNote" : false,
      "readContent" : false,
      "writeContent" : false,
      "readAnnotation" : false,
      "writeAnnotation" : false,
      "readRendition" : false,
      "writeRendition" : false,
      "internalViewerPrint" : false,
      "deleteAnnotation" : false,
      "deleteRendition" : false,
      "writeArchivedContent" : false,
      "writeArchivedProperties" : false,
      "revertToVersion" : false
    } ],
    "linkPermissions" : [ {
      "customPermissions" : null,
      "areaName" : null,
      "objectclassName" : null,
      "readProperties" : false,
      "writeProperties" : false,
      "changeObjectclass" : false,
      "readNote" : false,
      "writeNote" : false,
      "lock" : false,
      "delete" : false,
      "finalize" : false,
      "archive" : false,
      "move" : false,
      "deleteNote" : false,
      "updateReferenceType" : false
    } ],
    "workflowPermissions" : [ {
      "customPermissions" : null,
      "areaName" : null,
      "wfname" : null,
      "start" : false,
      "writeProperties" : false,
      "suspend" : false,
      "resume" : false,
      "end" : false,
      "withdraw" : false,
      "reset" : false,
      "readTasks" : false,
      "readProcesses" : false
    } ]
  },
  "sessionPasswordRemainingDays" : 30,
  "sessionPasswordExpirationToWarn" : false,
  "sessionPasswordChangeAllowed" : false,
  "sessionPrincipalId" : "8a8116b3-33d5ee05-0133-d5efbf76-000b",
  "sessionPositionIds" : null,
  "sessionGroupIds" : null,
  "sessionDefaultPositionId" : null,
  "sessionObjectclassToLayoutsMapping" : null,
  "sessionObjectclassToLayoutTypedVariousLayoutsMapping" : null
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:authenticationinfo xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <sessionpermissions>
        <folderpermissions>
            <folderpermission>
                <readproperties>false</readproperties>
                <writeproperties>false</writeproperties>
                <changeobjectclass>false</changeobjectclass>
                <readnote>false</readnote>
                <writenote>false</writenote>
                <lock>false</lock>
                <delete>false</delete>
                <finalize>false</finalize>
                <archive>false</archive>
                <move>false</move>
                <deletenote>false</deletenote>
                <createfolder>false</createfolder>
                <createdocument>false</createdocument>
                <createlink>false</createlink>
            </folderpermission>
        </folderpermissions>
        <documentpermissions>
            <documentpermission>
                <readproperties>false</readproperties>
                <writeproperties>false</writeproperties>
                <changeobjectclass>false</changeobjectclass>
                <readnote>false</readnote>
                <writenote>false</writenote>
                <lock>false</lock>
                <delete>false</delete>
                <finalize>false</finalize>
                <archive>false</archive>
                <move>false</move>
                <deletenote>false</deletenote>
                <readcontent>false</readcontent>
                <writecontent>false</writecontent>
                <readannotation>false</readannotation>
                <writeannotation>false</writeannotation>
                <readrendition>false</readrendition>
                <writerendition>false</writerendition>
                <internalviewerPrint>false</internalviewerPrint>
                <deleteannotation>false</deleteannotation>
                <deleterendition>false</deleterendition>
                <writearchivedcontent>false</writearchivedcontent>
                <writearchivedproperties>false</writearchivedproperties>
                <reverttoversion>false</reverttoversion>
            </documentpermission>
        </documentpermissions>
        <linkpermissions>
            <linkpermission>
                <readproperties>false</readproperties>
                <writeproperties>false</writeproperties>
                <changeobjectclass>false</changeobjectclass>
                <readnote>false</readnote>
                <writenote>false</writenote>
                <lock>false</lock>
                <delete>false</delete>
                <finalize>false</finalize>
                <archive>false</archive>
                <move>false</move>
                <deletenote>false</deletenote>
                <updatereferencetype>false</updatereferencetype>
            </linkpermission>
        </linkpermissions>
        <workflowpermissions>
            <workflowpermission>
                <start>false</start>
                <writeproperties>false</writeproperties>
                <suspend>false</suspend>
                <resume>false</resume>
                <end>false</end>
                <withdraw>false</withdraw>
                <reset>false</reset>
                <readtasks>false</readtasks>
                <readprocesses>false</readprocesses>
            </workflowpermission>
        </workflowpermissions>
    </sessionpermissions>
    <sessionpasswordremainingdays>30</sessionpasswordremainingdays>
    <sessionpasswordexpirationtowarn>false</sessionpasswordexpirationtowarn>
    <sessionpasswordchangeallowed>false</sessionpasswordchangeallowed>
    <sessionprincipalid>8a8116b3-33d5ee05-0133-d5efbf76-000b</sessionprincipalid>
</ns2:authenticationinfo>

XML Schema

Source: schema.xsd

<xs:element name="authenticationinfo" type="tns:authenticationinfo"/>

text/html

application/xhtml+xml

application/x-www-form-urlencoded

*/*

text/plain

text/csv

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

application/atom+xml

text/html

application/xhtml+xml

application/x-www-form-urlencoded

application/atom+xml

application/atom+xml

application/rss+xml

text/html

application/x-www-form-urlencoded

text/html

application/atom+xml

application/rss+xml

application/atom+xml

application/rss+xml

text/html

application/atom+xml

application/rss+xml

text/html

text/html

application/x-www-form-urlencoded

text/html

application/xml, application/json (ns3:commonmessagesetting)

Example
    
JSON:
{
  "messageStoreSize" : 1000
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:commonmessagesetting xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <messagestoresize>1000</messagestoresize>
</ns2:commonmessagesetting>

XML Schema

Source: schema.xsd

<xs:element name="commonmessagesetting" type="tns:commonmessagesetting"/>

application/xml (ns3:commonmessagesetting)

XML Schema

Source: schema.xsd

<xs:element name="commonmessagesetting" type="tns:commonmessagesetting"/>

application/json (ns3:commonmessagesetting)

XML Schema

Source: schema.xsd

<xs:element name="commonmessagesetting" type="tns:commonmessagesetting"/>

application/xml

application/json

application/xml, application/json (ns3:workflowmessagesetting)

Example
        
JSON:
{
  "messagePropertyNames" : [ "processidentifier" ],
  "searchPropertyNames" : [ "processidentifier" ],
  "propertyChangePropertyNames" : [ "processidentifier" ],
  "allPropertyChanges" : false,
  "instanceAutoAddMode" : "None"
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:workflowmessagesetting xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <messagepropertyname>processidentifier</messagepropertyname>
    <searchpropertyname>processidentifier</searchpropertyname>
    <propertychangepropertyname>processidentifier</propertychangepropertyname>
    <allpropertychanges>false</allpropertychanges>
    <instanceautoaddmode>None</instanceautoaddmode>
</ns2:workflowmessagesetting>

    

XML Schema

Source: schema.xsd

<xs:element name="workflowmessagesetting" type="tns:workflowmessagesetting"/>

application/xml (ns3:workflowmessagesetting)

XML Schema

Source: schema.xsd

<xs:element name="workflowmessagesetting" type="tns:workflowmessagesetting"/>

application/json (ns3:workflowmessagesetting)

XML Schema

Source: schema.xsd

<xs:element name="workflowmessagesetting" type="tns:workflowmessagesetting"/>

application/xml, application/json (ns3:resourcemessagesetting)

Example
        
JSON:
{
  "messagePropertyNames" : [ "displayname" ],
  "searchPropertyNames" : [ "displayname" ],
  "propertyChangePropertyNames" : [ "displayname" ],
  "allPropertyChanges" : true,
  "contentPropertyChanges" : true,
  "textPlainContentChangeAsPropertyChange" : false,
  "textPlainContentHeadOffSize" : 100
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourcemessagesetting xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <messagepropertyname>displayname</messagepropertyname>
    <searchpropertyname>displayname</searchpropertyname>
    <propertychangepropertyname>displayname</propertychangepropertyname>
    <allpropertychanges>true</allpropertychanges>
    <contentpropertychanges>true</contentpropertychanges>
    <textplaincontentchangeaspropertychange>false</textplaincontentchangeaspropertychange>
    <textplaincontentheadoffsize>100</textplaincontentheadoffsize>
</ns2:resourcemessagesetting>

    

XML Schema

Source: schema.xsd

<xs:element name="resourcemessagesetting" type="tns:resourcemessagesetting"/>

application/xml (ns3:resourcemessagesetting)

XML Schema

Source: schema.xsd

<xs:element name="resourcemessagesetting" type="tns:resourcemessagesetting"/>

application/json (ns3:resourcemessagesetting)

XML Schema

Source: schema.xsd

<xs:element name="resourcemessagesetting" type="tns:resourcemessagesetting"/>

application/xml, application/json (ns3:roles)

Example
    
JSON:
{
  "roles" : [ {
    "areaName" : "DA",
    "roleName" : "everyone",
    "everyone" : true,
    "systemAdmin" : false,
    "descriptionId" : "the role for users without any specific role",
    "displayNameId" : "everyone",
    "lastModified" : 1610741552759
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:roles xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <role>
        <areaname>DA</areaname>
        <rolename>everyone</rolename>
        <everyone>true</everyone>
        <systemadmin>false</systemadmin>
        <descriptionid>the role for users without any specific role</descriptionid>
        <displaynameid>everyone</displaynameid>
        <lastmodified>2021-01-15T21:12:32.759+01:00</lastmodified>
    </role>
</ns2:roles>

XML Schema

Source: schema.xsd

<xs:element name="roles" type="tns:roles"/><xs:element name="roles" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>

application/xml, application/json (ns3:role)

Example
        
JSON:
{
  "areaName" : "DA",
  "roleName" : "everyone",
  "everyone" : true,
  "systemAdmin" : false,
  "descriptionId" : "the role for users without any specific role",
  "displayNameId" : "everyone",
  "lastModified" : 1610741552759
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:role xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <areaname>DA</areaname>
    <rolename>everyone</rolename>
    <everyone>true</everyone>
    <systemadmin>false</systemadmin>
    <descriptionid>the role for users without any specific role</descriptionid>
    <displaynameid>everyone</displaynameid>
    <lastmodified>2021-01-15T21:12:32.759+01:00</lastmodified>
</ns2:role>

    

XML Schema

Source: schema.xsd

<xs:element name="role" type="tns:role"/><xs:element name="role" minOccurs="0">
        <xs:simpleType>
          <xs:restriction base="xs:string">
            <xs:enumeration value="Chair"/>
            <xs:enumeration value="Required"/>
            <xs:enumeration value="Optional"/>
            <xs:enumeration value="Information"/>
          </xs:restriction>
        </xs:simpleType>
      </xs:element><xs:element name="role" type="tns:role" minOccurs="0" maxOccurs="unbounded"/>

application/xml, application/json (ns3:roles)

Example
        
JSON:
{
  "roles" : [ {
    "areaName" : "DA",
    "roleName" : "everyone",
    "everyone" : true,
    "systemAdmin" : false,
    "descriptionId" : "the role for users without any specific role",
    "displayNameId" : "everyone",
    "lastModified" : 1610741552759
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:roles xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <role>
        <areaname>DA</areaname>
        <rolename>everyone</rolename>
        <everyone>true</everyone>
        <systemadmin>false</systemadmin>
        <descriptionid>the role for users without any specific role</descriptionid>
        <displaynameid>everyone</displaynameid>
        <lastmodified>2021-01-15T21:12:32.759+01:00</lastmodified>
    </role>
</ns2:roles>

    

XML Schema

Source: schema.xsd

<xs:element name="roles" type="tns:roles"/><xs:element name="roles" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>

application/xml, application/json (ns3:roles)

Example
        
JSON:
{
  "roles" : [ {
    "areaName" : "DA",
    "roleName" : "everyone",
    "everyone" : true,
    "systemAdmin" : false,
    "descriptionId" : "the role for users without any specific role",
    "displayNameId" : "everyone",
    "lastModified" : 1610741552759
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:roles xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <role>
        <areaname>DA</areaname>
        <rolename>everyone</rolename>
        <everyone>true</everyone>
        <systemadmin>false</systemadmin>
        <descriptionid>the role for users without any specific role</descriptionid>
        <displaynameid>everyone</displaynameid>
        <lastmodified>2021-01-15T21:12:32.759+01:00</lastmodified>
    </role>
</ns2:roles>

    

XML Schema

Source: schema.xsd

<xs:element name="roles" type="tns:roles"/><xs:element name="roles" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>

none

any

application/xml, application/json (ns3:valuesetlist)

Example
    
JSON:
{
  "valueSets" : [ {
    "name" : "name",
    "lastModified" : 1610741552781,
    "displayNameId" : "displayNameId",
    "data" : "QUJD"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:valuesetlist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <valueset>
        <name>name</name>
        <lastModified>2021-01-15T21:12:32.781+01:00</lastModified>
        <displayNameId>displayNameId</displayNameId>
        <data>QUJD</data>
    </valueset>
</ns2:valuesetlist>

XML Schema

Source: schema.xsd

<xs:element name="valuesetlist" type="tns:valuesetlist"/>

application/xml, application/json (ns3:valueset)

Example
        
JSON:
{
  "name" : "name",
  "lastModified" : 1610741552781,
  "displayNameId" : "displayNameId",
  "data" : "QUJD"
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:valueset xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <name>name</name>
    <lastModified>2021-01-15T21:12:32.781+01:00</lastModified>
    <displayNameId>displayNameId</displayNameId>
    <data>QUJD</data>
</ns2:valueset>

    

XML Schema

Source: schema.xsd

<xs:element name="valueset" type="tns:valueset"/><xs:element name="valueset" type="tns:valueset" minOccurs="0" maxOccurs="unbounded"/>

application/xml, application/json (ns3:workflowresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "workflowInstanceKey" : {
      "id" : "DA$NOTSET$1$NOTSET$NOTSET$1",
      "documentAreaName" : "MyDocAreaName",
      "instanceType" : "PROCESS_ID"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:workflowresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <workflowinstancekey id="DA$NOTSET$1$NOTSET$NOTSET$1">
                <areaname>MyDocAreaName</areaname>
                <type>PROCESS_ID</type>
            </workflowinstancekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:workflowresult>

XML Schema

Source: schema.xsd

<xs:element name="workflowresult" type="tns:workflowresult"/>

text/plain

application/json (ns3:workflowresult)

XML Schema

Source: schema.xsd

<xs:element name="workflowresult" type="tns:workflowresult"/>

application/xml (ns3:workflowresult)

XML Schema

Source: schema.xsd

<xs:element name="workflowresult" type="tns:workflowresult"/>

text/html

application/xhtml+xml

text/plain

application/json (ns3:workflowresult)

XML Schema

Source: schema.xsd

<xs:element name="workflowresult" type="tns:workflowresult"/>

application/xml (ns3:workflowresult)

XML Schema

Source: schema.xsd

<xs:element name="workflowresult" type="tns:workflowresult"/>

text/html

application/xhtml+xml

application/xml (ns3:publishedresource)

XML Schema

Source: schema.xsd

<xs:element name="publishedresource" type="tns:publishedresource"/><xs:element name="publishedresource" type="tns:publishedresource" minOccurs="0" maxOccurs="unbounded"/>

application/json (ns3:publishedresource)

XML Schema

Source: schema.xsd

<xs:element name="publishedresource" type="tns:publishedresource"/><xs:element name="publishedresource" type="tns:publishedresource" minOccurs="0" maxOccurs="unbounded"/>

*/*

*/*

application/json (ns3:principalmessageslist)

XML Schema

Source: schema.xsd

<xs:element name="principalmessageslist" type="tns:principalmessageslist"/>

application/xml (ns3:principalmessageslist)

XML Schema

Source: schema.xsd

<xs:element name="principalmessageslist" type="tns:principalmessageslist"/>

application/atom+xml

*/*

text/plain

application/xml, application/json (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

text/html

application/xhtml+xml

application/json (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="resubmissionresubmissiondate">
        <string>2011-11-24</string>
    </property>
    <property name="resubmissionsubject">
        <string>New Subject</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

text/plain

application/xml, application/json (ns3:workflowresult)

Example
        
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "workflowInstanceKey" : {
      "id" : "DA$NOTSET$1$NOTSET$NOTSET$1",
      "documentAreaName" : "MyDocAreaName",
      "instanceType" : "PROCESS_ID"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:workflowresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <workflowinstancekey id="DA$NOTSET$1$NOTSET$NOTSET$1">
                <areaname>MyDocAreaName</areaname>
                <type>PROCESS_ID</type>
            </workflowinstancekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:workflowresult>

    

XML Schema

Source: schema.xsd

<xs:element name="workflowresult" type="tns:workflowresult"/>

text/html

application/xhtml+xml

text/plain

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

application/xml (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml, application/json (ns3:resourcekey)

the resourcekey of the created resource
XML Schema

Source: schema.xsd

<xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0" maxOccurs="unbounded"/>
header parameters
parameter value description

Location

anyURI

The URI where the created link is accessible.

application/xml (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml, application/json (ns3:masterdatakey)

Example
    
JSON:
{
  "id" : "MD$DA$I1",
  "masterdataScopeName" : "MD",
  "ownerDocumentAreaName" : "DA"
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:masterdatakey id="MD$DA$I1" xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <masterdatascopename>MD</masterdatascopename>
    <ownerdocumentareaname>DA</ownerdocumentareaname>
</ns2:masterdatakey>

XML Schema

Source: schema.xsd

<xs:element name="masterdatakey" type="tns:masterdatakey"/><xs:element name="masterdatakey" type="tns:masterdatakey"/>

application/xml, application/json (ns3:masterdataresult)

Example
    
JSON:
{
  "id" : "MD",
  "displayName" : "SEARCH",
  "count" : 1,
  "items" : [ {
    "masterdataKey" : {
      "id" : "MD$DA$I1",
      "masterdataScopeName" : "MD",
      "ownerDocumentAreaName" : "DA"
    },
    "properties" : [ {
      "name" : "MdName",
      "value" : "FiktiverName"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:masterdataresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>MD</id>
    <displayname>SEARCH</displayname>
    <count>1</count>
    <items>
        <item>
            <masterdatakey id="MD$DA$I1">
                <masterdatascopename>MD</masterdatascopename>
                <ownerdocumentareaname>DA</ownerdocumentareaname>
            </masterdatakey>
            <properties>
                <property name="MdName">
                    <string>FiktiverName</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:masterdataresult>

XML Schema

Source: schema.xsd

<xs:element name="masterdataresult" type="tns:masterdataresult"/>

*/*

application/xml (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml, application/json (ns3:masterdatakey)

Example
        
JSON:
{
  "id" : "MD$DA$I1",
  "masterdataScopeName" : "MD",
  "ownerDocumentAreaName" : "DA"
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:masterdatakey id="MD$DA$I1" xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <masterdatascopename>MD</masterdatascopename>
    <ownerdocumentareaname>DA</ownerdocumentareaname>
</ns2:masterdatakey>

    

XML Schema

Source: schema.xsd

<xs:element name="masterdatakey" type="tns:masterdatakey"/><xs:element name="masterdatakey" type="tns:masterdatakey"/>

application/xml (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/xml, application/json (ns3:properties)

Example
        
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

    

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/atom+xml (ns3:masterdataresult)

XML Schema

Source: schema.xsd

<xs:element name="masterdataresult" type="tns:masterdataresult"/>

application/json (ns3:masterdataresult)

XML Schema

Source: schema.xsd

<xs:element name="masterdataresult" type="tns:masterdataresult"/>

application/json (ns3:commonsetting)

XML Schema

Source: schema.xsd

<xs:element name="commonsetting" type="tns:commonsetting"/>

application/xml (ns3:commonsetting)

XML Schema

Source: schema.xsd

<xs:element name="commonsetting" type="tns:commonsetting"/>

text/html

application/xhtml+xml

text/plain

application/xml, application/json (ns3:workflowresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "workflowInstanceKey" : {
      "id" : "DA$NOTSET$1$NOTSET$NOTSET$1",
      "documentAreaName" : "MyDocAreaName",
      "instanceType" : "PROCESS_ID"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:workflowresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <workflowinstancekey id="DA$NOTSET$1$NOTSET$NOTSET$1">
                <areaname>MyDocAreaName</areaname>
                <type>PROCESS_ID</type>
            </workflowinstancekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:workflowresult>

XML Schema

Source: schema.xsd

<xs:element name="workflowresult" type="tns:workflowresult"/>

text/html

application/xhtml+xml

application/xml (ns3:workflowprocess)

Example
    
JSON:
{
  "name" : "Resubmission",
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:workflowprocess xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <name>Resubmission</name>
    <properties>
        <property name="resubmissionresubmissiondate">
            <string>2011-11-24</string>
        </property>
        <property name="resubmissionsubject">
            <string>New Subject</string>
        </property>
    </properties>
</ns2:workflowprocess>

XML Schema

Source: schema.xsd

<xs:element name="workflowprocess" type="tns:workflowprocess"/>

application/json (ns3:workflowprocess)

Example
    
JSON:
{
  "name" : "Resubmission",
  "properties" : [ {
    "name" : "resubmissionresubmissiondate",
    "value" : "2011-11-24"
  }, {
    "name" : "resubmissionsubject",
    "value" : "New Subject"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:workflowprocess xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <name>Resubmission</name>
    <properties>
        <property name="resubmissionresubmissiondate">
            <string>2011-11-24</string>
        </property>
        <property name="resubmissionsubject">
            <string>New Subject</string>
        </property>
    </properties>
</ns2:workflowprocess>

XML Schema

Source: schema.xsd

<xs:element name="workflowprocess" type="tns:workflowprocess"/>

application/xml, application/json (ns3:workflowinstancekey)

Example
    
JSON:
{
  "id" : "DA$NOTSET$1$NOTSET$NOTSET$1",
  "documentAreaName" : "MyDocAreaName",
  "instanceType" : "PROCESS_ID"
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:workflowinstancekey id="DA$NOTSET$1$NOTSET$NOTSET$1" xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <areaname>MyDocAreaName</areaname>
    <type>PROCESS_ID</type>
</ns2:workflowinstancekey>

XML Schema

Source: schema.xsd

<xs:element name="workflowinstancekey" type="tns:workflowinstancekey"/><xs:element name="workflowinstancekey" type="tns:workflowinstancekey"/><xs:element name="workflowinstancekey" type="tns:workflowinstancekey" minOccurs="0" maxOccurs="unbounded"/>

text/plain

application/json (ns3:workflowresult)

XML Schema

Source: schema.xsd

<xs:element name="workflowresult" type="tns:workflowresult"/>

application/xml (ns3:workflowresult)

XML Schema

Source: schema.xsd

<xs:element name="workflowresult" type="tns:workflowresult"/>

text/html

application/xhtml+xml

text/plain

application/json (ns3:workflowresult)

XML Schema

Source: schema.xsd

<xs:element name="workflowresult" type="tns:workflowresult"/>

application/xml (ns3:workflowresult)

XML Schema

Source: schema.xsd

<xs:element name="workflowresult" type="tns:workflowresult"/>

text/html

application/xhtml+xml

text/plain

application/xml, application/json (ns3:systeminfo)

Example
    
JSON:
{
  "version" : "123",
  "systemId" : "7.2.1000.4712",
  "serverTime" : 1610741552759,
  "locales" : [ "de", "en_US" ],
  "fulltextActive" : false
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:systeminfo xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <version>123</version>
    <systemid>7.2.1000.4712</systemid>
    <servertime>2021-01-15T21:12:32.759+01:00</servertime>
    <locales>
        <locale>de</locale>
        <locale>en_US</locale>
    </locales>
    <fulltextactive>false</fulltextactive>
</ns2:systeminfo>

XML Schema

Source: schema.xsd

<xs:element name="systeminfo" type="tns:systeminfo"/>

text/plain

application/xml

text/plain

application/xml

application/json

application/json

multipart/mixed

application/json

application/xml, application/json (ns3:publishedresourcelist)

Example
    
JSON:
{
  "publishedResource" : [ {
    "uuid" : "uuid",
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "publisher" : "publisher",
    "publisherName" : "publisherCommonName",
    "publisherCommonName" : null,
    "publishDate" : 1610741552782,
    "duration" : 1000,
    "areaName" : "MyDocAreaName",
    "displayname" : "displayname",
    "contentType" : "plain/text",
    "lastModifiedDate" : 1610741552782
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:publishedresourcelist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <publishedresource uuid="uuid">
        <resourcekey id="DA$NOTSET$3$2$NOTSET">
            <areaname>MyDocAreaName</areaname>
            <type>DOCUMENT</type>
        </resourcekey>
        <publisher>publisher</publisher>
        <publishername>publisherCommonName</publishername>
        <publishdate>2021-01-15T21:12:32.782+01:00</publishdate>
        <duration>1000</duration>
        <areaname>MyDocAreaName</areaname>
        <displayname>displayname</displayname>
        <contenttype>plain/text</contenttype>
        <lastmodifieddate>2021-01-15T21:12:32.782+01:00</lastmodifieddate>
    </publishedresource>
</ns2:publishedresourcelist>

XML Schema

Source: schema.xsd

<xs:element name="publishedresourcelist" type="tns:publishedresourcelist"/>

application/xml, application/json (ns3:publishedresourcelist)

Example
        
JSON:
{
  "publishedResource" : [ {
    "uuid" : "uuid",
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "publisher" : "publisher",
    "publisherName" : "publisherCommonName",
    "publisherCommonName" : null,
    "publishDate" : 1610741552782,
    "duration" : 1000,
    "areaName" : "MyDocAreaName",
    "displayname" : "displayname",
    "contentType" : "plain/text",
    "lastModifiedDate" : 1610741552782
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:publishedresourcelist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <publishedresource uuid="uuid">
        <resourcekey id="DA$NOTSET$3$2$NOTSET">
            <areaname>MyDocAreaName</areaname>
            <type>DOCUMENT</type>
        </resourcekey>
        <publisher>publisher</publisher>
        <publishername>publisherCommonName</publishername>
        <publishdate>2021-01-15T21:12:32.782+01:00</publishdate>
        <duration>1000</duration>
        <areaname>MyDocAreaName</areaname>
        <displayname>displayname</displayname>
        <contenttype>plain/text</contenttype>
        <lastmodifieddate>2021-01-15T21:12:32.782+01:00</lastmodifieddate>
    </publishedresource>
</ns2:publishedresourcelist>

    

XML Schema

Source: schema.xsd

<xs:element name="publishedresourcelist" type="tns:publishedresourcelist"/>

application/xml, application/json (ns3:processmetadatalist)

Example
    
JSON:
{
  "processMetadatas" : [ {
    "processName" : "Resubmission",
    "displayNameId" : "Resubmission",
    "descriptionId" : "Resubmission",
    "definitionTypeId" : "default",
    "creationDate" : 1610741552760,
    "lastModified" : 1610741552760,
    "taskNames" : [ "Wiedervorlegen", "Wiedervorgelegte Objekte" ],
    "mappedLayouts" : [ {
      "task" : "Wiedervorgelegte Objekte",
      "layoutNames" : [ {
        "name" : "default_viewresubmission_indexmask",
        "clientType" : "COCKPIT",
        "layoutType" : "WORKFLOW_INDEXING"
      } ]
    } ],
    "taskMetadata" : [ {
      "taskName" : "Wiedervorgelegte Objekte",
      "displayNameId" : "Reminder",
      "descriptionId" : "",
      "endLabelId" : "Delete"
    } ],
    "propertiesUsed" : [ "resubmissionsubject", "resubmissionrecipientid", "resubmissionresubmissiondate", "processinitiator" ],
    "orgEntityIdsUsed" : [ ],
    "active" : true,
    "activationDate" : 1610741552762,
    "lastStartDate" : 1610741552762,
    "version" : 1,
    "startBehavior" : {
      "basketBehavior" : "ExistingFolderMustNotBeUsed",
      "attachmentBehavior" : [ "Copy", "Link", "None" ],
      "priorityBehavior" : [ "High", "Low", "Normal", "VeryLow", "VeryHigh" ],
      "allowedFolderObjectclasses" : [ "B0" ],
      "allowAllFolderObjectclasses" : false
    },
    "allocableSubProcessDefinitions" : null,
    "displayNameReferencePropertyName" : "defaultresubmissiondisplayname",
    "hasStartTask" : true,
    "versionComment" : "Initial version.",
    "moveToManagedBasket" : false
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:processmetadatalist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <processmetadata>
        <processname>Resubmission</processname>
        <displaynameid>Resubmission</displaynameid>
        <descriptionid>Resubmission</descriptionid>
        <definitiontypeid>default</definitiontypeid>
        <creationdate>2021-01-15T21:12:32.760+01:00</creationdate>
        <lastmodified>2021-01-15T21:12:32.760+01:00</lastmodified>
        <tasknames>
            <tasknames>Wiedervorlegen</tasknames>
            <tasknames>Wiedervorgelegte Objekte</tasknames>
        </tasknames>
        <mappedlayouts>
            <mappedlayouts task="Wiedervorgelegte Objekte">
                <layoutnames>
                    <layoutname name="default_viewresubmission_indexmask">
                        <clienttype>COCKPIT</clienttype>
                        <layouttype>WORKFLOW_INDEXING</layouttype>
                    </layoutname>
                </layoutnames>
            </mappedlayouts>
        </mappedlayouts>
        <taskmetadata>
            <taskmetadata>
                <taskname>Wiedervorgelegte Objekte</taskname>
                <displaynameid>Reminder</displaynameid>
                <descriptionid></descriptionid>
                <endlabelid>Delete</endlabelid>
            </taskmetadata>
        </taskmetadata>
        <propertiesused>
            <propertiesused>resubmissionsubject</propertiesused>
            <propertiesused>resubmissionrecipientid</propertiesused>
            <propertiesused>resubmissionresubmissiondate</propertiesused>
            <propertiesused>processinitiator</propertiesused>
        </propertiesused>
        <orgentityidsused/>
        <active>true</active>
        <activationdate>2021-01-15T21:12:32.762+01:00</activationdate>
        <laststartdate>2021-01-15T21:12:32.762+01:00</laststartdate>
        <version>1</version>
        <startbehavior>
            <basketbehavior>ExistingFolderMustNotBeUsed</basketbehavior>
            <attachmentbehavior>Copy</attachmentbehavior>
            <attachmentbehavior>Link</attachmentbehavior>
            <attachmentbehavior>None</attachmentbehavior>
            <prioritybehavior>High</prioritybehavior>
            <prioritybehavior>Low</prioritybehavior>
            <prioritybehavior>Normal</prioritybehavior>
            <prioritybehavior>VeryLow</prioritybehavior>
            <prioritybehavior>VeryHigh</prioritybehavior>
            <allowedfolderobjectclasses>B0</allowedfolderobjectclasses>
            <allowallfolderobjectclasses>false</allowallfolderobjectclasses>
        </startbehavior>
        <displaynamereferencepropertyname>defaultresubmissiondisplayname</displaynamereferencepropertyname>
        <hasstarttask>true</hasstarttask>
        <versioncomment>Initial version.</versioncomment>
        <movetomanagedbasket>false</movetomanagedbasket>
    </processmetadata>
</ns2:processmetadatalist>

XML Schema

Source: schema.xsd

<xs:element name="processmetadatalist" type="tns:processmetadatalist"/>

application/xml, application/json (ns3:processmetadatalist)

Example
        
JSON:
{
  "processMetadatas" : [ {
    "processName" : "Resubmission",
    "displayNameId" : "Resubmission",
    "descriptionId" : "Resubmission",
    "definitionTypeId" : "default",
    "creationDate" : 1610741552760,
    "lastModified" : 1610741552760,
    "taskNames" : [ "Wiedervorlegen", "Wiedervorgelegte Objekte" ],
    "mappedLayouts" : [ {
      "task" : "Wiedervorgelegte Objekte",
      "layoutNames" : [ {
        "name" : "default_viewresubmission_indexmask",
        "clientType" : "COCKPIT",
        "layoutType" : "WORKFLOW_INDEXING"
      } ]
    } ],
    "taskMetadata" : [ {
      "taskName" : "Wiedervorgelegte Objekte",
      "displayNameId" : "Reminder",
      "descriptionId" : "",
      "endLabelId" : "Delete"
    } ],
    "propertiesUsed" : [ "resubmissionsubject", "resubmissionrecipientid", "resubmissionresubmissiondate", "processinitiator" ],
    "orgEntityIdsUsed" : [ ],
    "active" : true,
    "activationDate" : 1610741552762,
    "lastStartDate" : 1610741552762,
    "version" : 1,
    "startBehavior" : {
      "basketBehavior" : "ExistingFolderMustNotBeUsed",
      "attachmentBehavior" : [ "Copy", "Link", "None" ],
      "priorityBehavior" : [ "High", "Low", "Normal", "VeryLow", "VeryHigh" ],
      "allowedFolderObjectclasses" : [ "B0" ],
      "allowAllFolderObjectclasses" : false
    },
    "allocableSubProcessDefinitions" : null,
    "displayNameReferencePropertyName" : "defaultresubmissiondisplayname",
    "hasStartTask" : true,
    "versionComment" : "Initial version.",
    "moveToManagedBasket" : false
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:processmetadatalist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <processmetadata>
        <processname>Resubmission</processname>
        <displaynameid>Resubmission</displaynameid>
        <descriptionid>Resubmission</descriptionid>
        <definitiontypeid>default</definitiontypeid>
        <creationdate>2021-01-15T21:12:32.760+01:00</creationdate>
        <lastmodified>2021-01-15T21:12:32.760+01:00</lastmodified>
        <tasknames>
            <tasknames>Wiedervorlegen</tasknames>
            <tasknames>Wiedervorgelegte Objekte</tasknames>
        </tasknames>
        <mappedlayouts>
            <mappedlayouts task="Wiedervorgelegte Objekte">
                <layoutnames>
                    <layoutname name="default_viewresubmission_indexmask">
                        <clienttype>COCKPIT</clienttype>
                        <layouttype>WORKFLOW_INDEXING</layouttype>
                    </layoutname>
                </layoutnames>
            </mappedlayouts>
        </mappedlayouts>
        <taskmetadata>
            <taskmetadata>
                <taskname>Wiedervorgelegte Objekte</taskname>
                <displaynameid>Reminder</displaynameid>
                <descriptionid></descriptionid>
                <endlabelid>Delete</endlabelid>
            </taskmetadata>
        </taskmetadata>
        <propertiesused>
            <propertiesused>resubmissionsubject</propertiesused>
            <propertiesused>resubmissionrecipientid</propertiesused>
            <propertiesused>resubmissionresubmissiondate</propertiesused>
            <propertiesused>processinitiator</propertiesused>
        </propertiesused>
        <orgentityidsused/>
        <active>true</active>
        <activationdate>2021-01-15T21:12:32.762+01:00</activationdate>
        <laststartdate>2021-01-15T21:12:32.762+01:00</laststartdate>
        <version>1</version>
        <startbehavior>
            <basketbehavior>ExistingFolderMustNotBeUsed</basketbehavior>
            <attachmentbehavior>Copy</attachmentbehavior>
            <attachmentbehavior>Link</attachmentbehavior>
            <attachmentbehavior>None</attachmentbehavior>
            <prioritybehavior>High</prioritybehavior>
            <prioritybehavior>Low</prioritybehavior>
            <prioritybehavior>Normal</prioritybehavior>
            <prioritybehavior>VeryLow</prioritybehavior>
            <prioritybehavior>VeryHigh</prioritybehavior>
            <allowedfolderobjectclasses>B0</allowedfolderobjectclasses>
            <allowallfolderobjectclasses>false</allowallfolderobjectclasses>
        </startbehavior>
        <displaynamereferencepropertyname>defaultresubmissiondisplayname</displaynamereferencepropertyname>
        <hasstarttask>true</hasstarttask>
        <versioncomment>Initial version.</versioncomment>
        <movetomanagedbasket>false</movetomanagedbasket>
    </processmetadata>
</ns2:processmetadatalist>

    

XML Schema

Source: schema.xsd

<xs:element name="processmetadatalist" type="tns:processmetadatalist"/>

application/xml, application/json (ns3:processmetadatalist)

Example
        
JSON:
{
  "processName" : "Resubmission",
  "displayNameId" : "Resubmission",
  "descriptionId" : "Resubmission",
  "definitionTypeId" : "default",
  "creationDate" : 1610741552760,
  "lastModified" : 1610741552760,
  "taskNames" : [ "Wiedervorlegen", "Wiedervorgelegte Objekte" ],
  "mappedLayouts" : [ {
    "task" : "Wiedervorgelegte Objekte",
    "layoutNames" : [ {
      "name" : "default_viewresubmission_indexmask",
      "clientType" : "COCKPIT",
      "layoutType" : "WORKFLOW_INDEXING"
    } ]
  } ],
  "taskMetadata" : [ {
    "taskName" : "Wiedervorgelegte Objekte",
    "displayNameId" : "Reminder",
    "descriptionId" : "",
    "endLabelId" : "Delete"
  } ],
  "propertiesUsed" : [ "resubmissionsubject", "resubmissionrecipientid", "resubmissionresubmissiondate", "processinitiator" ],
  "orgEntityIdsUsed" : [ ],
  "active" : true,
  "activationDate" : 1610741552762,
  "lastStartDate" : 1610741552762,
  "version" : 1,
  "startBehavior" : {
    "basketBehavior" : "ExistingFolderMustNotBeUsed",
    "attachmentBehavior" : [ "Copy", "Link", "None" ],
    "priorityBehavior" : [ "High", "Low", "Normal", "VeryLow", "VeryHigh" ],
    "allowedFolderObjectclasses" : [ "B0" ],
    "allowAllFolderObjectclasses" : false
  },
  "allocableSubProcessDefinitions" : null,
  "displayNameReferencePropertyName" : "defaultresubmissiondisplayname",
  "hasStartTask" : true,
  "versionComment" : "Initial version.",
  "moveToManagedBasket" : false
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:processmetadata xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <processname>Resubmission</processname>
    <displaynameid>Resubmission</displaynameid>
    <descriptionid>Resubmission</descriptionid>
    <definitiontypeid>default</definitiontypeid>
    <creationdate>2021-01-15T21:12:32.760+01:00</creationdate>
    <lastmodified>2021-01-15T21:12:32.760+01:00</lastmodified>
    <tasknames>
        <tasknames>Wiedervorlegen</tasknames>
        <tasknames>Wiedervorgelegte Objekte</tasknames>
    </tasknames>
    <mappedlayouts>
        <mappedlayouts task="Wiedervorgelegte Objekte">
            <layoutnames>
                <layoutname name="default_viewresubmission_indexmask">
                    <clienttype>COCKPIT</clienttype>
                    <layouttype>WORKFLOW_INDEXING</layouttype>
                </layoutname>
            </layoutnames>
        </mappedlayouts>
    </mappedlayouts>
    <taskmetadata>
        <taskmetadata>
            <taskname>Wiedervorgelegte Objekte</taskname>
            <displaynameid>Reminder</displaynameid>
            <descriptionid></descriptionid>
            <endlabelid>Delete</endlabelid>
        </taskmetadata>
    </taskmetadata>
    <propertiesused>
        <propertiesused>resubmissionsubject</propertiesused>
        <propertiesused>resubmissionrecipientid</propertiesused>
        <propertiesused>resubmissionresubmissiondate</propertiesused>
        <propertiesused>processinitiator</propertiesused>
    </propertiesused>
    <orgentityidsused/>
    <active>true</active>
    <activationdate>2021-01-15T21:12:32.762+01:00</activationdate>
    <laststartdate>2021-01-15T21:12:32.762+01:00</laststartdate>
    <version>1</version>
    <startbehavior>
        <basketbehavior>ExistingFolderMustNotBeUsed</basketbehavior>
        <attachmentbehavior>Copy</attachmentbehavior>
        <attachmentbehavior>Link</attachmentbehavior>
        <attachmentbehavior>None</attachmentbehavior>
        <prioritybehavior>High</prioritybehavior>
        <prioritybehavior>Low</prioritybehavior>
        <prioritybehavior>Normal</prioritybehavior>
        <prioritybehavior>VeryLow</prioritybehavior>
        <prioritybehavior>VeryHigh</prioritybehavior>
        <allowedfolderobjectclasses>B0</allowedfolderobjectclasses>
        <allowallfolderobjectclasses>false</allowallfolderobjectclasses>
    </startbehavior>
    <displaynamereferencepropertyname>defaultresubmissiondisplayname</displaynamereferencepropertyname>
    <hasstarttask>true</hasstarttask>
    <versioncomment>Initial version.</versioncomment>
    <movetomanagedbasket>false</movetomanagedbasket>
</ns2:processmetadata>

    

XML Schema

Source: schema.xsd

<xs:element name="processmetadatalist" type="tns:processmetadatalist"/>

*/*

application/xml, application/json (ns3:globalclientsetting)

XML Schema

Source: schema.xsd

<xs:element name="globalclientsetting" type="tns:globalclientsetting"/><xs:element name="globalclientsetting" type="tns:globalclientsetting" maxOccurs="unbounded"/>

application/json (ns3:globalclientsettings)

XML Schema

Source: schema.xsd

<xs:element name="globalclientsettings" type="tns:globalclientsettings"/>

application/xml (ns3:globalclientsettings)

XML Schema

Source: schema.xsd

<xs:element name="globalclientsettings" type="tns:globalclientsettings"/>

application/json (ns3:globalclientsettings)

XML Schema

Source: schema.xsd

<xs:element name="globalclientsettings" type="tns:globalclientsettings"/>

application/xml (ns3:globalclientsettings)

XML Schema

Source: schema.xsd

<xs:element name="globalclientsettings" type="tns:globalclientsettings"/>

application/json (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml (ns3:stringlist)

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml, application/json (ns3:globalclientsetting)

XML Schema

Source: schema.xsd

<xs:element name="globalclientsetting" type="tns:globalclientsetting"/><xs:element name="globalclientsetting" type="tns:globalclientsetting" maxOccurs="unbounded"/>

text/plain

text/plain

text/plain

application/xml, application/json (ns3:resourcekey)

the resourcekey of the created resource
XML Schema

Source: schema.xsd

<xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0" maxOccurs="unbounded"/>
header parameters
parameter value description

Location

anyURI

The URI where the new folder is accessible.

application/xml, application/json (ns3:resourcekey)

the resourcekey of the created resource
XML Schema

Source: schema.xsd

<xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0" maxOccurs="unbounded"/>
header parameters
parameter value description

Location

anyURI

The URI where the new folder is accessible.

text/plain

application/xml, application/json (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

text/html

application/xhtml+xml

application/xml (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

application/json (ns3:properties)

Example
    
JSON:
{
  "properties" : [ {
    "name" : "displayname",
    "value" : "displayname-value"
  }, {
    "name" : "name",
    "value" : "name-value"
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:properties xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <property name="displayname">
        <string>displayname-value</string>
    </property>
    <property name="name">
        <string>name-value</string>
    </property>
</ns2:properties>

XML Schema

Source: schema.xsd

<xs:element name="properties" type="tns:properties"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
            <xs:complexType>
              <xs:sequence>
                <xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
              </xs:sequence>
            </xs:complexType>
          </xs:element><xs:element name="properties" type="tns:property" minOccurs="0" maxOccurs="unbounded"/><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element><xs:element name="properties" minOccurs="0">
        <xs:complexType>
          <xs:sequence>
            <xs:element name="property" type="tns:property" minOccurs="0" maxOccurs="unbounded"/>
          </xs:sequence>
        </xs:complexType>
      </xs:element>

*/*

*/*

application/x-www-form-urlencoded

*/*

text/plain

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

application/xml, application/json (ns3:stringlist)

Example
    
JSON:
{
  "elements" : [ "Resubmission", "SendMessage", "FloatingFile", "Exercise", "Approval", "Empty" ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:stringlist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <string>Resubmission</string>
    <string>SendMessage</string>
    <string>FloatingFile</string>
    <string>Exercise</string>
    <string>Approval</string>
    <string>Empty</string>
</ns2:stringlist>

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml, application/json (ns3:stringlist)

Example
        
JSON:
{
  "elements" : [ "Resubmission", "SendMessage", "FloatingFile", "Exercise", "Approval", "Empty" ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:stringlist xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <string>Resubmission</string>
    <string>SendMessage</string>
    <string>FloatingFile</string>
    <string>Exercise</string>
    <string>Approval</string>
    <string>Empty</string>
</ns2:stringlist>

    

XML Schema

Source: schema.xsd

<xs:element name="stringlist">
    <xs:complexType>
      <xs:sequence>
        <xs:element name="string" type="xs:string" minOccurs="0" maxOccurs="unbounded"/>
      </xs:sequence>
    </xs:complexType>
  </xs:element>

application/xml, application/json (ns3:commonmessagesetting)

Example
    
JSON:
{
  "messageStoreSize" : 1000
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:commonmessagesetting xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <messagestoresize>1000</messagestoresize>
</ns2:commonmessagesetting>

XML Schema

Source: schema.xsd

<xs:element name="commonmessagesetting" type="tns:commonmessagesetting"/>

application/xml (ns3:commonmessagesetting)

XML Schema

Source: schema.xsd

<xs:element name="commonmessagesetting" type="tns:commonmessagesetting"/>

application/json (ns3:commonmessagesetting)

XML Schema

Source: schema.xsd

<xs:element name="commonmessagesetting" type="tns:commonmessagesetting"/>

application/xml

application/json

application/xml, application/json (ns3:principalmessagesetting)

Example
        
JSON:
{
  "repository" : true,
  "workflow" : true,
  "collaboration" : false
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:principalmessagesetting xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <repository>true</repository>
    <workflow>true</workflow>
    <collaboration>false</collaboration>
</ns2:principalmessagesetting>

    

XML Schema

Source: schema.xsd

<xs:element name="principalmessagesetting" type="tns:principalmessagesetting"/>

application/xml (ns3:principalmessagesetting)

XML Schema

Source: schema.xsd

<xs:element name="principalmessagesetting" type="tns:principalmessagesetting"/>

application/json (ns3:principalmessagesetting)

XML Schema

Source: schema.xsd

<xs:element name="principalmessagesetting" type="tns:principalmessagesetting"/>

application/xml

application/json

text/plain

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

application/xml, application/json (ns3:dictionary)

Example
    
JSON:
{
  "translations" : {
    "Note" : "Notiz",
    "not set" : "nicht gesetzt",
    "username" : "Benutzername"
  },
  "lastModified" : 1610741552760
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:dictionary xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <translations>
        <entry>
            <key>Note</key>
            <value>Notiz</value>
        </entry>
        <entry>
            <key>not set</key>
            <value>nicht gesetzt</value>
        </entry>
        <entry>
            <key>username</key>
            <value>Benutzername</value>
        </entry>
    </translations>
    <lastmodified>2021-01-15T21:12:32.760+01:00</lastmodified>
</ns2:dictionary>

XML Schema

Source: schema.xsd

<xs:element name="dictionary" type="tns:dictionary"/>
header parameters
parameter value description

Last-Modified

string

Modification date.

text/plain

application/xml, application/json (ns3:resourceresult)

Example
    
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/html

application/xhtml+xml

application/xml, application/json (ns3:resourceresult)

Example
        
JSON:
{
  "id" : "Docs$NOTSET$2$1$NOTSET",
  "displayName" : "Name",
  "count" : 1,
  "items" : [ {
    "resourceKey" : {
      "id" : "DA$NOTSET$3$2$NOTSET",
      "areaName" : "MyDocAreaName",
      "type" : "DOCUMENT"
    },
    "properties" : [ {
      "name" : "displayname",
      "value" : "displayname-value"
    }, {
      "name" : "name",
      "value" : "name-value"
    } ]
  } ]
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourceresult xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <id>Docs$NOTSET$2$1$NOTSET</id>
    <displayname>Name</displayname>
    <count>1</count>
    <items>
        <item>
            <resourcekey id="DA$NOTSET$3$2$NOTSET">
                <areaname>MyDocAreaName</areaname>
                <type>DOCUMENT</type>
            </resourcekey>
            <properties>
                <property name="displayname">
                    <string>displayname-value</string>
                </property>
                <property name="name">
                    <string>name-value</string>
                </property>
            </properties>
        </item>
    </items>
</ns2:resourceresult>

    

XML Schema

Source: schema.xsd

<xs:element name="resourceresult" type="tns:resourceresult"/>

text/plain

application/xml, application/json (ns3:resourcekey)

Example
    
JSON:
{
  "id" : "DA$NOTSET$3$2$NOTSET",
  "areaName" : "MyDocAreaName",
  "type" : "DOCUMENT"
}

XML:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ns2:resourcekey id="DA$NOTSET$3$2$NOTSET" xmlns:ns2="http://www.ceyoniq.com/applicationlayer/2012/01">
    <areaname>MyDocAreaName</areaname>
    <type>DOCUMENT</type>
</ns2:resourcekey>

XML Schema

Source: schema.xsd

<xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0"/><xs:element name="resourcekey" type="tns:resourcekey" minOccurs="0" maxOccurs="unbounded"/>

text/html

application/xhtml+xml