Apache Syncope 2.0.6

Namespaces

PrefixURIXSDWADL
syncope2http://syncope.apache.org/2.0syncope2.xsdsyncope.wadl

REST resources

/

General info about this Apache Syncope deployment.

assignableGroups/{realm:.*}

Parameters
NameDescriptionStyleTypeDefault
realmof the User and Any Objects assignable to the returned Groupstemplatexs:string

Returns the list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm.

Parameters
NameDescriptionStyleTypeDefault
pagesearch pagequeryxs:int1
sizesearch page sizequeryxs:int25

Request

Response

Content typesyncope2:pagedResult
list of Groups, according to provided paging instructions, assignable to Users and Any Objects of the provided Realm
Media typesapplication/json
application/xml

numbers

Provides some numbers about the managed entities (users, groups, any objects...).

Response

Content typesyncope2:numbersInfo
some numbers about the managed entities (users, groups, any objects...)
Media typesapplication/json
application/xml

platform

Provides information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...).

Response

Content typesyncope2:platformInfo
information summary about platform configuration (workflow adapters, provisioning managers, validators, actions, correlation rules, reportlets, ...)
Media typesapplication/json
application/xml

system

Provides information about the underlying system (Operating System, CPU / memory usage, ...).

Response

Content typesyncope2:systemInfo
information about the underlying system (Operating System, CPU / memory usage, ...)
Media typesapplication/json
application/xml

userTypeExtension/{groupName}

Parameters
NameDescriptionStyleTypeDefault
groupNamegroup nametemplatexs:string

Extracts User type extension information, for the provided group.

Response

Content typesyncope2:typeExtension
User type extension information, for the provided group
Media typesapplication/json
application/xml

/accessTokens

REST operations for access tokens.

Returns a paged list of existing access tokens matching the given query.

Parameters
NameDescriptionStyleTypeDefault
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope2:pagedResult
paged list of existing access tokens matching the given query
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyaccess token keytemplatexs:string

Invalidates the access token matching the provided key.

Response

Status204

/login

Returns an empty response bearing the X-Syncope-Token header value, in case of successful authentication. The provided value is a signed JSON Web Token.

Response

Content type
empty response bearing the X-Syncope-Token header value, in case of successful authentication
Media types*/*

/logout

Invalidates the access token of the requesting user.

Response

Status204

/refresh

Returns an empty response bearing the X-Syncope-Token header value, with extended lifetime. The provided value is a signed JSON Web Token.

Response

Content type
an empty response bearing the X-Syncope-Token header value, with extended lifetime
Media types*/*

/anyObjects

REST operations for anyObjects.

Parameters
NameDescriptionStyleTypeDefault
realmquery conditionsmatrixxs:string/

Returns a paged list of any objects matching the given query.

Parameters
NameDescriptionStyleTypeDefault
detailsquery conditionsqueryxs:booleantrue
fiqlquery conditionsqueryxs:string
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope2:pagedResult
paged list of any objects matching the given query
Media typesapplication/json
application/xml

Creates a new any object.

Request

Content typesyncope2:anyTO
any object to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created any object as well as the any object itself enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string

Deletes any object matching provided key.

Response

Content type
Response object featuring the deleted any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

Reads the any object matching the provided key. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope2:anyTO
any object with matching key
Media typesapplication/json
application/xml

Updates any object matching the provided key.

Request

Content typesyncope2:anyPatch
complete update
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

Updates any object matching the provided key.

Request

Content typesyncope2:anyTO
complete update
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/{key}/{schemaType}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL

Reads the any object matching the provided key. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope2:attributes
any object with matching key
Media typesapplication/json
application/xml

/{key}/{schemaType}/{schema}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
schemaschematemplatexs:string

Deletes any object matching provided key.

Response

Status204

Reads the any object matching the provided key. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope2:attribute
any object with matching key
Media typesapplication/json
application/xml

Updates any object matching the provided key.

Request

Content typesyncope2:attribute
attribute
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/{key}/associate/{action}

Executes resource-related operations on given any object.

Request

Content typesyncope2:associationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/xml

Response

Content type
Response object featuring BulkActionResult as Entity
Media typesapplication/json
application/xml

/{key}/deassociate/{action}

Executes resource-related operations on given any object.

Request

Content typesyncope2:deassociationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/xml

Response

Content type
Response object featuring BulkActionResult as Entity
Media typesapplication/json
application/xml

/bulk

Executes the provided bulk action.

Request

Content typesyncope2:bulkAction
list of any object ids against which the bulk action will be performed.
Media typesapplication/json
application/xml

Response

Content type
Response object featuring BulkActionResult as Entity
Media typesapplication/json
application/xml

/anyTypeClasses

REST operations for any type classes.

Returns a list of all anyTypeClasss.

Response

Content typesyncope2:anyTypeClasss
list of all anyTypeClasss.
Media typesapplication/json
application/xml

Creates a new anyTypeClass.

Request

Content typesyncope2:anyTypeClass
anyTypeClass to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created anyTypeClass
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyanyTypeClass key to be deletedtemplatexs:string

Deletes the anyTypeClass matching the provided key.

