REST API for Oracle Integration 3

All REST Endpoints

B2B/Document Customization

The operations from the B2B/Document Customization category.

Clone a B2B Document: Method: post
Path: /ic/api/b2b/v1/b2bdocuments/{documentId}/clone
Clone a B2B Schema: Method: post
Path: /ic/api/b2b/v1/schemas/{schemaId}/clone
Create a B2B Document: Method: post
Path: /ic/api/b2b/v1/b2bdocuments
Create a B2B Schema: Method: post
Path: /ic/api/b2b/v1/schemas
Create a B2B Schema from an SEF File: Method: post
Path: /ic/api/b2b/v1/import
Delete a B2B Document: Method: delete
Path: /ic/api/b2b/v1/b2bdocuments/{documentId}
Delete a B2B Schema: Method: delete
Path: /ic/api/b2b/v1/schemas/{schemaId}
Export a B2B Document: Method: get
Path: /ic/api/b2b/v1/b2bdocuments/{documentId}/export
Export a B2B Schema: Method: get
Path: /ic/api/b2b/v1/schemas/{schemaId}/export
Generate a Schema Implementation Guide: Method: get
Path: /ic/api/b2b/v1/schemas/{schemaId}/guide
Import a B2B Document: Method: post
Path: /ic/api/b2b/v1/b2bdocuments/import
Import a B2B Schema: Method: post
Path: /ic/api/b2b/v1/schemas/import
Retrieve a B2B Document: Method: get
Path: /ic/api/b2b/v1/b2bdocuments/{documentId}
Retrieve a B2B Schema: Method: get
Path: /ic/api/b2b/v1/schemas/{schemaId}
Retrieve an Element's Code List: Method: get
Path: /ic/api/b2b/v1/schemas/{schemaId}/{elementId}/codes
Retrieve B2B Document Standards: Method: get
Path: /ic/api/b2b/v1/standards
Retrieve B2B Document Types: Method: get
Path: /ic/api/b2b/v1/standards/{standardId}/{versionId}/{transactionId}
Retrieve B2B Documents: Method: get
Path: /ic/api/b2b/v1/b2bdocuments
Retrieve B2B Schemas: Method: get
Path: /ic/api/b2b/v1/schemas
Retrieve Document Transactions: Method: get
Path: /ic/api/b2b/v1/standards/{standardId}/{versionId}
Retrieve Document Versions: Method: get
Path: /ic/api/b2b/v1/standards/{standardId}
Retrieve Documents for a B2B Schema: Method: get
Path: /ic/api/b2b/v1/schemas/{schemaId}/documents
Retrieve Integrations Using a B2B Document: Method: get
Path: /ic/api/b2b/v1/b2bdocuments/{documentId}/integrations
Retrieve Trading Partners using a B2B Document: Method: get
Path: /ic/api/b2b/v1/b2bdocuments/{documentId}/partners
Update a B2B Document: Method: put
Path: /ic/api/b2b/v1/b2bdocuments/{documentId}
Update a B2B Schema: Method: put
Path: /ic/api/b2b/v1/schemas/{schemaId}

B2B/Monitoring

The operations from the B2B/Monitoring category.

Download B2B Business Message Payload: Method: get
Path: /ic/api/b2b/v1/monitoring/businessmessages/{id}/payload/download
Download B2B Wire Message Payload: Method: get
Path: /ic/api/b2b/v1/monitoring/wiremessages/{id}/payload/download
Retrieve Business Message Details: Method: get
Path: /ic/api/b2b/v1/monitoring/businessmessages/{id}
Retrieve Business Messages: Method: get
Path: /ic/api/b2b/v1/monitoring/businessmessages
Retrieve the Wire Message Payload: Method: get
Path: /ic/api/b2b/v1/monitoring/wiremessages/{id}/payload
Retrieve Wire Message Details: Method: get
Path: /ic/api/b2b/v1/monitoring/wiremessages/{id}
Retrieve Wire Messages: Method: get
Path: /ic/api/b2b/v1/monitoring/wiremessages
View Business Message Payload: Method: get
Path: /ic/api/b2b/v1/monitoring/businessmessages/{id}/payload

