CHOReVOLUTION Console and Identity Manager Development Guide
Table of content
Development guide
Identity Manager source code
In order to modify/extend the CHOReVOLUTION Identity Manager and the Choreography Management Console, the source code can be checked out anonymously over HTTPs by doing:
git clone https://tuleap.ow2.org/plugins/git/chorevolution/syncope.git
cd syncope
cd syncope
Building
The Identity Manager can be built with the following commands.
git clone https://tuleap.ow2.org/plugins/git/chorevolution/syncope.git
cd syncope
mvn clean install
cd syncope
mvn clean install
In order to check the provided changes, the Identity Manager can be run in embedded mode, with a database in memory, by executing the following command.
mvn -P embedded
In order to deploy it in a real environment, more information at compile time are required. Please, see below.
mvn clean install -Dconf.directory=/opt/syncope/conf -Dbundles.directory=/opt/syncope/bundles -Dlog.directory=/opt/syncope/log
Take a look at Installation steps for deployment instructions.
For more detail about Apache Syncope features and extensibility, please take a look at the Apache Syncope reference guide.
ConnId Federation Server connector source code and building instruction
In the same way, the ConnId connector for the Federation Server can be extended/modified as well.
git clone https://tuleap.ow2.org/plugins/git/chorevolution/connid-federation-server
cd connid-federation-server
mvn clean install
cd connid-federation-server
mvn clean install
In order to check the changes, the generated bundle (connid-federation-server-0.1-SNAPSHOT-bundle.jar) under the target folder must be deployed.
Do it by copying the file into the bundles folder:
- syncope/core/target/bundles in embedded mode
- /opt/syncope/bundles otherwise
You can reload the connector via the administration console: click on the Syncope box in the topology section and then on Reload all connectors.
See below for details.
CHOReVOLUTION Identity Manager basic configurations
After having the project up & running it will be possible to start further development/configuration activities intended to integrate and support CHOReVOLUTION features for a specific domain.
This domain, usually relative to a specific organization, defines a virtual environment given on the basis of the business goals of that organization.
Thus, when we have to provide the platform features for a specific organization, we have to start by configuring its operational environment: the domain.
Domains allow the physical separation of all data managed by the Identity Manager based on Apache Syncope, by storing the data for different domains into different database instances.
Therefore, the Apache Syncope can facilitate Users, Groups, Any Objects, External Resources, Policies, Tasks, etc. from different domains (e.g. tenants) in a single core instance.
By default, a single Master domain is defined, which also bears the configuration for additional domains.
Each domain’s persistence unit can be configured to work with one of the supported DBMSes: for instance Master can be on MySQL, Domain1 on PostgreSQL, DomainN on Oracle and so on.
Domains are defined by three files in the configuration directory; assuming that the domain name is Two, such files are:
- domains/TwoDomain.xml - general configuration;
- domains/Two.properties - for DBMS parameters;
- domains/TwoContent.xml - for content initialization.
When adding a new domain to an existing deployment it is possible to copy, rename and edit the files available for the Master domain, which is always present.
Adding a new domain requires re-deploying the Core application and restarting the Java EE container.
Once a new domain is added, the admin credentials for such domain can be set barely invoking the REST layer through curl (see below).
curl -X POST --header 'Content-Type: application/json' --header 'Accept: application/json' --header 'X-Syncope-Domain: Master' --header 'Authorization: Basic YWRtaW46cGFzc3dvcmQ=' -d '{ \
"key": "two", \
"adminPwd": "password", \
"adminCipherAlgorithm": "SHA" \
}' 'http://the-idm-host:the-idm-port/syncope/rest/domains'
"key": "two", \
"adminPwd": "password", \
"adminCipherAlgorithm": "SHA" \
}' 'http://the-idm-host:the-idm-port/syncope/rest/domains'
At this point it is possible to log-in into the administration console into the specified domain in order to define user profile schema attributes, groups and so on and so forth.
The first required step concerns the definition of the user schemas.
Following, the next step concerns the creation of security groups.
Then the third required step concerns the creation of particular users.
At the end, the forth required step concerns the specification of Enactment Engine instances.
For more specific IdM feature please refer to the Apache Syncope reference guide.
Identity Manager REST API
Apache Syncope
CHOReVOLUTION Identity Manager
Contact Info: fabio.martelli@tirasa.net
Version: 1.0.0
BasePath:/syncope/rest
Apache 2.0 License
http://www.apache.org/licenses/LICENSE-2.0.html
Access
Methods
[ Jump to Models ]Table of Contents
_
_anyObjects
post /anyObjects/{key}/associate/{action}post /anyObjects/bulkpost /anyObjectspost /anyObjects/{key}/deassociate/{action}delete /anyObjects/{key}patch /anyObjects/{key}get /anyObjects/{key}delete /anyObjects/{key}/{schemaType}/{schema}get /anyObjects/{key}/{schemaType}/{schema}get /anyObjects/{key}/{schemaType}put /anyObjects/{key}/{schemaType}/{schema}get /anyObjectsput /anyObjects/{key}
_anyTypeClasses
post /anyTypeClassesdelete /anyTypeClasses/{key}get /anyTypeClassesget /anyTypeClasses/{key}put /anyTypeClasses/{key}
_anyTypes
_chors
put /chors/{id}/{serviceId}/securityFilterpost /chorsdelete /chors/{id}get /chors/enactmentEngine/{id}/virtualMachienesget /chors/{id}/enactmentEnginepost /chors/{id}/{operation}/notifyCompletionpost /chors/{id}post /chors/{id}/{serviceId}get /chors/{id}/{serviceId}/securityFilterInfoput /chors/{id}
_collector
_configurations
delete /configurations/{schema}get /configurations/streamget /configurations/{schema}get /configurationsput /configurations/{schema}
_connectors
post /connectors/{key}/supportedObjectClassespost /connectors/checkpost /connectorsdelete /connectors/{key}get /connectors/bundlesget /connectorsget /connectors/{key}get /connectors/byResource/{resourceName}post /connectors/reloadput /connectors/{key}
_consoleinterface
get /consoleinterface/cd/{cdName}/{choreographyInstancePK}get /consoleinterface/{choreographyId}/averageCdsget /consoleinterface/{choreographyId}/{cdName}/averageOperationsget /consoleinterface/{choreographyId}/averageServicesget /consoleinterface/instance/{choreographyInstancePK}/cdsget /consoleinterface/choreographiesget /consoleinterface/{choreographyId}/serviceListdelete /consoleinterface/instance/{choreographyInstancePK}get /consoleinterface/{choreographyId}/instancesAverageget /consoleinterface/choreography/{choreographyId}get /consoleinterface/instance/{choreographyInstancePK}get /consoleinterface/service/{serviceName}/{choreographyInstancePK}get /consoleinterface/{choreographyId}/instancesget /consoleinterface/instance/{choreographyInstancePK}/{cdname}/operationsget /consoleinterface/instance/{choreographyInstancePK}/serviceList
_domains
_groups
post /groups/{key}/associate/{action}post /groups/bulkpost /groups/{key}/members/{actionType}post /groupspost /groups/{key}/deassociate/{action}delete /groups/{key}get /groups/ownpatch /groups/{key}get /groups/{key}get /groups/{key}/{anyTypeKey}/typeExtensiondelete /groups/{key}/{schemaType}/{schema}get /groups/{key}/{schemaType}/{schema}get /groups/{key}/{schemaType}put /groups/{key}/{schemaType}/{schema}get /groupsput /groups/{key}
_loggers
delete /loggers/{type}/{key}get /loggers/eventsget /loggers/{type}get /loggers/{type}/{key}put /loggers/{type}/{key}
_mailTemplates
post /mailTemplatesdelete /mailTemplates/{key}get /mailTemplates/{key}/{format}get /mailTemplatesget /mailTemplates/{key}delete /mailTemplates/{key}/{format}put /mailTemplates/{key}/{format}
_notifications
post /notifications/jobpost /notificationsdelete /notifications/{key}get /notifications/jobget /notificationsget /notifications/{key}put /notifications/{key}
_policies
_realms
post /realms/{fullPath}delete /realms/{fullPath}get /realmsget /realms/{fullPath}put /realms/{fullPath}
_relationshipTypes
post /relationshipTypesdelete /relationshipTypes/{key}get /relationshipTypesget /relationshipTypes/{key}put /relationshipTypes/{key}
_reportTemplates
post /reportTemplatesdelete /reportTemplates/{key}get /reportTemplates/{key}/{format}get /reportTemplatesget /reportTemplates/{key}delete /reportTemplates/{key}/{format}put /reportTemplates/{key}/{format}
_reports
post /reports/jobs/{key}post /reportsdelete /reports/{key}delete /reports/executions/{executionKey}delete /reports/{key}/executionspost /reports/{key}/executeget /reports/executions/{executionKey}/streamget /reportsget /reports/{key}/executionsget /reports/jobsget /reports/executions/recentget /reports/{key}put /reports/{key}
_resources
post /resources/{key}/bulkDeassociation/{anyTypeKey}/{action}post /resources/checkpost /resourcesdelete /resources/{key}get /resourcesget /resources/{key}/{anyTypeKey}get /resources/{key}get /resources/{key}/{anyTypeKey}/{anyKey}delete /resources/{key}/{anyTypeKey}post /resources/{key}/{anyTypeKey}put /resources/{key}
_roles
post /rolesdelete /roles/{key}get /roles/{key}/consoleLayoutget /rolesget /roles/{key}delete /roles/{key}/consoleLayoutput /roles/{key}/consoleLayoutput /roles/{key}
_schemas_type
post /schemas/{type}delete /schemas/{type}/{key}get /schemas/{type}get /schemas/{type}/{key}put /schemas/{type}/{key}
_securityQuestions
post /securityQuestionsdelete /securityQuestions/{key}get /securityQuestionsget /securityQuestions/{key}get /securityQuestions/byUser/{username}put /securityQuestions/{key}
_tasks
post /tasks/jobs/{key}post /tasks/bulkpost /tasksdelete /tasks/{key}delete /tasks/executions/{executionKey}delete /tasks/{key}/executionspost /tasks/{key}/executeget /tasksget /tasks/{key}/executionsget /tasks/jobsget /tasks/executions/recentget /tasks/{key}put /tasks/{key}
_users
post /users/{key}/associate/{action}post /users/bulkpost /userspost /users/{key}/deassociate/{action}delete /users/{key}patch /users/{key}get /users/{key}delete /users/{key}/{schemaType}/{schema}get /users/{key}/{schemaType}/{schema}get /users/{key}/{schemaType}put /users/{key}/{schemaType}/{schema}get /userspost /users/{key}/statusput /users/{key}
_users_self
post /users/self/changePasswordpost /users/self/confirmPasswordResetpost /users/selfdelete /users/selfpatch /users/self/{key}get /users/selfpost /users/self/requestPasswordResetput /users/self/{key}
_userworkflow
get /userworkflow/formspost /userworkflow/forms/{taskId}/claimpost /userworkflow/tasks/{taskId}/executeget /userworkflow/forms/{userKey}post /userworkflow/forms
_workflows_anyTypeKind
_
Up
get /numbersProvides some numbers about the managed entities (users, groups, any objects...). (numbers)
Request headers
Return type
Example data
Content-Type: application/json
{
"any2ByRealm" : {
"key" : 123
},
"totalRoles" : 123,
"totalUsers" : 123,
"any1ByRealm" : {
"key" : 123
},
"totalAny2" : 123,
"totalAny1" : 123,
"confCompleteness" : {
"key" : true
},
"totalGroups" : 123,
"groupsByRealm" : {
"key" : 123
},
"totalResources" : 123,
"anyType1" : "aeiou",
"anyType2" : "aeiou",
"usersByRealm" : {
"key" : 123
},
"usersByStatus" : {
"key" : 123
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
some numbers about the managed entities (users, groups, any objects...) NumbersInfo
Up
get /platformProvides information summary about platform configuration (workflow adapters, provisioning managers, validators,
actions, correlation rules, reportlets, ...). (platform)
Request headers
Return type
Example data
Content-Type: application/json
{
"entitlements" : [ "aeiou" ],
"mappingItemTransformers" : [ "aeiou" ],
"validators" : [ "aeiou" ],
"userWorkflowAdapter" : "aeiou",
"selfRegAllowed" : true,
"pushActions" : [ "aeiou" ],
"groupProvisioningManager" : "aeiou",
"pullActions" : [ "aeiou" ],
"groupWorkflowAdapter" : "aeiou",
"reportletConfs" : [ "aeiou" ],
"anyObjectWorkflowAdapter" : "aeiou",
"reconciliationFilterBuilders" : [ "aeiou" ],
"connIdLocations" : [ "aeiou" ],
"notificationRecipientsProviders" : [ "aeiou" ],
"anyObjectProvisioningManager" : "aeiou",
"accountRules" : [ "aeiou" ],
"pwdResetAllowed" : true,
"pushCorrelationRules" : [ "aeiou" ],
"passwordRules" : [ "aeiou" ],
"version" : "aeiou",
"pullCorrelationRules" : [ "aeiou" ],
"pwdResetRequiringSecurityQuestions" : true,
"taskJobs" : [ "aeiou" ],
"passwordGenerator" : "aeiou",
"virAttrCache" : "aeiou",
"userProvisioningManager" : "aeiou",
"logicActions" : [ "aeiou" ],
"propagationActions" : [ "aeiou" ]
}Example data
Content-Type: application/xml
<platformInfo>
<version>string</version>
<selfRegAllowed>true</selfRegAllowed>
<pwdResetAllowed>true</pwdResetAllowed>
<pwdResetRequiringSecurityQuestions>true</pwdResetRequiringSecurityQuestions>
<anyObjectWorkflowAdapter>string</anyObjectWorkflowAdapter>
<userWorkflowAdapter>string</userWorkflowAdapter>
<groupWorkflowAdapter>string</groupWorkflowAdapter>
<anyObjectProvisioningManager>string</anyObjectProvisioningManager>
<userProvisioningManager>string</userProvisioningManager>
<groupProvisioningManager>string</groupProvisioningManager>
<virAttrCache>string</virAttrCache>
<passwordGenerator>string</passwordGenerator>
<connIdLocations>
<connIdLocations>string</connIdLocations>
</connIdLocations>
<entitlements>
<entitlements>string</entitlements>
</entitlements>
<reportletConfs>
<reportletConfs>string</reportletConfs>
</reportletConfs>
<accountRules>
<accountRules>string</accountRules>
</accountRules>
<passwordRules>
<passwordRules>string</passwordRules>
</passwordRules>
<mappingItemTransformers>
<mappingItemTransformers>string</mappingItemTransformers>
</mappingItemTransformers>
<taskJobs>
<taskJobs>string</taskJobs>
</taskJobs>
<reconciliationFilterBuilders>
<reconciliationFilterBuilders>string</reconciliationFilterBuilders>
</reconciliationFilterBuilders>
<logicActions>
<logicActions>string</logicActions>
</logicActions>
<propagationActions>
<propagationActions>string</propagationActions>
</propagationActions>
<pullActions>
<pullActions>string</pullActions>
</pullActions>
<pushActions>
<pushActions>string</pushActions>
</pushActions>
<pullCorrelationRules>
<pullCorrelationRules>string</pullCorrelationRules>
</pullCorrelationRules>
<pushCorrelationRules>
<pushCorrelationRules>string</pushCorrelationRules>
</pushCorrelationRules>
<validators>
<validators>string</validators>
</validators>
<notificationRecipientsProviders>
<notificationRecipientsProviders>string</notificationRecipientsProviders>
</notificationRecipientsProviders>
</platformInfo>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...) PlatformInfo
Up
get /systemProvides information about the underlying system (Operating System, CPU / memory usage, ...). (system)
Request headers
Return type
Example data
Content-Type: application/json
{
"jvm" : "aeiou",
"hostname" : "aeiou",
"availableProcessors" : 123,
"os" : "aeiou",
"load" : [ {
"systemLoadAverage" : 1.3579000000000001069366817318950779736042022705078125,
"totalMemory" : 123456789,
"freeMemory" : 123456789,
"maxMemory" : 123456789,
"uptime" : 123456789
} ],
"startTime" : 123456789
}Example data
Content-Type: application/xml
<systemInfo>
<hostname>string</hostname>
<os>string</os>
<jvm>string</jvm>
<availableProcessors>0</availableProcessors>
<startTime>123456</startTime>
<load>
</load>
</systemInfo>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
information about the underlying system (Operating System, CPU / memory usage, ...) SystemInfo_anyObjects
Up
post /anyObjects/{key}/associate/{action}Executes resource-related operations on given any object. (anyObjectsAssociate)
Path parameters
key (required)
Path Parameter — key of any object to be read
action (required)
Path Parameter — action
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — external resources to be used for propagation-related operations
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring BulkActionResult as Entity
Up
post /anyObjects/bulkExecutes the provided bulk action. (anyObjectsBulk)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — list of any object ids against which the bulk action will be performed.
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring BulkActionResult as Entity
Up
post /anyObjects (anyObjectsCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter —
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected
Up
post /anyObjects/{key}/deassociate/{action}Executes resource-related operations on given any object. (anyObjectsDeassociate)
Path parameters
key (required)
Path Parameter — key of any object to be read
action (required)
Path Parameter — action
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — external resources to be used for propagation-related operations
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring BulkActionResult as Entity
Up
delete /anyObjects/{key}Deletes any object matching provided key. (anyObjectsDelete)
Path parameters
key (required)
Path Parameter — key of any object to be deleted
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring the deleted any object enriched with propagation status information - ProvisioningResult as Entity
Up
patch /anyObjects/{key} (anyObjectsPatchUpdate)
Path parameters
key (required)
Path Parameter — key of any object to be read
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter —
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected
Up
get /anyObjects/{key}Reads the any object matching the provided key. (anyObjectsRead)
Path parameters
key (required)
Path Parameter — key of any object to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"creator" : "aeiou",
"auxClasses" : [ "aeiou" ],
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"resources" : [ "aeiou" ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
}Example data
Content-Type: application/xml
<null>
<creator>string</creator>
<creationDate>2000-01-23T04:56:07.000Z</creationDate>
<lastModifier>string</lastModifier>
<lastChangeDate>2000-01-23T04:56:07.000Z</lastChangeDate>
<key>string</key>
<type>string</type>
<realm>string</realm>
<status>string</status>
<auxClasses>
<auxClasses>string</auxClasses>
</auxClasses>
<plainAttrs>
</plainAttrs>
<derAttrs>
</derAttrs>
<virAttrs>
</virAttrs>
<resources>
<resources>string</resources>
</resources>
</null>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
any object with matching key AnyTO
Up
delete /anyObjects/{key}/{schemaType}/{schema}Deletes the attribute, owned by the given any object, for the given schema type and schema. (anyObjectsSchemaDelete)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
schema (required)
Path Parameter — schema
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected
Up
get /anyObjects/{key}/{schemaType}/{schema}Reads the attribute, owned by the given any object, for the given schema type and schema. (anyObjectsSchemaRead)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
schema (required)
Path Parameter — schema
Request headers
Return type
Example data
Content-Type: application/json
{
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
}Example data
Content-Type: application/xml
<attribute>
<schema>string</schema>
<values>
<values>string</values>
</values>
</attribute>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
attribute, owned by the given any object, for the given schema type and schema AttrTO
Up
get /anyObjects/{key}/{schemaType}Reads the list of attributes owned by the given any object for the given schema type. (anyObjectsSchemaTypeRead)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
Request headers
Return type
array[AttrTO]
Example data
Content-Type: application/json
[ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ]Example data
Content-Type: application/xml
<attribute>
<schema>string</schema>
<values>
<values>string</values>
</values>
</attribute>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of attributes, owned by the given any object, for the given schema type
Up
put /anyObjects/{key}/{schemaType}/{schema}Adds or replaces the attribute, owned by the given any object, for the given schema type and schema. (anyObjectsSchemaUpdate)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
schema (required)
Path Parameter — schema
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — attribute
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring the updated any object attribute - as Entity
Up
get /anyObjectsReturns a paged list of any objects matching the given query. (anyObjectsSearch)
Request headers
Query parameters
page (optional)
Query Parameter — query conditions default: 1 format: int32
size (optional)
Query Parameter — default: 25 format: int32
orderby (optional)
Query Parameter —
realm (optional)
Query Parameter — default: /
details (optional)
Query Parameter — default: true
fiql (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"result" : [ {
"creator" : "aeiou",
"auxClasses" : [ "aeiou" ],
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"resources" : [ "aeiou" ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ],
"size" : 123,
"prev" : "aeiou",
"page" : 123,
"totalCount" : 123
}Example data
Content-Type: application/xml
<pagedResult>
<prev>string</prev>
<next>string</next>
<page>0</page>
<size>0</size>
<totalCount>0</totalCount>
<result>
</result>
</pagedResult>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
paged list of any objects matching the given query PagedResultAnyTO
Up
put /anyObjects/{key} (anyObjectsUpdate)
Path parameters
key (required)
Path Parameter — key of any object to be read
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter —
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected_anyTypeClasses
Up
post /anyTypeClassesCreates a new anyTypeClass. (anyTypeClassesCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — anyTypeClass to be created
Request headers
Responses
0
Response object featuring Location header of created anyTypeClass
Up
delete /anyTypeClasses/{key}Deletes the anyTypeClass matching the provided key. (anyTypeClassesDelete)
Path parameters
key (required)
Path Parameter — anyTypeClass key to be deleted
Request headers
Responses
0
no value expected
Up
get /anyTypeClassesReturns a list of all anyTypeClasss. (anyTypeClassesList)
Request headers
Return type
array[AnyTypeClassTO]
Example data
Content-Type: application/json
[ {
"plainSchemas" : [ "aeiou" ],
"derSchemas" : [ "aeiou" ],
"inUseByTypes" : [ "aeiou" ],
"virSchemas" : [ "aeiou" ],
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<anyTypeClass>
<key>string</key>
<plainSchemas>
<plainSchemas>string</plainSchemas>
</plainSchemas>
<derSchemas>
<derSchemas>string</derSchemas>
</derSchemas>
<virSchemas>
<virSchemas>string</virSchemas>
</virSchemas>
<inUseByTypes>
<inUseByTypes>string</inUseByTypes>
</inUseByTypes>
</anyTypeClass>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all anyTypeClasss.
Up
get /anyTypeClasses/{key}Returns anyTypeClass with matching key. (anyTypeClassesRead)
Path parameters
key (required)
Path Parameter — anyTypeClass key to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"plainSchemas" : [ "aeiou" ],
"derSchemas" : [ "aeiou" ],
"inUseByTypes" : [ "aeiou" ],
"virSchemas" : [ "aeiou" ],
"key" : "aeiou"
}Example data
Content-Type: application/xml
<anyTypeClass>
<key>string</key>
<plainSchemas>
<plainSchemas>string</plainSchemas>
</plainSchemas>
<derSchemas>
<derSchemas>string</derSchemas>
</derSchemas>
<virSchemas>
<virSchemas>string</virSchemas>
</virSchemas>
<inUseByTypes>
<inUseByTypes>string</inUseByTypes>
</inUseByTypes>
</anyTypeClass>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
anyTypeClass with matching key AnyTypeClassTO
Up
put /anyTypeClasses/{key}Updates the anyTypeClass matching the provided key. (anyTypeClassesUpdate)
Path parameters
key (required)
Path Parameter — key of any object to be read
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — anyTypeClass to be stored
Request headers
Responses
0
no value expected_anyTypes
Up
post /anyTypesCreates a new anyType. (anyTypesCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — anyType to be created
Request headers
Responses
0
Response object featuring Location header of created anyType
Up
delete /anyTypes/{key}Deletes the anyType matching the provided key. (anyTypesDelete)
Path parameters
key (required)
Path Parameter — anyType key to be deleted
Request headers
Responses
0
no value expected
Up
get /anyTypesReturns a list of all anyTypes. (anyTypesList)
Request headers
Return type
array[AnyTypeTO]
Example data
Content-Type: application/json
[ {
"kind" : "aeiou",
"classes" : [ "aeiou" ],
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<anyType>
<key>string</key>
<kind>string</kind>
<classes>
<classes>string</classes>
</classes>
</anyType>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all anyTypes.
Up
get /anyTypes/{key}Returns anyType with matching key. (anyTypesRead)
Path parameters
key (required)
Path Parameter — anyType key to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"kind" : "aeiou",
"classes" : [ "aeiou" ],
"key" : "aeiou"
}Example data
Content-Type: application/xml
<anyType>
<key>string</key>
<kind>string</kind>
<classes>
<classes>string</classes>
</classes>
</anyType>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
anyType with matching key AnyTypeTO
Up
put /anyTypes/{key}Updates the anyType matching the provided key. (anyTypesUpdate)
Path parameters
key (required)
Path Parameter — key of any object to be read
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — anyType to be stored
Request headers
Responses
0
no value expected_chors
Up
put /chors/{id}/{serviceId}/securityFilterConfigure the Federation Server URL into the security filter instance associated to the given service,
in the given choreography (if available). (chorsConfigureSecurityFilter)
Path parameters
id (required)
Path Parameter — choreography id
serviceId (required)
Path Parameter — choreography service id
Request body
body (optional)
Body Parameter — Federation Server URL to configure
Request headers
Responses
0
no value expected
Up
post /chorsEnact a new choreography. (chorsCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/xml
Request body
body (optional)
Body Parameter — ChorSpec XML representation
Request headers
Query parameters
name (required)
Query Parameter — choreography name
enactmentEngineKey (required)
Query Parameter — target enactment engine instance
Responses
0
the choreography deployment id as generated by the enactment engine
Up
delete /chors/{id}Retire the given choreography. (chorsDelete)
Path parameters
id (required)
Path Parameter — choreography id
Request headers
Responses
0
no value expected
Up
get /chors/enactmentEngine/{id}/virtualMachienesReturns the enactment engine associated to the choreography (chorsGetEEVmList)
Path parameters
id (required)
Path Parameter — enactment engine key
Request headers
Return type
array[VirtualMachineInfoTO]
Example data
Content-Type: application/json
[ {
"cpuNumber" : 123,
"os" : "aeiou",
"id" : "aeiou",
"storage" : 123,
"ram" : 123
} ]Responses
200
list of virtual machines for the enactment engine
Up
get /chors/{id}/enactmentEngineReturns the enactment engine associated to the choreography (chorsGetEnactmentEngine)
Path parameters
id (required)
Path Parameter — choreography id
Request headers
Return type
Example data
Content-Type: application/json
{
"creator" : "aeiou",
"auxClasses" : [ "aeiou" ],
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"resources" : [ "aeiou" ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"memberships" : [ {
"groupName" : "aeiou",
"rightKey" : "aeiou",
"plainAttrs" : [ "" ],
"virAttrs" : [ "" ],
"type" : "aeiou",
"derAttrs" : [ "" ],
"rightType" : "aeiou"
} ],
"relationships" : [ {
"rightKey" : "aeiou",
"type" : "aeiou",
"rightType" : "aeiou"
} ],
"dynGroups" : [ "aeiou" ],
"name" : "aeiou",
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
}Responses
200
Enactment engine associated to the choreography AnyObjectTO
Up
post /chors/{id}/{operation}/notifyCompletionThis operation will used to notify that an enactment operation was completed, providing the
related concrete ChorSpec. (chorsNotifyCompletion)
Path parameters
id (required)
Path Parameter — choreography id
operation (required)
Path Parameter — the operation performed by the enactment engine on the given choreography
Consumes
This API call consumes the following media types via the Content-Type request header:application/xml
Request body
body (optional)
Body Parameter — ChorSpec XML representation, as enacted by the enactment engine
Request headers
Query parameters
name (required)
Query Parameter — choreography name
message (optional)
Query Parameter — execution message - reporting success or failure (for example)
Responses
0
no value expected
Up
post /chors/{id}Performs the given action on the given choreography. (chorsOnChoreography)
Path parameters
id (required)
Path Parameter — choreography id
Request headers
Query parameters
action (required)
Query Parameter — action to be performed
newSize (optional)
Query Parameter — (normally ignored, required if format: int32
Responses
0
no value expected
Up
post /chors/{id}/{serviceId}Performs the given action on the given choreography's service. (chorsOnChoreographyService)
Path parameters
id (required)
Path Parameter — choreography id
serviceId (required)
Path Parameter — choreography service id
Request headers
Query parameters
action (required)
Query Parameter — action to be performed
argument (optional)
Query Parameter — Security context name if
Responses
0
no value expected
Up
get /chors/{id}/{serviceId}/securityFilterInfoReturns information about the current status of the security filter instance associated to the given service,
in the given choreography (if available). (chorsReadSecurityFilterInfo)
Path parameters
id (required)
Path Parameter — choreography id
serviceId (required)
Path Parameter — choreography service id
Request headers
Return type
Example data
Content-Type: application/json
{
"securityContext" : "aeiou",
"status" : "aeiou"
}Example data
Content-Type: application/xml
<null>
<status>string</status>
<securityContext>string</securityContext>
</null>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
information about the current status of the security filter instance associated to the given service, in the given choreography (if available) SecurityFilterInfo
Up
put /chors/{id}Enact an existing choreography, with updated specification. (chorsUpdate)
Path parameters
id (required)
Path Parameter — choreography id
Consumes
This API call consumes the following media types via the Content-Type request header:application/xml
Request body
body (optional)
Body Parameter — ChorSpec XML representation
Request headers
Query parameters
name (required)
Query Parameter — choreography name
Responses
0
no value expected_collector
Up
post /collector/instance (collectorAddInstance)
Consumes
This API call consumes the following media types via the Content-Type request header:application/xmlapplication/json
Request body
body (optional)
Body Parameter —
Request headers
Responses
0
no value expected
Up
get /collector/databaseTest method (collectorGetDatabase)
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/xmlapplication/json
Responses
0
no value expected
Up
post /collector/logeventThis method collects events from choreography execution (collectorLogEvent)
Consumes
This API call consumes the following media types via the Content-Type request header:application/xmlapplication/json
Request body
body (optional)
Body Parameter —
Request headers
Responses
0
no value expected_configurations
Up
delete /configurations/{schema}Deletes the configuration parameter with matching schema. (configurationsDelete)
Path parameters
schema (required)
Path Parameter — configuration parameter schema
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request headers
Responses
0
no value expected
Up
get /configurations/streamExports internal storage content as downloadable XML file. (configurationsExport)
Request headers
Responses
0
internal storage content as downloadable XML file
Up
get /configurations/{schema}Returns configuration parameter with matching schema. (configurationsGet)
Path parameters
schema (required)
Path Parameter — identifier of configuration to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
}Example data
Content-Type: application/xml
<attribute>
<schema>string</schema>
<values>
<values>string</values>
</values>
</attribute>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
configuration parameter with matching schema AttrTO
Up
get /configurationsReturns all configuration parameters. (configurationsList)
Request headers
Return type
array[AttrTO]
Example data
Content-Type: application/json
[ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ]Example data
Content-Type: application/xml
<attribute>
<schema>string</schema>
<values>
<values>string</values>
</values>
</attribute>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
all configuration parameters
Up
put /configurations/{schema}Creates / updates the configuration parameter with the given schema. (configurationsSet)
Path parameters
schema (required)
Path Parameter — identifier of configuration to be read
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — parameter value
Request headers
Responses
0
no value expected_connectors
Up
post /connectors/{key}/supportedObjectClassesBuilds the list of ConnId object classes information for the connector bundle matching the given connector
instance key, with the provided configuration. (connectorsBuildObjectClassInfo)
Path parameters
key (required)
Path Parameter — connector instance key
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — connector instance object providing configuration properties
Request headers
Query parameters
includeSpecial (optional)
Query Parameter — if set to true, special schema names (like '__PASSWORD__') will be included;
default is false default: false
Return type
array[ConnIdObjectClassTO]
Example data
Content-Type: application/json
[ {
"container" : true,
"auxiliary" : true,
"attributes" : [ "aeiou" ],
"type" : "aeiou"
} ]Example data
Content-Type: application/xml
<connIdObjectClass>
<type>string</type>
<container>true</container>
<auxiliary>true</auxiliary>
<attributes>
<attributes>string</attributes>
</attributes>
</connIdObjectClass>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
supported object classes info for the connector bundle matching the given connector instance key, with the provided configuration
Up
post /connectors/checkChecks whether the connection to resource could be established. (connectorsCheck)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — connector instance to be used for connection check
Request headers
Responses
0
no value expected
Up
post /connectorsCreates a new connector instance. (connectorsCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — connector instance to be created
Request headers
Responses
0
Response object featuring Location header of created connector instance
Up
delete /connectors/{key}Deletes the connector instance matching the provided key. (connectorsDelete)
Path parameters
key (required)
Path Parameter — connector instance key to be deleted
Request headers
Responses
0
no value expected
Up
get /connectors/bundlesReturns available connector bundles with property keys in selected language. (connectorsGetBundles)
Request headers
Query parameters
lang (optional)
Query Parameter — language to select property keys; default language is English
Return type
array[ConnBundleTO]
Example data
Content-Type: application/json
[ {
"displayName" : "aeiou",
"bundleName" : "aeiou",
"connectorName" : "aeiou",
"location" : "aeiou",
"version" : "aeiou",
"properties" : [ {
"displayName" : "aeiou",
"name" : "aeiou",
"defaultValues" : [ "{}" ],
"type" : "aeiou",
"helpMessage" : "aeiou",
"required" : true,
"order" : 123,
"confidential" : true
} ]
} ]Example data
Content-Type: application/xml
<connectorBundle>
<displayName>string</displayName>
<location>string</location>
<bundleName>string</bundleName>
<connectorName>string</connectorName>
<version>string</version>
<properties>
</properties>
</connectorBundle>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
available connector bundles with property keys in selected language
Up
get /connectorsReturns a list of all connector instances with property keys in the matching language. (connectorsList)
Request headers
Query parameters
lang (optional)
Query Parameter — language to select property keys, null for default (English).
An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.
Return type
array[ConnInstanceTO]
Example data
Content-Type: application/json
[ {
"poolConf" : {
"minIdle" : 123,
"maxIdle" : 123,
"minEvictableIdleTimeMillis" : 123456789,
"maxWait" : 123456789,
"maxObjects" : 123
},
"capabilities" : [ "aeiou" ],
"connRequestTimeout" : 123,
"displayName" : "aeiou",
"connectorName" : "aeiou",
"bundleName" : "aeiou",
"location" : "aeiou",
"conf" : [ {
"schema" : {
"displayName" : "aeiou",
"name" : "aeiou",
"defaultValues" : [ "{}" ],
"type" : "aeiou",
"helpMessage" : "aeiou",
"required" : true,
"order" : 123,
"confidential" : true
},
"values" : [ "{}" ],
"overridable" : true
} ],
"version" : "aeiou",
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<connInstance>
<key>string</key>
<location>string</location>
<connectorName>string</connectorName>
<bundleName>string</bundleName>
<version>string</version>
<displayName>string</displayName>
<connRequestTimeout>0</connRequestTimeout>
<conf>
</conf>
<capabilities>
<capabilities>string</capabilities>
</capabilities>
</connInstance>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all connector instances with property keys in the matching language
Up
get /connectors/{key}Returns connector instance with matching key. (connectorsRead)
Path parameters
key (required)
Path Parameter — connector instance key to be read
Request headers
Query parameters
lang (optional)
Query Parameter — language to select property keys, null for default (English).
An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.
Return type
Example data
Content-Type: application/json
{
"poolConf" : {
"minIdle" : 123,
"maxIdle" : 123,
"minEvictableIdleTimeMillis" : 123456789,
"maxWait" : 123456789,
"maxObjects" : 123
},
"capabilities" : [ "aeiou" ],
"connRequestTimeout" : 123,
"displayName" : "aeiou",
"connectorName" : "aeiou",
"bundleName" : "aeiou",
"location" : "aeiou",
"conf" : [ {
"schema" : {
"displayName" : "aeiou",
"name" : "aeiou",
"defaultValues" : [ "{}" ],
"type" : "aeiou",
"helpMessage" : "aeiou",
"required" : true,
"order" : 123,
"confidential" : true
},
"values" : [ "{}" ],
"overridable" : true
} ],
"version" : "aeiou",
"key" : "aeiou"
}Example data
Content-Type: application/xml
<connInstance>
<key>string</key>
<location>string</location>
<connectorName>string</connectorName>
<bundleName>string</bundleName>
<version>string</version>
<displayName>string</displayName>
<connRequestTimeout>0</connRequestTimeout>
<conf>
</conf>
<capabilities>
<capabilities>string</capabilities>
</capabilities>
</connInstance>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
connector instance with matching key ConnInstanceTO
Up
get /connectors/byResource/{resourceName}Returns connector instance for matching resource. (connectorsReadByResource)
Path parameters
resourceName (required)
Path Parameter — resource name to be used for connector lookup
Request headers
Query parameters
lang (optional)
Query Parameter — language to select property keys, null for default (English).
An ISO 639 alpha-2 or alpha-3 language code, or a language subtag up to 8 characters in length.
Return type
Example data
Content-Type: application/json
{
"poolConf" : {
"minIdle" : 123,
"maxIdle" : 123,
"minEvictableIdleTimeMillis" : 123456789,
"maxWait" : 123456789,
"maxObjects" : 123
},
"capabilities" : [ "aeiou" ],
"connRequestTimeout" : 123,
"displayName" : "aeiou",
"connectorName" : "aeiou",
"bundleName" : "aeiou",
"location" : "aeiou",
"conf" : [ {
"schema" : {
"displayName" : "aeiou",
"name" : "aeiou",
"defaultValues" : [ "{}" ],
"type" : "aeiou",
"helpMessage" : "aeiou",
"required" : true,
"order" : 123,
"confidential" : true
},
"values" : [ "{}" ],
"overridable" : true
} ],
"version" : "aeiou",
"key" : "aeiou"
}Example data
Content-Type: application/xml
<connInstance>
<key>string</key>
<location>string</location>
<connectorName>string</connectorName>
<bundleName>string</bundleName>
<version>string</version>
<displayName>string</displayName>
<connRequestTimeout>0</connRequestTimeout>
<conf>
</conf>
<capabilities>
<capabilities>string</capabilities>
</capabilities>
</connInstance>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
connector instance for matching resource ConnInstanceTO
Up
post /connectors/reloadReload all connector bundles and instances. (connectorsReload)
Request headers
Responses
0
no value expected
Up
put /connectors/{key}Updates the connector instance matching the provided key. (connectorsUpdate)
Path parameters
key (required)
Path Parameter — connector instance key to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — connector instance to be stored
Request headers
Responses
0
no value expected_consoleinterface
Up
get /consoleinterface/cd/{cdName}/{choreographyInstancePK}Retrieved Coordination Delegate (connectorsGetCd)
Path parameters
choreographyInstancePK (required)
Path Parameter — choreography instance
cdName (required)
Path Parameter — coordination delegate name
Request headers
Return type
Example data
Content-Type: application/json
{
"networkOverheadForBusinessMessagesExchangeTime" : 123456789,
"serviceExecutionTime" : 123456789,
"instanceId" : "aeiou",
"executedOperations" : 123,
"coordinationMessages" : 123,
"waitTimeForSchedulingOperation" : 123456789,
"name" : "aeiou",
"networkOverheadForCoordinationMessagesExchangeTime" : 123456789,
"waitTimeForSynchronizing" : 123456789,
"coordinationAlgorithmReasoningTime" : 123456789
}Responses
200
coordination delegate CoordinationDelegateTO
Up
get /consoleinterface/{choreographyId}/averageCdsRetrieves average CD execution time (consoleinterfaceAverageCdList)
Path parameters
choreographyId (required)
Path Parameter — choreography id
Request headers
Return type
array[AVGCoordinationDelegateTO]
Example data
Content-Type: application/json
[ {
"minCoordinationMessages" : 123,
"networkOverheadForBusinessMessagesExchangeTime" : 1.3579000000000001069366817318950779736042022705078125,
"serviceExecutionTime" : 1.3579000000000001069366817318950779736042022705078125,
"minExecutedOperations" : 123,
"waitTimeForSchedulingOperation" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"networkOverheadForCoordinationMessagesExchangeTime" : 1.3579000000000001069366817318950779736042022705078125,
"waitTimeForSynchronizing" : 1.3579000000000001069366817318950779736042022705078125,
"coordinationAlgorithmReasoningTime" : 1.3579000000000001069366817318950779736042022705078125,
"maxExecutedOperations" : 123,
"choreographyId" : "aeiou",
"maxCoordinationMessages" : 123
} ]Responses
200
average execution time
Up
get /consoleinterface/{choreographyId}/{cdName}/averageOperationsRetrieves average CD execution time (consoleinterfaceAverageOperationList)
Path parameters
choreographyId (required)
Path Parameter — choreograpy id
cdName (required)
Path Parameter — coordination delegate
Request headers
Return type
array[AVGOperationDataTO]
Example data
Content-Type: application/json
[ {
"networkOverheadForBusinessMessagesExchangeTime" : 1.3579000000000001069366817318950779736042022705078125,
"serviceExecutionTime" : 1.3579000000000001069366817318950779736042022705078125,
"minMessageNumber" : 123,
"maxMessageNumber" : 123,
"waitTimeForSchedulingOperation" : 1.3579000000000001069366817318950779736042022705078125,
"name" : "aeiou",
"serviceWaitTimeForResponse" : 1.3579000000000001069366817318950779736042022705078125,
"networkOverheadForCoordinationMessagesExchangeTime" : 1.3579000000000001069366817318950779736042022705078125,
"waitTimeForSynchronizing" : 1.3579000000000001069366817318950779736042022705078125,
"coordinationAlgorithmReasoningTime" : 1.3579000000000001069366817318950779736042022705078125
} ]Responses
200
average execution time
Up
get /consoleinterface/{choreographyId}/averageServicesRetrieves average service execution time (consoleinterfaceAverageServiceList)
Path parameters
choreographyId (required)
Path Parameter — choreography id
Request headers
Return type
array[AVGServiceTO]
Example data
Content-Type: application/json
[ {
"executionTime" : 1.3579000000000001069366817318950779736042022705078125,
"minExecutedOperations" : 123,
"name" : "aeiou",
"waitTimeForResponse" : 1.3579000000000001069366817318950779736042022705078125,
"maxExecutedOperations" : 123
} ]Responses
200
average execution time
Up
get /consoleinterface/instance/{choreographyInstancePK}/cdsThis is a temporary method. (consoleinterfaceCdList)
Path parameters
choreographyInstancePK (required)
Path Parameter —
Request headers
Return type
array[CoordinationDelegateTO]
Example data
Content-Type: application/json
[ {
"networkOverheadForBusinessMessagesExchangeTime" : 123456789,
"serviceExecutionTime" : 123456789,
"instanceId" : "aeiou",
"executedOperations" : 123,
"coordinationMessages" : 123,
"waitTimeForSchedulingOperation" : 123456789,
"name" : "aeiou",
"networkOverheadForCoordinationMessagesExchangeTime" : 123456789,
"waitTimeForSynchronizing" : 123456789,
"coordinationAlgorithmReasoningTime" : 123456789
} ]Responses
200
all CDs of selected choreography instance
Up
get /consoleinterface/choreographiesThis is a temporary method. (consoleinterfaceChoreographyList)
Request headers
Return type
array[ChoreographyTO]
Example data
Content-Type: application/json
[ {
"diagram" : [ "" ],
"image" : [ "" ],
"name" : "aeiou",
"description" : "aeiou",
"messages" : [ "" ],
"id" : "aeiou",
"groupKey" : "aeiou"
} ]Responses
200
all defined choreographies
Up
get /consoleinterface/{choreographyId}/serviceListRetrieves choreography service list (consoleinterfaceChoreographyServiceList)
Path parameters
choreographyId (required)
Path Parameter — choreography id
Request headers
Return type
array[ServiceTO]
Example data
Content-Type: application/json
[ {
"executionTime" : 123456789,
"executedOperations" : 123,
"name" : "aeiou",
"waitTimeForResponse" : 123456789
} ]Responses
200
service list
Up
delete /consoleinterface/instance/{choreographyInstancePK}Deltes instance (consoleinterfaceDeleteInstance)
Path parameters
choreographyInstancePK (required)
Path Parameter — choreography instance
Request headers
Responses
0
no value expected
Up
get /consoleinterface/{choreographyId}/instancesAverageRetrieves average execution time (consoleinterfaceGetAverageInstanceExecutionTime)
Path parameters
choreographyId (required)
Path Parameter — choreography id
Request headers
Return type
Double
Example data
Content-Type: application/json
1.3579000000000001069366817318950779736042022705078125Responses
200
average execution time Double
Up
get /consoleinterface/choreography/{choreographyId}Retrieves choreography (consoleinterfaceGetChoreography)
Path parameters
choreographyId (required)
Path Parameter —
Request headers
Return type
Example data
Content-Type: application/json
{
"diagram" : [ "" ],
"image" : [ "" ],
"name" : "aeiou",
"description" : "aeiou",
"messages" : [ "" ],
"id" : "aeiou",
"groupKey" : "aeiou"
}Responses
200
choreography ChoreographyTO
Up
get /consoleinterface/instance/{choreographyInstancePK}Retrieves choreography instance (consoleinterfaceGetChoreographyInstance)
Path parameters
choreographyInstancePK (required)
Path Parameter —
Request headers
Return type
Example data
Content-Type: application/json
{
"executionTime" : 123456789,
"choreographyInstanceId" : "aeiou",
"id" : "aeiou",
"choreographyId" : "aeiou",
"instanceDescription" : "aeiou",
"choreographyName" : "aeiou",
"status" : "aeiou"
}Responses
200
choreography instance ChoreographyInstanceTO
Up
get /consoleinterface/service/{serviceName}/{choreographyInstancePK}Retrieves services (consoleinterfaceGetService)
Path parameters
choreographyInstancePK (required)
Path Parameter — choreography instance
serviceName (required)
Path Parameter — service name
Request headers
Return type
Example data
Content-Type: application/json
{
"executionTime" : 123456789,
"executedOperations" : 123,
"name" : "aeiou",
"waitTimeForResponse" : 123456789
}Responses
200
service ServiceTO
Up
get /consoleinterface/{choreographyId}/instancesThis is a temporary method. (consoleinterfaceInstanceList)
Path parameters
choreographyId (required)
Path Parameter —
Request headers
Return type
array[ChoreographyInstanceTO]
Example data
Content-Type: application/json
[ {
"executionTime" : 123456789,
"choreographyInstanceId" : "aeiou",
"id" : "aeiou",
"choreographyId" : "aeiou",
"instanceDescription" : "aeiou",
"choreographyName" : "aeiou",
"status" : "aeiou"
} ]Responses
200
all instances of selected choreography
Up
get /consoleinterface/instance/{choreographyInstancePK}/{cdname}/operationsRetrieves CD operations (consoleinterfaceOperationList)
Path parameters
choreographyInstancePK (required)
Path Parameter —
cdname (required)
Path Parameter —
Request headers
Return type
array[OperationDataTO]
Example data
Content-Type: application/json
[ {
"networkOverheadForBusinessMessagesExchangeTime" : 123456789,
"serviceExecutionTime" : 123456789,
"messageNumber" : 123,
"waitTimeForSchedulingOperation" : 123456789,
"name" : "aeiou",
"serviceWaitTimeForResponse" : 123456789,
"networkOverheadForCoordinationMessagesExchangeTime" : 123456789,
"waitTimeForSynchronizing" : 123456789,
"coordinationAlgorithmReasoningTime" : 123456789
} ]Responses
200
all operations performed by selected CD
Up
get /consoleinterface/instance/{choreographyInstancePK}/serviceListRetrieves service instance list. (instanceServiceList)
Path parameters
choreographyInstancePK (required)
Path Parameter — choreography instance
Request headers
Return type
array[ServiceTO]
Example data
Content-Type: application/json
[ {
"executionTime" : 123456789,
"executedOperations" : 123,
"name" : "aeiou",
"waitTimeForResponse" : 123456789
} ]Responses
200
service instance list_domains
Up
post /domainsCreates a new domain. (domainsCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — domain to be created
Request headers
Responses
0
Response object featuring Location header of created domain
Up
delete /domains/{key}Deletes the domain matching the provided key. (domainsDelete)
Path parameters
key (required)
Path Parameter — domain key to be deleted
Request headers
Responses
0
no value expected
Up
get /domainsReturns a list of all domains. (domainsList)
Request headers
Return type
array[DomainTO]
Example data
Content-Type: application/json
[ {
"adminPwd" : "aeiou",
"key" : "aeiou",
"adminCipherAlgorithm" : "aeiou"
} ]Example data
Content-Type: application/xml
<domain>
<key>string</key>
<adminPwd>string</adminPwd>
<adminCipherAlgorithm>string</adminCipherAlgorithm>
</domain>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all domains.
Up
get /domains/{key}Returns domain with matching key. (domainsRead)
Path parameters
key (required)
Path Parameter — domain key to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"adminPwd" : "aeiou",
"key" : "aeiou",
"adminCipherAlgorithm" : "aeiou"
}Example data
Content-Type: application/xml
<domain>
<key>string</key>
<adminPwd>string</adminPwd>
<adminCipherAlgorithm>string</adminCipherAlgorithm>
</domain>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
domain with matching key DomainTO
Up
put /domains/{key}Updates the domain matching the provided key. (domainsUpdate)
Path parameters
key (required)
Path Parameter — domain key to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — domain to be stored
Request headers
Responses
0
no value expected_groups
Up
post /groups/{key}/associate/{action}Executes resource-related operations on given any object. (groupsAssociate)
Path parameters
key (required)
Path Parameter — group key
action (required)
Path Parameter — action
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — external resources to be used for propagation-related operations
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring BulkActionResult as Entity
Up
post /groups/bulkExecutes the provided bulk action. (groupsBulk)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — list of any object ids against which the bulk action will be performed.
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring BulkActionResult as Entity
Up
post /groups/{key}/members/{actionType}(De)provision all members of the given group from / onto all the resources associated to it. (groupsBulkMembersAction)
Path parameters
key (required)
Path Parameter — group key
actionType (required)
Path Parameter — action type to perform on all group members
Request headers
Return type
Example data
Content-Type: application/json
{
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"end" : "2000-01-23T04:56:07.000+00:00",
"refKey" : "aeiou",
"jobType" : "aeiou",
"message" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
}Responses
200
execution report for the task generated on purpose ExecTO
Up
post /groups (groupsCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter —
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected
Up
post /groups/{key}/deassociate/{action}Executes resource-related operations on given any object. (groupsDeassociate)
Path parameters
key (required)
Path Parameter — group key
action (required)
Path Parameter — action
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — external resources to be used for propagation-related operations
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring BulkActionResult as Entity
Up
delete /groups/{key}Deletes any object matching provided key. (groupsDelete)
Path parameters
key (required)
Path Parameter — key of any object to be deleted
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring the deleted any object enriched with propagation status information - ProvisioningResult as Entity
Up
get /groups/ownThis method is similar to read() but uses different authentication handling to ensure that a user
can read his own groups. (groupsOwn)
Request headers
Return type
array[GroupTO]
Example data
Content-Type: application/json
[ {
"creator" : "aeiou",
"auxClasses" : [ "aeiou" ],
"groupOwner" : "aeiou",
"adynMembershipConds" : {
"key" : "aeiou"
},
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"resources" : [ "aeiou" ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"udynMembershipCond" : "aeiou",
"userOwner" : "aeiou",
"typeExtensions" : [ {
"auxClasses" : [ "aeiou" ],
"anyType" : "aeiou"
} ],
"name" : "aeiou",
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
own groups
Up
patch /groups/{key} (groupsPatchUpdate)
Path parameters
key (required)
Path Parameter — key of any object to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter —
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected
Up
get /groups/{key}Reads the any object matching the provided key. (groupsRead)
Path parameters
key (required)
Path Parameter — key of any object to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"creator" : "aeiou",
"auxClasses" : [ "aeiou" ],
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"resources" : [ "aeiou" ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
}Example data
Content-Type: application/xml
<null>
<creator>string</creator>
<creationDate>2000-01-23T04:56:07.000Z</creationDate>
<lastModifier>string</lastModifier>
<lastChangeDate>2000-01-23T04:56:07.000Z</lastChangeDate>
<key>string</key>
<type>string</type>
<realm>string</realm>
<status>string</status>
<auxClasses>
<auxClasses>string</auxClasses>
</auxClasses>
<plainAttrs>
</plainAttrs>
<derAttrs>
</derAttrs>
<virAttrs>
</virAttrs>
<resources>
<resources>string</resources>
</resources>
</null>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
any object with matching key AnyTO
Up
get /groups/{key}/{anyTypeKey}/typeExtensionExtracts type extension information, for the provided group and any type. (groupsReadTypeExtension)
Path parameters
key (required)
Path Parameter — group key
anyTypeKey (required)
Path Parameter — any type key
Request headers
Return type
Example data
Content-Type: application/json
{
"auxClasses" : [ "aeiou" ],
"anyType" : "aeiou"
}Example data
Content-Type: application/xml
<typeExtension>
<anyType>string</anyType>
<auxClasses>
<auxClasses>string</auxClasses>
</auxClasses>
</typeExtension>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
type extension information, for the provided group and any type TypeExtensionTO
Up
delete /groups/{key}/{schemaType}/{schema}Deletes the attribute, owned by the given any object, for the given schema type and schema. (groupsSchemaDelete)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
schema (required)
Path Parameter — schema
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected
Up
get /groups/{key}/{schemaType}/{schema}Reads the attribute, owned by the given any object, for the given schema type and schema. (groupsSchemaRead)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
schema (required)
Path Parameter — schema
Request headers
Return type
Example data
Content-Type: application/json
{
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
}Example data
Content-Type: application/xml
<attribute>
<schema>string</schema>
<values>
<values>string</values>
</values>
</attribute>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
attribute, owned by the given any object, for the given schema type and schema AttrTO
Up
get /groups/{key}/{schemaType}Reads the list of attributes owned by the given any object for the given schema type. (groupsSchemaTypeRead)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
Request headers
Return type
array[AttrTO]
Example data
Content-Type: application/json
[ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ]Example data
Content-Type: application/xml
<attribute>
<schema>string</schema>
<values>
<values>string</values>
</values>
</attribute>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of attributes, owned by the given any object, for the given schema type
Up
put /groups/{key}/{schemaType}/{schema}Adds or replaces the attribute, owned by the given any object, for the given schema type and schema. (groupsSchemaUpdate)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
schema (required)
Path Parameter — schema
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — attribute
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring the updated any object attribute - as Entity
Up
get /groupsReturns a paged list of any objects matching the given query. (groupsSearch)
Request headers
Query parameters
page (optional)
Query Parameter — query conditions default: 1 format: int32
size (optional)
Query Parameter — default: 25 format: int32
orderby (optional)
Query Parameter —
realm (optional)
Query Parameter — default: /
details (optional)
Query Parameter — default: true
fiql (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"result" : [ {
"creator" : "aeiou",
"auxClasses" : [ "aeiou" ],
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"resources" : [ "aeiou" ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ],
"size" : 123,
"prev" : "aeiou",
"page" : 123,
"totalCount" : 123
}Example data
Content-Type: application/xml
<pagedResult>
<prev>string</prev>
<next>string</next>
<page>0</page>
<size>0</size>
<totalCount>0</totalCount>
<result>
</result>
</pagedResult>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
paged list of any objects matching the given query PagedResultAnyTO
Up
put /groups/{key} (groupsUpdate)
Path parameters
key (required)
Path Parameter — key of any object to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter —
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected_loggers
Up
delete /loggers/{type}/{key}Deletes the logger with matching name. (loggersDelete)
Path parameters
type (required)
Path Parameter — LoggerType to be selected
key (required)
Path Parameter — Logger name to be deleted
Request headers
Responses
0
no value expected
Up
get /loggers/eventsReturns a list of all managed events in audit. (loggersEvents)
Request headers
Return type
array[EventCategoryTO]
Example data
Content-Type: application/json
[ {
"type" : "aeiou",
"category" : "aeiou",
"subcategory" : "aeiou",
"events" : [ "aeiou" ]
} ]Example data
Content-Type: application/xml
<eventCategory>
<type>string</type>
<category>string</category>
<subcategory>string</subcategory>
<events>
<events>string</events>
</events>
</eventCategory>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all managed events in audit
Up
get /loggers/{type}Returns a list of loggers with matching type. (loggersList)
Path parameters
type (required)
Path Parameter — LoggerType to be selected
Request headers
Return type
array[LoggerTO]
Example data
Content-Type: application/json
[ {
"level" : "aeiou",
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<logger>
<key>string</key>
<level>string</level>
</logger>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of loggers with matching type
Up
get /loggers/{type}/{key}Returns logger with matching type and name. (loggersRead)
Path parameters
type (required)
Path Parameter — LoggerType to be selected.
key (required)
Path Parameter — Logger name to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"level" : "aeiou",
"key" : "aeiou"
}Example data
Content-Type: application/xml
<logger>
<key>string</key>
<level>string</level>
</logger>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
logger with matching type and name LoggerTO
Up
put /loggers/{type}/{key}Creates or updates (if existing) the logger with matching name. (loggersUpdate)
Path parameters
type (required)
Path Parameter — LoggerType to be selected
key (required)
Path Parameter — Logger key
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — Logger to be created or updated
Request headers
Responses
0
no value expected_mailTemplates
Up
post /mailTemplatesCreates a new mail template. (mailTemplatesCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — Creates a new mail template.
Request headers
Responses
0
Response object featuring Location header of created mail template
Up
delete /mailTemplates/{key}Deletes the mail template matching the given key. (mailTemplatesDelete)
Path parameters
key (required)
Path Parameter — key for mail template to be deleted
Request headers
Responses
0
no value expected
Up
get /mailTemplates/{key}/{format}Gets the template for the given key and format, if available. (mailTemplatesGetFormat)
Path parameters
key (required)
Path Parameter — mail template
format (required)
Path Parameter — template format
Request headers
Responses
0
mail template with matching key and format, if available
Up
get /mailTemplatesReturns a list of all mail templates. (mailTemplatesList)
Request headers
Return type
array[MailTemplateTO]
Example data
Content-Type: application/json
[ {
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<mailTemplate>
<key>string</key>
</mailTemplate>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all mail templates.
Up
get /mailTemplates/{key}Returns mail template with matching key. (mailTemplatesRead)
Path parameters
key (required)
Path Parameter — key of mail template to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"key" : "aeiou"
}Example data
Content-Type: application/xml
<mailTemplate>
<key>string</key>
</mailTemplate>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
mail template with matching key MailTemplateTO
Up
delete /mailTemplates/{key}/{format}Removes the template for the given key and format, if available. (mailTemplatesRemoveFormat)
Path parameters
key (required)
Path Parameter — mail template
format (required)
Path Parameter — template format
Request headers
Responses
0
no value expected
Up
put /mailTemplates/{key}/{format}Sets the template for the given key and format, if available. (mailTemplatesSetFormat)
Path parameters
key (required)
Path Parameter — mail template
format (required)
Path Parameter — template format
Request body
body (optional)
Body Parameter — template to be set
Request headers
Responses
0
no value expected_notifications
Up
post /notifications/jobExecutes an action on the notification job. (notificationsActionJob)
Request headers
Query parameters
action (optional)
Query Parameter — action to execute
Responses
0
no value expected
Up
post /notificationsCreates a new notification. (notificationsCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — Creates a new notification.
Request headers
Responses
0
Response object featuring Location header of created notification
Up
delete /notifications/{key}Deletes the notification matching the given key. (notificationsDelete)
Path parameters
key (required)
Path Parameter — key for notification to be deleted
Request headers
Responses
0
no value expected
Up
get /notifications/jobReturns details about notification job. (notificationsGetJob)
Request headers
Return type
Example data
Content-Type: application/json
{
"running" : true,
"scheduled" : true,
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"refKey" : "aeiou",
"type" : "aeiou"
}Example data
Content-Type: application/xml
<job>
<type>string</type>
<refKey>string</refKey>
<refDesc>string</refDesc>
<running>true</running>
<scheduled>true</scheduled>
<start>2000-01-23T04:56:07.000Z</start>
</job>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
details about notification job JobTO
Up
get /notificationsReturns a list of all notifications. (notificationsList)
Request headers
Return type
array[NotificationTO]
Example data
Content-Type: application/json
[ {
"template" : "aeiou",
"subject" : "aeiou",
"active" : true,
"recipientsFIQL" : "aeiou",
"traceLevel" : "aeiou",
"recipientAttrName" : "aeiou",
"staticRecipients" : [ "aeiou" ],
"recipientsProviderClassName" : "aeiou",
"sender" : "aeiou",
"abouts" : {
"key" : "aeiou"
},
"selfAsRecipient" : true,
"key" : "aeiou",
"events" : [ "aeiou" ]
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all notifications.
Up
get /notifications/{key}Returns notification with matching key. (notificationsRead)
Path parameters
key (required)
Path Parameter — key of notification to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"template" : "aeiou",
"subject" : "aeiou",
"active" : true,
"recipientsFIQL" : "aeiou",
"traceLevel" : "aeiou",
"recipientAttrName" : "aeiou",
"staticRecipients" : [ "aeiou" ],
"recipientsProviderClassName" : "aeiou",
"sender" : "aeiou",
"abouts" : {
"key" : "aeiou"
},
"selfAsRecipient" : true,
"key" : "aeiou",
"events" : [ "aeiou" ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
notification with matching key NotificationTO
Up
put /notifications/{key}Updates the notification matching the given key. (notificationsUpdate)
Path parameters
key (required)
Path Parameter — key of notification to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — notification to be stored
Request headers
Responses
0
no value expected_policies
Up
post /policiesCreate a new policy. (policiesCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — Policy to be created (needs to match type)
Request headers
Responses
0
Response object featuring Location header of created policy
Up
delete /policies/{key}Delete policy matching the given key. (policiesDelete)
Path parameters
key (required)
Path Parameter — key of policy to be deleted
Request headers
Responses
0
no value expected
Up
get /policiesReturns a list of policies of the matching type. (policiesList)
Request headers
Query parameters
type (required)
Query Parameter —
Return type
array[AbstractPolicyTO]
Example data
Content-Type: application/json
[ {
"usedByRealms" : [ "aeiou" ],
"description" : "aeiou",
"usedByResources" : [ "aeiou" ],
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<abstractPolicy>
<key>string</key>
<description>string</description>
<usedByResources>
<usedByResources>string</usedByResources>
</usedByResources>
<usedByRealms>
<usedByRealms>string</usedByRealms>
</usedByRealms>
</abstractPolicy>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of policies with matching type
Up
get /policies/{key}Returns the policy matching the given key. (policiesRead)
Path parameters
key (required)
Path Parameter — response type (extending PolicyTO)
Request headers
Return type
Example data
Content-Type: application/json
{
"usedByRealms" : [ "aeiou" ],
"description" : "aeiou",
"usedByResources" : [ "aeiou" ],
"key" : "aeiou"
}Example data
Content-Type: application/xml
<abstractPolicy>
<key>string</key>
<description>string</description>
<usedByResources>
<usedByResources>string</usedByResources>
</usedByResources>
<usedByRealms>
<usedByRealms>string</usedByRealms>
</usedByRealms>
</abstractPolicy>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
policy with matching id AbstractPolicyTO
Up
put /policies/{key}Updates policy matching the given key. (policiesUpdate)
Path parameters
key (required)
Path Parameter — policy key
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — Policy to replace existing policy
Request headers
Responses
0
no value expected_realms
Up
post /realms/{fullPath}Creates a new realm under the given path. (realmsCreate)
Path parameters
fullPath (required)
Path Parameter — full path of the parent realm
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — new realm.
Request headers
Responses
0
Response object featuring Location header of created realm as well as the realm itself enriched with propagation status information - ProvisioningResult as Entity
Up
delete /realms/{fullPath}Deletes the realm under the given path. (realmsDelete)
Path parameters
fullPath (required)
Path Parameter — realm path
Request headers
Responses
0
Response object featuring the deleted realm enriched with propagation status information - ProvisioningResult as Entity
Up
get /realmsReturns a list of all realms. (realmsList)
Request headers
Return type
array[RealmTO]
Example data
Content-Type: application/json
[ {
"fullPath" : "aeiou",
"accountPolicy" : "aeiou",
"parent" : "aeiou",
"passwordPolicy" : "aeiou",
"templates" : {
"key" : {
"creator" : "aeiou",
"auxClasses" : [ "aeiou" ],
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"resources" : [ "aeiou" ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
}
},
"name" : "aeiou",
"resources" : [ "aeiou" ],
"actionsClassNames" : [ "aeiou" ],
"key" : "aeiou"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all realms.
Up
get /realms/{fullPath}Returns realms rooted at the given path. (realmsListByFP)
Path parameters
fullPath (required)
Path Parameter — full path of the root realm where to read from
Request headers
Return type
array[RealmTO]
Example data
Content-Type: application/json
[ {
"fullPath" : "aeiou",
"accountPolicy" : "aeiou",
"parent" : "aeiou",
"passwordPolicy" : "aeiou",
"templates" : {
"key" : {
"creator" : "aeiou",
"auxClasses" : [ "aeiou" ],
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"resources" : [ "aeiou" ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
}
},
"name" : "aeiou",
"resources" : [ "aeiou" ],
"actionsClassNames" : [ "aeiou" ],
"key" : "aeiou"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
realms rooted at the given path
Up
put /realms/{fullPath}Updates the realm under the given path. (realmsUpdate)
Path parameters
fullPath (required)
Path Parameter — full path of the root realm where to read from
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — realm to be stored
Request headers
Responses
0
Response object featuring the updated realm enriched with propagation status information - ProvisioningResult as Entity_relationshipTypes
Up
post /relationshipTypesCreates a new relationshipType. (relationshipTypesCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — relationshipType to be created
Request headers
Responses
0
Response object featuring Location header of created relationshipType
Up
delete /relationshipTypes/{key}Deletes the relationshipType matching the provided key. (relationshipTypesDelete)
Path parameters
key (required)
Path Parameter — relationshipType key to be deleted
Request headers
Responses
0
no value expected
Up
get /relationshipTypesReturns a list of all relationshipTypes. (relationshipTypesList)
Request headers
Return type
array[RelationshipTypeTO]
Example data
Content-Type: application/json
[ {
"description" : "aeiou",
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<relationshipType>
<key>string</key>
<description>string</description>
</relationshipType>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all relationshipTypes.
Up
get /relationshipTypes/{key}Returns relationshipType with matching key. (relationshipTypesRead)
Path parameters
key (required)
Path Parameter — relationshipType key to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"description" : "aeiou",
"key" : "aeiou"
}Example data
Content-Type: application/xml
<relationshipType>
<key>string</key>
<description>string</description>
</relationshipType>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
relationshipType with matching key RelationshipTypeTO
Up
put /relationshipTypes/{key}Updates the relationshipType matching the provided key. (relationshipTypesUpdate)
Path parameters
key (required)
Path Parameter — relationshipType key to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — relationshipType to be stored
Request headers
Responses
0
no value expected_reportTemplates
Up
post /reportTemplatesCreates a new report template. (reportTemplatesCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — Creates a new report template.
Request headers
Responses
0
Response object featuring Location header of created report template
Up
delete /reportTemplates/{key}Deletes the report template matching the given key. (reportTemplatesDelete)
Path parameters
key (required)
Path Parameter — key for report template to be deleted
Request headers
Responses
0
no value expected
Up
get /reportTemplates/{key}/{format}Gets the template for the given key and format, if available. (reportTemplatesGetFormat)
Path parameters
key (required)
Path Parameter — report template
format (required)
Path Parameter — template format
Request headers
Responses
0
report template with matching key and format, if available
Up
get /reportTemplatesReturns a list of all report templates. (reportTemplatesList)
Request headers
Return type
array[ReportTemplateTO]
Example data
Content-Type: application/json
[ {
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<reportTemplate>
<key>string</key>
</reportTemplate>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all report templates.
Up
get /reportTemplates/{key}Returns report template with matching key. (reportTemplatesRead)
Path parameters
key (required)
Path Parameter — key of report template to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"key" : "aeiou"
}Example data
Content-Type: application/xml
<reportTemplate>
<key>string</key>
</reportTemplate>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
report template with matching key ReportTemplateTO
Up
delete /reportTemplates/{key}/{format}Removes the template for the given key and format, if available. (reportTemplatesRemoveFormat)
Path parameters
key (required)
Path Parameter — report template
format (required)
Path Parameter — template format
Request headers
Responses
0
no value expected
Up
put /reportTemplates/{key}/{format}Sets the template for the given key and format, if available. (reportTemplatesSetFormat)
Path parameters
key (required)
Path Parameter — report template
format (required)
Path Parameter — template format
Request body
body (optional)
Body Parameter — template to be set
Request headers
Responses
0
no value expected_reports
Up
post /reports/jobs/{key}Executes an action on an existing executable's job. (reportsActionJob)
Path parameters
key (required)
Path Parameter — executable key
Request headers
Query parameters
action (optional)
Query Parameter — action to execute
Responses
0
no value expected
Up
post /reportsCreates a new report. (reportsCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — report to be created
Request headers
Responses
0
Response object featuring Location header of created report
Up
delete /reports/{key}Deletes report with matching key. (reportsDelete)
Path parameters
key (required)
Path Parameter — Deletes report with matching key
Request headers
Responses
0
no value expected
Up
delete /reports/executions/{executionKey}Deletes the executable execution matching the provided key. (reportsDeleteExecution)
Path parameters
executionKey (required)
Path Parameter — key of executable execution to be deleted
Request headers
Responses
0
no value expected
Up
delete /reports/{key}/executionsDeletes the executions belonging matching the given query. (reportsDeleteExecutions)
Path parameters
key (required)
Path Parameter — query conditions
Request headers
Query parameters
startedBefore (optional)
Query Parameter — format: date-time
startedAfter (optional)
Query Parameter — format: date-time
endedBefore (optional)
Query Parameter — format: date-time
endedAfter (optional)
Query Parameter — format: date-time
Return type
Example data
Content-Type: application/json
{
"results" : {
"key" : "aeiou"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/xmlapplication/json
Responses
200
bulk action result BulkActionResult
Up
post /reports/{key}/executeExecutes the executable matching the given query. (reportsExecute)
Path parameters
key (required)
Path Parameter — query conditions
Request headers
Query parameters
startAt (optional)
Query Parameter — format: date-time
dryRun (optional)
Query Parameter — default: false
Return type
Example data
Content-Type: application/json
{
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"end" : "2000-01-23T04:56:07.000+00:00",
"refKey" : "aeiou",
"jobType" : "aeiou",
"message" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
}Example data
Content-Type: application/xml
<exec>
<start>2000-01-23T04:56:07.000Z</start>
<end>2000-01-23T04:56:07.000Z</end>
<key>string</key>
<jobType>string</jobType>
<refKey>string</refKey>
<refDesc>string</refDesc>
<status>string</status>
<message>string</message>
</exec>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
execution report for the executable matching the given query ExecTO
Up
get /reports/executions/{executionKey}/streamExports the report execution with matching key in the requested format. (reportsExportExecutionResult)
Path parameters
executionKey (required)
Path Parameter — key of execution report to be selected
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request headers
Query parameters
format (optional)
Query Parameter — file-format selection
Responses
0
a stream for content download
Up
get /reportsReturns a list of all existing reports. (reportsList)
Request headers
Return type
array[ReportTO]
Example data
Content-Type: application/json
[ {
"cronExpression" : "aeiou",
"template" : "aeiou",
"reportletConfs" : [ {
"name" : "aeiou"
} ],
"executions" : [ {
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"end" : "2000-01-23T04:56:07.000+00:00",
"refKey" : "aeiou",
"jobType" : "aeiou",
"message" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ],
"nextExec" : "2000-01-23T04:56:07.000+00:00",
"latestExecStatus" : "aeiou",
"start" : "2000-01-23T04:56:07.000+00:00",
"name" : "aeiou",
"active" : true,
"end" : "2000-01-23T04:56:07.000+00:00",
"lastExec" : "2000-01-23T04:56:07.000+00:00",
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<report>
<start>2000-01-23T04:56:07.000Z</start>
<end>2000-01-23T04:56:07.000Z</end>
<key>string</key>
<name>string</name>
<cronExpression>string</cronExpression>
<latestExecStatus>string</latestExecStatus>
<lastExec>2000-01-23T04:56:07.000Z</lastExec>
<nextExec>2000-01-23T04:56:07.000Z</nextExec>
<active>true</active>
<template>string</template>
<reportletConfs>
</reportletConfs>
<executions>
</executions>
</report>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
paged list of existing reports matching the given query
Up
get /reports/{key}/executionsReturns a paged list of executions matching the given query. (reportsListExecutions)
Path parameters
key (required)
Path Parameter —
Request headers
Query parameters
page (optional)
Query Parameter — query conditions default: 1 format: int32
size (optional)
Query Parameter — default: 25 format: int32
orderby (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"result" : [ {
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"end" : "2000-01-23T04:56:07.000+00:00",
"refKey" : "aeiou",
"jobType" : "aeiou",
"message" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ],
"size" : 123,
"prev" : "aeiou",
"page" : 123,
"totalCount" : 123
}Example data
Content-Type: application/xml
<pagedResult>
<prev>string</prev>
<next>string</next>
<page>0</page>
<size>0</size>
<totalCount>0</totalCount>
<result>
</result>
</pagedResult>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
paged list of executions the given query PagedResultExecTO
Up
get /reports/jobsList jobs (running and / or scheduled). (reportsListJobs)
Request headers
Return type
array[JobTO]
Example data
Content-Type: application/json
[ {
"running" : true,
"scheduled" : true,
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"refKey" : "aeiou",
"type" : "aeiou"
} ]Example data
Content-Type: application/xml
<job>
<type>string</type>
<refKey>string</refKey>
<refDesc>string</refDesc>
<running>true</running>
<scheduled>true</scheduled>
<start>2000-01-23T04:56:07.000Z</start>
</job>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
jobs (running and / or scheduled)
Up
get /reports/executions/recentReturns the list of recently completed executions, ordered by end date descendent. (reportsListRecentExecutions)
Request headers
Query parameters
max (optional)
Query Parameter — the maximum number of executions to return default: 25 format: int32
Return type
array[ExecTO]
Example data
Content-Type: application/json
[ {
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"end" : "2000-01-23T04:56:07.000+00:00",
"refKey" : "aeiou",
"jobType" : "aeiou",
"message" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ]Example data
Content-Type: application/xml
<exec>
<start>2000-01-23T04:56:07.000Z</start>
<end>2000-01-23T04:56:07.000Z</end>
<key>string</key>
<jobType>string</jobType>
<refKey>string</refKey>
<refDesc>string</refDesc>
<status>string</status>
<message>string</message>
</exec>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of recently completed executions, ordered by end date descendent
Up
get /reports/{key}Returns report with matching key. (reportsRead)
Path parameters
key (required)
Path Parameter — key of report to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"cronExpression" : "aeiou",
"template" : "aeiou",
"reportletConfs" : [ {
"name" : "aeiou"
} ],
"executions" : [ {
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"end" : "2000-01-23T04:56:07.000+00:00",
"refKey" : "aeiou",
"jobType" : "aeiou",
"message" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ],
"nextExec" : "2000-01-23T04:56:07.000+00:00",
"latestExecStatus" : "aeiou",
"start" : "2000-01-23T04:56:07.000+00:00",
"name" : "aeiou",
"active" : true,
"end" : "2000-01-23T04:56:07.000+00:00",
"lastExec" : "2000-01-23T04:56:07.000+00:00",
"key" : "aeiou"
}Example data
Content-Type: application/xml
<report>
<start>2000-01-23T04:56:07.000Z</start>
<end>2000-01-23T04:56:07.000Z</end>
<key>string</key>
<name>string</name>
<cronExpression>string</cronExpression>
<latestExecStatus>string</latestExecStatus>
<lastExec>2000-01-23T04:56:07.000Z</lastExec>
<nextExec>2000-01-23T04:56:07.000Z</nextExec>
<active>true</active>
<template>string</template>
<reportletConfs>
</reportletConfs>
<executions>
</executions>
</report>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
report with matching key ReportTO
Up
put /reports/{key}Updates report with matching key. (reportsUpdate)
Path parameters
key (required)
Path Parameter — key of report to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — report to be stored
Request headers
Responses
0
no value expected_resources
Up
post /resources/{key}/bulkDeassociation/{anyTypeKey}/{action}De-associate any objects from the given resource. (resourcesBulkDeassociation)
Path parameters
key (required)
Path Parameter — Name of resource
anyTypeKey (required)
Path Parameter — Any type key
action (required)
Path Parameter — action
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — any objects to be used for propagation-related operations
Request headers
Return type
Example data
Content-Type: application/json
{
"results" : {
"key" : "aeiou"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
Bulk action result BulkActionResult
Up
post /resources/checkChecks whether the connection to resource could be established. (resourcesCheck)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — resource to be checked
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected
Up
post /resourcesCreates a new resource. (resourcesCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — Resource to be created
Request headers
Responses
0
Response object featuring Location header of created resource
Up
delete /resources/{key}Deletes the resource matching the given name. (resourcesDelete)
Path parameters
key (required)
Path Parameter — name of resource to be deleted
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request headers
Responses
0
no value expected
Up
get /resourcesReturns a list of all resources. (resourcesList)
Request headers
Return type
array[ResourceTO]
Example data
Content-Type: application/json
[ {
"passwordPolicy" : "aeiou",
"orgUnit" : {
"syncToken" : "aeiou",
"connObjectLink" : "aeiou",
"objectClass" : "aeiou",
"extAttrName" : "aeiou",
"key" : "aeiou"
},
"deleteTraceLevel" : "aeiou",
"connectorDisplayName" : "aeiou",
"capabilitiesOverride" : [ "aeiou" ],
"pullPolicy" : "aeiou",
"randomPwdIfNotProvided" : true,
"accountPolicy" : "aeiou",
"confOverride" : [ {
"schema" : {
"displayName" : "aeiou",
"name" : "aeiou",
"defaultValues" : [ "{}" ],
"type" : "aeiou",
"helpMessage" : "aeiou",
"required" : true,
"order" : 123,
"confidential" : true
},
"values" : [ "{}" ],
"overridable" : true
} ],
"provisions" : [ {
"mapping" : {
"connObjectLink" : "aeiou",
"linkingItems" : [ "" ],
"items" : [ "" ],
"connObjectKeyItem" : {
"intAttrName" : "aeiou",
"password" : true,
"purpose" : "aeiou",
"pullJEXLTransformer" : "aeiou",
"mandatoryCondition" : "aeiou",
"connObjectKey" : true,
"propagationJEXLTransformer" : "aeiou",
"extAttrName" : "aeiou",
"mappingItemTransformerClassNames" : [ "aeiou" ],
"key" : "aeiou"
}
},
"syncToken" : "aeiou",
"auxClasses" : [ "aeiou" ],
"anyType" : "aeiou",
"objectClass" : "aeiou",
"virSchemas" : [ "aeiou" ],
"key" : "aeiou"
} ],
"overrideCapabilities" : true,
"connector" : "aeiou",
"provisioningTraceLevel" : "aeiou",
"createTraceLevel" : "aeiou",
"updateTraceLevel" : "aeiou",
"enforceMandatoryCondition" : true,
"propagationPriority" : 123,
"propagationActionsClassNames" : [ "aeiou" ],
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<resource>
<key>string</key>
<connector>string</connector>
<connectorDisplayName>string</connectorDisplayName>
<propagationPriority>0</propagationPriority>
<randomPwdIfNotProvided>true</randomPwdIfNotProvided>
<enforceMandatoryCondition>true</enforceMandatoryCondition>
<createTraceLevel>string</createTraceLevel>
<updateTraceLevel>string</updateTraceLevel>
<deleteTraceLevel>string</deleteTraceLevel>
<provisioningTraceLevel>string</provisioningTraceLevel>
<passwordPolicy>string</passwordPolicy>
<accountPolicy>string</accountPolicy>
<pullPolicy>string</pullPolicy>
<overrideCapabilities>true</overrideCapabilities>
<provisions>
</provisions>
<confOverride>
</confOverride>
<capabilitiesOverride>
<capabilitiesOverride>string</capabilitiesOverride>
</capabilitiesOverride>
<propagationActionsClassNames>
<propagationActionsClassNames>string</propagationActionsClassNames>
</propagationActionsClassNames>
</resource>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all resources
Up
get /resources/{key}/{anyTypeKey}Returns a paged list of connector objects from external resource, for the given type, matching
page/size conditions. (resourcesListConnObjects)
Path parameters
key (required)
Path Parameter — name of resource to read connector object from
anyTypeKey (required)
Path Parameter — any object type
Request headers
Query parameters
size (optional)
Query Parameter — query conditions default: 25 format: int32
connIdPagedResultsCookie (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"result" : [ {
"attrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ]
} ],
"remainingPagedResults" : 123,
"allResultsReturned" : true,
"pagedResultsCookie" : "aeiou"
}Example data
Content-Type: application/xml
<pagedConnObjectResult>
<next>string</next>
<pagedResultsCookie>string</pagedResultsCookie>
<remainingPagedResults>0</remainingPagedResults>
<allResultsReturned>true</allResultsReturned>
<result>
</result>
</pagedConnObjectResult>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
connector objects from the external resource, for the given type PagedConnObjectTOResult
Up
get /resources/{key}Returns the resource with matching name. (resourcesRead)
Path parameters
key (required)
Path Parameter — Name of resource to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"passwordPolicy" : "aeiou",
"orgUnit" : {
"syncToken" : "aeiou",
"connObjectLink" : "aeiou",
"objectClass" : "aeiou",
"extAttrName" : "aeiou",
"key" : "aeiou"
},
"deleteTraceLevel" : "aeiou",
"connectorDisplayName" : "aeiou",
"capabilitiesOverride" : [ "aeiou" ],
"pullPolicy" : "aeiou",
"randomPwdIfNotProvided" : true,
"accountPolicy" : "aeiou",
"confOverride" : [ {
"schema" : {
"displayName" : "aeiou",
"name" : "aeiou",
"defaultValues" : [ "{}" ],
"type" : "aeiou",
"helpMessage" : "aeiou",
"required" : true,
"order" : 123,
"confidential" : true
},
"values" : [ "{}" ],
"overridable" : true
} ],
"provisions" : [ {
"mapping" : {
"connObjectLink" : "aeiou",
"linkingItems" : [ "" ],
"items" : [ "" ],
"connObjectKeyItem" : {
"intAttrName" : "aeiou",
"password" : true,
"purpose" : "aeiou",
"pullJEXLTransformer" : "aeiou",
"mandatoryCondition" : "aeiou",
"connObjectKey" : true,
"propagationJEXLTransformer" : "aeiou",
"extAttrName" : "aeiou",
"mappingItemTransformerClassNames" : [ "aeiou" ],
"key" : "aeiou"
}
},
"syncToken" : "aeiou",
"auxClasses" : [ "aeiou" ],
"anyType" : "aeiou",
"objectClass" : "aeiou",
"virSchemas" : [ "aeiou" ],
"key" : "aeiou"
} ],
"overrideCapabilities" : true,
"connector" : "aeiou",
"provisioningTraceLevel" : "aeiou",
"createTraceLevel" : "aeiou",
"updateTraceLevel" : "aeiou",
"enforceMandatoryCondition" : true,
"propagationPriority" : 123,
"propagationActionsClassNames" : [ "aeiou" ],
"key" : "aeiou"
}Example data
Content-Type: application/xml
<resource>
<key>string</key>
<connector>string</connector>
<connectorDisplayName>string</connectorDisplayName>
<propagationPriority>0</propagationPriority>
<randomPwdIfNotProvided>true</randomPwdIfNotProvided>
<enforceMandatoryCondition>true</enforceMandatoryCondition>
<createTraceLevel>string</createTraceLevel>
<updateTraceLevel>string</updateTraceLevel>
<deleteTraceLevel>string</deleteTraceLevel>
<provisioningTraceLevel>string</provisioningTraceLevel>
<passwordPolicy>string</passwordPolicy>
<accountPolicy>string</accountPolicy>
<pullPolicy>string</pullPolicy>
<overrideCapabilities>true</overrideCapabilities>
<provisions>
</provisions>
<confOverride>
</confOverride>
<capabilitiesOverride>
<capabilitiesOverride>string</capabilitiesOverride>
</capabilitiesOverride>
<propagationActionsClassNames>
<propagationActionsClassNames>string</propagationActionsClassNames>
</propagationActionsClassNames>
</resource>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
resource with matching name ResourceTO
Up
get /resources/{key}/{anyTypeKey}/{anyKey}Returns connector object from the external resource, for the given type and key. (resourcesReadConnObject)
Path parameters
key (required)
Path Parameter — name of resource to read connector object from
anyTypeKey (required)
Path Parameter — any object type
anyKey (required)
Path Parameter — any object key
Request headers
Return type
Example data
Content-Type: application/json
{
"attrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ]
}Example data
Content-Type: application/xml
<connObject>
<attrs>
</attrs>
</connObject>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
connector object from the external resource, for the given type and key ConnObjectTO
Up
delete /resources/{key}/{anyTypeKey}Removes the sync token value associated to the given any type from the given resource. (resourcesRemoveSyncToken)
Path parameters
key (required)
Path Parameter — resource
anyTypeKey (required)
Path Parameter — any type
Request headers
Responses
0
no value expected
Up
post /resources/{key}/{anyTypeKey}Queries the connector underlying the given resource for the latest sync token value associated to the given any
type and stores the value internally, for later usage. (resourcesSetLatestSyncToken)
Path parameters
key (required)
Path Parameter — resource
anyTypeKey (required)
Path Parameter — any type
Request headers
Responses
0
no value expected
Up
put /resources/{key}Updates the resource matching the given name. (resourcesUpdate)
Path parameters
key (required)
Path Parameter — Name of resource to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — resource to be stored
Request headers
Responses
0
no value expected_roles
Up
post /rolesCreates a new role. (rolesCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — role to be created
Request headers
Responses
0
Response object featuring Location header of created role
Up
delete /roles/{key}Deletes the role matching the provided key. (rolesDelete)
Path parameters
key (required)
Path Parameter — role key to be deleted
Request headers
Responses
0
no value expected
Up
get /roles/{key}/consoleLayoutGets the console layout information as JSON string for the role with the given key, if available. (rolesGetConsoleLayoutInfo)
Path parameters
key (required)
Path Parameter — role key
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
0
console layout information as JSON string for the role with the given key, if available
Up
get /rolesReturns a list of all roles. (rolesList)
Request headers
Return type
array[RoleTO]
Example data
Content-Type: application/json
[ {
"entitlements" : [ "aeiou" ],
"realms" : [ "aeiou" ],
"dynMembershipCond" : "aeiou",
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<role>
<key>string</key>
<dynMembershipCond>string</dynMembershipCond>
<entitlements>
<entitlements>string</entitlements>
</entitlements>
<realms>
<realms>string</realms>
</realms>
</role>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all roles.
Up
get /roles/{key}Returns role with matching key. (rolesRead)
Path parameters
key (required)
Path Parameter — role key to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"entitlements" : [ "aeiou" ],
"realms" : [ "aeiou" ],
"dynMembershipCond" : "aeiou",
"key" : "aeiou"
}Example data
Content-Type: application/xml
<role>
<key>string</key>
<dynMembershipCond>string</dynMembershipCond>
<entitlements>
<entitlements>string</entitlements>
</entitlements>
<realms>
<realms>string</realms>
</realms>
</role>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
role with matching key RoleTO
Up
delete /roles/{key}/consoleLayoutRemoves the console layout information for the role with the given key, if available. (rolesRemoveConsoleLayoutInfo)
Path parameters
key (required)
Path Parameter — role key
Request headers
Responses
0
no value expected
Up
put /roles/{key}/consoleLayoutSets the console layout information as JSON string for the role with the given key, if available. (rolesSetConsoleLayoutInfo)
Path parameters
key (required)
Path Parameter — role key
Consumes
This API call consumes the following media types via the Content-Type request header:application/json
Request body
body (optional)
Body Parameter — console layout information to be set
Request headers
Responses
0
no value expected
Up
put /roles/{key}Updates the role matching the provided key. (rolesUpdate)
Path parameters
key (required)
Path Parameter — role key to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — role to be stored
Request headers
Responses
0
no value expected_schemas_type
Up
post /schemas/{type}Creates a new schema. (schemaCreate)
Path parameters
type (required)
Path Parameter — type for schema to be created
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — schema to be created
Request headers
Responses
0
Response object featuring Location header of created schema
Up
delete /schemas/{type}/{key}Deletes the schema matching the given type and key. (schemaDelete)
Path parameters
type (required)
Path Parameter — type for schema to be deleted
key (required)
Path Parameter — name of schema to be deleted
Request headers
Responses
0
no value expected
Up
get /schemas/{type}Returns a list of schemas matching the given query. (schemaList)
Path parameters
type (required)
Path Parameter — actual SchemaTO
Request headers
Query parameters
anyTypeClass (optional)
Query Parameter — query conditions
Return type
array[AbstractSchemaTO]
Example data
Content-Type: application/json
[ {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
} ]Example data
Content-Type: application/xml
<abstractSchema>
<key>string</key>
<anyTypeClass>string</anyTypeClass>
</abstractSchema>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of schemas with matching type, for the given anyTypeClass if provided
Up
get /schemas/{type}/{key}Returns schema matching the given type and key. (schemaRead)
Path parameters
type (required)
Path Parameter — actual SchemaTO
key (required)
Path Parameter — type for schemas to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"anyTypeClass" : "aeiou",
"key" : "aeiou"
}Example data
Content-Type: application/xml
<abstractSchema>
<key>string</key>
<anyTypeClass>string</anyTypeClass>
</abstractSchema>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
schema matching the given type and name AbstractSchemaTO
Up
put /schemas/{type}/{key}Updates the schema matching the given type and key. (schemaUpdate)
Path parameters
type (required)
Path Parameter — type for schemas to be updated
key (required)
Path Parameter — type for schemas to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — updated schema to be stored
Request headers
Responses
0
no value expected_securityQuestions
Up
post /securityQuestionsCreates a new security question. (securityQuestionsCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — security question to be created
Request headers
Responses
0
Response object featuring Location header of created security question
Up
delete /securityQuestions/{key}Deletes the security question matching the provided key. (securityQuestionsDelete)
Path parameters
key (required)
Path Parameter — security question key to be deleted
Request headers
Responses
0
no value expected
Up
get /securityQuestionsReturns a list of all security questions. (securityQuestionsList)
Request headers
Return type
array[SecurityQuestionTO]
Example data
Content-Type: application/json
[ {
"key" : "aeiou",
"content" : "aeiou"
} ]Example data
Content-Type: application/xml
<securityQuestion>
<key>string</key>
<content>string</content>
</securityQuestion>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all security questions
Up
get /securityQuestions/{key}Returns security question with matching key. (securityQuestionsRead)
Path parameters
key (required)
Path Parameter — security question key to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"key" : "aeiou",
"content" : "aeiou"
}Example data
Content-Type: application/xml
<securityQuestion>
<key>string</key>
<content>string</content>
</securityQuestion>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
security question with matching key SecurityQuestionTO
Up
get /securityQuestions/byUser/{username}Ask for security question configured for the user matching the given username, if any. (securityQuestionsReadByUser)
Path parameters
username (required)
Path Parameter — username for which the security question is requested
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request headers
Return type
Example data
Content-Type: application/json
{
"key" : "aeiou",
"content" : "aeiou"
}Example data
Content-Type: application/xml
<securityQuestion>
<key>string</key>
<content>string</content>
</securityQuestion>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
security question, if configured for the user matching the given username SecurityQuestionTO
Up
put /securityQuestions/{key}Updates the security question matching the provided key. (securityQuestionsUpdate)
Path parameters
key (required)
Path Parameter — security question key to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — security question to be stored
Request headers
Responses
0
no value expected_tasks
Up
post /tasks/jobs/{key}Executes an action on an existing executable's job. (tasksActionJob)
Path parameters
key (required)
Path Parameter — executable key
Request headers
Query parameters
action (optional)
Query Parameter — action to execute
Responses
0
no value expected
Up
post /tasks/bulkExecutes the provided bulk action. (tasksBulk)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — list of task ids against which the bulk action will be performed.
Request headers
Return type
Example data
Content-Type: application/json
{
"results" : {
"key" : "aeiou"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
Bulk action result BulkActionResult
Up
post /tasksCreates a new task. (tasksCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — task to be created
Request headers
Responses
0
Response object featuring Location header of created task
Up
delete /tasks/{key}Deletes the task matching the provided key. (tasksDelete)
Path parameters
key (required)
Path Parameter — key of task to be deleted
Request headers
Responses
0
no value expected
Up
delete /tasks/executions/{executionKey}Deletes the executable execution matching the provided key. (tasksDeleteExecution)
Path parameters
executionKey (required)
Path Parameter — key of executable execution to be deleted
Request headers
Responses
0
no value expected
Up
delete /tasks/{key}/executionsDeletes the executions belonging matching the given query. (tasksDeleteExecutions)
Path parameters
key (required)
Path Parameter — query conditions
Request headers
Query parameters
startedBefore (optional)
Query Parameter — format: date-time
startedAfter (optional)
Query Parameter — format: date-time
endedBefore (optional)
Query Parameter — format: date-time
endedAfter (optional)
Query Parameter — format: date-time
Return type
Example data
Content-Type: application/json
{
"results" : {
"key" : "aeiou"
}
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/xmlapplication/json
Responses
200
bulk action result BulkActionResult
Up
post /tasks/{key}/executeExecutes the executable matching the given query. (tasksExecute)
Path parameters
key (required)
Path Parameter — query conditions
Request headers
Query parameters
startAt (optional)
Query Parameter — format: date-time
dryRun (optional)
Query Parameter — default: false
Return type
Example data
Content-Type: application/json
{
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"end" : "2000-01-23T04:56:07.000+00:00",
"refKey" : "aeiou",
"jobType" : "aeiou",
"message" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
}Example data
Content-Type: application/xml
<exec>
<start>2000-01-23T04:56:07.000Z</start>
<end>2000-01-23T04:56:07.000Z</end>
<key>string</key>
<jobType>string</jobType>
<refKey>string</refKey>
<refDesc>string</refDesc>
<status>string</status>
<message>string</message>
</exec>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
execution report for the executable matching the given query ExecTO
Up
get /tasksReturns a paged list of existing tasks matching the given query. (tasksList)
Request headers
Query parameters
page (optional)
Query Parameter — type of taskTO default: 1 format: int32
size (optional)
Query Parameter — query conditions default: 25 format: int32
orderby (optional)
Query Parameter —
type (required)
Query Parameter —
resource (optional)
Query Parameter —
notification (optional)
Query Parameter —
anyTypeKind (optional)
Query Parameter —
entityKey (optional)
Query Parameter —
details (optional)
Query Parameter — default: true
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"result" : [ {
"executions" : [ {
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"end" : "2000-01-23T04:56:07.000+00:00",
"refKey" : "aeiou",
"jobType" : "aeiou",
"message" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ],
"latestExecStatus" : "aeiou",
"start" : "2000-01-23T04:56:07.000+00:00",
"end" : "2000-01-23T04:56:07.000+00:00",
"key" : "aeiou"
} ],
"size" : 123,
"prev" : "aeiou",
"page" : 123,
"totalCount" : 123
}Example data
Content-Type: application/xml
<pagedResult>
<prev>string</prev>
<next>string</next>
<page>0</page>
<size>0</size>
<totalCount>0</totalCount>
<result>
</result>
</pagedResult>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
paged list of existing tasks matching the given query PagedResultAbstractTaskTO
Up
get /tasks/{key}/executionsReturns a paged list of executions matching the given query. (tasksListExecutions)
Path parameters
key (required)
Path Parameter —
Request headers
Query parameters
page (optional)
Query Parameter — query conditions default: 1 format: int32
size (optional)
Query Parameter — default: 25 format: int32
orderby (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"result" : [ {
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"end" : "2000-01-23T04:56:07.000+00:00",
"refKey" : "aeiou",
"jobType" : "aeiou",
"message" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ],
"size" : 123,
"prev" : "aeiou",
"page" : 123,
"totalCount" : 123
}Example data
Content-Type: application/xml
<pagedResult>
<prev>string</prev>
<next>string</next>
<page>0</page>
<size>0</size>
<totalCount>0</totalCount>
<result>
</result>
</pagedResult>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
paged list of executions the given query PagedResultExecTO
Up
get /tasks/jobsList jobs (running and / or scheduled). (tasksListJobs)
Request headers
Return type
array[JobTO]
Example data
Content-Type: application/json
[ {
"running" : true,
"scheduled" : true,
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"refKey" : "aeiou",
"type" : "aeiou"
} ]Example data
Content-Type: application/xml
<job>
<type>string</type>
<refKey>string</refKey>
<refDesc>string</refDesc>
<running>true</running>
<scheduled>true</scheduled>
<start>2000-01-23T04:56:07.000Z</start>
</job>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
jobs (running and / or scheduled)
Up
get /tasks/executions/recentReturns the list of recently completed executions, ordered by end date descendent. (tasksListRecentExecutions)
Request headers
Query parameters
max (optional)
Query Parameter — the maximum number of executions to return default: 25 format: int32
Return type
array[ExecTO]
Example data
Content-Type: application/json
[ {
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"end" : "2000-01-23T04:56:07.000+00:00",
"refKey" : "aeiou",
"jobType" : "aeiou",
"message" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ]Example data
Content-Type: application/xml
<exec>
<start>2000-01-23T04:56:07.000Z</start>
<end>2000-01-23T04:56:07.000Z</end>
<key>string</key>
<jobType>string</jobType>
<refKey>string</refKey>
<refDesc>string</refDesc>
<status>string</status>
<message>string</message>
</exec>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of recently completed executions, ordered by end date descendent
Up
get /tasks/{key}Returns the task matching the given key. (tasksRead)
Path parameters
key (required)
Path Parameter — type of taskTO
Request headers
Query parameters
details (optional)
Query Parameter — key of task to be read default: true
Return type
Example data
Content-Type: application/json
{
"executions" : [ {
"start" : "2000-01-23T04:56:07.000+00:00",
"refDesc" : "aeiou",
"end" : "2000-01-23T04:56:07.000+00:00",
"refKey" : "aeiou",
"jobType" : "aeiou",
"message" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ],
"latestExecStatus" : "aeiou",
"start" : "2000-01-23T04:56:07.000+00:00",
"end" : "2000-01-23T04:56:07.000+00:00",
"key" : "aeiou"
}Example data
Content-Type: application/xml
<abstractTask>
<start>2000-01-23T04:56:07.000Z</start>
<end>2000-01-23T04:56:07.000Z</end>
<key>string</key>
<latestExecStatus>string</latestExecStatus>
<executions>
</executions>
</abstractTask>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
task with matching id AbstractTaskTO
Up
put /tasks/{key}Updates the task matching the provided key. (tasksUpdate)
Path parameters
key (required)
Path Parameter — type of taskTO
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — updated task to be stored
Request headers
Responses
0
no value expected_users
Up
post /users/{key}/associate/{action}Executes resource-related operations on given any object. (usersAssociate)
Path parameters
key (required)
Path Parameter — user key
action (required)
Path Parameter — action
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — external resources to be used for propagation-related operations
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring BulkActionResult as Entity
Up
post /users/bulkExecutes the provided bulk action. (usersBulk)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — list of any object ids against which the bulk action will be performed.
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring BulkActionResult as Entity
Up
post /users (usersCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter —
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected
Up
post /users/{key}/deassociate/{action}Executes resource-related operations on given any object. (usersDeassociate)
Path parameters
key (required)
Path Parameter — user key
action (required)
Path Parameter — action
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — external resources to be used for propagation-related operations
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring BulkActionResult as Entity
Up
delete /users/{key}Deletes any object matching provided key. (usersDelete)
Path parameters
key (required)
Path Parameter — key of any object to be deleted
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring the deleted any object enriched with propagation status information - ProvisioningResult as Entity
Up
patch /users/{key} (usersPatchUpdate)
Path parameters
key (required)
Path Parameter — key of any object to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter —
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected
Up
get /users/{key}Reads the any object matching the provided key. (usersRead)
Path parameters
key (required)
Path Parameter — key of any object to be read
Request headers
Return type
Example data
Content-Type: application/json
{
"creator" : "aeiou",
"auxClasses" : [ "aeiou" ],
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"resources" : [ "aeiou" ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
}Example data
Content-Type: application/xml
<null>
<creator>string</creator>
<creationDate>2000-01-23T04:56:07.000Z</creationDate>
<lastModifier>string</lastModifier>
<lastChangeDate>2000-01-23T04:56:07.000Z</lastChangeDate>
<key>string</key>
<type>string</type>
<realm>string</realm>
<status>string</status>
<auxClasses>
<auxClasses>string</auxClasses>
</auxClasses>
<plainAttrs>
</plainAttrs>
<derAttrs>
</derAttrs>
<virAttrs>
</virAttrs>
<resources>
<resources>string</resources>
</resources>
</null>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
any object with matching key AnyTO
Up
delete /users/{key}/{schemaType}/{schema}Deletes the attribute, owned by the given any object, for the given schema type and schema. (usersSchemaDelete)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
schema (required)
Path Parameter — schema
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected
Up
get /users/{key}/{schemaType}/{schema}Reads the attribute, owned by the given any object, for the given schema type and schema. (usersSchemaRead)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
schema (required)
Path Parameter — schema
Request headers
Return type
Example data
Content-Type: application/json
{
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
}Example data
Content-Type: application/xml
<attribute>
<schema>string</schema>
<values>
<values>string</values>
</values>
</attribute>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
attribute, owned by the given any object, for the given schema type and schema AttrTO
Up
get /users/{key}/{schemaType}Reads the list of attributes owned by the given any object for the given schema type. (usersSchemaTypeRead)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
Request headers
Return type
array[AttrTO]
Example data
Content-Type: application/json
[ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ]Example data
Content-Type: application/xml
<attribute>
<schema>string</schema>
<values>
<values>string</values>
</values>
</attribute>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of attributes, owned by the given any object, for the given schema type
Up
put /users/{key}/{schemaType}/{schema}Adds or replaces the attribute, owned by the given any object, for the given schema type and schema. (usersSchemaUpdate)
Path parameters
key (required)
Path Parameter — any object key
schemaType (required)
Path Parameter — schema type
schema (required)
Path Parameter — schema
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — attribute
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring the updated any object attribute - as Entity
Up
get /usersReturns a paged list of any objects matching the given query. (usersSearch)
Request headers
Query parameters
page (optional)
Query Parameter — query conditions default: 1 format: int32
size (optional)
Query Parameter — default: 25 format: int32
orderby (optional)
Query Parameter —
realm (optional)
Query Parameter — default: /
details (optional)
Query Parameter — default: true
fiql (optional)
Query Parameter —
Return type
Example data
Content-Type: application/json
{
"next" : "aeiou",
"result" : [ {
"creator" : "aeiou",
"auxClasses" : [ "aeiou" ],
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"resources" : [ "aeiou" ],
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"key" : "aeiou",
"status" : "aeiou"
} ],
"size" : 123,
"prev" : "aeiou",
"page" : 123,
"totalCount" : 123
}Example data
Content-Type: application/xml
<pagedResult>
<prev>string</prev>
<next>string</next>
<page>0</page>
<size>0</size>
<totalCount>0</totalCount>
<result>
</result>
</pagedResult>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
paged list of any objects matching the given query PagedResultAnyTO
Up
post /users/{key}/statusPerforms a status update on given. (usersStatus)
Path parameters
key (required)
Path Parameter — user key
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — status update details
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring the updated user enriched with propagation status information - ProvisioningResult as Entity
Up
put /users/{key} (usersUpdate)
Path parameters
key (required)
Path Parameter — key of any object to be updated
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter —
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
no value expected_users_self
Up
post /users/self/changePasswordChanges own password. (usersSelfChangePassword)
Request headers
Query parameters
password (required)
Query Parameter — the password value to update
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring the updated user - ProvisioningResult as Entity
Up
post /users/self/confirmPasswordResetReset the password value for the user matching the provided token, if available and still valid.
If the token actually matches one of users, and if it is still valid at the time of submission, the matching
user's password value is set as provided. The new password value will need anyway to comply with all relevant
password policies. (usersSelfConfirmPasswordReset)
Request body
body (optional)
Body Parameter — new password to be set
Request headers
Query parameters
token (required)
Query Parameter — password reset token
Responses
0
no value expected
Up
post /users/selfSelf-registration for new user. (usersSelfCreate)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — user to be created
Request headers
Query parameters
storePassword (optional)
Query Parameter — whether password shall be stored internally default: true
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring Location header of self-registered user as well as the user itself - ProvisioningResult as Entity
Up
delete /users/selfSelf-deletes user. (usersSelfDelete)
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring the deleted user - ProvisioningResult as Entity
Up
patch /users/self/{key}Self-updates user. (usersSelfPatchUpdate)
Path parameters
key (required)
Path Parameter — user key
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — modification to be applied to self
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring the updated user - ProvisioningResult as Entity
Up
get /users/selfReturns the user making the service call. (usersSelfRead)
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
calling user data, including owned entitlements as header value
Up
post /users/self/requestPasswordResetProvides answer for the security question configured for user matching the given username, if any.
If provided answer matches the one stored for that user, a password reset token is internally generated,
otherwise an error is returned. (usersSelfRequestPasswordReset)
Request body
body (optional)
Body Parameter — actual answer text
Request headers
Query parameters
username (required)
Query Parameter — username for which the security answer is provided
Responses
0
no value expected
Up
put /users/self/{key}Self-updates user. (usersSelfUpdate)
Path parameters
key (required)
Path Parameter — user key
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — modification to be applied to self
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
Response object featuring the updated user - ProvisioningResult as Entity_userworkflow
Up
get /userworkflow/formsReturns a list of all available workflow forms. (guserworkflowSetForms)
Request headers
Return type
array[WorkflowFormTO]
Example data
Content-Type: application/json
[ {
"owner" : "aeiou",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"workflowFormProperties" : [ {
"readable" : true,
"datePattern" : "aeiou",
"name" : "aeiou",
"id" : "aeiou",
"type" : "aeiou",
"value" : "aeiou",
"required" : true,
"writable" : true,
"enumValues" : {
"key" : "aeiou"
}
} ],
"taskId" : "aeiou",
"key" : "aeiou",
"username" : "aeiou"
} ]Example data
Content-Type: application/xml
<workflowForm>
<username>string</username>
<taskId>string</taskId>
<key>string</key>
<createTime>2000-01-23T04:56:07.000Z</createTime>
<dueDate>2000-01-23T04:56:07.000Z</dueDate>
<owner>string</owner>
<workflowFormProperties>
</workflowFormProperties>
</workflowForm>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of all available workflow forms
Up
post /userworkflow/forms/{taskId}/claimClaims the form for the given task id. (userworkflowClaimForm)
Path parameters
taskId (required)
Path Parameter — workflow task id
Request headers
Return type
Example data
Content-Type: application/json
{
"owner" : "aeiou",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"workflowFormProperties" : [ {
"readable" : true,
"datePattern" : "aeiou",
"name" : "aeiou",
"id" : "aeiou",
"type" : "aeiou",
"value" : "aeiou",
"required" : true,
"writable" : true,
"enumValues" : {
"key" : "aeiou"
}
} ],
"taskId" : "aeiou",
"key" : "aeiou",
"username" : "aeiou"
}Example data
Content-Type: application/xml
<workflowForm>
<username>string</username>
<taskId>string</taskId>
<key>string</key>
<createTime>2000-01-23T04:56:07.000Z</createTime>
<dueDate>2000-01-23T04:56:07.000Z</dueDate>
<owner>string</owner>
<workflowFormProperties>
</workflowFormProperties>
</workflowForm>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
the workflow form for the given task id WorkflowFormTO
Up
post /userworkflow/tasks/{taskId}/executeExecutes workflow task for matching id. (userworkflowExecuteTask)
Path parameters
taskId (required)
Path Parameter — workflow task id
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — argument to be passed to workflow task
Request headers
Return type
Example data
Content-Type: application/json
{
"auxClasses" : [ "aeiou" ],
"securityAnswer" : "aeiou",
"roles" : [ "aeiou" ],
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"lastLoginDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"memberships" : [ {
"groupName" : "aeiou",
"rightKey" : "aeiou",
"plainAttrs" : [ "" ],
"virAttrs" : [ "" ],
"type" : "aeiou",
"derAttrs" : [ "" ],
"rightType" : "aeiou"
} ],
"relationships" : [ {
"rightKey" : "aeiou",
"type" : "aeiou",
"rightType" : "aeiou"
} ],
"password" : "aeiou",
"dynGroups" : [ "aeiou" ],
"key" : "aeiou",
"creator" : "aeiou",
"tokenExpireTime" : "2000-01-23T04:56:07.000+00:00",
"securityQuestion" : "aeiou",
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"mustChangePassword" : true,
"resources" : [ "aeiou" ],
"changePwdDate" : "2000-01-23T04:56:07.000+00:00",
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"token" : "aeiou",
"dynRoles" : [ "aeiou" ],
"failedLogins" : 123,
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"status" : "aeiou",
"username" : "aeiou"
}Example data
Content-Type: application/xml
<user>
<creator>string</creator>
<creationDate>2000-01-23T04:56:07.000Z</creationDate>
<lastModifier>string</lastModifier>
<lastChangeDate>2000-01-23T04:56:07.000Z</lastChangeDate>
<key>string</key>
<type>string</type>
<realm>string</realm>
<status>string</status>
<password>string</password>
<token>string</token>
<tokenExpireTime>2000-01-23T04:56:07.000Z</tokenExpireTime>
<username>string</username>
<lastLoginDate>2000-01-23T04:56:07.000Z</lastLoginDate>
<changePwdDate>2000-01-23T04:56:07.000Z</changePwdDate>
<failedLogins>0</failedLogins>
<securityQuestion>string</securityQuestion>
<securityAnswer>string</securityAnswer>
<mustChangePassword>true</mustChangePassword>
<auxClasses>
<auxClasses>string</auxClasses>
</auxClasses>
<plainAttrs>
</plainAttrs>
<derAttrs>
</derAttrs>
<virAttrs>
</virAttrs>
<resources>
<resources>string</resources>
</resources>
<roles>
<roles>string</roles>
</roles>
<dynRoles>
<dynRoles>string</dynRoles>
</dynRoles>
<relationships>
</relationships>
<memberships>
</memberships>
<dynGroups>
<dynGroups>string</dynGroups>
</dynGroups>
</user>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
updated user UserTO
Up
get /userworkflow/forms/{userKey}Returns a list of available forms for the given user key. (userworkflowGetFormForUser)
Path parameters
userKey (required)
Path Parameter — user key
Request headers
Return type
Example data
Content-Type: application/json
{
"owner" : "aeiou",
"createTime" : "2000-01-23T04:56:07.000+00:00",
"dueDate" : "2000-01-23T04:56:07.000+00:00",
"workflowFormProperties" : [ {
"readable" : true,
"datePattern" : "aeiou",
"name" : "aeiou",
"id" : "aeiou",
"type" : "aeiou",
"value" : "aeiou",
"required" : true,
"writable" : true,
"enumValues" : {
"key" : "aeiou"
}
} ],
"taskId" : "aeiou",
"key" : "aeiou",
"username" : "aeiou"
}Example data
Content-Type: application/xml
<workflowForm>
<username>string</username>
<taskId>string</taskId>
<key>string</key>
<createTime>2000-01-23T04:56:07.000Z</createTime>
<dueDate>2000-01-23T04:56:07.000Z</dueDate>
<owner>string</owner>
<workflowFormProperties>
</workflowFormProperties>
</workflowForm>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
list of available forms for the given user key WorkflowFormTO
Up
post /userworkflow/formsSubmits a workflow form. (userworkflowSubmitForm)
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — workflow form.
Request headers
Return type
Example data
Content-Type: application/json
{
"auxClasses" : [ "aeiou" ],
"securityAnswer" : "aeiou",
"roles" : [ "aeiou" ],
"virAttrs" : [ "" ],
"lastModifier" : "aeiou",
"lastLoginDate" : "2000-01-23T04:56:07.000+00:00",
"type" : "aeiou",
"derAttrs" : [ "" ],
"memberships" : [ {
"groupName" : "aeiou",
"rightKey" : "aeiou",
"plainAttrs" : [ "" ],
"virAttrs" : [ "" ],
"type" : "aeiou",
"derAttrs" : [ "" ],
"rightType" : "aeiou"
} ],
"relationships" : [ {
"rightKey" : "aeiou",
"type" : "aeiou",
"rightType" : "aeiou"
} ],
"password" : "aeiou",
"dynGroups" : [ "aeiou" ],
"key" : "aeiou",
"creator" : "aeiou",
"tokenExpireTime" : "2000-01-23T04:56:07.000+00:00",
"securityQuestion" : "aeiou",
"lastChangeDate" : "2000-01-23T04:56:07.000+00:00",
"mustChangePassword" : true,
"resources" : [ "aeiou" ],
"changePwdDate" : "2000-01-23T04:56:07.000+00:00",
"creationDate" : "2000-01-23T04:56:07.000+00:00",
"token" : "aeiou",
"dynRoles" : [ "aeiou" ],
"failedLogins" : 123,
"plainAttrs" : [ {
"schema" : "aeiou",
"schemaInfo" : {
"anyTypeClass" : "aeiou",
"key" : "aeiou"
},
"values" : [ "aeiou" ]
} ],
"realm" : "aeiou",
"status" : "aeiou",
"username" : "aeiou"
}Example data
Content-Type: application/xml
<user>
<creator>string</creator>
<creationDate>2000-01-23T04:56:07.000Z</creationDate>
<lastModifier>string</lastModifier>
<lastChangeDate>2000-01-23T04:56:07.000Z</lastChangeDate>
<key>string</key>
<type>string</type>
<realm>string</realm>
<status>string</status>
<password>string</password>
<token>string</token>
<tokenExpireTime>2000-01-23T04:56:07.000Z</tokenExpireTime>
<username>string</username>
<lastLoginDate>2000-01-23T04:56:07.000Z</lastLoginDate>
<changePwdDate>2000-01-23T04:56:07.000Z</changePwdDate>
<failedLogins>0</failedLogins>
<securityQuestion>string</securityQuestion>
<securityAnswer>string</securityAnswer>
<mustChangePassword>true</mustChangePassword>
<auxClasses>
<auxClasses>string</auxClasses>
</auxClasses>
<plainAttrs>
</plainAttrs>
<derAttrs>
</derAttrs>
<virAttrs>
</virAttrs>
<resources>
<resources>string</resources>
</resources>
<roles>
<roles>string</roles>
</roles>
<dynRoles>
<dynRoles>string</dynRoles>
</dynRoles>
<relationships>
</relationships>
<memberships>
</memberships>
<dynGroups>
<dynGroups>string</dynGroups>
</dynGroups>
</user>Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
200
updated user UserTO_workflows_anyTypeKind
Up
get /workflows/{anyTypeKind}Exports workflow definition for matching kind. (userworkflowExportDefinition)
Path parameters
anyTypeKind (required)
Path Parameter — any object type
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/jsonapplication/xml
Responses
0
workflow definition for matching kind
Up
get /workflows/{anyTypeKind}/diagram.pngExports workflow diagram representation. (userworkflowExportDiagram)
Path parameters
anyTypeKind (required)
Path Parameter — any object type
Request headers
Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.image/png
Responses
0
workflow diagram representation
Up
put /workflows/{anyTypeKind}Imports workflow definition for matching kind. (userworkflowImportDefinition)
Path parameters
anyTypeKind (required)
Path Parameter — any object type
Consumes
This API call consumes the following media types via the Content-Type request header:application/jsonapplication/xml
Request body
body (optional)
Body Parameter — workflow definition for matching kind
Request headers
Responses
0
no value expectedModels
[ Jump to Methods ]Table of Contents
AVGCoordinationDelegateTOAVGOperationDataTOAVGServiceTOAbstractPolicyTOAbstractReportletConfAbstractSchemaTOAbstractTaskTOAnyObjectTOAnyPatchAnyTOAnyTypeClassTOAnyTypeTOAssociationPatchAttrPatchAttrTOBooleanReplacePatchItemBulkActionBulkActionResultChoreographyInstanceTOChoreographyTOConnBundleTOConnConfPropSchemaConnConfPropertyConnIdObjectClassTOConnInstanceTOConnObjectTOConnPoolConfTOCoordinationDelegateTODeassociationPatchDomainTOEventCategoryTOEventDataTOExecTOGroupTOInputStreamJobTOLoadInstantLoggerTOMailTemplateTOMappingItemTOMappingTOMembershipPatchMembershipTONotificationTONumbersInfoOperationDataTOOrgUnitTOPagedConnObjectTOResultPagedResultAbstractTaskTOPagedResultAnyTOPagedResultExecTOPasswordPatchPlatformInfoProvisionTORealmTORelationshipPatchRelationshipTORelationshipTypeTOReportTOReportTemplateTOResourceDeassociationPatchResourceTORoleTOSchedTaskTOSecurityFilterInfoSecurityQuestionTOServiceTOStatusPatchStringPatchItemStringReplacePatchItemSystemInfoTypeExtensionTOUserPatchUserTOVirtualMachineInfoTOWorkflowFormPropertyTOWorkflowFormTO
AVGCoordinationDelegateTO - Up
name (optional)
maxExecutedOperations (optional)
Integer format: int32
minExecutedOperations (optional)
Integer format: int32
maxCoordinationMessages (optional)
Integer format: int32
minCoordinationMessages (optional)
Integer format: int32
serviceExecutionTime (optional)
Double format: double
networkOverheadForBusinessMessagesExchangeTime (optional)
Double format: double
coordinationAlgorithmReasoningTime (optional)
Double format: double
networkOverheadForCoordinationMessagesExchangeTime (optional)
Double format: double
waitTimeForSchedulingOperation (optional)
Double format: double
waitTimeForSynchronizing (optional)
Double format: double
choreographyId (optional)
AVGOperationDataTO - Up
name (optional)
serviceExecutionTime (optional)
Double format: double
serviceWaitTimeForResponse (optional)
Double format: double
networkOverheadForBusinessMessagesExchangeTime (optional)
Double format: double
coordinationAlgorithmReasoningTime (optional)
Double format: double
networkOverheadForCoordinationMessagesExchangeTime (optional)
Double format: double
waitTimeForSchedulingOperation (optional)
Double format: double
waitTimeForSynchronizing (optional)
Double format: double
minMessageNumber (optional)
Integer format: int32
maxMessageNumber (optional)
Integer format: int32
AbstractPolicyTO - Up
key (optional)
description (optional)
usedByResources (optional)
usedByRealms (optional)
AbstractReportletConf - Up
name (optional)
AbstractTaskTO - Up
AnyObjectTO - Up
creator (optional)
creationDate (optional)
Date format: date-time
lastModifier (optional)
lastChangeDate (optional)
Date format: date-time
key (optional)
type (optional)
realm (optional)
status (optional)
name (optional)
auxClasses (optional)
plainAttrs (optional)
derAttrs (optional)
virAttrs (optional)
resources (optional)
relationships (optional)
memberships (optional)
dynGroups (optional)
AnyPatch - Up
key (optional)
realm (optional)
auxClasses (optional)
plainAttrs (optional)
virAttrs (optional)
resources (optional)
AnyTO - Up
creator (optional)
creationDate (optional)
Date format: date-time
lastModifier (optional)
lastChangeDate (optional)
Date format: date-time
key (optional)
type (optional)
realm (optional)
status (optional)
auxClasses (optional)
plainAttrs (optional)
derAttrs (optional)
virAttrs (optional)
resources (optional)
AnyTypeClassTO - Up
key (optional)
plainSchemas (optional)
derSchemas (optional)
virSchemas (optional)
inUseByTypes (optional)
AnyTypeTO - Up
key (optional)
kind (optional)
Enum:
USER
GROUP
ANY_OBJECT
classes (optional)
BulkAction - Up
type (optional)
Enum:
MUSTCHANGEPASSWORD
DELETE
REACTIVATE
SUSPEND
DRYRUN
EXECUTE
targets (optional)
ChoreographyTO - Up
id (optional)
groupKey (optional)
name (optional)
description (optional)
diagram (optional)
messages (optional)
image (optional)
ConnIdObjectClassTO - Up
type (optional)
container (optional)
auxiliary (optional)
attributes (optional)
ConnInstanceTO - Up
key (optional)
location (optional)
connectorName (optional)
bundleName (optional)
version (optional)
displayName (optional)
connRequestTimeout (optional)
Integer format: int32
poolConf (optional)
conf (optional)
capabilities (optional)
Enum:
ConnObjectTO - Up
attrs (optional)
CoordinationDelegateTO - Up
name (optional)
executedOperations (optional)
Integer format: int32
coordinationMessages (optional)
Integer format: int32
serviceExecutionTime (optional)
Long format: int64
networkOverheadForBusinessMessagesExchangeTime (optional)
Long format: int64
coordinationAlgorithmReasoningTime (optional)
Long format: int64
networkOverheadForCoordinationMessagesExchangeTime (optional)
Long format: int64
waitTimeForSchedulingOperation (optional)
Long format: int64
waitTimeForSynchronizing (optional)
Long format: int64
instanceId (optional)
DeassociationPatch - Up
key (optional)
action (optional)
Enum:
UNLINK
DEPROVISION
UNASSIGN
resources (optional)
EventCategoryTO - Up
type (optional)
Enum:
LOGIC
TASK
PROPAGATION
PULL
PUSH
CUSTOM
category (optional)
subcategory (optional)
events (optional)
EventDataTO - Up
choreographyName (optional)
choreographyInstanceId (optional)
artifactType (optional)
Enum:
CD
SERVICE
artifactRole (optional)
artifactName (optional)
sourceState (optional)
targetState (optional)
operation (optional)
eventType (optional)
Enum:
SENDING_REQUEST
RECEIVING_REQUEST
FORWARDING_REQUEST
REPLY_RESPONSE
RECEIVING_RESPONSE
FORWARDING_RESPONSE
SEND_UPDATE_BEFORE
SEND_UPDATE_AFTER
SEND_NOTIFY_BEFORE
SEND_NOTIFY_AFTER
WAIT_UPDATE_STATE_BEFORE
WAIT_UPDATE_STATE_AFTER
WAIT_ALL_NOTIFY_BEFORE
WAIT_ALL_NOTIFY_AFTER
targetArtifactName (optional)
eventTimestamp (optional)
Long format: int64
GroupTO - Up
creator (optional)
creationDate (optional)
Date format: date-time
lastModifier (optional)
lastChangeDate (optional)
Date format: date-time
key (optional)
type (optional)
realm (optional)
status (optional)
name (optional)
userOwner (optional)
groupOwner (optional)
udynMembershipCond (optional)
adynMembershipConds (optional)
auxClasses (optional)
plainAttrs (optional)
derAttrs (optional)
virAttrs (optional)
resources (optional)
typeExtensions (optional)
MailTemplateTO - Up
key (optional)
MappingItemTO - Up
key (optional)
intAttrName (optional)
extAttrName (optional)
connObjectKey (optional)
password (optional)
mandatoryCondition (optional)
purpose (optional)
Enum:
BOTH
PULL
PROPAGATION
NONE
propagationJEXLTransformer (optional)
pullJEXLTransformer (optional)
mappingItemTransformerClassNames (optional)
MappingTO - Up
connObjectLink (optional)
connObjectKeyItem (optional)
items (optional)
linkingItems (optional)
MembershipPatch - Up
operation (optional)
Enum:
ADD_REPLACE
DELETE
group (optional)
plainAttrs (optional)
virAttrs (optional)
MembershipTO - Up
type (optional)
rightType (optional)
rightKey (optional)
groupName (optional)
plainAttrs (optional)
derAttrs (optional)
virAttrs (optional)
NotificationTO - Up
key (optional)
abouts (optional)
recipientsFIQL (optional)
recipientAttrName (optional)
selfAsRecipient (optional)
recipientsProviderClassName (optional)
sender (optional)
subject (optional)
template (optional)
traceLevel (optional)
Enum:
NONE
FAILURES
SUMMARY
ALL
active (optional)
events (optional)
staticRecipients (optional)
NumbersInfo - Up
totalUsers (optional)
Integer format: int32
usersByRealm (optional)
usersByStatus (optional)
totalGroups (optional)
Integer format: int32
groupsByRealm (optional)
anyType1 (optional)
totalAny1 (optional)
Integer format: int32
any1ByRealm (optional)
anyType2 (optional)
totalAny2 (optional)
Integer format: int32
any2ByRealm (optional)
totalResources (optional)
Integer format: int32
totalRoles (optional)
Integer format: int32
confCompleteness (optional)
OperationDataTO - Up
name (optional)
serviceExecutionTime (optional)
Long format: int64
serviceWaitTimeForResponse (optional)
Long format: int64
networkOverheadForBusinessMessagesExchangeTime (optional)
Long format: int64
coordinationAlgorithmReasoningTime (optional)
Long format: int64
networkOverheadForCoordinationMessagesExchangeTime (optional)
Long format: int64
waitTimeForSchedulingOperation (optional)
Long format: int64
waitTimeForSynchronizing (optional)
Long format: int64
messageNumber (optional)
Integer format: int32
PagedConnObjectTOResult - Up
PasswordPatch - Up
operation (optional)
Enum:
ADD_REPLACE
DELETE
value (optional)
onSyncope (optional)
resources (optional)
PlatformInfo - Up
version (optional)
selfRegAllowed (optional)
pwdResetAllowed (optional)
pwdResetRequiringSecurityQuestions (optional)
anyObjectWorkflowAdapter (optional)
userWorkflowAdapter (optional)
groupWorkflowAdapter (optional)
anyObjectProvisioningManager (optional)
userProvisioningManager (optional)
groupProvisioningManager (optional)
virAttrCache (optional)
passwordGenerator (optional)
connIdLocations (optional)
entitlements (optional)
reportletConfs (optional)
accountRules (optional)
passwordRules (optional)
mappingItemTransformers (optional)
taskJobs (optional)
reconciliationFilterBuilders (optional)
logicActions (optional)
propagationActions (optional)
pullActions (optional)
pushActions (optional)
pullCorrelationRules (optional)
pushCorrelationRules (optional)
validators (optional)
notificationRecipientsProviders (optional)
ProvisionTO - Up
key (optional)
anyType (optional)
objectClass (optional)
syncToken (optional)
mapping (optional)
auxClasses (optional)
virSchemas (optional)
RealmTO - Up
key (optional)
name (optional)
parent (optional)
fullPath (optional)
accountPolicy (optional)
passwordPolicy (optional)
templates (optional)
actionsClassNames (optional)
resources (optional)
ReportTO - Up
start (optional)
Date format: date-time
end (optional)
Date format: date-time
key (optional)
name (optional)
cronExpression (optional)
latestExecStatus (optional)
lastExec (optional)
Date format: date-time
nextExec (optional)
Date format: date-time
active (optional)
template (optional)
reportletConfs (optional)
executions (optional)
ReportTemplateTO - Up
key (optional)
ResourceDeassociationPatch - Up
key (optional)
anyTypeKey (optional)
action (optional)
Enum:
UNLINK
DEPROVISION
UNASSIGN
anyKyes (optional)
ResourceTO - Up
key (optional)
connector (optional)
connectorDisplayName (optional)
orgUnit (optional)
propagationPriority (optional)
Integer format: int32
randomPwdIfNotProvided (optional)
enforceMandatoryCondition (optional)
createTraceLevel (optional)
Enum:
NONE
FAILURES
SUMMARY
ALL
updateTraceLevel (optional)
Enum:
NONE
FAILURES
SUMMARY
ALL
deleteTraceLevel (optional)
Enum:
NONE
FAILURES
SUMMARY
ALL
provisioningTraceLevel (optional)
Enum:
NONE
FAILURES
SUMMARY
ALL
passwordPolicy (optional)
accountPolicy (optional)
pullPolicy (optional)
overrideCapabilities (optional)
provisions (optional)
confOverride (optional)
capabilitiesOverride (optional)
Enum:
propagationActionsClassNames (optional)
SchedTaskTO - Up
start (optional)
Date format: date-time
end (optional)
Date format: date-time
key (optional)
latestExecStatus (optional)
startAt (optional)
Date format: date-time
cronExpression (optional)
jobDelegateClassName (optional)
name (optional)
description (optional)
lastExec (optional)
Date format: date-time
nextExec (optional)
Date format: date-time
active (optional)
executions (optional)
UserPatch - Up
key (optional)
realm (optional)
username (optional)
password (optional)
securityQuestion (optional)
securityAnswer (optional)
mustChangePassword (optional)
auxClasses (optional)
plainAttrs (optional)
virAttrs (optional)
resources (optional)
relationships (optional)
memberships (optional)
roles (optional)
UserTO - Up
creator (optional)
creationDate (optional)
Date format: date-time
lastModifier (optional)
lastChangeDate (optional)
Date format: date-time
key (optional)
type (optional)
realm (optional)
status (optional)
password (optional)
token (optional)
tokenExpireTime (optional)
Date format: date-time
username (optional)
lastLoginDate (optional)
Date format: date-time
changePwdDate (optional)
Date format: date-time
failedLogins (optional)
Integer format: int32
securityQuestion (optional)
securityAnswer (optional)
mustChangePassword (optional)
auxClasses (optional)
plainAttrs (optional)
derAttrs (optional)
virAttrs (optional)
resources (optional)
roles (optional)
dynRoles (optional)
relationships (optional)
memberships (optional)
dynGroups (optional)