Response

Status204

Returns anyTypeClass with matching key.

Response

Content typesyncope2:anyTypeClass
anyTypeClass with matching key
Media typesapplication/json
application/xml

Updates the anyTypeClass matching the provided key.

Request

Content typesyncope2:anyTypeClass
anyTypeClass to be stored
Media typesapplication/json
application/xml

Response

Status204

/anyTypes

REST operations for any types.

Returns a list of all anyTypes.

Response

Content typesyncope2:anyTypes
list of all anyTypes.
Media typesapplication/json
application/xml

Creates a new anyType.

Request

Content typesyncope2:anyType
anyType to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created anyType
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyanyType key to be deletedtemplatexs:string

Deletes the anyType matching the provided key.

Response

Status204

Returns anyType with matching key.

Response

Content typesyncope2:anyType
anyType with matching key
Media typesapplication/json
application/xml

Updates the anyType matching the provided key.

Request

Content typesyncope2:anyType
anyType to be stored
Media typesapplication/json
application/xml

Response

Status204

/configurations

REST operations for configuration.

Returns all configuration parameters.

Response

Content typesyncope2:attributes
all configuration parameters
Media typesapplication/json
application/xml

/{schema}

Parameters
NameDescriptionStyleTypeDefault
schemaconfiguration parameter schematemplatexs:string

Deletes the configuration parameter with matching schema.

Response

Status204

Returns configuration parameter with matching schema.

Response

Content typesyncope2:attribute
configuration parameter with matching schema
Media typesapplication/json
application/xml

Creates / updates the configuration parameter with the given schema.

Request

Content typesyncope2:attribute
parameter value
Media typesapplication/json
application/xml

Response

Status204

/stream

Exports internal storage content as downloadable XML file.

Response

Content type
internal storage content as downloadable XML file
Media types*/*

/connectors

REST operations for connector bundles and instances.

Returns a list of all connector instances with property keys in the matching language.

Parameters
NameDescriptionStyleTypeDefault
langlanguage 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.queryxs:string

Request

Response

Content typesyncope2:connInstances
list of all connector instances with property keys in the matching language
Media typesapplication/json
application/xml

Creates a new connector instance.

Request

Content typesyncope2:connInstance
connector instance to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created connector instance
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyconnector instance key to be deletedtemplatexs:string

Deletes the connector instance matching the provided key.

Response

Status204

Returns connector instance with matching key.

Parameters
NameDescriptionStyleTypeDefault
langlanguage 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.queryxs:string

Request

Response

Content typesyncope2:connInstance
connector instance with matching key
Media typesapplication/json
application/xml

Updates the connector instance matching the provided key.

Request

Content typesyncope2:connInstance
connector instance to be stored
Media typesapplication/json
application/xml

Response

Status204

/{key}/supportedObjectClasses

Builds the list of ConnId object classes information for the connector bundle matching the given connector instance key, with the provided configuration.

Parameters
NameDescriptionStyleTypeDefault
includeSpecialif set to true, special schema names (like '__PASSWORD__') will be included; default is falsequeryxs:booleanfalse

Request

Content typesyncope2:connInstance
connector instance object providing configuration properties
Media typesapplication/json
application/xml

Response

Content typesyncope2:connIdObjectClasss
supported object classes info for the connector bundle matching the given connector instance key, with the provided configuration
Media typesapplication/json
application/xml

/bundles

Returns available connector bundles with property keys in selected language.

Parameters
NameDescriptionStyleTypeDefault
langlanguage to select property keys; default language is Englishqueryxs:string

Request

Response

Content typesyncope2:connectorBundles
available connector bundles with property keys in selected language
Media typesapplication/json
application/xml

/byResource/{resourceName}

Parameters
NameDescriptionStyleTypeDefault
resourceNameresource name to be used for connector lookuptemplatexs:string

Returns connector instance for matching resource.

Parameters
NameDescriptionStyleTypeDefault
langlanguage 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.queryxs:string

Request

Response

Content typesyncope2:connInstance
connector instance for matching resource
Media typesapplication/json
application/xml

/check

Checks whether the connection to resource could be established.

Request

Content typesyncope2:connInstance
connector instance to be used for connection check
Media typesapplication/json
application/xml

Response

Status204

/reload

Reload all connector bundles and instances.

Response

Status204

/connectorsHistory

REST operations for connector configuration versioning.

/{connectorKey}

Parameters
NameDescriptionStyleTypeDefault
connectorKeyconnector instance keytemplatexs:string

Returns a list of all connector configuration history instances for the given connector instance key.

Response

Content typesyncope2:connInstanceHistoryConfs
list of all connector configuration history instances for the given connector instance key
Media typesapplication/json
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyconnector configuration history instance key to be deletedtemplatexs:string

Deletes the connector configuration history instance matching the provided key.

Response

Status204

Restores the connector configuration history instance matching the provided key.

Response

Status204

/domains

REST operations for domains.

Returns a list of all domains.

Response

Content typesyncope2:domains
list of all domains.
Media typesapplication/json
application/xml

Creates a new domain.

Request

Content typesyncope2:domain
domain to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created domain
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keydomain key to be deletedtemplatexs:string

Deletes the domain matching the provided key.

Response

Status204

Returns domain with matching key.

Response

Content typesyncope2:domain
domain with matching key
Media typesapplication/json
application/xml

Updates the domain matching the provided key.

Request

Content typesyncope2:domain
domain to be stored
Media typesapplication/json
application/xml

Response

Status204

/dynRealms

REST operations for dynamic realms.

Returns a list of all dynamic realms.

Response

Content typesyncope2:dynRealms
list of all dynamic realms.
Media typesapplication/json
application/xml

Creates a new dynamic realm.

Request

Content typesyncope2:dynRealm
dynamic realm to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created dynamic realm
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keydynamic realm key to be deletedtemplatexs:string

Deletes the dynamic realm matching the provided key.

Response

Status204

Returns dynamic realm with matching key.

Response

Content typesyncope2:dynRealm
dynamic realm with matching key
Media typesapplication/json
application/xml

Updates the dynamic realm matching the provided key.

Request

Content typesyncope2:dynRealm
dynamic realm to be stored
Media typesapplication/json
application/xml

Response

Status204

/groups

REST operations for groups.

Parameters
NameDescriptionStyleTypeDefault
realmquery conditionsmatrixxs:string/

Returns a paged list of any objects matching the given query.

Parameters
NameDescriptionStyleTypeDefault
detailsquery conditionsqueryxs:booleantrue
fiqlquery conditionsqueryxs:string
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope2:pagedResult
paged list of any objects matching the given query
Media typesapplication/json
application/xml

Creates a new any object.

Request

Content typesyncope2:anyTO
any object to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created any object as well as the any object itself enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string

Deletes any object matching provided key.

Response

Content type
Response object featuring the deleted any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

Reads the any object matching the provided key. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope2:anyTO
any object with matching key
Media typesapplication/json
application/xml

Updates any object matching the provided key.

Request

Content typesyncope2:anyPatch
complete update
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

Updates any object matching the provided key.

Request

Content typesyncope2:anyTO
complete update
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/{key}/{schemaType}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL

Reads the any object matching the provided key. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope2:attributes
any object with matching key
Media typesapplication/json
application/xml

/{key}/{schemaType}/{schema}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
schemaschematemplatexs:string

Deletes any object matching provided key.

Response

Status204

Reads the any object matching the provided key. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope2:attribute
any object with matching key
Media typesapplication/json
application/xml

Updates any object matching the provided key.

Request

Content typesyncope2:attribute
attribute
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/{key}/associate/{action}

Executes resource-related operations on given any object.

Request

Content typesyncope2:associationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/xml

Response

Content type
Response object featuring BulkActionResult as Entity
Media typesapplication/json
application/xml

/{key}/deassociate/{action}

Executes resource-related operations on given any object.

Request

Content typesyncope2:deassociationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/xml

Response

Content type
Response object featuring BulkActionResult as Entity
Media typesapplication/json
application/xml

/{key}/members/{actionType}

Parameters
NameDescriptionStyleTypeDefault
keygroup keytemplatexs:string
actionTypetemplatexs:string
  • PROVISION
  • DEPROVISION

(De)provision all members of the given group from / onto all the resources associated to it.

Response

Content typesyncope2:exec
execution report for the task generated on purpose
Media types*/*