B2B/Projects/B2B Documents

The operations from the B2B/Projects category.

Clone a B2B Document: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}/clone
Create a B2B Document: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/b2bdocuments
Delete a B2B Document: Method: delete
Path: /ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}
Export a B2B Document: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}/export
Import a B2B Document: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/b2bdocuments/import
Retrieve a B2B Document: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}
Retrieve B2B Documents: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/b2bdocuments
Retrieve Integrations That Use a B2B Document: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}/integrations
Retrieve Trading Partners of a B2B Document: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}/partners
Update a B2B Document: Method: put
Path: /ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}

B2B/Projects/Schemas

The operations from the B2B/Projects category.

Clone a B2B Schema: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}/clone
Create a B2B Schema: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/schemas
Create a B2B Schema by Importing SEF File: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/import
Delete a B2B Schema: Method: delete
Path: /ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}
Export a B2B Schema: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}/export
Generate a Schema Implementation Guide: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}/guide
Import a B2B Schema: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/schemas/import
Retrieve a B2B Schema: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}
Retrieve an Element's Code List: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}/{elementId}/codes
Retrieve B2B Schemas: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/schemas
Retrieve Documents for a B2B Schema: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}/documents
Update a B2B Schema: Method: put
Path: /ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}

B2B/Projects/Standards

The operations from the B2B/Projects category.

Retrieve B2B Document Standards: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/standards
Retrieve B2B Document Types: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/standards/{standardId}/{versionId}/{transactionId}
Retrieve Document Transactions: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/standards/{standardId}/{versionId}
Retrieve Document Versions: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/standards/{standardId}

B2B/Projects/Trading Partners

The operations from the B2B/Projects category.

Create a Trading Partner: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners
Create a Transport: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/transports
Create an Inbound Agreement: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs
Create an Outbound Agreement: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/outboundagrs
Create or Update B2B Identifiers: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/identifiers
Create or Update errorGroups for Trading Partner: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/errorGroups
Create or Update Trading Partner Contacts: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/contacts
Delete a B2B Identifier: Method: delete
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/identifiers/{identifierId}
Delete a Trading Partner: Method: delete
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}
Delete a Transport: Method: delete
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/transports/{transportId}
Delete an ErrorGroup: Method: delete
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/errorGroups/{errorGroupId}
Delete an Inbound Agreement: Method: delete
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs/{agrId}
Delete an Outbound Agreement: Method: delete
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/outboundagrs/{agrId}
Deploy a Transport: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/transports/{transportId}/deploy
Deploy an Inbound Agreement: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs/{agrId}/deploy
Deploy an Outbound Agreement: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/outboundagrs/{agrId}/deploy
Export a Trading Partner: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/export
Import a Trading Partner: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/import
Retrieve a Trading Partner: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}
Retrieve a Transport: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/transports/{transportId}
Retrieve an ErrorGroup: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/errorGroups/{errorGroupId}
Retrieve an ErrorGroup Usage: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/errorGroups/{errorGroupId}/usage
Retrieve an Inbound Agreement: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs/{agrId}
Retrieve an Outbound Agreement: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/outboundagrs/{agrId}
Retrieve B2B Identifiers: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/identifiers
Retrieve Control Numbers of a Trading Partner: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/controlNumbers
Retrieve Inbound Agreements: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs
Retrieve Outbound Agreements: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/outboundagrs
Retrieve Trading Partner Contact Details: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/contacts
Retrieve Trading Partners: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners
Retrieve Transports: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/errorCodeLookup
Retrieve Transports: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/errorGroups
Retrieve Transports: Method: get
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/transports
Set Control Numbers for a Trading Partner: Method: put
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/controlNumbers
Undeploy a Transport: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/transports/{transportId}/undeploy
Undeploy an Inbound Agreement: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs/{agrId}/undeploy
Undeploy an Outbound Agreement: Method: post
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/outboundagrs/{agrId}/undeploy
Update a Trading Partner: Method: put
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}
Update a Transport: Method: put
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/transports/{transportId}
Update an Inbound Agreement: Method: put
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs/{agrId}
Update an Outbound Agreement: Method: put
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/outboundagrs/{agrId}
Update errorGroups for Trading Partner: Method: put
Path: /ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/errorGroups/{errorGroupId}

