Available operations
This table shows an overview of the available operations for endpoint
/connect/model
:
Standard operations GET list, GET details, POST, PUT,
DELETE |
Activation, deactivation, etc. | Other operations | |
---|---|---|---|
Data flows | Yes | Activate, deactivate | - |
Connection points | Yes | n/a | Refresh documents, for two-way IMS, update properties such as password. |
File templates | Yes | n/a | - |
Mappings | Yes | Approve | - |
Enterprise Location | Yes | n/a | Download installer, generate credentials |
This table shows an overview of the available operations for endpoint
/scriptingservice/model
:
Standard operationsGET list, GET details, POST, PUT,
DELETE |
Activation, deactivation, etc. | Other operations | |
---|---|---|---|
Scripts | Yes | Approve | - |
Libraries | Yes | n/a | - |
This table shows an overview of the available operations for endpoint
/process/model
:
Standard operations GET list, GET details, POST, PUT,
DELETE |
Activation, deactivation, etc. | Other operations | |
---|---|---|---|
Monitors | Yes | Activate, deactivate | - |
Workflows | Yes | Activate, deactivate | - |
Activation policies | Yes | Activate, deactivate | - |
Alarm templates | Yes | Activate, deactivate | - |
Business rules | Yes | Approve | Revert, submit, undo submit, reject |
This table shows an overview of the available operations for endpoint
/datacatalog
:
Standard operationsGET list, GET details, POST, PUT,
DELETE |
Activation, deactivation, etc. | Other operations | |
---|---|---|---|
Objects | Yes, but:
|
n/a | Specific methods for getting summary, multiple objects, audit information, change events, and specific properties, such as the schema. |
Nouns | Same as for objects | n/a | - |
Schema extensions | Yes | n/a | - |
Locale selections | Only GET and POST , because the whole set is
retrieved and posted in one go. |
n/a | - |
This table shows an overview of the available operations for endpoint
/configuration/model
:
Standard operationsGET list, GET details, POST, PUT,
DELETE |
Activation, deactivation, etc. | Other operations | |
---|---|---|---|
Codes | Yes | n/a | - |
Workflow authorizations | Yes, except PUT |
n/a | - |
Email templates | Only GET and POST , because the whole set is
retrieved and posted in one go. |
n/a | - |
This table shows an overview of the available operations for endpoint
/usage/model
:
Standard operationsGET list, GET details, POST, PUT,
DELETE |
Activation, deactivation, etc. | Other operations | |
---|---|---|---|
Usage | GET that is based on name and entity type, such as workflow or
script. |
n/a | - |
Resources that have versioning for models, mappings, scripts, libraries and business rules, have specific behavior for the standard operations. For example:
- When you
PUT
the resource, it does not overwrite the whole model, but adds a new draft or overwrites the existing draft version. - You can
GET
a specific version, such as the latest approved one. This does not apply to business rules.
The Data Catalog API, which was released earlier for other purposes, has minor deviations from the newer APIs. The Data Catalog API is expected to be aligned in a future version.
See Data Catalog API.
To update an existing object, you can use the combination of GET
and
PUT
. For example, to add a document to an existing data flow, you can
GET
the data flow. Then create a PUT
request that is based
on the GET
response plus the new document.