/bulk

Executes the provided bulk action.

Request

Content typesyncope2:bulkAction
list of any object ids against which the bulk action will be performed.
Media typesapplication/json
application/xml

Response

Content type
Response object featuring BulkActionResult as Entity
Media typesapplication/json
application/xml

/own

This method is similar to read() but uses different authentication handling to ensure that a user can read his own groups.

Response

Content typesyncope2:groups
own groups
Media typesapplication/json
application/xml

/loggers

REST operations for logging and auditing.

/{type}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • LOG
  • AUDIT

Returns a list of loggers with matching type.

Response

Content typesyncope2:loggers
list of loggers with matching type
Media typesapplication/json
application/xml

/{type}/{key}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • LOG
  • AUDIT

Creates or updates (if existing) the logger with matching name.

Request

Content typesyncope2:logger
Logger to be created or updated
Media typesapplication/json
application/xml

Response

Status204

/{type}/{name}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • LOG
  • AUDIT
nameLogger name to be deletedtemplatexs:string

Deletes the logger with matching name.

Response

Status204

Returns logger with matching type and name.

Response

Content typesyncope2:logger
logger with matching type and name
Media typesapplication/json
application/xml

/events

Returns the list of all managed events in audit.

Response

Content typesyncope2:eventCategorys
list of all managed events in audit
Media typesapplication/json
application/xml

/memoryAppenders

Returns the list of memory appenders available in the current logging configuration.

Response

Content type
the list of memory appenders available in the current logging configuration
Media typesapplication/json
application/xml

/memoryAppenders/{memoryAppender}/lastLogStatements

Parameters
NameDescriptionStyleTypeDefault
memoryAppendermemory appender nametemplatexs:string

Return the last log statements available in the provided memory appender.

Response