B2B/Trading Partner

The operations from the B2B/Trading Partner category.

Create a Trading Partner: Method: post
Path: /ic/api/b2b/v1/tpm/partners
Create a Transport: Method: post
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/transports
Create an Inbound Agreement: Method: post
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs
Create an Outbound Agreement: Method: post
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs
Create/Update B2B Identifiers: Method: post
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/identifiers
Create/Update Host Profile: Method: post
Path: /ic/api/b2b/v1/tpm/host
Create/Update Trading Partner Contacts: Method: post
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/contacts
Delete a B2B Identifier: Method: delete
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/identifiers/{identifierId}
Delete a Host Identifier: Method: delete
Path: /ic/api/b2b/v1/tpm/host/{id}
Delete a Trading Partner: Method: delete
Path: /ic/api/b2b/v1/tpm/partners/{tpId}
Delete a Transport: Method: delete
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/transports/{transportId}
Delete an Inbound Agreement: Method: delete
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}
Delete an Outbound Agreement: Method: delete
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}
Deploy a Transport: Method: post
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/transports/{transportId}/deploy
Deploy an Inbound Agreement: Method: post
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}/deploy
Deploy an Outbound Agreement: Method: post
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}/deploy
Export a Trading Partner: Method: get
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/export
Import a Trading Partner: Method: post
Path: /ic/api/b2b/v1/tpm/partners/import
Retrieve a Trading Partner: Method: get
Path: /ic/api/b2b/v1/tpm/partners/{tpId}
Retrieve a Transport: Method: get
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/transports/{transportId}
Retrieve an Inbound Agreement: Method: get
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}
Retrieve an Outbound Agreement: Method: get
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}
Retrieve B2B Identifiers: Method: get
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/identifiers
Retrieve Control Numbers of a Trading Partner: Method: get
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/controlNumbers
Retrieve Inbound Agreements: Method: get
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs
Retrieve Outbound Agreements: Method: get
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs
Retrieve the Host Profile: Method: get
Path: /ic/api/b2b/v1/tpm/host
Retrieve Trading Partner Contact Details: Method: get
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/contacts
Retrieve Trading Partners: Method: get
Path: /ic/api/b2b/v1/tpm/partners
Retrieve Transports: Method: get
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/transports
Set Control Numbers for a Trading Partner: Method: put
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/controlNumbers
Undeploy a Transport: Method: post
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/transports/{transportId}/undeploy
Undeploy an Inbound Agreement: Method: post
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}/undeploy
Undeploy an Outbound Agreement: Method: post
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}/undeploy
Update a Trading Partner: Method: put
Path: /ic/api/b2b/v1/tpm/partners/{tpId}
Update a Transport: Method: put
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/transports/{transportId}
Update an Inbound Agreement: Method: put
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}
Update an Outbound Agreement: Method: put
Path: /ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}

B2B/Trading Partner Migration from SOA-B2B

The operations from the B2B/Trading Partner Migration from SOA-B2B category.

Migrate Trading Partners from SOA-B2B: Method: post
Path: /ic/api/b2b/v1/migration/partners/import

Clone Instance

The operations from the Clone Instance category.

Export Design-Time Metadata of a Service Instance: Method: post
Path: ic/api/common/v1/exportServiceInstanceArchive
Import Design-Time Metadata of a Service Instance: Method: post
Path: ic/api/common/v1/importServiceInstanceArchive
Retrieve the Status of an Export Operation: Method: get
Path: ic/api/common/v1/exportServiceInstanceArchive/{jobId}
Retrieve the Status of an Import Operation: Method: get
Path: ic/api/common/v1/importServiceInstanceArchive/{jobId}

Environment

