All REST Endpoints
- Clone a B2B Document
- Method: postPath:
/ic/api/b2b/v1/b2bdocuments/{documentId}/clone
- Clone a B2B Schema
- Method: postPath:
/ic/api/b2b/v1/schemas/{schemaId}/clone
- Create a B2B Document
- Method: postPath:
/ic/api/b2b/v1/b2bdocuments
- Create a B2B Schema
- Method: postPath:
/ic/api/b2b/v1/schemas
- Create a B2B schema from an SEF File
- Method: postPath:
/ic/api/b2b/v1/import
- Delete a B2B Document
- Method: deletePath:
/ic/api/b2b/v1/b2bdocuments/{documentId}
- Delete a B2B Schema
- Method: deletePath:
/ic/api/b2b/v1/schemas/{schemaId}
- Generate a Schema Implementation Guide
- Method: getPath:
/ic/api/b2b/v1/schemas/{schemaId}/guide
- Retrieve a B2B Document
- Method: getPath:
/ic/api/b2b/v1/b2bdocuments/{documentId}
- Retrieve a B2B Schema
- Method: getPath:
/ic/api/b2b/v1/schemas/{schemaId}
- Retrieve an Element's Code List
- Method: getPath:
/ic/api/b2b/v1/schemas/{schemaId}/{elementId}/codes
- Retrieve B2B Document Standards
- Method: getPath:
/ic/api/b2b/v1/standards
- Retrieve B2B Document Types
- Method: getPath:
/ic/api/b2b/v1/standards/{standardId}/{versionId}/{transactionId}
- Retrieve B2B Documents
- Method: getPath:
/ic/api/b2b/v1/b2bdocuments
- Retrieve B2B Schemas
- Method: getPath:
/ic/api/b2b/v1/schemas
- Retrieve Document Transactions
- Method: getPath:
/ic/api/b2b/v1/standards/{standardId}/{versionId}
- Retrieve Document Versions
- Method: getPath:
/ic/api/b2b/v1/standards/{standardId}
- Retrieve Documents for a B2B Schema
- Method: getPath:
/ic/api/b2b/v1/schemas/{schemaId}/documents
- Retrieve Integrations Using a B2B Document
- Method: getPath:
/ic/api/b2b/v1/b2bdocuments/{documentId}/integrations
- Retrieve Trading Partners using a B2B Document
- Method: getPath:
/ic/api/b2b/v1/b2bdocuments/{documentId}/partners
- Update a B2B Document
- Method: putPath:
/ic/api/b2b/v1/b2bdocuments/{documentId}
- Update a B2B Schema
- Method: putPath:
/ic/api/b2b/v1/schemas/{schemaId}
- Download B2B Business Message Payload
- Method: getPath:
/ic/api/b2b/v1/monitoring/businessmessages/{id}/payload/download
- Download B2B Wire Message Payload
- Method: getPath:
/ic/api/b2b/v1/monitoring/wiremessages/{id}/payload/download
- Retrieve Business Message Details
- Method: getPath:
/ic/api/b2b/v1/monitoring/businessmessages/{id}
- Retrieve Business Messages
- Method: getPath:
/ic/api/b2b/v1/monitoring/businessmessages
- Retrieve Wire Message Details
- Method: getPath:
/ic/api/b2b/v1/monitoring/wiremessages/{id}
- Retrieve Wire Messages
- Method: getPath:
/ic/api/b2b/v1/monitoring/wiremessages
- Create a Trading Partner
- Method: postPath:
/ic/api/b2b/v1/tpm/partners
- Create an Inbound Agreement
- Method: postPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs
- Create an Outbound Agreement
- Method: postPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs
- Create/Update B2B Identifiers
- Method: postPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/identifiers
- Create/Update Host Profile
- Method: postPath:
/ic/api/b2b/v1/tpm/host
- Create/Update Trading Partner Contacts
- Method: postPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/contacts
- Delete a B2B Identifier
- Method: deletePath:
/ic/api/b2b/v1/tpm/partners/{tpId}/identifiers/{identifierId}
- Delete a Host Identifier
- Method: deletePath:
/ic/api/b2b/v1/tpm/host/{id}
- Delete a Trading Partner
- Method: deletePath:
/ic/api/b2b/v1/tpm/partners/{tpId}
- Delete an Inbound Agreement
- Method: deletePath:
/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}
- Delete an Outbound Agreement
- Method: deletePath:
/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}
- Deploy an Inbound Agreement
- Method: postPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}/deploy
- Deploy an Outbound Agreement
- Method: postPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}/deploy
- Export a Trading Partner
- Method: getPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/export
- Import a Trading Partner
- Method: postPath:
/ic/api/b2b/v1/tpm/partners/import
- Retrieve a Trading Partner
- Method: getPath:
/ic/api/b2b/v1/tpm/partners/{tpId}
- Retrieve an Inbound Agreement
- Method: getPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}
- Retrieve an Outbound Agreement
- Method: getPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}
- Retrieve B2B Identifiers
- Method: getPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/identifiers
- Retrieve Inbound Agreements
- Method: getPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs
- Retrieve Outbound Agreements
- Method: getPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs
- Retrieve the Host Profile
- Method: getPath:
/ic/api/b2b/v1/tpm/host
- Retrieve Trading Partner Contact Details
- Method: getPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/contacts
- Retrieve Trading Partners
- Method: getPath:
/ic/api/b2b/v1/tpm/partners
- Undeploy an Inbound Agreement
- Method: postPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}/undeploy
- Undeploy an Outbound Agreement
- Method: postPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}/undeploy
- Update a Trading Partner
- Method: putPath:
/ic/api/b2b/v1/tpm/partners/{tpId}
- Update an Inbound Agreement
- Method: putPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}
- Update an Outbound Agreement
- Method: putPath:
/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}
- Create an Empty Decision Model
- Method: putPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}
- Delete a Decision Model and Snapshots
- Method: deletePath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}
- Delete a Decision Model Snapshot
- Method: deletePath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}
- Deploy a Decision Model Snapshot
- Method: putPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}
- Get a Decision Model
- Method: getPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}
- Get a List of Decision Model Names in a Space
- Method: getPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models
- Get a List of Decision Model Snapshot Names
- Method: getPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions
- Get a List of Decision Services of a Decision Model Snapshot
- Method: getPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services
- Get a List of Runtime Version IDs of a Decision Model
- Method: getPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags
- Get a List of Space IDs
- Method: getPath:
/ic/api/process/v1/dmn/spaces
- Get a New Access Token and Refresh Token
- Method: postPath:
/ic/api/process/v1/auth/token/permission
- Get a Space by Space ID
- Method: getPath:
/ic/api/process/v1/dmn/spaces/{spaceId}
- Get Information about a Decision Service by Snapshot Name
- Method: getPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services/{decisionServiceName}
- Get Information of a Deployed Decision Service by the Runtime Version ID
- Method: getPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}/definition/decision-services/{decisionServiceName}
- Get the Snapshot Name Associated with a Runtime Version ID
- Method: getPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}
- Import a Decision Model Snapshot
- Method: putPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}
- Invoke a Decision Service by Snapshot Name
- Method: postPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services/{decisionServiceName}
- Invoke a Deployed Decision Service by the Runtime Version ID
- Method: postPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}/definition/decision-services/{decisionServiceName}
- Read or Export a Decision Model Snapshot
- Method: getPath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}
- Refresh the Access Token
- Method: postPath:
/ic/api/process/v1/auth/token/refresh
- Undeploy a Runtime Version ID of a Decision Model
- Method: deletePath:
/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}
- Create a List of Domains Allowed for CORS Processing
- Method: postPath:
/ic/api/integration/v1/environment/corsdomains
- Retrieve List of Domains Allowed for CORS Processing
- Method: getPath:
/ic/api/integration/v1/environment/corsdomains
- Update the List of Allowed Domains for CORS Processing
- Method: putPath:
/ic/api/integration/v1/environment/corsdomains
- Delete a Connection
- Method: deletePath:
/ic/api/integration/v1/connections/{id}
- Refresh Metadata for a Connection
- Method: postPath:
/ic/api/integration/v1/connections/{id}/metadata
- Retrieve a Connection
- Method: getPath:
/ic/api/integration/v1/connections/{id}
- Retrieve Connection Property Attachment
- Method: getPath:
/ic/api/integration/v1/connections/{id}/attachments/{connPropName}
- Retrieve Connections
- Method: getPath:
/ic/api/integration/v1/connections
- Test a Connection
- Method: postPath:
/ic/api/integration/v1/connections/{id}/test
- Update a Connection
- Method: postPath:
/ic/api/integration/v1/connections/{id}
- Upload Connection Property Attachment
- Method: postPath:
/ic/api/integration/v1/connections/{id}/attachments/{connPropName}
- Validate a Connection
- Method: postPath:
/ic/api/integration/v1/connections/{id}/validate
- Validate and Test a Connection
- Method: postPath:
/ic/api/integration/v1/connections/{id}/testWithAttachments
- Clone an Integration
- Method: postPath:
/ic/api/integration/v1/integrations/{id}/clone
- Delete an Integration Version
- Method: deletePath:
/ic/api/integration/v1/integrations/{id}
- Export an Integration
- Method: getPath:
/ic/api/integration/v1/integrations/{id}/archive
- Import(Add) an Integration
- Method: postPath:
/ic/api/integration/v1/integrations/archive
- Import(Replace) an Integration
- Method: putPath:
/ic/api/integration/v1/integrations/archive
- Retrieve an Integration
- Method: getPath:
/ic/api/integration/v1/integrations/{id}
- Retrieve Integration Activation Errors
- Method: getPath:
/ic/api/integration/v1/integrations/{id}/activationErrors
- Retrieve Integration Activation Status
- Method: getPath:
/ic/api/integration/v1/integrations/{id}/activationStatus
- Retrieve Integrations
- Method: getPath:
/ic/api/integration/v1/integrations
- Update(Activate/Deactivate) an Integration
- Method: postPath:
/ic/api/integration/v1/integrations/{id}
- Pause an Integration Schedule
- Method: postPath:
/ic/api/integration/v1/integrations/{id}/schedule/pause
- Resume an Integration Schedule
- Method: postPath:
/ic/api/integration/v1/integrations/{id}/schedule/resume
- Retrieve Scheduled Integration Run Status
- Method: getPath:
/ic/api/integration/v1/integrations/{id}/schedule/jobs/{job_id}
- Run a Scheduled Integration Now
- Method: postPath:
/ic/api/integration/v1/integrations/{id}/schedule/jobs
- Start an Integration Schedule
- Method: postPath:
/ic/api/integration/v1/integrations/{id}/schedule/start
- Stop an Integration Schedule
- Method: postPath:
/ic/api/integration/v1/integrations/{id}/schedule/stop
- Update Scheduled Integration Parameters
- Method: patchPath:
/ic/api/integration/v1/integrations/{id}/schedule/parameters
Retrieve, import, export, and delete libraries.
JavaScript libraries provide a means to register and organize JavaScript for use in orchestration integrations. Library functions are automatically available for your integrations.
API Library Jar
The API library jar file contains Javascript files/functions which will be consumed in integrations as callouts. You download the library jar file to modify the JS functions. You can then import the modified library jar as a new library or update the existing library.
API Library Metadata
Once you have imported the API library, you configure it using the API library metadata XML file. The API library metadata file contains details such as classification and data types of input/output parameters of JS functions. You import the library metadata XML file using the library id. You can export the metadata XML file for mass update of JS function configuration details and import it back into the system.
- Delete a Library Version
- Method: deletePath:
/ic/api/integration/v1/libraries/{id}
- Export a Library
- Method: getPath:
/ic/api/integration/v1/libraries/{id}/archive
- Export Library Metadata
- Method: getPath:
/ic/api/integration/v1/libraries/{id}/metadata
- Import Library Metadata
- Method: postPath:
/ic/api/integration/v1/libraries/{id}/metadata
- Import(Register) a Library
- Method: postPath:
/ic/api/integration/v1/libraries/archive
- Retrieve a Library
- Method: getPath:
/ic/api/integration/v1/libraries/{id}
- Retrieve Libraries
- Method: getPath:
/ic/api/integration/v1/libraries
- Update a Library
- Method: postPath:
/ic/api/integration/v1/libraries/{id}/archive
Retrieve, create, update, and delete lookups.
Lookups are reusable tables that map the different terms used to describe the same item across your applications.
For example, one application uses a specific set of codes to describe countries, while another application uses a different set of codes to describe the same countries. Lookups can be used for items such as mapping gender codes, nationality codes, currency codes, or any type of information that your applications must share with each other but that they represent differently.
- Clone a Lookup
- Method: postPath:
/ic/api/integration/v1/lookups/{name}/clone
- Create a Lookup
- Method: postPath:
/ic/api/integration/v1/lookups
- Delete a Lookup
- Method: deletePath:
/ic/api/integration/v1/lookups/{name}
- Export a Lookup
- Method: getPath:
/ic/api/integration/v1/lookups/{name}/archive
- Import(Add) a Lookup
- Method: postPath:
/ic/api/integration/v1/lookups/archive
- Import(Replace) a Lookup
- Method: putPath:
/ic/api/integration/v1/lookups/archive
- Retrieve a Lookup
- Method: getPath:
/ic/api/integration/v1/lookups/{name}
- Retrieve Lookups
- Method: getPath:
/ic/api/integration/v1/lookups
- Retrieve Usage of the Lookup
- Method: getPath:
/ic/api/integration/v1/lookups/{name}/usage
- Update a Lookup
- Method: putPath:
/ic/api/integration/v1/lookups/{name}
- Abort an Integration Instance
- Method: postPath:
/ic/api/integration/v1/monitoring/instances/{id}/abort
- Discard an Errored Integration Instance
- Method: postPath:
/ic/api/integration/v1/monitoring/errors/{id}/discard
- Discard Errored Integration Instances
- Method: postPath:
/ic/api/integration/v1/monitoring/errors/discard
- Download a Log File
- Method: getPath:
/ic/api/integration/v1/monitoring/logs/{id}
- Download an Incident (Deprecated)
- Method: getPath:
/ic/api/integration/v1/monitoring/incident
- Download Database Purge Logs
- Method: getPath:
/ic/api/integration/v1/monitoring/logs/oicpurgelogs
- Report an Incident(Deprecated)
- Method: postPath:
/ic/api/integration/v1/monitoring/reportIncident
- Resubmit a Failed Scheduled Integration Run
- Method: postPath:
/ic/api/integration/v1/monitoring/runs/{id}/resubmit
- Resubmit an Errored Integration Instance
- Method: postPath:
/ic/api/integration/v1/monitoring/errors/{id}/resubmit
- Resubmit Errored Integration Instances
- Method: postPath:
/ic/api/integration/v1/monitoring/errors/resubmit
- Retrieve Activity Stream Messages (Deprecated)
- Method: getPath:
/ic/api/integration/v1/monitoring/integrationActivityStream
- Retrieve an Error Recovery Job
- Method: getPath:
/ic/api/integration/v1/monitoring/errors/recoveryJobs/{id}
- Retrieve an Errored Integration Instance
- Method: getPath:
/ic/api/integration/v1/monitoring/errors/{id}
- Retrieve an Integration Instance
- Method: getPath:
/ic/api/integration/v1/monitoring/instances/{id}
- Retrieve Audit Records
- Method: getPath:
/ic/api/integration/v1/monitoring/auditRecords
- Retrieve Error Recovery Jobs
- Method: getPath:
/ic/api/integration/v1/monitoring/errors/recoveryJobs
- Retrieve Errored Instances
- Method: getPath:
/ic/api/integration/v1/monitoring/errors
- Retrieve Historical Tracking Metrics
- Method: getPath:
/ic/api/integration/v1/monitoring/history
- Retrieve Integration Instance Activity Stream
- Method: getPath:
/ic/api/integration/v1/monitoring/instances/{id}/activityStream
- Retrieve Integration Instances
- Method: getPath:
/ic/api/integration/v1/monitoring/instances
- Retrieve Message Count Summary
- Method: getPath:
/ic/api/integration/v1/monitoring/integrations/messages/summary
- Retrieve Monitoring Data for an Integration
- Method: getPath:
/ic/api/integration/v1/monitoring/integrations/{id}
- Retrieve Monitoring Data for Integrations
- Method: getPath:
/ic/api/integration/v1/monitoring/integrations
- Retrieve Status of Agent Groups
- Method: getPath:
/ic/api/integration/v1/monitoring/agentgroups
- Retrieve Status of Agents in an Agent Group
- Method: getPath:
/ic/api/integration/v1/monitoring/agentgroups/{id}/agents
- Retrieve Status of an Agent
- Method: getPath:
/ic/api/integration/v1/monitoring/agentgroups/{id}/agents/{key}
- Retrieve Status of an Agent Group
- Method: getPath:
/ic/api/integration/v1/monitoring/agentgroups/{id}
- Retrieve the Activity Stream (Deprecated)
- Method: getPath:
/ic/api/integration/v1/monitoring/activityStream
- Clone a Package
- Method: postPath:
/ic/api/integration/v1/packages/{packagename}/clone
- Delete a Package
- Method: deletePath:
/ic/api/integration/v1/packages/{packagename}
- Export a Package
- Method: getPath:
/ic/api/integration/v1/packages/{packagename}/archive
- Import Sample Packages
- Method: postPath:
/ic/api/integration/v1/packages/loadSamples
- Import(Add) a Package
- Method: postPath:
/ic/api/integration/v1/packages/archive
- Import(Replace) a Package
- Method: putPath:
/ic/api/integration/v1/packages/archive
- Retrieve a Package
- Method: getPath:
/ic/api/integration/v1/packages/{packagename}
- Retrieve Packages
- Method: getPath:
/ic/api/integration/v1/packages
- Update Package Dependencies
- Method: postPath:
/ic/api/integration/v1/packages/{packagename}
- Deploy a Project
- Method: postPath:
/ic/api/process/v1/targets/{targetId}
- Retrieve a Deployed Project Revision
- Method: getPath:
/ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions/{revision}
- Retrieve Endpoint Configuration for Deployed Project Revision
- Method: getPath:
/ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions/{revision}/endpoints
- Retrieve Revisions of a Project
- Method: getPath:
/ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions
- Retrieve the Compatibility Report for Revisions
- Method: getPath:
/ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions/{revision}/compatibility-report
- Undeploy a Project Revision
- Method: deletePath:
/ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions/{revision}
- Update a Deployed Project Revision
- Method: patchPath:
/ic/api/process/v1/targets/{targetId}/projects/{projectId}/revisions/{revision}
- Copy a Project
- Method: postPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/clone
- Create a DesignTime Process
- Method: postPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes
- Create a Snapshot
- Method: postPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots
- Create or Import a New Project into the Space
- Method: postPath:
/ic/api/process/v1/spaces/{spaceId}/projects
- Delete a DesignTime Process
- Method: deletePath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes/{processId}
- Delete a Project
- Method: deletePath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}
- Delete a Snapshot
- Method: deletePath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots/{snapshotId}
- Deploy the Latest Published Version of a Project
- Method: postPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/deploy
- Deploy the Latest Version of a Project
- Method: postPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots/{snapshotId}/deploy
- Export a Snapshot
- Method: getPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots/{snapshotId}/exp
- Exports a Project
- Method: getPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/exp
- Generate and Export a Report for a Process
- Method: putPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes/{processId}/report
- Generate and Export a Report for All Processes
- Method: putPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/report
- Retrieve a DesignTime Process by ID
- Method: getPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes/{processId}
- Retrieve a Project by ID
- Method: getPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}
- Retrieve a Snapshot by ID
- Method: getPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots/{snapshotId}
- Retrieve Processes
- Method: getPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/processes
- Retrieve Projects
- Method: getPath:
/ic/api/process/v1/spaces/{spaceId}/projects
- Retrieve the Snapshots for a Project
- Method: getPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}/snapshots
- Update the Project Description
- Method: putPath:
/ic/api/process/v1/spaces/{spaceId}/projects/{projectId}
- Get a Dynamic Process Definition by ID
- Method: getPath:
/ic/api/process/v1/dp-definitions/{id}
- Get a List of Dynamic Process Definitions
- Method: getPath:
/ic/api/process/v1/dp-definitions
- Get Dynamic Process Definition Interface
- Method: getPath:
/ic/api/process/v1/dp-definitions/{id}/interface
- Get Dynamic Process Definition Metadata
- Method: getPath:
/ic/api/process/v1/dp-definitions/{id}/metadata
- Control a Dynamic Process Execution
- Method: putPath:
/ic/api/process/v1/dp-executions/{id}
- Get a List of Dynamic Process Executions
- Method: getPath:
/ic/api/process/v1/dp-executions
- Get Dynamic Process Execution Details
- Method: getPath:
/ic/api/process/v1/dp-executions/{id}
- Get the folder details
- Method: getPath:
/ic/api/process/v1/dp-instances/{id}/folders/{folderId}
- Control a Dynamic Process Instance
- Method: putPath:
/ic/api/process/v1/dp-instances/{id}
- Create a New Dynamic Process Instance
- Method: postPath:
/ic/api/process/v1/dp-instances
- Get a Dynamic Process Instance by ID
- Method: getPath:
/ic/api/process/v1/dp-instances/{id}
- Get a List of Dynamic Process Instances
- Method: getPath:
/ic/api/process/v1/dp-instances
- Get list of folders associated with a dynamic-process instance
- Method: getPath:
/ic/api/process/v1/dp-instances/{id}/folders
- Get Variable Data
- Method: getPath:
/ic/api/process/v1/dp-instances/{id}/variables/{variableName}
- Get Variables for Dynamic Process Instance
- Method: getPath:
/ic/api/process/v1/dp-instances/{id}/variables
- Get a Dynamic Process Resource
- Method: getPath:
/ic/api/process/v1/dp-resources/{name}
- Get a List of Dynamic Process Resources
- Method: getPath:
/ic/api/process/v1/dp-resources
- Add, Update or Delete Permissions for a Role
- Method: postPath:
/ic/api/process/v1/dp-roles/{id}/permissions
- Add, Update, or Delete Members for a Role
- Method: postPath:
/ic/api/process/v1/dp-roles/{id}/members
- Create a New Dynamic Process Role
- Method: postPath:
/ic/api/process/v1/dp-roles
- Delete a Dynamic Process Role
- Method: deletePath:
/ic/api/process/v1/dp-roles/{id}
- Get a Dynamic Process Role
- Method: getPath:
/ic/api/process/v1/dp-roles/{id}
- Get Dynamic Process Role Permissions
- Method: getPath:
/ic/api/process/v1/dp-roles/{id}/permissions
- Get Members for a Dynamic Process Role
- Method: getPath:
/ic/api/process/v1/dp-roles/{id}/members
- List Dynamic Process Roles
- Method: getPath:
/ic/api/process/v1/dp-roles
- Update a Dynamic Process Role
- Method: putPath:
/ic/api/process/v1/dp-roles/{id}
- Add a Member to a Role/Remove a Member from a Role
- Method: postPath:
/ic/api/process/v1/identities/roles/{roleid}/members
- Delete an Application Role
- Method: deletePath:
/ic/api/process/v1/identities/roles/{roleid}
- Retrieve a Group
- Method: getPath:
/ic/api/process/v1/identities/groups/{groupid}
- Retrieve a Logged in User
- Method: getPath:
/ic/api/process/v1/identities/loggedInUser
- Retrieve a Role
- Method: getPath:
/ic/api/process/v1/identities/roles/{roleid}
- Retrieve a User
- Method: getPath:
/ic/api/process/v1/identities/users/{userid}
- Retrieve All Users, Groups or Roles
- Method: getPath:
/ic/api/process/v1/identities/{scope}
- Retrieve Identities
- Method: getPath:
/ic/api/process/v1/identities
- Retrieve Members in a Role
- Method: getPath:
/ic/api/process/v1/identities/roles/{roleid}/members
- Retrieve users in a group
- Method: getPath:
/ic/api/process/v1/identities/groups/{groupid}/users
- Delete User and Application Preferences for the Logged in User
- Method: deletePath:
/ic/api/process/v1/preferences
- Delete User Preferences for Users
- Method: deletePath:
/ic/api/process/v1/preferences/bulk
- Get User and Application Preferences for the Logged in User
- Method: getPath:
/ic/api/process/v1/preferences
- Grant or Revoke Preferences for the Logged in User
- Method: postPath:
/ic/api/process/v1/preferences
- Grant or Revoke Preferences for Users
- Method: putPath:
/ic/api/process/v1/preferences/bulk
- Create or Execute an Analytics Query
- Method: postPath:
/ic/api/process/v1/analyticsqueries
- Delete a Business Query
- Method: deletePath:
/ic/api/process/v1/analyticsqueries/{businessQueryId}
- Retrieve Analytics Query Definition or Execution Result
- Method: getPath:
/ic/api/process/v1/analyticsqueries/{businessQueryId}
- Retrieve Available Columns for Data Source
- Method: getPath:
/ic/api/process/v1/analyticsqueries-datasources/{dataSource}/columns
- Retrieve Data Sources
- Method: getPath:
/ic/api/process/v1/analyticsqueries-datasources
- Retrieve DataObject names
- Method: getPath:
/ic/api/process/v1/analyticsdataobjects
- Retrieve DataObject's data
- Method: getPath:
/ic/api/process/v1/analyticsdataobjects/{dataObjectName}/data
- Retrieve DataObject's Metadata
- Method: getPath:
/ic/api/process/v1/analyticsdataobjects/{dataObjectName}
- Retrieve Supported Aggregate Operations
- Method: getPath:
/ic/api/process/v1/analyticsqueries-aggregateoperations
- Retrieve Supported Comparison Operators
- Method: getPath:
/ic/api/process/v1/analyticsqueries-comparisonoperators
- Return Links of DataSource Columns
- Method: getPath:
/ic/api/process/v1/analyticsqueries-datasources/{dataSource}
- Returns OOTB and Business Queries
- Method: getPath:
/ic/api/process/v1/analyticsqueries
- Update Business Query
- Method: putPath:
/ic/api/process/v1/analyticsqueries/{businessQueryId}
- Retrieve a Form Instance for a Webform
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/{serviceName}/webform
- Retrieve a Managed Folder Metadata
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/documents/managed-folders/{folderName}
- Retrieve an Incoming Folder Metadata
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-folders/{folderName}
- Retrieve Conversation Metadata
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/conversations/{conversationName}
- Retrieve Conversations
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/conversations
- Retrieve Document Metadata
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/documents
- Retrieve Incoming Document Metadata
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-documents
- Retrieve Incoming Document Metadata for a Document
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-documents/{documentName}
- Retrieve Incoming Folders Metadata
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-folders
- Retrieve Process Definitions
- Method: getPath:
/ic/api/process/v1/process-definitions
- Retrieve Process Metadata
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/process-metadata
- Retrieve the Managed Folders Metadata
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/documents/managed-folders
- Retrieve the Startup Folder Name
- Method: getPath:
/ic/api/process/v1/process-definitions/{processDefId}/startFolderName
- Update the Interface Type for Process Definitions (Deprecated)
- Method: putPath:
/ic/api/process/v1/process-definitions
- Add Attachments to a Process
- Method: postPath:
/ic/api/process/v1/processes/{processId}/attachments
- Add Comments to a Process
- Method: postPath:
/ic/api/process/v1/processes/{processId}/comments
- Create a Process Instance
- Method: postPath:
/ic/api/process/v1/processes
- Delete Process Attachments
- Method: deletePath:
/ic/api/process/v1/processes/{processId}/attachments/{attachmentId}
- Get Faults for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/faults
- Perform Actions on a List of Instances
- Method: putPath:
/ic/api/process/v1/processes
- Retrieve a Conversation for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/conversations/{conversationId}
- Retrieve a Process Attachment as a Stream
- Method: getPath:
/ic/api/process/v1/processes/{processId}/attachments/{attachmentName}/stream
- Retrieve a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}
- Retrieve a Process Instance by case ID
- Method: getPath:
/ic/api/process/v1/processes/dynamic-process/{executionId}
- Retrieve Activities Flow for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/activityflows
- Retrieve Conversations for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/conversations
- Retrieve Data Objects by Open Activity ID
- Method: getPath:
/ic/api/process/v1/processes/{processId}/activities/{activityId}/dataobjects
- Retrieve Data Objects for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/dataobjects
- Retrieve Instance Metrics for the User
- Method: getPath:
/ic/api/process/v1/processes/instance-metrics
- Retrieve Open activities for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/activities
- Retrieve the Approval Outcome
- Method: getPath:
/ic/api/process/v1/processes/{processId}/approval
- Retrieve the Attachment List for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/attachments
- Retrieve the Audit Diagram of a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/audit
- Retrieve the Audit Instance Payload document for given audit query ID
- Method: getPath:
/ic/api/process/v1/processes/{processId}/audit/{queryId}/payload
- Retrieve the Comment List for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/comments
- Retrieve the DOCs folder Details for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/folders/{folderId}
- Retrieve the List of DOCs Folders for a Process Instance
- Method: getPath:
/ic/api/process/v1/processes/{processId}/folders
- Retrieve the Process Instance List
- Method: getPath:
/ic/api/process/v1/processes
- Update the Process State
- Method: putPath:
/ic/api/process/v1/processes/{processId}
- Delete a QuickStart App
- Method: deletePath:
/ic/api/process/v1/quickStartApps/{quickStartAppId}
- Retrieve a QuickStart App by ID
- Method: getPath:
/ic/api/process/v1/quickStartApps/{quickStartAppId}
- Retrieve QuickStart Apps
- Method: getPath:
/ic/api/process/v1/quickStartApps
- Add a User to a Space
- Method: putPath:
/ic/api/process/v1/spaces/{spaceId}/permissions/{principal}
- Create a Space
- Method: postPath:
/ic/api/process/v1/spaces
- Delete a Space
- Method: deletePath:
/ic/api/process/v1/spaces/{spaceId}
- List Permissions Assigned to a Space
- Method: getPath:
/ic/api/process/v1/spaces/{spaceId}/permissions
- Remove User from a Space
- Method: deletePath:
/ic/api/process/v1/spaces/{spaceId}/permissions/{principal}
- Retrieve a Space by ID
- Method: getPath:
/ic/api/process/v1/spaces/{spaceId}
- Retrieve Permission Details
- Method: getPath:
/ic/api/process/v1/spaces/{spaceId}/permissions/{principal}
- Retrieve Spaces
- Method: getPath:
/ic/api/process/v1/spaces
- Add a Task Attachment
- Method: postPath:
/ic/api/process/v1/tasks/{id}/attachments
- Add a Task Comment
- Method: postPath:
/ic/api/process/v1/tasks/{id}/comments
- Delete a Task Attachment
- Method: deletePath:
/ic/api/process/v1/tasks/{id}/attachments/{attachmentName}
- Perform an Action on a Task
- Method: putPath:
/ic/api/process/v1/tasks/{id}
- Perform Bulk Action on Tasks
- Method: putPath:
/ic/api/process/v1/tasks
- Retrieve a Custom Task List
- Method: getPath:
/ic/api/process/v1/tasks/views/{viewname}
- Retrieve a List of Task Conversations
- Method: getPath:
/ic/api/process/v1/tasks/{id}/conversations
- Retrieve a Task
- Method: getPath:
/ic/api/process/v1/tasks/{id}
- Retrieve a Task Attachment as a Stream
- Method: getPath:
/ic/api/process/v1/tasks/{id}/attachments/{attachmentName}/stream
- Retrieve a Task Attachment by Name
- Method: getPath:
/ic/api/process/v1/tasks/{id}/attachments/{attachmentName}
- Retrieve a Task Conversation by Conversation ID
- Method: getPath:
/ic/api/process/v1/tasks/{id}/conversations/{conversationId}
- Retrieve a Task List
- Method: getPath:
/ic/api/process/v1/tasks
- Retrieve Custom Task Lists
- Method: getPath:
/ic/api/process/v1/tasks/views
- Retrieve DOCs Folder Details by Folder ID for a Task
- Method: getPath:
/ic/api/process/v1/tasks/{id}/folders/{folderId}
- Retrieve DOCs Folder Details for a Task
- Method: getPath:
/ic/api/process/v1/tasks/{id}/folders
- Retrieve Task Attachments
- Method: getPath:
/ic/api/process/v1/tasks/{id}/attachments
- Retrieve Task Comments
- Method: getPath:
/ic/api/process/v1/tasks/{id}/comments
- Retrieve Task History
- Method: getPath:
/ic/api/process/v1/tasks/{id}/history
- Retrieve Task Metrics for the User
- Method: getPath:
/ic/api/process/v1/tasks/task-metrics
- Retrieve the Task Payload
- Method: getPath:
/ic/api/process/v1/tasks/{id}/payload
- Update the Task Payload
- Method: postPath:
/ic/api/process/v1/tasks/{id}/payload