Content typesyncope2:logStatements
the last log statements available in the provided memory appender
Media typesapplication/json
application/xml

/mailTemplates

REST operations for mail templates.

Returns a list of all mail templates.

Response

Content typesyncope2:mailTemplates
list of all mail templates.
Media typesapplication/json
application/xml

Creates a new mail template.

Request

Content typesyncope2:mailTemplate
Creates a new mail template.
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created mail template
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keykey for mail template to be deletedtemplatexs:string

Deletes the mail template matching the given key.

Response

Status204

Returns mail template with matching key.

Response

Content typesyncope2:mailTemplate
mail template with matching key
Media typesapplication/json
application/xml

/{key}/{format}

Parameters
NameDescriptionStyleTypeDefault
keymail templatetemplatexs:string
formattemplatexs:string
  • HTML
  • TEXT

Removes the template for the given key and format, if available.

Response

Status204

Gets the template for the given key and format, if available.

Response

Content type
mail template with matching key and format, if available
Media types*/*

Sets the template for the given key and format, if available.

Request

Content type
template to be set
Media types*/*

Response

Status204

/notifications

REST operations for notifications.

Returns a list of all notifications.

Response

Content typesyncope2:notifications
list of all notifications.
Media typesapplication/json
application/xml

Creates a new notification.

Request

Content typesyncope2:notification
Creates a new notification.
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created notification
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keykey for notification to be deletedtemplatexs:string

Deletes the notification matching the given key.

Response

Status204

Returns notification with matching key.

Response

Content typesyncope2:notification
notification with matching key
Media typesapplication/json
application/xml

Updates the notification matching the given key.

Request

Content typesyncope2:notification
notification to be stored
Media typesapplication/json
application/xml

Response

Status204

/job

Returns details about notification job.

Response

Content typesyncope2:job
details about notification job
Media typesapplication/json
application/xml

Executes an action on the notification job.

Parameters
NameDescriptionStyleTypeDefault
actionqueryxs:string
  • START
  • STOP

Request

Response

Status204

/policies

REST operations for policies.

Parameters
NameDescriptionStyleTypeDefault
typematrixxs:string
  • ACCOUNT
  • PASSWORD
  • PULL
  • PUSH

Returns a list of policies of the matching type.

Response

Content typesyncope2:abstractPolicys
list of policies with matching type
Media typesapplication/json
application/xml

Create a new policy.

Request

Content typesyncope2:abstractPolicy
Policy to be created (needs to match type)
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created policy
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keykey of policy to be deletedtemplatexs:string

Delete policy matching the given key.

Response

Status204

Returns the policy matching the given key.

Response

Content typesyncope2:abstractPolicy
policy with matching id
Media typesapplication/json
application/xml

Updates policy matching the given key.

Request

Content typesyncope2:abstractPolicy
Policy to replace existing policy
Media typesapplication/json
application/xml

Response

Status204

/realms

REST operations for realms.

Returns realms rooted at the given path.

Response

Content typesyncope2:realms
realms rooted at the given path
Media typesapplication/json
application/xml

/{fullPath:.*}

Parameters
NameDescriptionStyleTypeDefault
fullPathrealm pathtemplatexs:string

Deletes the realm under the given path.

Response

Content type
Response object featuring the deleted realm enriched with propagation status information - ProvisioningResult as Entity
Media types*/*

Returns realms rooted at the given path.

Response

Content typesyncope2:realms
realms rooted at the given path
Media typesapplication/json
application/xml

Updates the realm under the given path.

Request

Content typesyncope2:realm
realm to be stored
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated realm enriched with propagation status information - ProvisioningResult as Entity
Media types*/*

/{parentPath:.*}

Parameters
NameDescriptionStyleTypeDefault
parentPathfull path of the parent realmtemplatexs:string

Creates a new realm under the given path.

Request