Oracle Integration applications allow authenticated access from Oracle domains like oracle.com, oraclecorp.com, oracleonsrcloud.com, oc.scloud, oci.scloud, oracleiaas.com, and oraclecloud.com. All domains belonging to arbitrary origins need to be registered in the allowed list of sites for cross-origin resource sharing (CORS) processing. Use this API only if you want to allow access from non-Oracle cloud domains. You need Administrator permissions to use CORS related API functions.

Create a List of Domains Allowed for CORS Processing: Method: post
Path: /ic/api/integration/v1/environment/corsdomains
Delete the List of Domains Supported for CORS Processing: Method: delete
Path: /ic/api/integration/v1/environment/corsdomains
Retrieve List of Domains Allowed for CORS Processing: Method: get
Path: /ic/api/integration/v1/environment/corsdomains
Update the List of Allowed Domains for CORS Processing: Method: put
Path: /ic/api/integration/v1/environment/corsdomains

Integrations/Certificates

The operations from the Integrations/Certificates category.

Delete a Certificate: Method: delete
Path: /ic/api/integration/v1/certificates/{id}
Retrieve a Certificate: Method: get
Path: /ic/api/integration/v1/certificates/{id}
Retrieve Certificates: Method: get
Path: /ic/api/integration/v1/certificates
Update a Certificate: Method: post
Path: /ic/api/integration/v1/certificates/{id}
Upload a Certificate: Method: post
Path: /ic/api/integration/v1/certificates

Integrations/Connections

The operations from the Integrations/Connections category.

Delete a Connection: Method: delete
Path: /ic/api/integration/v1/connections/{id}
Refresh Metadata for a Connection: Method: post
Path: /ic/api/integration/v1/connections/{id}/metadata
Retrieve a Connection: Method: get
Path: /ic/api/integration/v1/connections/{id}
Retrieve Connection Property Attachment: Method: get
Path: /ic/api/integration/v1/connections/{id}/attachments/{connPropName}
Retrieve Connections: Method: get
Path: /ic/api/integration/v1/connections
Test a Connection: Method: post
Path: /ic/api/integration/v1/connections/{id}/test
Update a Connection: Method: post
Path: /ic/api/integration/v1/connections/{id}
Upload Connection Property Attachment: Method: post
Path: /ic/api/integration/v1/connections/{id}/attachments/{connPropName}
Validate a Connection: Method: post
Path: /ic/api/integration/v1/connections/{id}/validate
Validate and Test a Connection: Method: post
Path: /ic/api/integration/v1/connections/{id}/testWithAttachments

Integrations/Event Types

The operations from the Integrations/Event Types category.

Clone an Event Type: Method: post
Path: /ic/api/integration/v1/eventTypes/{id}/clone
Create an Event Type: Method: post
Path: /ic/api/integration/v1/eventTypes
Delete an Event Type: Method: delete
Path: /ic/api/integration/v1/eventTypes/{code}
Retrieve an Event Type: Method: get
Path: /ic/api/integration/v1/eventTypes/{id}
Retrieve Event Types: Method: get
Path: /ic/api/integration/v1/eventTypes
Update an Event Type: Method: post
Path: /ic/api/integration/v1/eventTypes/{id}/update

Integrations/Integrations

The operations from the Integrations/Integrations category.

Clone an Integration: Method: post
Path: /ic/api/integration/v1/integrations/{id}/clone
Delete an Integration Version: Method: delete
Path: /ic/api/integration/v1/integrations/{id}
Export an Integration: Method: get
Path: /ic/api/integration/v1/integrations/{id}/archive
Import (Replace) an Integration: Method: put
Path: /ic/api/integration/v1/integrations/archive
Import(Add) an Integration: Method: post
Path: /ic/api/integration/v1/integrations/archive
Retrieve an Integration: Method: get
Path: /ic/api/integration/v1/integrations/{id}
Retrieve Integration Activation Errors: Method: get
Path: /ic/api/integration/v1/integrations/{id}/activationErrors
Retrieve Integration Activation Status: Method: get
Path: /ic/api/integration/v1/integrations/{id}/activationStatus
Retrieve Integrations: Method: get
Path: /ic/api/integration/v1/integrations
Update(Activate/Deactivate) an Integration: Method: post
Path: /ic/api/integration/v1/integrations/{id}