Content typesyncope2:realm
new realm.
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created realm as well as the realm itself enriched with propagation status information - ProvisioningResult as Entity
Media types*/*

/relationshipTypes

REST operations for relationship types.

Returns a list of all relationshipTypes.

Response

Content typesyncope2:relationshipTypes
list of all relationshipTypes.
Media typesapplication/json
application/xml

Creates a new relationshipType.

Request

Content typesyncope2:relationshipType
relationshipType to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created relationshipType
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyrelationshipType key to be deletedtemplatexs:string

Deletes the relationshipType matching the provided key.

Response

Status204

Returns relationshipType with matching key.

Response

Content typesyncope2:relationshipType
relationshipType with matching key
Media typesapplication/json
application/xml

Updates the relationshipType matching the provided key.

Request

Content typesyncope2:relationshipType
relationshipType to be stored
Media typesapplication/json
application/xml

Response

Status204

/reports

REST operations for reports.

Returns a list of all existing reports.

Response

Content typesyncope2:reports
paged list of existing reports matching the given query
Media typesapplication/json
application/xml

Creates a new report.

Request

Content typesyncope2:report
report to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created report
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyDeletes report with matching keytemplatexs:string

Deletes report with matching key.

Response

Status204

Returns report with matching key.

Response

Content typesyncope2:report
report with matching key
Media typesapplication/json
application/xml

Updates report with matching key.

Request

Content typesyncope2:report
report to be stored
Media typesapplication/json
application/xml

Response

Status204

/{key}/execute

Parameters
NameDescriptionStyleTypeDefault
keyquery conditionstemplatexs:string

Executes the executable matching the given query.

Parameters
NameDescriptionStyleTypeDefault
startAtquery conditionsqueryxs:dateTime
dryRunquery conditionsqueryxs:booleanfalse

Request

Response

Content typesyncope2:exec
execution report for the executable matching the given query
Media typesapplication/json
application/xml

/{key}/executions

Parameters
NameDescriptionStyleTypeDefault
keyquery conditionstemplatexs:string

Deletes the executions belonging matching the given query.

Parameters
NameDescriptionStyleTypeDefault
startedBeforequery conditionsqueryxs:dateTime
startedAfterquery conditionsqueryxs:dateTime
endedBeforequery conditionsqueryxs:dateTime
endedAfterquery conditionsqueryxs:dateTime

Request

Response

Content typesyncope2:bulkActionResult
bulk action result
Media typesapplication/xml
application/json

Returns a paged list of executions matching the given query.

Parameters
NameDescriptionStyleTypeDefault
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope2:pagedResult
paged list of executions the given query
Media typesapplication/json
application/xml

/executions/{executionKey}

Parameters
NameDescriptionStyleTypeDefault
executionKeykey of executable execution to be deletedtemplatexs:string

Deletes the executable execution matching the provided key.

Response

Status204

/executions/{executionKey}/stream

Parameters
NameDescriptionStyleTypeDefault
executionKeykey of execution report to be selectedtemplatexs:string

Exports the report execution with matching key in the requested format.

Parameters
NameDescriptionStyleTypeDefault
formatqueryxs:string
  • XML
  • HTML
  • PDF
  • RTF
  • CSV

Request

Response

Content type
a stream for content download
Media types*/*

/executions/recent

Returns the list of recently completed executions, ordered by end date descendent.

Parameters
NameDescriptionStyleTypeDefault
maxthe maximum number of executions to returnqueryxs:int25

Request

Response

Content typesyncope2:execs
list of recently completed executions, ordered by end date descendent
Media typesapplication/json
application/xml

/jobs

List jobs (running and / or scheduled).

Response

Content typesyncope2:jobs
jobs (running and / or scheduled)
Media typesapplication/json
application/xml

/jobs/{key}

Parameters
NameDescriptionStyleTypeDefault
keyexecutable keytemplatexs:string

Executes an action on an existing executable's job.

Parameters
NameDescriptionStyleTypeDefault
actionqueryxs:string
  • START
  • STOP

Request

Response

Status204

/reportTemplates

REST operations for report templates.

Returns a list of all report templates.

Response

Content typesyncope2:reportTemplates
list of all report templates.
Media typesapplication/json
application/xml

Creates a new report template.

Request

Content typesyncope2:reportTemplate
Creates a new report template.
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created report template
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keykey for report template to be deletedtemplatexs:string

Deletes the report template matching the given key.

Response

Status204

Returns report template with matching key.

Response

Content typesyncope2:reportTemplate
report template with matching key
Media typesapplication/json
application/xml

/{key}/{format}

Parameters
NameDescriptionStyleTypeDefault
keyreport templatetemplatexs:string
formattemplatexs:string
  • FO
  • HTML
  • CSV

Removes the template for the given key and format, if available.

Response

Status204

Gets the template for the given key and format, if available.

Response

Content type
report template with matching key and format, if available
Media types*/*

Sets the template for the given key and format, if available.

Request

Content type
template to be set
Media types*/*

Response

Status204

/resources

REST operations for external resources.

Returns a list of all resources.

Response

Content typesyncope2:resources
list of all resources
Media typesapplication/json
application/xml

Creates a new resource.

Request

Content typesyncope2:resource
Resource to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created resource
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyname of resource to be deletedtemplatexs:string

Deletes the resource matching the given name.

Response

Status204

Returns the resource with matching name.

Response

Content typesyncope2:resource
resource with matching name
Media typesapplication/json
application/xml

Updates the resource matching the given name.

Request

Content typesyncope2:resource
resource to be stored
Media typesapplication/json
application/xml

Response

Status204

/{key}/{anyTypeKey}

Parameters
NameDescriptionStyleTypeDefault
keyresourcetemplatexs:string
anyTypeKeyany typetemplatexs:string

Removes the sync token value associated to the given any type from the given resource.

Response

Status204

Returns a paged list of connector objects from external resource, for the given type, matching page/size conditions.

Parameters
NameDescriptionStyleTypeDefault
pagedResultsCookiename of resource to read connector object fromqueryxs:string
sizename of resource to read connector object fromqueryxs:int25

Request

Response

Content typesyncope2:pagedConnObjectResult
connector objects from the external resource, for the given type
Media typesapplication/json
application/xml

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.

Response

Status204

/{key}/{anyTypeKey}/{anyKey}

Parameters
NameDescriptionStyleTypeDefault
keyname of resource to read connector object fromtemplatexs:string
anyTypeKeyany object typetemplatexs:string
anyKeyany object keytemplatexs:string

Returns connector object from the external resource, for the given type and key.

Response

Content typesyncope2:connObject
connector object from the external resource, for the given type and key
Media typesapplication/json
application/xml

/{key}/bulkDeassociation/{anyTypeKey}/{action}

De-associate any objects from the given resource.

Request

Content typesyncope2:resourceDeassociationPatch
any objects to be used for propagation-related operations
Media typesapplication/json
application/xml

Response

Content typesyncope2:bulkActionResult
Bulk action result
Media typesapplication/json
application/xml

/check

Checks whether the connection to resource could be established.

Request

Content typesyncope2:resource
resource to be checked
Media typesapplication/json
application/xml

Response

Status204

/resourcesHistory

REST operations for resource configuration versioning.

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyresource configuration history key to be deletedtemplatexs:string

Deletes the resource configuration history matching the provided key.

Response

Status204

Restores the resource configuration history matching the provided key.

Response

Status204

/{resourceKey}

Parameters
NameDescriptionStyleTypeDefault
resourceKeyresource keytemplatexs:string

Returns a list of all resource configuration history for the given resource key.

Response

Content typesyncope2:resourceHistoryConfs
list of all resource configuration history for the given resource key
Media typesapplication/json
application/xml

/roles

REST operations for roles.

Returns a list of all roles.

Response

Content typesyncope2:roles
list of all roles.
Media typesapplication/json
application/xml

Creates a new role.

Request

Content typesyncope2:role
role to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created role
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyrole key to be deletedtemplatexs:string

Deletes the role matching the provided key.

Response

Status204

Returns role with matching key.

Response

Content typesyncope2:role
role with matching key
Media typesapplication/json
application/xml

Updates the role matching the provided key.

Request

Content typesyncope2:role
role to be stored
Media typesapplication/json
application/xml

Response

Status204

/{key}/consoleLayout

Parameters
NameDescriptionStyleTypeDefault
keyrole keytemplatexs:string

Removes the console layout information for the role with the given key, if available.

Response

Status204

Gets the console layout information as JSON string for the role with the given key, if available.

Response

Content type
console layout information as JSON string for the role with the given key, if available
Media typesapplication/json

Sets the console layout information as JSON string for the role with the given key, if available.

Request

Content type
console layout information to be set
Media typesapplication/json

Response

Status204

/schemas

REST operations for attribute schemas.

/{type}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL

Returns a list of schemas matching the given query.

Parameters
NameDescriptionStyleTypeDefault
anyTypeClassesquery conditionsqueryxs:string

Request

Response

Content typesyncope2:abstractSchemas
list of schemas with matching type, for the given anyTypeClass if provided
Media typesapplication/json
application/xml

Creates a new schema.

Request

Content typesyncope2:abstractSchema
schema to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created schema
Media types*/*

/{type}/{key}

Parameters
NameDescriptionStyleTypeDefault
typetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
keyname of schema to be deletedtemplatexs:string

Deletes the schema matching the given type and key.

Response

Status204

Returns schema matching the given type and key.

Response

Content typesyncope2:abstractSchema
schema matching the given type and name
Media typesapplication/json
application/xml

Updates the schema matching the given type and key.

Request

Content typesyncope2:abstractSchema
updated schema to be stored
Media typesapplication/json
application/xml

Response

Status204

/securityQuestions

REST operations for configuration.

Returns a list of all security questions.

Response

Content typesyncope2:securityQuestions
list of all security questions
Media typesapplication/json
application/xml

Creates a new security question.

Request

Content typesyncope2:securityQuestion
security question to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created security question
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keysecurity question key to be deletedtemplatexs:string

Deletes the security question matching the provided key.

Response

Status204

Returns security question with matching key.

Response

Content typesyncope2:securityQuestion
security question with matching key
Media typesapplication/json
application/xml

Updates the security question matching the provided key.

Request

Content typesyncope2:securityQuestion
security question to be stored
Media typesapplication/json
application/xml

Response

Status204

/byUser/{username}

Parameters
NameDescriptionStyleTypeDefault
usernameusername for which the security question is requestedtemplatexs:string

Ask for security question configured for the user matching the given username, if any.

Response

Content typesyncope2:securityQuestion
security question, if configured for the user matching the given username
Media typesapplication/json
application/xml

/tasks

REST operations for tasks.

Parameters
NameDescriptionStyleTypeDefault
typematrixxs:string
  • PROPAGATION
  • NOTIFICATION
  • SCHEDULED
  • PULL
  • PUSH

Returns a paged list of existing tasks matching the given query.

Parameters
NameDescriptionStyleTypeDefault
notificationquery conditionsqueryxs:string
anyTypeKindqueryxs:string
  • USER
  • GROUP
  • ANY_OBJECT
entityKeyquery conditionsqueryxs:string
detailsquery conditionsqueryxs:booleantrue
resourcequery conditionsqueryxs:string
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope2:pagedResult
paged list of existing tasks matching the given query
Media typesapplication/json
application/xml

Creates a new task.

Request

Content typesyncope2:schedTask
task to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created task
Media types*/*