Integrations/Integrations/Scheduled Integrations

The operations from the Integrations/Integrations/Scheduled Integrations category.

Add a Schedule: Method: post
Path: /ic/api/integration/v1/integrations/{id}/schedule
Pause an Integration Schedule: Method: post
Path: /ic/api/integration/v1/integrations/{id}/schedule/pause
Resume an Integration Schedule: Method: post
Path: /ic/api/integration/v1/integrations/{id}/schedule/resume
Retrieve a Schedule: Method: get
Path: /ic/api/integration/v1/integrations/{id}/schedule
Run a Scheduled Integration Now: Method: post
Path: /ic/api/integration/v1/integrations/{id}/schedule/jobs
Start an Integration Schedule: Method: post
Path: /ic/api/integration/v1/integrations/{id}/schedule/start
Stop an Integration Schedule: Method: post
Path: /ic/api/integration/v1/integrations/{id}/schedule/stop
Update a Schedule: Method: put
Path: /ic/api/integration/v1/integrations/{id}/schedule
Update Scheduled Integration Parameters: Method: patch
Path: /ic/api/integration/v1/integrations/{id}/schedule/parameters

Integrations/Libraries

The operations from the Integrations/Libraries category.

Delete a Library Version: Method: delete
Path: /ic/api/integration/v1/libraries/{id}
Export a Library: Method: get
Path: /ic/api/integration/v1/libraries/{id}/archive
Export Library Metadata (Deprecated): Method: get
Path: /ic/api/integration/v1/libraries/{id}/metadata
Import Library Metadata (Deprecated): Method: post
Path: /ic/api/integration/v1/libraries/{id}/metadata
Import(Register) a Library: Method: post
Path: /ic/api/integration/v1/libraries/archive
Retrieve a Library: Method: get
Path: /ic/api/integration/v1/libraries/{id}
Retrieve Libraries: Method: get
Path: /ic/api/integration/v1/libraries
Update a Library: Method: post
Path: /ic/api/integration/v1/libraries/{id}/archive

Integrations/Lookups

The operations from the Integrations/Lookups category.

Clone a Lookup: Method: post
Path: /ic/api/integration/v1/lookups/{name}/clone
Create a Lookup: Method: post
Path: /ic/api/integration/v1/lookups
Delete a Lookup: Method: delete
Path: /ic/api/integration/v1/lookups/{name}
Export a Lookup: Method: get
Path: /ic/api/integration/v1/lookups/{name}/archive
Import(Add) a Lookup: Method: post
Path: /ic/api/integration/v1/lookups/archive
Import(Replace) a Lookup: Method: put
Path: /ic/api/integration/v1/lookups/archive
Retrieve a Lookup: Method: get
Path: /ic/api/integration/v1/lookups/{name}
Retrieve Lookups: Method: get
Path: /ic/api/integration/v1/lookups
Retrieve Usage of the Lookup: Method: get
Path: /ic/api/integration/v1/lookups/{name}/usage
Update a Lookup: Method: put
Path: /ic/api/integration/v1/lookups/{name}

Integrations/Monitoring

The operations from the Integrations/Monitoring category.