/{key}

Parameters
NameDescriptionStyleTypeDefault
keykey of task to be deletedtemplatexs:string

Deletes the task matching the provided key.

Response

Status204

Returns the task matching the given key.

Parameters
NameDescriptionStyleTypeDefault
detailswhether include executions or not, defaults to truequeryxs:booleantrue

Request

Response

Content typesyncope2:abstractTask
task with matching id
Media typesapplication/json
application/xml

Updates the task matching the provided key.

Request

Content typesyncope2:abstractTask
updated task to be stored
Media typesapplication/json
application/xml

Response

Status204

/{key}/execute

Parameters
NameDescriptionStyleTypeDefault
keyquery conditionstemplatexs:string

Executes the executable matching the given query.

Parameters
NameDescriptionStyleTypeDefault
startAtquery conditionsqueryxs:dateTime
dryRunquery conditionsqueryxs:booleanfalse

Request

Response

Content typesyncope2:exec
execution report for the executable matching the given query
Media typesapplication/json
application/xml

/{key}/executions

Parameters
NameDescriptionStyleTypeDefault
keyquery conditionstemplatexs:string

Deletes the executions belonging matching the given query.

Parameters
NameDescriptionStyleTypeDefault
startedBeforequery conditionsqueryxs:dateTime
startedAfterquery conditionsqueryxs:dateTime
endedBeforequery conditionsqueryxs:dateTime
endedAfterquery conditionsqueryxs:dateTime

Request

Response

Content typesyncope2:bulkActionResult
bulk action result
Media typesapplication/xml
application/json

Returns a paged list of executions matching the given query.

Parameters
NameDescriptionStyleTypeDefault
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope2:pagedResult
paged list of executions the given query
Media typesapplication/json
application/xml

/bulk

Executes the provided bulk action.

Request

Content typesyncope2:bulkAction
list of task ids against which the bulk action will be performed.
Media typesapplication/json
application/xml

Response

Content typesyncope2:bulkActionResult
Bulk action result
Media typesapplication/json
application/xml

/executions/{executionKey}

Parameters
NameDescriptionStyleTypeDefault
executionKeykey of executable execution to be deletedtemplatexs:string

Deletes the executable execution matching the provided key.

Response

Status204

/executions/recent

Returns the list of recently completed executions, ordered by end date descendent.

Parameters
NameDescriptionStyleTypeDefault
maxthe maximum number of executions to returnqueryxs:int25

Request

Response

Content typesyncope2:execs
list of recently completed executions, ordered by end date descendent
Media typesapplication/json
application/xml

/jobs

List jobs (running and / or scheduled).

Response

Content typesyncope2:jobs
jobs (running and / or scheduled)
Media typesapplication/json
application/xml

/jobs/{key}

Parameters
NameDescriptionStyleTypeDefault
keyexecutable keytemplatexs:string

Executes an action on an existing executable's job.

Parameters
NameDescriptionStyleTypeDefault
actionqueryxs:string
  • START
  • STOP

Request

Response

Status204

/users

REST operations for users.

Parameters
NameDescriptionStyleTypeDefault
realmquery conditionsmatrixxs:string/

Returns a paged list of any objects matching the given query.

Parameters
NameDescriptionStyleTypeDefault
detailsquery conditionsqueryxs:booleantrue
fiqlquery conditionsqueryxs:string
pagequery conditionsqueryxs:int1
orderByquery conditionsqueryxs:string
sizequery conditionsqueryxs:int25

Request

Response

Content typesyncope2:pagedResult
paged list of any objects matching the given query
Media typesapplication/json
application/xml

Creates a new user.

Parameters
NameDescriptionStyleTypeDefault
storePasswordwhether password shall be stored internallyqueryxs:booleantrue

Request

Content typesyncope2:user
user to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created user as well as the user itself enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

Creates a new any object.

Request

Content typesyncope2:anyTO
any object to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of created any object as well as the any object itself enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/{key}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string

Deletes any object matching provided key.

Response

Content type
Response object featuring the deleted any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

Reads the any object matching the provided key. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope2:anyTO
any object with matching key
Media typesapplication/json
application/xml

Updates any object matching the provided key.

Request

Content typesyncope2:anyPatch
complete update
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

Updates any object matching the provided key.

Request

Content typesyncope2:anyTO
complete update
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/{key}/{schemaType}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL

Reads the any object matching the provided key. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope2:attributes
any object with matching key
Media typesapplication/json
application/xml

/{key}/{schemaType}/{schema}

Parameters
NameDescriptionStyleTypeDefault
keyany object key or nametemplatexs:string
schemaTypetemplatexs:string
  • PLAIN
  • DERIVED
  • VIRTUAL
schemaschematemplatexs:string

Deletes any object matching provided key.

Response

Status204

Reads the any object matching the provided key. Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter looks like a UUID then it is interpreted as as key, otherwise as a (user)name.

Response

Content typesyncope2:attribute
any object with matching key
Media typesapplication/json
application/xml

Updates any object matching the provided key.

Request

Content typesyncope2:attribute
attribute
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated any object enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/{key}/associate/{action}

Executes resource-related operations on given any object.

Request

Content typesyncope2:associationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/xml

Response

Content type
Response object featuring BulkActionResult as Entity
Media typesapplication/json
application/xml

/{key}/deassociate/{action}

Executes resource-related operations on given any object.

Request

Content typesyncope2:deassociationPatch
external resources to be used for propagation-related operations
Media typesapplication/json
application/xml

Response

Content type
Response object featuring BulkActionResult as Entity
Media typesapplication/json
application/xml

/{key}/status

Performs a status update on given user.

Request

Content typesyncope2:statusPatch
status update details
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated user enriched with propagation status information - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/bulk

Executes the provided bulk action.

Request

Content typesyncope2:bulkAction
list of any object ids against which the bulk action will be performed.
Media typesapplication/json
application/xml

Response

Content type
Response object featuring BulkActionResult as Entity
Media typesapplication/json
application/xml

/users/self

REST operations for user self-management.

Self-deletes user.

Response

Content type
Response object featuring the deleted user - ProvisioningResult as Entity
Media typesapplication/json
application/xml

Returns the user making the service call.

Response

Content type
calling user data, including owned entitlements as header value {@link org.apache.syncope.common.rest.api.RESTHeaders#OWNED_ENTITLEMENTS}
Media typesapplication/json
application/xml

Self-registration for new user.

Parameters
NameDescriptionStyleTypeDefault
storePasswordwhether password shall be stored internallyqueryxs:booleantrue

Request

Content typesyncope2:user
user to be created
Media typesapplication/json
application/xml

Response

Content type
Response object featuring Location header of self-registered user as well as the user itself - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/{key}

Self-updates user.

Request

Content typesyncope2:userPatch
complete update
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated user - ProvisioningResult as Entity
Media typesapplication/json
application/xml

Self-updates user.

Request

Content typesyncope2:user
complete update
Media typesapplication/json
application/xml

Response

Content type
Response object featuring the updated user - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/changePassword

Changes own password when change was forced by an administrator.

Request

Content typexs:string
Media types*/*

Response

Content type
Response object featuring the updated user - ProvisioningResult as Entity
Media typesapplication/json
application/xml

/confirmPasswordReset

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

Parameters
NameDescriptionStyleTypeDefault
tokenpassword reset tokenqueryxs:string

Request

Content typexs:string
Media types*/*

Response

Status204

/requestPasswordReset

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

Parameters
NameDescriptionStyleTypeDefault
usernameusername for which the security answer is providedqueryxs:string

Request

Content typexs:string
Media types*/*

Response

Status204

/userworkflow

REST operations related to user workflow.

/forms

Returns a list of all available workflow forms.

Response

Content typesyncope2:workflowForms
list of all available workflow forms
Media typesapplication/json
application/xml

Submits a workflow form.

Request

Content typesyncope2:workflowForm
workflow form.
Media typesapplication/json
application/xml

Response

Content typesyncope2:user
updated user
Media typesapplication/json
application/xml

/forms/{taskId}/claim

Parameters
NameDescriptionStyleTypeDefault
taskIdworkflow task idtemplatexs:string

Claims the form for the given task id.

Response

Content typesyncope2:workflowForm
the workflow form for the given task id
Media typesapplication/json
application/xml

/forms/{userKey}

Parameters
NameDescriptionStyleTypeDefault
userKeyuser keytemplatexs:string

Returns a list of available forms for the given user key.

Response

Content typesyncope2:workflowForm
list of available forms for the given user key
Media typesapplication/json
application/xml

/tasks/{taskId}/execute

Parameters
NameDescriptionStyleTypeDefault
taskIdworkflow task idtemplatexs:string

Executes workflow task for matching id.

Request

Content typesyncope2:user
argument to be passed to workflow task
Media typesapplication/json
application/xml

Response

Content typesyncope2:user
updated user
Media typesapplication/json
application/xml

/workflows

REST operations for workflow definition.

/{anyType}

Parameters
NameDescriptionStyleTypeDefault
anyTypeany object typetemplatexs:string

Lists the available workflow definitions, for the given any object type.

Response

Content typesyncope2:workflowDefinitions
available workflow definitions, for the given any object type
Media typesapplication/json
application/xml

/{anyType}/{key}

Parameters
NameDescriptionStyleTypeDefault
anyTypeany object typetemplatexs:string
keyworkflow definition keytemplatexs:string

Removes the workflow definition for matching any object type, under the provided key.

Response

Status204

Exports the workflow definition for matching any object type and key.

Response

Content type
workflow definition for matching any object type and key
Media typesapplication/json
application/xml

Imports the workflow definition for matching any object type, under the provided key.

Request

Content typexs:string
Media typesapplication/json
application/xml

Response

Status204

/{anyType}/{key}/diagram.png

Parameters
NameDescriptionStyleTypeDefault
anyTypeany object typetemplatexs:string
keyworkflow definition keytemplatexs:string

Exports the workflow diagram representation (if available), for matching any object type and key.

Response

Content type
workflow diagram representation
Media typesimage/png