Abort an Integration Instance: Method: post
Path: /ic/api/integration/v1/monitoring/instances/{id}/abort
Discard an Errored Integration Instance: Method: post
Path: /ic/api/integration/v1/monitoring/errors/{id}/discard
Discard Errored Integration Instances: Method: post
Path: /ic/api/integration/v1/monitoring/errors/discard
Download Large Payload in an Integration Instance: Method: get
Path: /ic/api/integration/v1/monitoring/instances/{id}/activityStreamDetails/{+key}
Resubmit an Errored Integration Instance: Method: post
Path: /ic/api/integration/v1/monitoring/errors/{id}/resubmit
Resubmit Errored Integration Instances: Method: post
Path: /ic/api/integration/v1/monitoring/errors/resubmit
Retrieve an Error Recovery Job: Method: get
Path: /ic/api/integration/v1/monitoring/errors/recoveryJobs/{id}
Retrieve an Errored Integration Instance: Method: get
Path: /ic/api/integration/v1/monitoring/errors/{id}
Retrieve an Integration Instance: Method: get
Path: /ic/api/integration/v1/monitoring/instances/{id}
Retrieve Audit Records: Method: get
Path: /ic/api/integration/v1/monitoring/auditRecords
Retrieve Error Recovery Jobs: Method: get
Path: /ic/api/integration/v1/monitoring/errors/recoveryJobs
Retrieve Errored Instances: Method: get
Path: /ic/api/integration/v1/monitoring/errors
Retrieve Historical Tracking Metrics: Method: get
Path: /ic/api/integration/v1/monitoring/history
Retrieve Integration Instance Activity Stream (Deprecated): Method: get
Path: /ic/api/integration/v1/monitoring/instances/{id}/activityStream
Retrieve Integration Instance Activity Stream Details: Method: get
Path: /ic/api/integration/v1/monitoring/instances/{id}/activityStreamDetails
Retrieve Integration Instances: Method: get
Path: /ic/api/integration/v1/monitoring/instances
Retrieve Message Count Summary: Method: get
Path: /ic/api/integration/v1/monitoring/integrations/messages/summary
Retrieve Monitoring Data for an Integration: Method: get
Path: /ic/api/integration/v1/monitoring/integrations/{id}
Retrieve Monitoring Data for Integrations: Method: get
Path: /ic/api/integration/v1/monitoring/integrations
Retrieve Status of Agent Groups: Method: get
Path: /ic/api/integration/v1/monitoring/agentgroups
Retrieve Status of Agents in an Agent Group: Method: get
Path: /ic/api/integration/v1/monitoring/agentgroups/{id}/agents
Retrieve Status of an Agent: Method: get
Path: /ic/api/integration/v1/monitoring/agentgroups/{id}/agents/{key}
Retrieve Status of an Agent Group: Method: get
Path: /ic/api/integration/v1/monitoring/agentgroups/{id}

Integrations/Packages

The operations from the Integrations/Packages category.

Delete a Package: Method: delete
Path: /ic/api/integration/v1/packages/{packagename}
Export a Package: Method: get
Path: /ic/api/integration/v1/packages/{packagename}/archive
Import Sample Packages (Deprecated): Method: post
Path: /ic/api/integration/v1/packages/loadSamples
Import(Add) a Package: Method: post
Path: /ic/api/integration/v1/packages/archive
Import(Replace) a Package: Method: put
Path: /ic/api/integration/v1/packages/archive
Retrieve a Package: Method: get
Path: /ic/api/integration/v1/packages/{packagename}
Retrieve Packages: Method: get
Path: /ic/api/integration/v1/packages
Update Package Dependencies: Method: post
Path: /ic/api/integration/v1/packages/{packagename}

Integrations/Projects

The operations from the Integrations/Projects category.

Delete a Project: Method: delete
Path: /ic/api/integration/v1/projects/{id}
Export a Project: Method: post
Path: /ic/api/integration/v1/projects/{id}/archive
Import(Add) a Project: Method: post
Path: /ic/api/integration/v1/projects/archive
Retrieve a Project: Method: get
Path: /ic/api/integration/v1/projects/{id}
Retrieve Projects: Method: get
Path: /ic/api/integration/v1/projects

Integrations/Projects/Connections

The operations from the Integrations/Projects/Connections category.

Delete a Connection in a Project: Method: delete
Path: /ic/api/integration/v1/projects/{projectId}/connections/{id}
Retrieve a Connection in a Project: Method: get
Path: /ic/api/integration/v1/projects/{projectId}/connections/{id}
Retrieve Connections in a Project: Method: get
Path: /ic/api/integration/v1/projects/{projectId}/connections
Test a Connection in a Project: Method: post
Path: /ic/api/integration/v1/projects/{projectId}/connections/{id}/test
Update a Connection in a Project: Method: post
Path: /ic/api/integration/v1/projects/{projectId}/connections/{id}

Integrations/Projects/Deployments

The operations from the Integrations/Projects/Deployments category.

Create a Deployment in a Project: Method: post
Path: /ic/api/integration/v1/projects/{projectId}/deployments
Delete a Deployment in a Project: Method: delete
Path: /ic/api/integration/v1/projects/{projectId}/deployments/{id}
Retrieve a Deployment in a Project: Method: get
Path: /ic/api/integration/v1/projects/{projectId}/deployments/{id}
Retrieve Deployments in a Project: Method: get
Path: /ic/api/integration/v1/projects/{projectId}/deployments
Update a Deployment in a Project: Method: post
Path: /ic/api/integration/v1/projects/{projectId}/deployments/{id}

Integrations/Projects/Integrations

The operations from the Integrations/Projects/Integrations category.

Delete an Integration Version in a Project: Method: delete
Path: /ic/api/integration/v1/projects/{projectId}/integrations/{id}
Import (Add) an Integration in a Project: Method: post
Path: /ic/api/integration/v1/projects/{projectId}/integrations/archive
Retrieve an Integration in a Project: Method: get
Path: /ic/api/integration/v1/projects/{projectId}/integrations/{id}
Retrieve Integrations in a Project: Method: get
Path: /ic/api/integration/v1/projects/{projectId}/integrations
Update an Integration in a Project: Method: post
Path: /ic/api/integration/v1/projects/{projectId}/integrations/{id}

Integrations/Projects/Libraries

The operations from the Integrations/Projects/Libraries category.

Delete a Library Version in a Project: Method: delete
Path: /ic/api/integration/v1/projects/{projectId}/libraries/{id}
Import (Register) a Library in a Project: Method: post
Path: /ic/api/integration/v1/projects/{projectId}/libraries/archive
Retrieve a Library in a Project: Method: get
Path: /ic/api/integration/v1/projects/{projectId}/libraries/{id}
Retrieve Libraries in a Project: Method: get
Path: /ic/api/integration/v1/projects/{projectId}/libraries
Update a Library in a Project: Method: post
Path: /ic/api/integration/v1/projects/{projectId}/libraries/{id}/archive

Integrations/Projects/Lookups

The operations from the Integrations/Projects/Lookups category.

Delete a Lookup in a Project: Method: delete
Path: /ic/api/integration/v1/projects/{projectId}/lookups/{name}
Import (Add) a Lookup in a Project: Method: post
Path: /ic/api/integration/v1/projects/{projectId}/lookups/archive
Retrieve a Lookup in a Project: Method: get
Path: /ic/api/integration/v1/projects/{projectId}/lookups/{name}
Retrieve Lookups in a Project: Method: get
Path: /ic/api/integration/v1/projects/{projectId}/lookups
Update a Lookup in a Project: Method: put
Path: /ic/api/integration/v1/projects/{projectId}/lookups/{name}

Integrations/Projects/RBAC

The operations from the Integrations/Projects/RBAC category.

Retrieve Project RBAC Details: Method: get
Path: /ic/api/integration/v1/projects/{id}/acl
Update Project RBAC Details: Method: put
Path: /ic/api/integration/v1/projects/{id}/acl

Integrations/Usages

The operations from the Integrations/Usages category.

Retrieve Integration Usages: Method: get
Path: /ic/api/integration/v1/usage

Rapid Adapter Builder

Delete Rapid Adapter Builder Adapter: Method: delete
Path: /ic/api/adapters/v1/adapterBundles/{id}
Get Rapid Adapter Builder Adapter: Method: get
Path: /ic/api/adapters/v1/adapterBundles/{id}
List All Rapid Adapter Builder Adapters: Method: get
Path: /ic/api/adapters/v1/adapterBundles
Register Rapid Adapter Builder Adapter: Method: post
Path: /ic/api/adapters/v1/adapterBundles
Update a Rapid Adapter Builder Adapter: Method: put
Path: /ic/api/adapters/v1/adapterBundles/{id}