{ "swagger":"2.0", "info":{ "description":"

Last Update: May, 2023

\n\nUse the REST API for Oracle Integration to automate business processes and integrate applications.

These REST APIs apply to all of your Oracle Integration instances. It doesn't matter which edition you're using, what features you have, or who manages your cloud environment. You'll find all the resources you need in this REST API for Oracle Integration.

If you're an administrator for Oracle Integration Classic (Oracle Integration in a user-managed environment), see REST API for Managing Oracle Integration Classic (User-Managed) for additional REST APIs.

\n\n", "version":"2024.06.04", "title":"REST API for Oracle Integration", "termsOfService":"https://oracle.com", "contact":{ "email":"noreply@oracle.com" }, "license":{ "name":"Oracle License", "url":"http://www.apache.org/licenses/LICENSE-2.0.html" }, "x-summary":"Last Update: May, 2023 Use the REST API for Oracle Integration to automate business processes and integrate applications." }, "tags":[ { "name":"B2B/Document Customization", "description":"The operations from the B2B/Document Customization category." }, { "name":"B2B/Monitoring", "description":"The operations from the B2B/Monitoring category." }, { "name":"B2B/Trading Partner", "description":"The operations from the B2B/Trading Partner category." }, { "name":"Decision Modeling Service", "description":"Manage decision models in Oracle Integration." }, { "name":"Environment", "description":"OIC applications do not allow authenticated access from arbitrary origins. All domains belonging to arbitrary origins need to be registered in the allowed list of sites for cross-origin resource sharing (CORS) processing. Retrieve, create, and update the list of allowed sites for CORS processing. You need Administrator permissions to use these API functions." }, { "name":"Integrations/Connections", "description":"Retrieve, update and delete connections and connection attachments. Connections define information about the instances of each configuration you are integrating. Oracle Integration includes a set of predefined adapters, which are the types of applications on which you can base your connections. A connection is based on an adapter." }, { "name":"Integrations/Integrations", "description":"Retrieve, import, export, update, activate, deactivate, publish, and delete integrations." }, { "name":"Integrations/Integrations/Scheduled Integrations", "description":"The operations from the Integrations/Integrations/Scheduled Integrations category." }, { "name":"Integrations/Libraries", "description":"

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.

" }, { "name":"Integrations/Lookups", "description":"

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.

" }, { "name":"Integrations/Monitoring", "description":"Retrieve and filter integration monitoring data." }, { "name":"Integrations/Packages", "description":"Retrieve, update and delete packages. Use packages to group one or more integrations into a single structure. Packages enable you to easily import and export a group of integrations to and from Oracle Integration. Packages are optional, meaning that integrations do not need to be part of packages." }, { "name":"Process/Deployed Projects", "description":"Manage deployed projects." }, { "name":"Process/Designtime Projects", "description":"Create and manage lifecycle operations of projects." }, { "name":"Process/Dynamic Process Definitions", "description":"Manage dynamic process definitions." }, { "name":"Process/Dynamic Process Executions", "description":"Manage dynamic process executions. Dynamic process executions are all the activities within the dynamic process such as processes, human tasks, stages, milestones. Each activity is identified with an execution ID." }, { "name":"Process/Dynamic Process Instances", "description":"Manage dynamic process instances." }, { "name":"Process/Dynamic Process Resources", "description":"Manage dynamic process resources." }, { "name":"Process/Dynamic Process Roles", "description":"Manage dynamic process roles." }, { "name":"Process/Identities", "description":"Manage Identities" }, { "name":"Process/Preferences", "description":"Manage user and application preferences. User preferences are individual preferences and include notification time zone, task list size and grouping, and task delegation when out of office. Users can set their own preferences. Administrators can additionally set and delete application preferences. Application preferences can only be set by administrators." }, { "name":"Process/Process Analytics", "description":"Retrieve AnalyticsQueries." }, { "name":"Process/Process Definitions", "description":"Retrieve Process Definitions" }, { "name":"Process/Process Instances", "description":"Create and retrieve information about process instances." }, { "name":"Process/QuickStart Apps", "description":"Create and manage QuickStart apps." }, { "name":"Process/Spaces", "description":"Create and manage spaces." }, { "name":"Process/Tasks", "description":"Retrieve task lists. Retrieve, create, update, and delete tasks." } ], "schemes":[ "https", "http" ], "paths":{ "/ic/api/integration/v1/connections":{ "get":{ "tags":[ "Integrations/Connections" ], "summary":"Retrieve Connections", "description":"Retrieves information about all connections ordered by the last updated time.", "operationId":"getConnections", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"q", "in":"query", "description":"

Filters connections by name, status, and role.

Valid parameters:

", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"

Lists connections ordered by name, last updated time, or adapter type.

Valid values:

", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Includes additional details about the adapter in the response. Valid value: adapter", "required":false, "type":"string" }, { "name":"offset", "in":"query", "description":"Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list connections starting at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" }, { "name":"limit", "in":"query", "description":"Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list connections starting at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ConnectionsRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-connections-get", "x-filename-id":"ic-api-integration-v1-connections-get" } }, "/ic/api/integration/v1/connections/{id}":{ "get":{ "tags":[ "Integrations/Connections" ], "summary":"Retrieve a Connection", "description":"Retrieves detailed information about the connection with the specified ID.", "operationId":"getConnection", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=UTF-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "type":"string" }, { "name":"expand", "in":"query", "description":"Includes additional details about the adapter in the response. Valid value: adapter", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ConnectionRs" } }, "404":{ "description":"Connection not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-connections-{id}-get", "x-filename-id":"ic-api-integration-v1-connections-id-get" }, "post":{ "tags":[ "Integrations/Connections" ], "summary":"Update a Connection", "description":"

Updates the security properties, connection properties, agentGroupId, or securityPolicy of a connection. Other properties are ignored.

Supported security properties depend on the selected securityPolicy and the connection type. The connection type also determines the supported securityPolicy values.

", "operationId":"updateConnection", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=UTF-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "type":"string" }, { "name":"X-HTTP-Method-Override", "in":"header", "description":"HTTP Method override in the header", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Connection resource", "required":true, "schema":{ "$ref":"#/definitions/ConnectionRs" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ConnectionRs" } }, "400":{ "description":"Missing header information" }, "404":{ "description":"Connection not found" }, "423":{ "description":"Connection is locked" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-connections-{id}-post", "x-filename-id":"ic-api-integration-v1-connections-id-post" }, "delete":{ "tags":[ "Integrations/Connections" ], "summary":"Delete a Connection", "description":"Deletes the connection with the specified ID.", "operationId":"deleteConnection", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Connection not found" }, "423":{ "description":"Connection is locked" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-connections-{id}-delete", "x-filename-id":"ic-api-integration-v1-connections-id-delete" } }, "/ic/api/integration/v1/connections/{id}/attachments/{connPropName}":{ "get":{ "tags":[ "Integrations/Connections" ], "summary":"Retrieve Connection Property Attachment", "description":"Downloads the attachment associated with the specified connection property. This operation returns a byte stream that is output to the display by default. In cURL, use the -o option to specify the file in which to save the response.", "operationId":"getAttachment", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/octet-stream" ], "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier.", "required":true, "type":"string" }, { "name":"connPropName", "in":"path", "description":"Connection property name.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "type":"string", "format":"byte" } } }, "404":{ "description":"Not found" }, "423":{ "description":"Connection is locked" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-connections-{id}-attachments-{connPropName}-get", "x-filename-id":"ic-api-integration-v1-connections-id-attachments-connpropname-get" }, "post":{ "tags":[ "Integrations/Connections" ], "summary":"Upload Connection Property Attachment", "description":"Uploads an attachment (such as a WSDL file) to a connection and associates the attachment with a specific connection property. If you are using cURL, use the -F option to specify the file to upload.", "operationId":"uploadAttachment", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier.", "required":true, "type":"string" }, { "name":"connPropName", "in":"path", "description":"Connection property name. For example: targetWSDLURL", "required":true, "type":"string" }, { "name":"serviceWSDL", "in":"query", "description":"Path and name of the WSDL file in the zip file. For example: serviceWSDL=/path/source.wsdl", "required":false, "type":"string" }, { "name":"file", "in":"formData", "description":"Upload connection attachment.", "required":true, "type":"file" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ConnectionRs" } }, "400":{ "description":"No file is uploaded" }, "404":{ "description":"Connection not found" }, "423":{ "description":"Connection is locked" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-connections-{id}-attachments-{connPropName}-post", "x-filename-id":"ic-api-integration-v1-connections-id-attachments-connpropname-post" } }, "/ic/api/integration/v1/connections/{id}/metadata":{ "post":{ "tags":[ "Integrations/Connections" ], "summary":"Refresh Metadata for a Connection", "description":"Refreshes the metadata of the adapter associated with the connection. Only applies to adapters that have implemented metadata caching.", "operationId":"refreshMetadata", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Connection not found" }, "412":{ "description":"Connection is locked" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-connections-{id}-metadata-post", "x-filename-id":"ic-api-integration-v1-connections-id-metadata-post" } }, "/ic/api/integration/v1/connections/{id}/test":{ "post":{ "tags":[ "Integrations/Connections" ], "summary":"Test a Connection", "description":"

Tests a connection by doing a ping test. Can be used to check the status of the connection.

", "operationId":"testConnection", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Connection not found" }, "409":{ "description":"Connection is not configured" }, "412":{ "description":"Connection is locked" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-connections-{id}-test-post", "x-filename-id":"ic-api-integration-v1-connections-id-test-post" } }, "/ic/api/integration/v1/connections/{id}/testWithAttachments":{ "post":{ "tags":[ "Integrations/Connections" ], "summary":"Validate and Test a Connection", "description":"Validates and tests the connection for certain adapters. For example, for the FTP adapter performs a full validation of the WSDL including imported schemas and WSDLs, and then tests the connection.", "operationId":"testConnectionWithAttachments", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=UTF-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "type":"string" }, { "name":"X-HTTP-Method-Override", "in":"header", "description":"HTTP Method override in the header", "required":true, "type":"string" }, { "name":"patchAttachments", "in":"query", "description":"Indicates whether it is a partial or a full update of the attachments. Set patchAttachments=true to send in the request payload only attachments that have changed. Set patchAttachments=false to send in the request payload all attachments (changed and unchanged).", "required":false, "type":"boolean" }, { "name":"action", "in":"query", "description":"When action=validate performs a full validation of the WSDL, including processing of the imported schemas and WSDLs.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Connection not found" }, "409":{ "description":"Connection is not configured" }, "412":{ "description":"Connection is locked" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-connections-{id}-testWithAttachments-post", "x-filename-id":"ic-api-integration-v1-connections-id-testwithattachments-post" } }, "/ic/api/integration/v1/connections/{id}/validate":{ "post":{ "tags":[ "Integrations/Connections" ], "summary":"Validate a Connection", "description":"Validates a connection.", "operationId":"validateConnectionMultipart", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=UTF-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "type":"string" }, { "name":"X-HTTP-Method-Override", "in":"header", "description":"HTTP Method override in the header", "required":true, "type":"string" }, { "name":"patchAttachments", "in":"query", "description":"Param to determine whether this partial update of attachments case", "required":false, "type":"boolean" }, { "in":"body", "name":"body", "description":"List of actions that have to be run during testing.", "required":false, "schema":{ "$ref":"#/definitions/FormDataMultiPart" } } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Connection not found" }, "412":{ "description":"Connection is locked" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-connections-{id}-validate-post", "x-filename-id":"ic-api-integration-v1-connections-id-validate-post" } }, "/ic/api/integration/v1/integrations":{ "get":{ "tags":[ "Integrations/Integrations" ], "summary":"Retrieve Integrations", "description":"Retrieves information about all integrations ordered by the last updated time.", "operationId":"getIntegrations", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"q", "in":"query", "description":"

Filters integrations by integration name, status, type, and integration style.

Valid parameters:

", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"

Orders results by integration name or last updated time.

Valid values:

", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Includes additional details in the response about connections in the integration or about the adapters for the connections. Valid values: connection, connection.adapter. ", "required":false, "type":"string" }, { "name":"offset", "description":"Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list integrations starting at the 4th item, and the list will contain 16 items.", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"limit", "in":"query", "description":"Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list integrations starting at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" }, { "name":"return", "in":"query", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/IntegrationsRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-integrations-get", "x-filename-id":"ic-api-integration-v1-integrations-get" } }, "/ic/api/integration/v1/integrations/archive":{ "post":{ "tags":[ "Integrations/Integrations" ], "summary":"Import(Add) an Integration", "description":"

Imports a new integration that was previously exported. To submit an import request, the integration must not be present in the environment. If the integration was imported earlier, use Import(Replace) an Integration instead.

Importing an integration with a different user name or version than what was exported is not supported.

If you are using cURL, use the -F option to specify the file to import.

", "operationId":"importAsNewIntegration", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"file", "in":"formData", "description":"Previously exported integration file", "required":true, "type":"file" }, { "name":"includeRecordingFlag", "in":"query", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"Successful operation, no content sent, the Location header provides the URI for the newly created integration" }, "400":{ "description":"No file is uploaded" }, "409":{ "description":"Integration already exists" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-integrations-archive-post", "x-filename-id":"ic-api-integration-v1-integrations-archive-post" }, "put":{ "tags":[ "Integrations/Integrations" ], "summary":"Import(Replace) an Integration", "description":"Updates an existing integration with the same name that was exported previously. If you are using cURL, use the -F option to specify the file to import. If this command returns with HTTP 404, use Import(Add) an Integration instead.", "operationId":"importAsUpdateIntegration", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"file", "in":"formData", "description":"Previously exported integration file", "required":true, "type":"file" }, { "name":"includeRecordingFlag", "in":"query", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"No file is uploaded" }, "404":{ "description":"Integration not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-integrations-archive-put", "x-filename-id":"ic-api-integration-v1-integrations-archive-put" } }, "/ic/api/integration/v1/integrations/{id}":{ "get":{ "tags":[ "Integrations/Integrations" ], "summary":"Retrieve an Integration", "description":"Retrieves detailed information about the integration with the specified ID. ", "operationId":"getIntegration", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" }, { "name":"expand", "in":"query", "description":"Includes additional details in the response about connections in the integration or about the adapters for the connections. Valid values: connection, connection.adapter.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/IntegrationRs" } }, "404":{ "description":"Not found" }, "412":{ "description":"Precondition failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-get", "x-filename-id":"ic-api-integration-v1-integrations-id-get" }, "post":{ "tags":[ "Integrations/Integrations" ], "summary":"Update(Activate/Deactivate) an Integration", "description":"

Activates or deactivates an integration. To modify an active integration, you need to deactivate it first.

", "operationId":"update", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" }, { "name":"X-HTTP-Method-Override", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Integration resource", "required":true, "schema":{ "$ref":"#/definitions/IntegrationRs" } }, { "name":"deleteEventSubscriptionFlag", "in":"query", "required":false, "type":"string" }, { "name":"enableAsyncActivationMode", "in":"query", "description":"Activates/Deactivates an integration in asynchronous mode. The cURL request does not wait for the update process to finish and returns with success, while the update finishes in the background.", "required":false, "type":"string" }, { "name":"oracleRecommendsFlag", "in":"query", "description":"Oracle Recommends Flag", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Integration not found" }, "412":{ "description":"Already activated/deactivated or can't be activated/deactivated" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-post", "x-filename-id":"ic-api-integration-v1-integrations-id-post" }, "delete":{ "tags":[ "Integrations/Integrations" ], "summary":"Delete an Integration Version", "description":"Deletes the integration with the specified ID. Make sure the integration you want to delete is not active. To deactivate an integration, use Update(Activate/Deactivate) an Integration.", "operationId":"deleteIntegration", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Not found" }, "423":{ "description":"Deletion not allowed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-delete", "x-filename-id":"ic-api-integration-v1-integrations-id-delete" } }, "/ic/api/integration/v1/integrations/{id}/activationErrors":{ "get":{ "tags":[ "Integrations/Integrations" ], "summary":"Retrieve Integration Activation Errors", "description":"Retrieves integration activation errors for the integration with the specified ID. ", "operationId":"getDeploymentErrors", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/IntegrationRs" } }, "404":{ "description":"Not found" }, "412":{ "description":"Precondition failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-activationErrors-get", "x-filename-id":"ic-api-integration-v1-integrations-id-activationerrors-get" } }, "/ic/api/integration/v1/integrations/{id}/activationStatus":{ "get":{ "tags":[ "Integrations/Integrations" ], "summary":"Retrieve Integration Activation Status", "description":"Retrieves integration activation progress. Possible responses:", "operationId":"getIntegrationDeploymentStatus", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"object", "additionalProperties":{ "type":"string" } } }, "404":{ "description":"Integration not found" }, "412":{ "description":"PreCondition Failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-activationStatus-get", "x-filename-id":"ic-api-integration-v1-integrations-id-activationstatus-get" } }, "/ic/api/integration/v1/integrations/{id}/archive":{ "get":{ "tags":[ "Integrations/Integrations" ], "summary":"Export an Integration", "description":"Exports an integration for use in other Oracle Integration environments to the location specified with the -o option. ", "operationId":"exportIntegration", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/octet-stream" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" }, { "name":"includeRecordingFlag", "in":"query", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "type":"string", "format":"byte" } } }, "404":{ "description":"Integration not found" }, "423":{ "description":"Integration is in locked status or PREBUILT type" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-archive-get", "x-filename-id":"ic-api-integration-v1-integrations-id-archive-get" } }, "/ic/api/integration/v1/integrations/{id}/clone":{ "post":{ "tags":[ "Integrations/Integrations" ], "summary":"Clone an Integration", "description":"Creates a new copy of an integration with identical connections and data mappings. The request body must contain at least the code, version, and name fields.", "operationId":"cloneIntegration", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Integration resource", "required":true, "schema":{ "$ref":"#/definitions/IntegrationRs" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request, missing required data" }, "404":{ "description":"Integration not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-clone-post", "x-filename-id":"ic-api-integration-v1-integrations-id-clone-post" } }, "/ic/api/integration/v1/integrations/{id}/schedule/jobs":{ "post":{ "tags":[ "Integrations/Integrations/Scheduled Integrations" ], "summary":"Run a Scheduled Integration Now", "description":"Creates an ad-hoc integration run for a scheduled integration. This is useful for when you want to test a scheduled integration.", "operationId":"runNow", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier", "required":true, "type":"string" }, { "name":"X-Oracle-IntegrationSuite-Parent-Ctx", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"ScheduleJob resource", "required":true, "schema":{ "$ref":"#/definitions/ScheduleJobRs" } } ], "responses":{ "204":{ "description":"Successful operation" }, "404":{ "description":"Resource not found" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-schedule-jobs-post", "x-filename-id":"ic-api-integration-v1-integrations-id-schedule-jobs-post" } }, "/ic/api/integration/v1/integrations/{id}/schedule/jobs/{job_id}":{ "get":{ "tags":[ "Integrations/Integrations/Scheduled Integrations" ], "summary":"Retrieve Scheduled Integration Run Status", "description":"Get the status of the scheduled integration run specified with the job ID.", "operationId":"getEssJobRequestState", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" }, { "name":"job_id", "in":"path", "description":"Request ID for the scheduled integration run.", "required":true, "type":"integer", "format":"int64" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Resource not found" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-schedule-jobs-{job_id}-get", "x-filename-id":"ic-api-integration-v1-integrations-id-schedule-jobs-job_id-get" } }, "/ic/api/integration/v1/integrations/{id}/schedule/parameters":{ "patch":{ "tags":[ "Integrations/Integrations/Scheduled Integrations" ], "summary":"Update Scheduled Integration Parameters", "description":"Update scheduled integration parameters. ", "operationId":"updateScheduleParams", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" }, { "name":"X-Oracle-IntegrationSuite-Parent-Ctx", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"ScheduleJob resource", "required":true, "schema":{ "$ref":"#/definitions/ScheduleJobRs" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request, missing required data" }, "404":{ "description":"Resource not found" }, "412":{ "description":"Precondition failed" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-schedule-parameters-patch", "x-filename-id":"ic-api-integration-v1-integrations-id-schedule-parameters-patch" } }, "/ic/api/integration/v1/integrations/{id}/schedule/pause":{ "post":{ "tags":[ "Integrations/Integrations/Scheduled Integrations" ], "summary":"Pause an Integration Schedule", "description":"Pauses an integration schedule. Existing runs are allowed to complete, but no new runs are submitted. ", "operationId":"pauseSchedule", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Resource not found" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-schedule-pause-post", "x-filename-id":"ic-api-integration-v1-integrations-id-schedule-pause-post" } }, "/ic/api/integration/v1/integrations/{id}/schedule/resume":{ "post":{ "tags":[ "Integrations/Integrations/Scheduled Integrations" ], "summary":"Resume an Integration Schedule", "description":"Resumes an integration schedule.", "operationId":"resumeSchedule", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Resource not found" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-schedule-resume-post", "x-filename-id":"ic-api-integration-v1-integrations-id-schedule-resume-post" } }, "/ic/api/integration/v1/integrations/{id}/schedule/start":{ "post":{ "tags":[ "Integrations/Integrations/Scheduled Integrations" ], "summary":"Start an Integration Schedule", "description":"Start the integration schedule for the integration with the specified ID.", "operationId":"startSchedule", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"ScheduleJob resource", "required":true, "schema":{ "$ref":"#/definitions/ScheduleJobRs" } } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Resource not found" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-schedule-start-post", "x-filename-id":"ic-api-integration-v1-integrations-id-schedule-start-post" } }, "/ic/api/integration/v1/integrations/{id}/schedule/stop":{ "post":{ "tags":[ "Integrations/Integrations/Scheduled Integrations" ], "summary":"Stop an Integration Schedule", "description":"Stops an integration schedule. Cancels all existing runs and no new runs are submitted.", "operationId":"stopSchedule", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration composite identifier. The ID consists of the code and the version separated by the | (vertical line) character. Format: code%7Cversion. Example: SC2RN%7C01.00.0000. When using cURL, substitute the %7C code for the vertical line.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Resource not found" } }, "x-internal-id":"ic-api-integration-v1-integrations-{id}-schedule-stop-post", "x-filename-id":"ic-api-integration-v1-integrations-id-schedule-stop-post" } }, "/ic/api/integration/v1/libraries":{ "get":{ "tags":[ "Integrations/Libraries" ], "summary":"Retrieve Libraries", "description":"Retrieves information about all libraries ordered by the last updated time.", "operationId":"getLibraries", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"q", "in":"query", "description":"Filters libraries by name and type.

Valid parameters:

", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"

Lists libraries ordered by name or last updated time.

Valid value:

", "required":false, "type":"string" }, { "name":"offset", "description":"Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list libraries starting at the 4th item, and the list will contain 16 items.", "in":"query", "required":false, "type":"integer", "format":"int32" }, { "name":"limit", "description":"Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list libraries starting at the 4th item, and the list will contain 16 items.", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/LibraryRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-libraries-get", "x-filename-id":"ic-api-integration-v1-libraries-get" } }, "/ic/api/integration/v1/libraries/archive":{ "post":{ "tags":[ "Integrations/Libraries" ], "summary":"Import(Register) a Library", "description":"Imports an API library jar file. If you are using cURL, use the -F option to specify the file to import. The request must contain the following attributes added with the -F option: name, code, version, type, and file. Description is optional.", "operationId":"registerNewLibrary", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"file", "in":"formData", "description":"library artifact file content", "required":true, "type":"file" }, { "name":"type", "in":"formData", "description":"library type ", "required":true, "type":"string" }, { "name":"name", "in":"formData", "description":"library name", "required":true, "type":"string" }, { "name":"code", "in":"formData", "description":"library identifier", "required":true, "type":"string" }, { "name":"description", "in":"formData", "description":"library description", "required":false, "type":"string" }, { "name":"version", "in":"formData", "description":"library version", "required":true, "type":"string" } ], "responses":{ "204":{ "description":"Successful operation, no content sent, the Location header provides the newly created library uri" }, "400":{ "description":"Malformed request parameters" }, "409":{ "description":"Library already exists" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-libraries-archive-post", "x-filename-id":"ic-api-integration-v1-libraries-archive-post" } }, "/ic/api/integration/v1/libraries/{id}":{ "get":{ "tags":[ "Integrations/Libraries" ], "summary":"Retrieve a Library", "description":"Retrieves detailed information about the library with the specified ID.", "operationId":"getLibrary", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"id", "in":"path", "description":"Library identifier. The id must be added to the request in the following form: code%7Cversion. For example: JSLIB%7C01.00.0000. The %7C is the encoded | (vertical line).", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/LibraryTypeRs" } }, "404":{ "description":"Not found" }, "412":{ "description":"Precondition failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-libraries-{id}-get", "x-filename-id":"ic-api-integration-v1-libraries-id-get" }, "delete":{ "tags":[ "Integrations/Libraries" ], "summary":"Delete a Library Version", "description":"Deletes the library with the specified ID. The ID consists of the code and the version separated by the | (vertical line) character. When using cURL, substitute the %7C code for the vertical line.", "operationId":"deleteLibrary", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Library identifier. The id must be added to the request in the following form: code%7Cversion. For example: JSLIB%7C01.00.0000. The %7C is the encoded | (vertical line).", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Not found" }, "423":{ "description":"Deletion not allowed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-libraries-{id}-delete", "x-filename-id":"ic-api-integration-v1-libraries-id-delete" } }, "/ic/api/integration/v1/libraries/{id}/archive":{ "get":{ "tags":[ "Integrations/Libraries" ], "summary":"Export a Library", "description":"Exports the library jar file containing the JS files to the location specified with the -o option. This operation returns a byte stream that is output to the display by default. If you are using cURL, use the -o option to save the response to a file.", "operationId":"exportLibrary", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/octet-stream" ], "parameters":[ { "name":"id", "in":"path", "description":"Library identifier. The id must be added to the request in the following form: code%7Cversion. For example: JSLIB%7C01.00.0000. The %7C is the encoded | (vertical line).", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "type":"string", "format":"byte" } } }, "404":{ "description":"Library not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-libraries-{id}-archive-get", "x-filename-id":"ic-api-integration-v1-libraries-id-archive-get" }, "post":{ "tags":[ "Integrations/Libraries" ], "summary":"Update a Library", "description":"Replace the existing jar/js file.", "operationId":"updateLibraryJarFile", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"file", "in":"formData", "description":"Library artifact file content", "required":true, "type":"file" }, { "name":"id", "in":"path", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/LibraryRs" } }, "204":{ "description":"Successful operation, no content sent, the Location header provides the newly created libraries uri" }, "400":{ "description":"Malformed request parameters" }, "409":{ "description":"Library already exists" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-libraries-{id}-archive-post", "x-filename-id":"ic-api-integration-v1-libraries-id-archive-post" } }, "/ic/api/integration/v1/libraries/{id}/metadata":{ "get":{ "tags":[ "Integrations/Libraries" ], "summary":"Export Library Metadata", "description":"Exports the metadata XML file for the library with the specified ID to a location specified with the -o option. This operation returns a byte stream that is output to the display by default. If you are using cURL, use the -o option to save the response to a file.", "operationId":"exportLibraryMetadata", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/octet-stream" ], "parameters":[ { "name":"id", "in":"path", "description":"Library identifier. The id must be added to the request in the following form: code%7Cversion. For example: JSLIB%7C01.00.0000. The %7C is the encoded | (vertical line).", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "type":"string", "format":"byte" } } }, "404":{ "description":"Library not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-libraries-{id}-metadata-get", "x-filename-id":"ic-api-integration-v1-libraries-id-metadata-get" }, "post":{ "tags":[ "Integrations/Libraries" ], "summary":"Import Library Metadata", "description":"Imports the metadata XML file for the library with the specified ID. If you are using cURL, use the -F option to specify the file to import.", "operationId":"importLibraryMetadata", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"file", "in":"formData", "description":"Library metadata file content", "required":true, "type":"file" }, { "name":"id", "in":"path", "description":"Library identifier. The id must be added to the request in the following form: code%7Cversion. For example: JSLIB%7C01.00.0000. The %7C is the encoded | (vertical line).", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/APILibrary" } }, "400":{ "description":"Bad request, missing required data" }, "404":{ "description":"Library not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-libraries-{id}-metadata-post", "x-filename-id":"ic-api-integration-v1-libraries-id-metadata-post" } }, "/ic/api/integration/v1/lookups":{ "get":{ "tags":[ "Integrations/Lookups" ], "summary":"Retrieve Lookups", "description":"Retrieves information about all lookups ordered by the last updated time.", "operationId":"getLookups", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"q", "in":"query", "description":"

Filters lookups by name and status.

Valid parameters:

", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"

Lists lookups ordered by name.

Valid value:

", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"Includes additional details in the response about the adapters used in the lookups. Valid value: adapter", "required":false, "type":"string" }, { "name":"offset", "in":"query", "description":"Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list lookups starting at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" }, { "name":"limit", "description":"Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list lookups starting at the 4th item, and the list will contain 16 items.", "in":"query", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/LookupsRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-lookups-get", "x-filename-id":"ic-api-integration-v1-lookups-get" }, "post":{ "tags":[ "Integrations/Lookups" ], "summary":"Create a Lookup", "description":"

Creates a lookup. The request body must contain:

", "operationId":"createLookup", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "in":"body", "name":"body", "description":"Lookup resource", "required":true, "schema":{ "$ref":"#/definitions/LookupRs" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request, missing required data" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-lookups-post", "x-filename-id":"ic-api-integration-v1-lookups-post" } }, "/ic/api/integration/v1/lookups/archive":{ "post":{ "tags":[ "Integrations/Lookups" ], "summary":"Import(Add) a Lookup", "description":"Imports a new lookup file that was previously exported from another environment. To submit an import request, the lookup must not be present in the environment. If the lookup was imported earlier, use Import(Replace) a Lookup instead.", "operationId":"importAsNewLookup", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"file", "in":"formData", "description":"Previously exported lookup file", "required":true, "type":"file" } ], "responses":{ "204":{ "description":"Successful operation, no content sent, the Location header provides the URI for the newly created lookup" }, "400":{ "description":"No file is uploaded" }, "409":{ "description":"Lookup already exists" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-lookups-archive-post", "x-filename-id":"ic-api-integration-v1-lookups-archive-post" }, "put":{ "tags":[ "Integrations/Lookups" ], "summary":"Import(Replace) a Lookup", "description":"Updates an existing lookup. If you are using cURL, use the -F option to specify the file to import. If this command returns with HTTP 404, use Import(Add) a Lookup instead.", "operationId":"importAsUpdateLookup", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"file", "in":"formData", "description":"Previously exported lookup file", "required":true, "type":"file" } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"No file is uploaded" }, "404":{ "description":"Lookup not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-lookups-archive-put", "x-filename-id":"ic-api-integration-v1-lookups-archive-put" } }, "/ic/api/integration/v1/lookups/{name}":{ "get":{ "tags":[ "Integrations/Lookups" ], "summary":"Retrieve a Lookup", "description":"Retrieves detailed information about the lookup with the specified name.", "operationId":"getLookup", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"name", "in":"path", "description":"Lookup name.", "required":true, "type":"string" }, { "name":"expand", "in":"query", "description":"Expand the lookup resource by adding related resources.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/LookupRs" } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-lookups-{name}-get", "x-filename-id":"ic-api-integration-v1-lookups-name-get" }, "put":{ "tags":[ "Integrations/Lookups" ], "summary":"Update a Lookup", "description":"

Updates a lookup with the name and values specified in the request body. The request body must contain:

", "operationId":"updateLookup", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"name", "in":"path", "description":"Lookup name", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Lookup resource", "required":true, "schema":{ "$ref":"#/definitions/LookupRs" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request, missing required data" }, "404":{ "description":"Lookup not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-lookups-{name}-put", "x-filename-id":"ic-api-integration-v1-lookups-name-put" }, "delete":{ "tags":[ "Integrations/Lookups" ], "summary":"Delete a Lookup", "description":"Deletes the lookup with the specified name.", "operationId":"deleteLookup", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"name", "in":"path", "description":"Lookup name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Lookup not found" }, "423":{ "description":"Lookup is locked" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-lookups-{name}-delete", "x-filename-id":"ic-api-integration-v1-lookups-name-delete" } }, "/ic/api/integration/v1/lookups/{name}/archive":{ "get":{ "tags":[ "Integrations/Lookups" ], "summary":"Export a Lookup", "description":"Exports a lookup. This operation returns a byte stream that is output to the display by default. If you are using cURL, use the -o option to save the response to a file.", "operationId":"exportLookup", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/octet-stream" ], "parameters":[ { "name":"name", "in":"path", "description":"Integration composite identifier", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "type":"string", "format":"byte" } } }, "404":{ "description":"Lookup not found" }, "423":{ "description":"Lookup is in locked status" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-lookups-{name}-archive-get", "x-filename-id":"ic-api-integration-v1-lookups-name-archive-get" } }, "/ic/api/integration/v1/lookups/{name}/clone":{ "post":{ "tags":[ "Integrations/Lookups" ], "summary":"Clone a Lookup", "description":"Clones the lookup with the specified name. The request must contain a JSON file with the new lookup's details attached with the -d option. The JSON file must contain the name attribute.", "operationId":"cloneLookup", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"name", "in":"path", "description":"Lookup name.", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Lookup resource", "required":true, "schema":{ "$ref":"#/definitions/LookupRs" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request, missing required data" }, "404":{ "description":"Lookup not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-lookups-{name}-clone-post", "x-filename-id":"ic-api-integration-v1-lookups-name-clone-post" } }, "/ic/api/integration/v1/lookups/{name}/usage":{ "get":{ "tags":[ "Integrations/Lookups" ], "summary":"Retrieve Usage of the Lookup", "description":"Lists all the integrations which use the specified lookup.", "operationId":"getIntegrationListUsingLookup", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"name", "in":"path", "description":"Lookup name.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/UsageRs" } }, "404":{ "description":"Lookup not found" }, "412":{ "description":"Precondition failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-lookups-{name}-usage-get", "x-filename-id":"ic-api-integration-v1-lookups-name-usage-get" } }, "/ic/api/integration/v1/monitoring/activityStream":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve the Activity Stream (Deprecated)", "description":"Retrieves a list of activities. This API has been deprecated since November 2020. Use the API Retrieve all activity stream messages instead.", "operationId":"getActivityStream", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"recordSize", "in":"query", "description":"

Filter parameter.

\n

\n

\n

\n

\nExample: \n

\n
/activityStream?recordSize=20
", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MonitoringActivityStreamRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-activityStream-get", "x-filename-id":"ic-api-integration-v1-monitoring-activitystream-get" } }, "/ic/api/integration/v1/monitoring/history":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Historical Tracking Metrics", "description":"This API fetches historical tracking metrics. These are the metrics collected since the environment was created.", "operationId":"getHistory", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"frequency", "in":"query", "description":"

Time frequency by which the metrics are to be grouped by. Valid values: hourly and daily.

\n

\nExample: \n

Retrieves hourly metrics for past 24 hours.

\n

\n
/history?frequency=hourly
\n

\n

Retrieves daily metrics for past 30 days.

\n

\n
/history?frequency=daily
", "required":false, "type":"string" }, { "name":"q", "in":"query", "description":"

Filter parameter.

\n

\n

\n

\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/HistoryItemsRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-history-get", "x-filename-id":"ic-api-integration-v1-monitoring-history-get" } }, "/ic/api/integration/v1/monitoring/agentgroups":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Status of Agent Groups", "description":"Retrieves monitoring data for all agent groups including current availability status.", "operationId":"getAgentGroupsMonitoring", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"q", "in":"query", "description":"

Filters results by agent group name.

\n

\n Example:\n

\n
{name:'Execution Agents Group'}
", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"

Orders results by name or last updated time.

\n

\n Examples:\n

\n
/agentgroups?orderBy=time
\n
/agentgroups?orderBy=name
", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/AgentGroupsMonitoringRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-agentgroups-get", "x-filename-id":"ic-api-integration-v1-monitoring-agentgroups-get" } }, "/ic/api/integration/v1/monitoring/agentgroups/{id}":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Status of an Agent Group", "description":"Retrieves monitoring data including current availability status for the agent group with the specified ID.", "operationId":"getAgentGroupMonitoring", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"

Agent group identifier.

\n

\n Example:\n

\n
agentgroups/EXECUTION_AGENT_GROUP
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/AgentGroupMonitoringRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-agentgroups-{id}-get", "x-filename-id":"ic-api-integration-v1-monitoring-agentgroups-id-get" } }, "/ic/api/integration/v1/monitoring/agentgroups/{id}/agents":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Status of Agents in an Agent Group", "description":"Retrieves monitoring data for agents in the specified agent group including availability status.", "operationId":"getAgentsMonitoring", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"id", "in":"path", "description":"

Agent group identifier.

\n

\n Example:\n

\n
agentgroups/EXECUTION_AGENT_GROUP/agents
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/AgentsMonitoringRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-agentgroups-{id}-agents-get", "x-filename-id":"ic-api-integration-v1-monitoring-agentgroups-id-agents-get" } }, "/ic/api/integration/v1/monitoring/agentgroups/{id}/agents/{key}":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Status of an Agent", "description":"Retrieves monitoring data including current availability status for an agent in the specified agent group.", "operationId":"getAgentMonitoring", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Agent group identifier.", "required":true, "type":"string" }, { "name":"key", "in":"path", "description":"Agent identifier.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/AgentMonitoringRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-agentgroups-{id}-agents-{key}-get", "x-filename-id":"ic-api-integration-v1-monitoring-agentgroups-id-agents-key-get" } }, "/ic/api/integration/v1/monitoring/auditRecords":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Audit Records", "description":"Retrieves audit records based on query.", "operationId":"getMonitoringAuditRecords", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"q", "in":"query", "description":"

Filter parameters.

\n

\n

\n

\n

\nExample: \n

\n
{limit: '10', type:/ICS_AppInstance/, distinct: 'true'}
", "required":false, "type":"string" }, { "name":"offset", "in":"query", "description":"Use with the limit parameter for paginating through the returned results. Default is 0. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list connections starting at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" }, { "name":"limit", "in":"query", "description":"Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list error integration instances starting at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MonitoringAuditResource" } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-auditRecords-get", "x-filename-id":"ic-api-integration-v1-monitoring-auditrecords-get" } }, "/ic/api/integration/v1/monitoring/errors":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Errored Instances", "description":"Retrieves information about all integration instances that have a errored status in the past hour, ordered by integration instance last updated time. Retrieves information such as integration instance identifiers, fault identifiers, integration details, error details and retry count. It includes connection information if the error occurred in the connection.", "operationId":"getErrors", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"q", "in":"query", "description":"

Filter parameters.

\n

\n\t

\n

\n

\n\tExample: \n

\n
{startdate:'2020-07-09 07:00:00', enddate:'2020-07-09 21:25:00', code:'ERROR', version:'01.00.0000', recoverable:'true', id:'118'}
", "required":false, "type":"string" }, { "name":"groupBy", "in":"query", "description":"

\n\t

\n

\n", "required":false, "type":"string" }, { "name":"expand", "in":"query", "description":"

\n\t

\n

\n", "required":false, "type":"string", "default":"integration" }, { "name":"offset", "in":"query", "description":"Use with the limit parameter for paginating through the returned results. Default is 0. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list connections starting at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" }, { "name":"limit", "in":"query", "description":"Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list error integration instances starting at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ErrorsRs" } }, "400":{ "description":"Malformed parameters" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-errors-get", "x-filename-id":"ic-api-integration-v1-monitoring-errors-get" } }, "/ic/api/integration/v1/monitoring/errors/discard":{ "post":{ "tags":[ "Integrations/Monitoring" ], "summary":"Discard Errored Integration Instances", "description":"Discards errored integration instances with the specified integration instance identifiers.", "operationId":"errorsDiscard", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "in":"body", "name":"body", "description":"

Information about the instances to discard or abort.

\n

\nExamples: \n

\n
{flowCode: 'MON_ERRORS_INT_AUTO', flowVersion: '01.00.0000', timewindow: '1h'}
\n
ids: ['4', '3', '2', '1']
\n
{connectionCode: 'RIGHTNOW', startDate: '2020-07-21 00:00:00', endDate: '2020-07-27 12:55:00'}
", "required":true, "schema":{ "$ref":"#/definitions/ErrorsBulkRequest" } } ], "responses":{ "202":{ "description":"Request Accepted" }, "400":{ "description":"Malformed parameters" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "412":{ "description":"Precondition Failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-errors-discard-post", "x-filename-id":"ic-api-integration-v1-monitoring-errors-discard-post" } }, "/ic/api/integration/v1/monitoring/errors/recoveryJobs":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Error Recovery Jobs", "description":"Retrieves a list of recovery jobs created when errored integration instances are resubmitted in a batch.", "operationId":"getRecoveryJobs", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"q", "in":"query", "description":"

Filter parameters.

\n

\n

\n

\n

\n\tExample: \n

\n
{primaryValue:'4', startdate:'2020-07-15 07:00:00', enddate:'2020-07-08 21:10:00'}
", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/RecoveryJobsRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-errors-recoveryJobs-get", "x-filename-id":"ic-api-integration-v1-monitoring-errors-recoveryjobs-get" } }, "/ic/api/integration/v1/monitoring/errors/recoveryJobs/{id}":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve an Error Recovery Job", "description":"Retrieves an error recovery job based on the specified job identifier.", "operationId":"getRecoveryJob", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"id", "in":"path", "description":"Recovery job identifier.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/RecoveryJobRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-errors-recoveryJobs-{id}-get", "x-filename-id":"ic-api-integration-v1-monitoring-errors-recoveryjobs-id-get" } }, "/ic/api/integration/v1/monitoring/errors/resubmit":{ "post":{ "tags":[ "Integrations/Monitoring" ], "summary":"Resubmit Errored Integration Instances", "description":"Resubmit multiple errored instances based on a list of given integration instance identifiers.", "operationId":"errorsResubmit", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "in":"body", "name":"body", "description":"

Criteria for which instances to resubmit.

\n

\nExamples: \n

\n
{flowCode: 'MON_ERRORS_INT_AUTO', flowVersion: '01.00.0000', timewindow: '1h'}
\n
ids: ['4', '3', '2', '1']
\n
{connectionCode: 'RIGHTNOW', startDate: '2020-07-21 00:00:00', endDate: '2020-07-27 12:55:00'}
", "required":true, "schema":{ "$ref":"#/definitions/ErrorsBulkRequest" } } ], "responses":{ "202":{ "description":"Request Accepted" }, "400":{ "description":"Malformed parameters" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "412":{ "description":"Precondition Failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-errors-resubmit-post", "x-filename-id":"ic-api-integration-v1-monitoring-errors-resubmit-post" } }, "/ic/api/integration/v1/monitoring/errors/{id}":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve an Errored Integration Instance", "description":"Retrieves details about the errored integration instance with the specified errored instance identifier.", "operationId":"getError", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"id", "in":"path", "description":"Errored integration instance identifier.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ErrorsRs" } }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Integration not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-errors-{id}-get", "x-filename-id":"ic-api-integration-v1-monitoring-errors-id-get" } }, "/ic/api/integration/v1/monitoring/errors/{id}/discard":{ "post":{ "tags":[ "Integrations/Monitoring" ], "summary":"Discard an Errored Integration Instance", "description":"Discard the errored integration instance with the specified errored instance identifier.", "operationId":"errorDiscard", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Errored integration instance identifier.", "required":true, "type":"string" } ], "responses":{ "202":{ "description":"Request Accepted" }, "400":{ "description":"Malformed parameters" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "412":{ "description":"Precondition failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-errors-{id}-discard-post", "x-filename-id":"ic-api-integration-v1-monitoring-errors-id-discard-post" } }, "/ic/api/integration/v1/monitoring/errors/{id}/resubmit":{ "post":{ "tags":[ "Integrations/Monitoring" ], "summary":"Resubmit an Errored Integration Instance", "description":"Resubmit the errored integration instance with the specified identifier.", "operationId":"errorResubmit", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Errored instance identifier.", "required":true, "type":"string" } ], "responses":{ "202":{ "description":"Request accepted" }, "400":{ "description":"Malformed parameters" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "412":{ "description":"Precondition failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-errors-{id}-resubmit-post", "x-filename-id":"ic-api-integration-v1-monitoring-errors-id-resubmit-post" } }, "/ic/api/integration/v1/monitoring/incident":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Download an Incident (Deprecated)", "description":"Downloads the incident with the specified ID. This API has been deprecated since November 2020. ", "operationId":"getIncident", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/zip" ], "parameters":[ { "name":"id", "in":"query", "description":"Incident identifier.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "type":"string", "format":"byte" } } }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Incident not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-incident-get", "x-filename-id":"ic-api-integration-v1-monitoring-incident-get" } }, "/ic/api/integration/v1/monitoring/instances":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Integration Instances", "description":"Retrieve information about integration instances for the past hour ordered by last updated time.", "operationId":"getInstances", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"q", "in":"query", "description":"

Filter parameters.

\n

\n\t

\n

\n

\n\tExample: \n

\n
{timewindow:'1h', id:'118', status:'FAILED', code:'ERROR', version:'01.00.0000', requestId:'2432', jobid:'18'}
", "required":false, "type":"string" }, { "name":"fields", "in":"query", "description":"Limit query results to a few fields. Valid values are runId, id and all.", "required":false, "type":"string" }, { "name":"offset", "in":"query", "description":"Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. Default value is 0. For example, offset=3&limit=16 indicates to list results at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" }, { "name":"limit", "in":"query", "description":"Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list results starting at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/InstancesRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-instances-get", "x-filename-id":"ic-api-integration-v1-monitoring-instances-get" } }, "/ic/api/integration/v1/monitoring/instances/{id}":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve an Integration Instance", "description":"Retrieves detailed information about the integration instance with the specified instance ID.", "operationId":"getInstance", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration instance identifier.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/InstanceRs" } }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Instance not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-instances-{id}-get", "x-filename-id":"ic-api-integration-v1-monitoring-instances-id-get" } }, "/ic/api/integration/v1/monitoring/instances/{id}/abort":{ "post":{ "tags":[ "Integrations/Monitoring" ], "summary":"Abort an Integration Instance", "description":"Abort a waiting or paused scheduled integration instance or any in-progress asynchronous integration instance with the specified identifier.", "operationId":"abortInstance", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration instance identifier.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/InstanceAbortRs" } }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Instance not found" }, "409":{ "description":"Instance not in-progress status" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-instances-{id}-abort-post", "x-filename-id":"ic-api-integration-v1-monitoring-instances-id-abort-post" } }, "/ic/api/integration/v1/monitoring/instances/{id}/activityStream":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Integration Instance Activity Stream", "description":"Retrieves activity stream and audit trail data of the integration instance with the specified identifier. The response includes the sequence of actions, invokes, error messages(if any), along with their timestamps.", "operationId":"getActivityStreamDetails", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"id", "in":"path", "description":"

Integration instance identifier.

\n

\nExample: \n

\n
/instances/2400001/activityStream
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MonitoringActivityStreamDetailsRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-instances-{id}-activityStream-get", "x-filename-id":"ic-api-integration-v1-monitoring-instances-id-activitystream-get" } }, "/ic/api/integration/v1/monitoring/integrationActivityStream":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Activity Stream Messages (Deprecated)", "description":"Deprecated since August 2021. Retrieves all messages from activity stream logs for integrations and their instances.", "operationId":"getIntegrationActivityStream", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"limit", "in":"query", "description":"Number of activity stream records to fetch.", "required":false, "type":"string", "default":"15" }, { "name":"q", "in":"query", "description":"

Filter parameters.

\n

\n\t

\n

\n

\n\tExample: \n

\n
{instanceId:'1', code:'ECHO', version : '01.00.0000'}
", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MonitoringActivityStreamRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-integrationActivityStream-get", "x-filename-id":"ic-api-integration-v1-monitoring-integrationactivitystream-get" } }, "/ic/api/integration/v1/monitoring/integrations":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Monitoring Data for Integrations", "description":"Retrieves a list of integrations along with respective count for total, processed, succeeded, errored and aborted messages within the specified time window.", "operationId":"getMonitoringIntegrations", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"q", "in":"query", "description":"

Filter parameters.

\n

\n\t

\n

\n

\n\tExample: \n

\n
{timewindow:'2d', status:'CONFIGURED', style:'freeform_scheduled'}
", "required":false, "type":"string" }, { "name":"orderBy", "in":"query", "description":"

Valid values:

\n

\n\t

\n

\n

\n\tExample:\n\t

To order the records by name

\n

\n
orderBy='name'
", "required":false, "type":"string" }, { "name":"offset", "in":"query", "description":"Start index for pagination support. Default value is 0.", "required":false, "type":"integer", "format":"int32" }, { "name":"limit", "in":"query", "description":"Number of integrations to fetch.", "required":false, "type":"integer", "format":"int32" }, { "name":"return", "in":"query", "description":"Type of records to return.", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MonitoringIntegrationsRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-integrations-get", "x-filename-id":"ic-api-integration-v1-monitoring-integrations-get" } }, "/ic/api/integration/v1/monitoring/integrations/messages/summary":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Message Count Summary", "description":"Retrieves summary of total, processed, succeeded, errored and aborted messages(instances) currently present in tracking runtime.", "operationId":"getMessageCount", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MessageCountRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-integrations-messages-summary-get", "x-filename-id":"ic-api-integration-v1-monitoring-integrations-messages-summary-get" } }, "/ic/api/integration/v1/monitoring/integrations/{id}":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Monitoring Data for an Integration", "description":"Retrieves a monitoring integration with the specified identifier and version.", "operationId":"getMonitoringIntegration", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration identifier and version.", "required":true, "type":"string" }, { "name":"q", "in":"query", "description":"

Filter parameter.

\n

\n

\n

\n", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/MonitoringIntegrationRs" } }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Integration not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-integrations-{id}-get", "x-filename-id":"ic-api-integration-v1-monitoring-integrations-id-get" } }, "/ic/api/integration/v1/monitoring/logs/oicpurgelogs":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Download Database Purge Logs", "description":"Download database purge logs. Database purge logs indicate when runtime data was purged from the database.", "operationId":"getMonitoringPurgeLog", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "text/plain" ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "type":"string", "format":"byte" } } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-logs-oicpurgelogs-get", "x-filename-id":"ic-api-integration-v1-monitoring-logs-oicpurgelogs-get" } }, "/ic/api/integration/v1/monitoring/logs/{id}":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Download a Log File", "description":"Download a log file identified by log file identifier.", "operationId":"getMonitoringLog", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/zip" ], "parameters":[ { "name":"id", "in":"path", "description":"Log file identifier. Valid values are icsflowlog, icsauditlog. The value icsdiagnosticlog has been deprecated since November 2020.", "required":true, "type":"string" }, { "name":"q", "in":"query", "description":"

\n Examples: \n

\n
{startdate :'2016-09-23 07:07:07' , enddate :'2016-09-23 08:17:07'}
\n
{timewindow:'3d'}
", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "type":"string", "format":"byte" } } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-logs-{id}-get", "x-filename-id":"ic-api-integration-v1-monitoring-logs-id-get" } }, "/ic/api/integration/v1/monitoring/reportIncident":{ "post":{ "tags":[ "Integrations/Monitoring" ], "summary":"Report an Incident(Deprecated)", "description":"Deprecated since August 2021. Report an incident with the specified incident identifier and description.", "operationId":"reportIncident", "consumes":[ "application/json" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "in":"body", "name":"body", "description":"

Information about the incident to report.

\n

\n Example: \n

\n
{name:'Incident1', description:'Incident Description'}
", "required":true, "schema":{ "$ref":"#/definitions/IncidentRs" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-reportIncident-post", "x-filename-id":"ic-api-integration-v1-monitoring-reportincident-post" } }, "/ic/api/integration/v1/monitoring/runs/{id}/resubmit":{ "post":{ "tags":[ "Integrations/Monitoring" ], "summary":"Resubmit a Failed Scheduled Integration Run", "description":"Resubmit a failed run of a scheduled integration.", "operationId":"runResubmit", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"id", "in":"path", "description":"Integration run identifier.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/RunResubmitRs" } }, "202":{ "description":"Request Accepted" }, "400":{ "description":"Malformed parameters" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden" }, "412":{ "description":"Precondition Failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-runs-{id}-resubmit-post", "x-filename-id":"ic-api-integration-v1-monitoring-runs-id-resubmit-post" } }, "/ic/api/integration/v1/packages":{ "get":{ "tags":[ "Integrations/Packages" ], "summary":"Retrieve Packages", "description":"Retrieves information about all packages ordered by the last updated time.", "operationId":"getPackages", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=collection" ], "parameters":[ { "name":"q", "in":"query", "description":"

Returns a filtered list of packages based on the specified parameters.

Valid parameters:

", "required":false, "type":"string" }, { "name":"offset", "in":"query", "description":"Use with the limit parameter for paginating through the returned results. The offset is the starting point from which to return records. For example, offset=3&limit=16 indicates to list packages starting at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" }, { "name":"limit", "in":"query", "description":"Use with the offset parameter for paginating through the returned results. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list packages starting at the 4th item, and the list will contain 16 items.", "required":false, "type":"integer", "format":"int32" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/PackagesRs" } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-packages-get", "x-filename-id":"ic-api-integration-v1-packages-get" } }, "/ic/api/integration/v1/packages/archive":{ "post":{ "tags":[ "Integrations/Packages" ], "summary":"Import(Add) a Package", "description":"Imports a new package file. To submit an import request, the package must not be present in the environment. If the package was imported earlier, use Import(Replace) a Package instead.", "operationId":"importPackage", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"file", "in":"formData", "description":"Previously exported package file", "required":true, "type":"file" }, { "name":"includeRecordingFlag", "in":"query", "required":false, "type":"string" } ], "responses":{ "204":{ "description":"Successful operation" }, "400":{ "description":"No file is uploaded" }, "409":{ "description":"Package already exists" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-packages-archive-post", "x-filename-id":"ic-api-integration-v1-packages-archive-post" }, "put":{ "tags":[ "Integrations/Packages" ], "summary":"Import(Replace) a Package", "description":"Updates an existing package with the same name that was exported previously. If you are using cURL, use the -F option to specify the file to import. If this command returns with HTTP 404, use Import(Add) a Package instead.", "operationId":"importAsUpdatePackage", "consumes":[ "multipart/form-data" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"file", "in":"formData", "description":"Previously exported package file", "required":true, "type":"file" }, { "name":"includeRecordingFlag", "in":"query", "required":false, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"No file is uploaded" }, "404":{ "description":"Package not found" }, "412":{ "description":"Can't be imported if integrations belonging to the package already exist and are ACTIVE or LOCKED." }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-packages-archive-put", "x-filename-id":"ic-api-integration-v1-packages-archive-put" } }, "/ic/api/integration/v1/packages/loadSamples":{ "post":{ "tags":[ "Integrations/Packages" ], "summary":"Import Sample Packages", "description":"Imports sample packages. If you already have sample integrations, getting new samples will overwrite existing integrations with the same name and version. If a sample integration is active or locked, it will not be overwritten.", "operationId":"importSamplePackages", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/SamplesRs" } }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-packages-loadSamples-post", "x-filename-id":"ic-api-integration-v1-packages-loadsamples-post" } }, "/ic/api/integration/v1/packages/{packagename}":{ "get":{ "tags":[ "Integrations/Packages" ], "summary":"Retrieve a Package", "description":"Retrieves detailed information about the package with the specified name.", "operationId":"getPackage", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"packagename", "in":"path", "description":"Package name", "required":true, "type":"string" }, { "name":"includeDependencies", "in":"query", "description":"Include integration dependency information in the integration section of the response.", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/PackageRs" } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-packages-{packagename}-get", "x-filename-id":"ic-api-integration-v1-packages-packagename-get" }, "post":{ "tags":[ "Integrations/Packages" ], "summary":"Update Package Dependencies", "description":"Update a package by name.", "operationId":"updatePackage", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8", "application/vnd.oracle.resource+json;type=singular" ], "parameters":[ { "name":"packagename", "in":"path", "description":"Package name", "required":true, "type":"string" }, { "name":"X-HTTP-Method-Override", "in":"header", "required":false, "type":"string" }, { "in":"body", "name":"body", "description":"Integration resource", "required":true, "schema":{ "$ref":"#/definitions/PackageRs" } } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/PackageRs" } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-packages-{packagename}-post", "x-filename-id":"ic-api-integration-v1-packages-packagename-post" }, "delete":{ "tags":[ "Integrations/Packages" ], "summary":"Delete a Package", "description":"Deletes a package.", "operationId":"deletePackage", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"packagename", "in":"path", "description":"Package name", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Package not found" }, "412":{ "description":"Package can't be deleted if it's of type DEVELOPED, or if any integration belonging to the package is ACTIVE or LOCKED" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-packages-{packagename}-delete", "x-filename-id":"ic-api-integration-v1-packages-packagename-delete" } }, "/ic/api/integration/v1/packages/{packagename}/archive":{ "get":{ "tags":[ "Integrations/Packages" ], "summary":"Export a Package", "description":"Exports a package. This operation returns a byte stream that is output to the display by default. If you are using cURL, use the -o option to save the response to a file.", "operationId":"exportPackage", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/octet-stream" ], "parameters":[ { "name":"packagename", "in":"path", "description":"Package name", "required":true, "type":"string" }, { "name":"includeRecordingFlag", "in":"query", "required":false, "type":"string" }, { "name":"prebuilt", "in":"query", "description":"Exports the package as prebuilt.", "required":false, "type":"boolean" }, { "name":"bartatype", "in":"query", "description":"BartaType BA|R|TA", "required":false, "type":"string" }, { "name":"builtby", "in":"query", "description":"BuiltBy", "required":false, "type":"string" }, { "name":"isView", "in":"query", "description":"isViewAllowed", "required":false, "type":"boolean" }, { "name":"isClone", "in":"query", "description":"isCloneAllowed", "required":false, "type":"boolean" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "type":"array", "items":{ "type":"string", "format":"byte" } } }, "404":{ "description":"Package not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-packages-{packagename}-archive-get", "x-filename-id":"ic-api-integration-v1-packages-packagename-archive-get" } }, "/ic/api/integration/v1/packages/{packagename}/clone":{ "post":{ "tags":[ "Integrations/Packages" ], "summary":"Clone a Package", "description":"Clones a package. The request body must contain the name fields.", "operationId":"clonePackage", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "name":"packagename", "in":"path", "description":"Package name", "required":true, "type":"string" }, { "in":"body", "name":"body", "description":"Clone Request resource", "required":true, "schema":{ "$ref":"#/definitions/PackageCloneMetadataRs" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request, missing required data" }, "404":{ "description":"Package not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-packages-{packagename}-clone-post", "x-filename-id":"ic-api-integration-v1-packages-packagename-clone-post" } }, "/ic/api/integration/v1/environment/corsdomains":{ "get":{ "tags":[ "Environment" ], "summary":"Retrieve List of Domains Allowed for CORS Processing", "description":"Retrieves the list of domains allowed for processing of cross-origin resource sharing (CORS) sites that are created and updated by the user.", "operationId":"getCorsDomains", "consumes":[ "application/json; charset=utf-8" ], "produces":[ "application/json; charset=UTF-8", "application/vnd.oracle.resource+json;type=singular" ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/CorsDomainsRs" } }, "500":{ "description":"Server error" } }, "security":[ { "integrationservicedeveloper Role":[ ] } ], "x-internal-id":"ic-api-integration-v1-environment-corsdomains-get", "x-filename-id":"ic-api-integration-v1-environment-corsdomains-get" }, "post":{ "tags":[ "Environment" ], "summary":"Create a List of Domains Allowed for CORS Processing", "description":"Creates a list of allowed domains for CORS processing. In the json payload, ensure that the list is in the following format: scheme, hostname, and port (optional). For example, \"corsDomains\": [\"https://abc.com\", \"http://xyz.com:123\"].", "operationId":"createCorsDomains", "consumes":[ "application/json" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "in":"body", "name":"body", "description":"CORS domains resource", "required":true, "schema":{ "$ref":"#/definitions/CorsDomainsRs" } } ], "responses":{ "204":{ "description":"Successful operation" }, "400":{ "description":"Bad request, missing required data" }, "500":{ "description":"Server error" } }, "security":[ { "integrationservicedeveloper Role":[ ] } ], "x-internal-id":"ic-api-integration-v1-environment-corsdomains-post", "x-filename-id":"ic-api-integration-v1-environment-corsdomains-post" }, "put":{ "tags":[ "Environment" ], "summary":"Update the List of Allowed Domains for CORS Processing", "description":"If you need to make modifications to the existing list of domains, use this API function to replace the existing list. Use the following format in the json payload: scheme, hostname, and port (optional). For example, \"corsDomains\": [\"https://abc.com\", \"http://xyz.com:123\"]. To clear or delete the list, update with an empty list. For example: \"corsDomains\": [].", "operationId":"updateCorsDomains", "consumes":[ "application/json" ], "produces":[ "application/json; charset=utf-8" ], "parameters":[ { "in":"body", "name":"body", "description":"CORS domains resource", "required":true, "schema":{ "$ref":"#/definitions/CorsDomainsRs" } } ], "responses":{ "204":{ "description":"Successful operation" }, "400":{ "description":"Bad request, missing required data" }, "500":{ "description":"Server error" } }, "security":[ { "integrationservicedeveloper Role":[ ] } ], "x-internal-id":"ic-api-integration-v1-environment-corsdomains-put", "x-filename-id":"ic-api-integration-v1-environment-corsdomains-put" } }, "/ic/api/process/v1/auth/token/permission":{ "post":{ "tags":[ "Decision Modeling Service" ], "summary":"Get a New Access Token and Refresh Token", "description":"Gets a new access token and a new refresh token using basic authentication.\n This is the initial call to make to get a token pair, an access token and a refresh token, for subsequent access to Decision Modeling Service. The caller may use the access token to access Decision Modeling Service for 15 minutes, while keeping the refresh token for obtaining a new access token upon the expiration of the initial access token. \n\n See Refresh the Access token for getting a new access token. See Decision Modeling Service for detecting access token expiration.\n", "security":[ { "basicAuth":[ ] } ], "parameters":[ { "$ref":"#/parameters/basicAuthHeader" } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "schema":{ "$ref":"#/definitions/Tokens" }, "examples":{ "application/json":{ "accessToken":{ "jwtToken":"JSUzI1NiIsInR5cCI6IkpX9.eyJleHAiOjC01YzgwOW4iOiJqY29vcGVyIiwQ.Ay6FY2LRNslKXQHVw73JC5UyF7741cg", "expiry":900 }, "refreshToken":{ "jwtToken":"eMUpQNFRZZTEybyJ9.eyJleHA1NjQ3fQ.L9GSU5Z7CI0mup_9fyQ80D4", "expiry":43200 } } } }, "401":{ "description":"Unauthorized" } }, "x-internal-id":"ic-api-process-v1-auth-token-permission-post", "x-filename-id":"ic-api-process-v1-auth-token-permission-post" } }, "/ic/api/process/v1/auth/token/refresh":{ "post":{ "tags":[ "Decision Modeling Service" ], "summary":"Refresh the Access Token", "description":"Gets a new access token using a refresh token. The caller may post to this resource to obtain a new access token which gives access to Decision Modeling Service for 15 minutes. The caller MUST put the refresh token string in the authorization header of the HTTP post request.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "schema":{ "$ref":"#/definitions/AccessToken" }, "examples":{ "application/json":{ "accessToken":{ "jwtToken":"JSUzI1NiIsInR5cCI6IkpX9.eyJleHAiOjC01YzgwOW4iOiJqY29vcGVyIiwQ.Ay6FY2LRNslKXQHVw73JC5UyF7741cg", "expiry":900 } } } }, "401":{ "description":"Unauthorized" } }, "x-internal-id":"ic-api-process-v1-auth-token-refresh-post", "x-filename-id":"ic-api-process-v1-auth-token-refresh-post" } }, "/ic/api/process/v1/dmn/spaces":{ "get":{ "tags":[ "Decision Modeling Service" ], "summary":"Get a List of Space IDs", "description":"Gets a list of space IDs created in the Decision Modeling Service. The list contains all spaces, created by PCS, which currently or previously have one or more decision models inside them. Authorization header MUST be set to type Bearer and an access token must be provided.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "schema":{ "$ref":"#/definitions/RestCollection" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-get", "x-filename-id":"ic-api-process-v1-dmn-spaces-get" } }, "/ic/api/process/v1/dmn/spaces/{spaceId}":{ "get":{ "tags":[ "Decision Modeling Service" ], "summary":"Get a Space by Space ID", "description":"

Gets the DMN space resource created in the Decision Model Service based on its space ID.

In Process, the resource ID of a DMN space is the same as that of the design time space in which it was created.

To retrieve the design time space ID, use the API /ic/api/process/v1/spaces.

", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "schema":{ "$ref":"#/definitions/RestObject" }, "examples":{ "application/json":{ "@class":".Space", "name":"0959b99e-b6cb-429e-b58f-94b7398463d0", "lastChangedTime":"2017/02/27T12:26:40", "lastChangedBy":"cdickens", "createdTime":"2017/02/27T12:24:27", "createdBy":"cdickens", "decisionModels":{ "@class":".RestCollection", "name":"decision-models", "lastChangedTime":"2017/02/27T12:26:40", "lastChangedBy":"cdickens", "createdTime":"2017/02/27T12:24:27", "createdBy":"cdickens" }, "permissions":{ "@class":".RestCollection", "name":"permissions", "lastChangedTime":"2017/02/27T12:24:27", "lastChangedBy":"cdickens", "createdTime":"2017/02/27T12:24:27", "createdBy":"cdickens", "items":[ { "@class":".Permission", "name":"Public", "lastChangedTime":"2017/02/27T12:24:27", "lastChangedBy":"cdickens", "createdTime":"2017/02/27T12:24:27", "createdBy":"cdickens", "read":false, "write":false, "execute":true, "administer":false } ] } } } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-get", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-get" } }, "/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models":{ "get":{ "tags":[ "Decision Modeling Service" ], "summary":"Get a List of Decision Model Names in a Space", "description":"Gets a list of names of the decision model names created in a space. Authorization header MUST be set to type Bearer and an access token must be provided.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "schema":{ "$ref":"#/definitions/RestCollection" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-get", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-get" } }, "/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}":{ "get":{ "tags":[ "Decision Modeling Service" ], "summary":"Get a Decision Model", "description":"Gets a decision model.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "name":"body", "in":"body", "description":"JSON representation of an empty decision model", "required":true, "schema":{ "$ref":"#/definitions/DecisionModel" } } ], "consumes":[ "application/json" ], "produces":[ "text/plain" ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/DecisionModel" }, "examples":{ "application/json":{ "@class":".DecisionModel", "name":"Decision Model 4", "versions":{ "@class":".RestCollection", "name":"versions", "items":[ ] }, "tags":{ "@class":".RestCollection", "name":"tags" }, "permissions":{ "@class":".RestCollection", "name":"permissions" } } } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-get", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-get" }, "put":{ "tags":[ "Decision Modeling Service" ], "summary":"Create an Empty Decision Model", "description":"Creates an empty decision model without any snapshots. This is the prerequisite for creating a snapshot in a decision model.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "name":"body", "in":"body", "description":"JSON representation of an empty decision model", "required":true, "schema":{ "$ref":"#/definitions/DecisionModel" } } ], "consumes":[ "application/json" ], "produces":[ "text/plain" ], "responses":{ "204":{ "description":"No Content (Operation successful)" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-put", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-put" }, "delete":{ "tags":[ "Decision Modeling Service" ], "summary":"Delete a Decision Model and Snapshots", "description":"Deletes a decision model together with all its snapshots. All snapshots including LATEST will be deleted. Authorization header MUST be set to type Bearer and an access token must be provided.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" } ], "produces":[ "text/plain" ], "responses":{ "204":{ "description":"No Content (Operation successful)" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-delete", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-delete" } }, "/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions":{ "get":{ "tags":[ "Decision Modeling Service" ], "summary":"Get a List of Decision Model Snapshot Names", "description":"Gets a list of names of the snapshots created for this decision model, including the snapshot named LATEST. Authorization header MUST be set to type Bearer and an access token must be provided.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "schema":{ "$ref":"#/definitions/RestCollection" } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-versions-get", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-versions-get" } }, "/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}":{ "get":{ "tags":[ "Decision Modeling Service" ], "summary":"Read or Export a Decision Model Snapshot", "description":"Reads a decision model snapshot. The response body if saved, may be used for import later. When using this API for export, the query parameters listed below MUST be set. Authorization header MUST be set to type Bearer and an access token must be provided.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "$ref":"#/parameters/decisionModelVersion" }, { "name":"levels", "description":"Maximum resource depth to expand. Set to all for this request", "type":"string", "in":"query", "required":true, "default":"all" }, { "name":"omitFields", "description":"A list of comma-seperated fields to be omittied from the response. MUST includes the following fields when making request to export a snapshot :lastChangedBy,lastChangedTime,createdBy,createdTime,links,interpretation,problems,references. When used for other purposes, it can be set to references,links.", "type":"string", "in":"query", "required":true, "default":"lastChangedBy,lastChangedTime,createdBy,createdTime,links,interpretation,problems,references" } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "schema":{ "$ref":"#/definitions/DecisionModelVersion" }, "examples":{ "application/json":{ "@class":".DecisionModelVersion", "name":"TestSnapshot1", "description":"Initial version", "contentLastChangedTime":"2017/02/04T17:24:12", "testCases":{ "@class":".RestCollection", "name":"test-cases", "items":[ { "@class":".TestCase", "testCaseData":{ "@class":".TestCaseData", "data":{ "inp":{ "@class":".Script", "lines":[ "1" ], "scriptNode":{ "@class":".ScriptNode", "interpretation":1, "kind":"Literal", "data":1 } } }, "name":"data" }, "result":{ "@class":".Definition", "requirementsModel":"list", "inputData":{ "@class":".RestCollection", "name":"input-data", "items":[ { "@class":".InputData", "typeRef":{ "@class":".TypeRef", "name":"number" }, "name":"inp" } ] }, "decisions":{ "@class":".RestCollection", "name":"decisions", "items":[ { "@class":".Decision", "listIndex":1, "logic":{ "@class":".Interpretable", "expression":{ "@class":".Script", "lines":[ "sum(inp)" ], "scriptNode":{ "@class":".ScriptNode", "interpretation":1, "references":[ { "$class":"path", "components":[ "spaces", "3d070270-6252-4c8e-af84-15058ca2b297", "decision-models", "Decision Model With List", "versions", "LATEST", "test-cases", "DefaultTestCase", "result", "input-data", "inp" ] } ], "kind":"Invocation", "children":[ { "@class":".ScriptNode", "interpretation":{ "$class":"function", "arguments":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "properties":{ "list of numbers":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"array", "items":{ "type":"number" } } } }, "returns":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"number" }, "closureScope":{ "$class":"path", "components":[ "sum" ] } }, "kind":"Qname", "data":[ "sum" ] }, { "@class":".ScriptNode", "kind":"Args", "children":[ { "@class":".ScriptNode", "interpretation":1, "references":[ { "$class":"path", "components":[ "spaces", "3d070270-6252-4c8e-af84-15058ca2b297", "decision-models", "Decision Model With List", "versions", "LATEST", "test-cases", "DefaultTestCase", "result", "input-data", "inp" ] } ], "kind":"Qname", "data":[ "inp" ] } ] } ] } }, "name":"logic" }, "name":"Decision With List" } ] }, "decisionServices":{ "@class":".RestCollection", "name":"decision-services", "items":[ { "@class":".DecisionService", "outputDecisions":{ "@class":".DecisionService$DecisionReferenceCollection" }, "inputData":{ "@class":".DecisionService$InputDataReferenceCollection" }, "inputDecisions":{ "@class":".DecisionService$DecisionReferenceCollection" }, "name":"Test Service" } ] }, "itemDefinitions":{ "@class":".RestCollection", "name":"item-definitions" }, "name":"result" }, "name":"DefaultTestCase" } ] }, "definition":{ "@class":".Definition", "requirementsModel":"list", "inputData":{ "@class":".RestCollection", "name":"input-data", "items":[ { "@class":".InputData", "typeRef":{ "@class":".TypeRef", "name":"number" }, "name":"inp" } ] }, "decisions":{ "@class":".RestCollection", "name":"decisions", "items":[ { "@class":".Decision", "listIndex":1, "links":[ { "rel":"self", "href":"http://example.com:7001/ic/api/process/v1/spaces/3d070270-6252-4c8e-af84-15058ca2b297/decision-models/Decision%20Model%20With%20List/versions/LATEST/definition/decisions/Decision%20With%20List/" } ], "logic":{ "@class":".Interpretable", "expression":{ "@class":".Script", "lines":[ "sum(inp)" ], "scriptNode":{ "@class":".ScriptNode", "interpretation":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"number" }, "references":[ { "$class":"path", "components":[ "spaces", "3d070270-6252-4c8e-af84-15058ca2b297", "decision-models", "Decision Model With List", "versions", "LATEST", "definition", "input-data", "inp" ] } ], "kind":"Invocation", "children":[ { "@class":".ScriptNode", "interpretation":{ "$class":"function", "arguments":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "properties":{ "list of numbers":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"array", "items":{ "type":"number" } } } }, "returns":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"number" }, "closureScope":{ "$class":"path", "components":[ "sum" ] } }, "kind":"Qname", "data":[ "sum" ] }, { "@class":".ScriptNode", "kind":"Args", "children":[ { "@class":".ScriptNode", "interpretation":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"number" }, "references":[ { "$class":"path", "components":[ "spaces", "3d070270-6252-4c8e-af84-15058ca2b297", "decision-models", "Decision Model With List", "versions", "LATEST", "definition", "input-data", "inp" ] } ], "kind":"Qname", "data":[ "inp" ] } ] } ] } }, "name":"logic" }, "name":"Decision With List" } ] }, "decisionServices":{ "@class":".RestCollection", "name":"decision-services", "items":[ { "@class":".DecisionService", "outputDecisions":{ "@class":".DecisionService$DecisionReferenceCollection" }, "inputData":{ "@class":".DecisionService$InputDataReferenceCollection" }, "inputDecisions":{ "@class":".DecisionService$DecisionReferenceCollection" }, "name":"Test Service" } ] }, "itemDefinitions":{ "@class":".RestCollection", "name":"item-definitions" }, "name":"definition" }, "permissions":{ "@class":".RestCollection", "name":"permissions" } } } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-versions-{decisionModelVersion}-get", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-versions-decisionmodelversion-get" }, "put":{ "tags":[ "Decision Modeling Service" ], "summary":"Import a Decision Model Snapshot", "description":"Imports a snapshot into a decision model.

Prerequisites:

To successfully import a decision model snapshot, the following conditions must be met:

Example:

{\n  \"@class\": \".DecisionModelVersion\",\n  \"name\": \"LATEST\",\n  \"description\": \"Initial version\"\n  ...\n  \n\n}
", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "$ref":"#/parameters/decisionModelVersion" }, { "name":"body", "in":"body", "description":"JSON representation of the decision model snapshot", "required":true, "schema":{ "$ref":"#/definitions/DecisionModelVersion" } } ], "consumes":[ "application/json" ], "produces":[ "text/plain" ], "responses":{ "204":{ "description":"No Content (Operation successful)" }, "400":{ "description":"Bad Request" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-versions-{decisionModelVersion}-put", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-versions-decisionmodelversion-put" }, "delete":{ "tags":[ "Decision Modeling Service" ], "summary":"Delete a Decision Model Snapshot", "description":"Deletes a decision model snapshot. Before the snapshot can be deleted, the caller should undeploy the snapshot by making a DELETE request on the corresponding tag resource /dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagName}. The tag name represents the runtime version ID of the snapshot. Otherwise, status 409 will be returned.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "$ref":"#/parameters/decisionModelVersion" } ], "produces":[ "text/plain" ], "responses":{ "204":{ "description":"No Content (Operation successful)" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "409":{ "description":"Conflict (Cannot delete active version)" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-versions-{decisionModelVersion}-delete", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-versions-decisionmodelversion-delete" } }, "/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags":{ "get":{ "tags":[ "Decision Modeling Service" ], "summary":"Get a List of Runtime Version IDs of a Decision Model", "description":"Gets a list of runtime version IDs of a decision model. A runtime ID version is the version ID assigned by the user when a snapshot is deployed. Runtime version IDs are the tag name in the tag resource path. Tag is a child resource of the decision model resource. The response body contains a reference to the snapshot name.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "name":"levels", "description":"Maximum resource depth to expand. Set to 2 for this request", "type":"number", "in":"query", "required":true, "default":2 } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "examples":{ "application/json":{ "@class":".RestCollection", "name":"tags", "lastChangedTime":"2017/02/01T15:49:47", "lastChangedBy":"jlondon", "createdTime":"2017/01/17T11:35:08", "createdBy":"jlondon", "items":[ { "@class":".DecisionModelTag", "name":"1.0", "lastChangedTime":"2017/02/01T15:49:47", "lastChangedBy":"jlondon", "createdTime":"2017/02/01T15:49:47", "createdBy":"jlondon", "ref":{ "@class":".DecisionModelTag$VersionReference", "name":"SampleDecisionModelSnapshot1" } } ] } } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-tags-get", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-tags-get" } }, "/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}":{ "get":{ "tags":[ "Decision Modeling Service" ], "summary":"Get the Snapshot Name Associated with a Runtime Version ID", "description":"Gets the snapshot name associated with a runtime version ID. A runtime ID version is the version ID assigned by the user when a snapshot is deployed. Runtime versions IDs are the tag name in the tag resource path. Tag is a child resource of the decision model resource. The response contains the json representation of a tag resource, of which the resource name is the runtime version ID, in which the ref attribute contains the snapshot name.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "$ref":"#/parameters/tagId" } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "schema":{ "$ref":"#/definitions/DecisionModelTag" }, "examples":{ "application/json":{ "@class":".DecisionModelTag", "name":"2.0", "lastChangedBy":"jlondon", "createdTime":"2017/02/01T15:49:47", "createdBy":"jlondon", "ref":{ "@class":".DecisionModelTag$VersionReference", "name":"SampleDecisionModelSnapshot1" } } } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-tags-{tagId}-get", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-tags-tagid-get" }, "put":{ "tags":[ "Decision Modeling Service" ], "summary":"Deploy a Decision Model Snapshot", "description":"Deploys a decision model snapshot. A runtime ID version is the version ID assigned by the user when a snapshot is deployed. Runtime versions IDs are the tag name in the tag resource path. Tag is a child resource of the decision model resource. The request body MUST contain the json representation of a tag resource, in which the ref attribute contains the snapshot name.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "$ref":"#/parameters/tagId" }, { "name":"body", "in":"body", "description":"json description of the runtime version ID.", "required":true, "schema":{ "$ref":"#/definitions/DecisionModelTag" } } ], "consumes":[ "application/json" ], "produces":[ "text/plain" ], "responses":{ "204":{ "description":"No Content (Operation successful)" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-tags-{tagId}-put", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-tags-tagid-put" }, "delete":{ "tags":[ "Decision Modeling Service" ], "summary":"Undeploy a Runtime Version ID of a Decision Model", "description":"Undeploys a particular runtime version ID of a decision model. A runtime ID version is the version ID assigned by the user when a snapshot is deployed. Runtime versions IDs are the tag name in the tag resource path. Tag is a child resource of the decision model resource. This DELETE request will delete a tag resource of a decision model. As the tag resource contains the reference to the snapshot, deleting the tag resource essentially free the snapshot from the runtime version binding. Hence, undeploying the snapshot. Currently, there is no single REST API to undeploy based on snapshot names. If caller wants to undeploy using snapshot names, he can do a GET on /tags resource path and loop through all the tag items in the collection to determine the tag that has attribute ref referrring to the snapshot he wants to delete.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "$ref":"#/parameters/tagId" } ], "produces":[ "text/plain" ], "responses":{ "204":{ "description":"No Content (Operation successful)" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-tags-{tagId}-delete", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-tags-tagid-delete" } }, "/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services":{ "get":{ "tags":[ "Decision Modeling Service" ], "summary":"Get a List of Decision Services of a Decision Model Snapshot", "description":"Reads the list of decision services of a decision model snapshot.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "$ref":"#/parameters/decisionModelVersion" } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "schema":{ "$ref":"#/definitions/RestCollection" }, "examples":{ "application/json":{ "@class":".RestCollection", "name":"decision-services", "lastChangedTime":"2017/02/04T17:37:05", "lastChangedBy":"jlondon", "createdTime":"2017/01/14T18:57:29", "createdBy":"jlondon", "items":[ { "@class":".DecisionService", "name":"Test Service" } ] } } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-versions-{decisionModelVersion}-definition-decision-services-get", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-versions-decisionmodelversion-definition-decision-services-get" } }, "/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services/{decisionServiceName}":{ "get":{ "tags":[ "Decision Modeling Service" ], "summary":"Get Information about a Decision Service by Snapshot Name", "description":"Gets the input argument and output returned from a decision service. The attribute interpretation in the response body contains JSON schema of the input arguments and return output. The snapshot name is identified by {decisionModelVersion}.\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "$ref":"#/parameters/decisionModelVersion" }, { "$ref":"#/parameters/decisionServiceName" } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "schema":{ "$ref":"#/definitions/DecisionService" }, "examples":{ "application/json":{ "@class":".DecisionService", "interpretation":{ "$class":"function", "arguments":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "properties":{ "InputInt":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"number" } } }, "returns":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "properties":{ "interpretation":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"number" }, "problems":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"array", "items":{ "type":"object", "properties":{ "message":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"string" } } } } } } }, "outputDecisions":{ "@class":".DecisionService$DecisionReferenceCollection", "items":[ { "@class":".DecisionService$DecisionReference", "name":"Plus One" } ] }, "inputData":{ "@class":".DecisionService$InputDataReferenceCollection", "items":[ { "@class":".DecisionService$InputDataReference", "name":"InputInt" } ] }, "inputDecisions":{ "@class":".DecisionService$DecisionReferenceCollection" }, "createdBy":"jstein", "createdTime":"2017/02/02T11:11:49", "lastChangedBy":"jstein", "lastChangedTime":"2017/02/02T11:12:44", "name":"Plus One Service" } } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-versions-{decisionModelVersion}-definition-decision-services-{decisionServiceName}-get", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-versions-decisionmodelversion-definition-decision-services-decisionservicename-get" }, "post":{ "tags":[ "Decision Modeling Service" ], "summary":"Invoke a Decision Service by Snapshot Name", "description":"Invokes a decision service by the snapshot name. The request body should contain a map of Interpretations representing input data. The response body returns a DecisionServiceResult containing the Interpretation of output and any Problems encountered. The snapshot name is identified by {decisionModelVersion}.\n \n For example, if the arguments attribute of the response shows the following JSON schema:\n ```JSON\n {\"arguments\":\n {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"emp\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"Emp_number\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"number\"\n },\n \"Emp_name\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"string\"\n }\n }\n }\n }\n } \n }\n ```\n The request body of the post request should contain the JSON representation of emp object as shown:\n ```JSON\n { \n \"emp\" :\n {\n \"Emp_name\": \"John Doe\",\n \"Emp_number\": 3\n }\n }\n ```\n", "parameters":[ { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "$ref":"#/parameters/decisionModelVersion" }, { "$ref":"#/parameters/decisionServiceName" }, { "name":"body", "in":"body", "description":"Json representation of a map of interpretations representing the input data. Schema shows an sample object with 3 fields.\n", "required":true, "schema":{ "$ref":"#/definitions/InvokeExample" } } ], "consumes":[ "application/json" ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-versions-{decisionModelVersion}-definition-decision-services-{decisionServiceName}-post", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-versions-decisionmodelversion-definition-decision-services-decisionservicename-post" } }, "/ic/api/process/v1/dmn/spaces/{spaceId}/decision-models/{decisionModelName}/tags/{tagId}/definition/decision-services/{decisionServiceName}":{ "get":{ "tags":[ "Decision Modeling Service" ], "summary":"Get Information of a Deployed Decision Service by the Runtime Version ID", "description":"Gets the input argument and output returned from a decision service. The attribute interpretation in the response body contains JSON schema of the input arguments and return output. Making this GET request is equivalent to making a GET request to /dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services/{decisionServiceName}, in which {decisionModelVersion} is the name of the snapshot behind the corresponding runtime version ID. Note that only deployed snapshots (identified by decisionModelVersion) have a runtime version ID (identified by tagId).\n", "parameters":[ { "$ref":"#/parameters/authorizationHeader" }, { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "$ref":"#/parameters/tagId" }, { "$ref":"#/parameters/decisionServiceName" } ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response", "schema":{ "$ref":"#/definitions/DecisionService" }, "examples":{ "application/json":{ "@class":".DecisionService", "interpretation":{ "$class":"function", "arguments":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "properties":{ "InputInt":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"number" } } }, "returns":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"object", "properties":{ "interpretation":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"number" }, "problems":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"array", "items":{ "type":"object", "properties":{ "message":{ "$schema":"http://json-schema.org/draft-04/schema#", "type":"string" } } } } } } }, "outputDecisions":{ "@class":".DecisionService$DecisionReferenceCollection", "items":[ { "@class":".DecisionService$DecisionReference", "name":"Plus One" } ] }, "inputData":{ "@class":".DecisionService$InputDataReferenceCollection", "items":[ { "@class":".DecisionService$InputDataReference", "name":"InputInt" } ] }, "inputDecisions":{ "@class":".DecisionService$DecisionReferenceCollection" }, "createdBy":"jstein", "createdTime":"2017/02/02T11:11:49", "lastChangedBy":"jstein", "lastChangedTime":"2017/02/02T11:12:44", "name":"Plus One Service" } } }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "404":{ "description":"Not Found" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-tags-{tagId}-definition-decision-services-{decisionServiceName}-get", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-tags-tagid-definition-decision-services-decisionservicename-get" }, "post":{ "tags":[ "Decision Modeling Service" ], "summary":"Invoke a Deployed Decision Service by the Runtime Version ID", "description":"Invokes a deployed decision service by the runtime version ID. The request body should contain a map of Interpretations representing input data. The response body returns a DecisionServiceResult containing the Interpretation of output and any Problems encountered. Making this POST request is equivalent to making a POST request to /dmn/spaces/{spaceId}/decision-models/{decisionModelName}/versions/{decisionModelVersion}/definition/decision-services/{decisionServiceName}, in which {decisionModelVersion} is the name of the snapshot behind the corresponding runtime version Id. Note that only deployed snapshots (identified by decisionModelVersion) have a runtime version Id (identified by tagId)\n \n For example, if the arguments attribute of the response shows the following JSON schema:\n ```JSON\n {\"arguments\":\n {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"emp\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"object\",\n \"properties\": {\n \"Emp_number\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"number\"\n },\n \"Emp_name\": {\n \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n \"type\": \"string\"\n }\n }\n }\n }\n } \n }\n ```\n The request body of the post request should contain the JSON representation of emp object as shown:\n ```JSON\n { \n \"emp\" :\n {\n \"Emp_name\": \"John Doe\",\n \"Emp_number\": 3\n }\n }\n ```\n", "parameters":[ { "$ref":"#/parameters/spaceId" }, { "$ref":"#/parameters/decisionModelName" }, { "$ref":"#/parameters/tagId" }, { "$ref":"#/parameters/decisionServiceName" }, { "name":"body", "in":"body", "description":"Json representation of a map of interpretations representing the input data. Schema shows an sample object with 3 fields.\n", "required":true, "schema":{ "$ref":"#/definitions/InvokeExample" } } ], "consumes":[ "application/json" ], "produces":[ "application/json", "text/plain" ], "responses":{ "200":{ "description":"Successful Response" }, "401":{ "description":"Unauthorized" }, "403":{ "description":"Forbidden (Expired or invalid token)" }, "500":{ "description":"Internal Server Error" } }, "x-internal-id":"ic-api-process-v1-dmn-spaces-{spaceId}-decision-models-{decisionModelName}-tags-{tagId}-definition-decision-services-{decisionServiceName}-post", "x-filename-id":"ic-api-process-v1-dmn-spaces-spaceid-decision-models-decisionmodelname-tags-tagid-definition-decision-services-decisionservicename-post" } }, "/ic/api/b2b/v1/tpm/host":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve the Host Profile", "description":"Retrieves the host company name and host Identifiers.", "operationId":"getHostProfile", "produces":[ "application/json" ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/HostIdentifiersRs" } }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-host-get", "x-filename-id":"ic-api-b2b-v1-tpm-host-get" }, "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Create/Update Host Profile", "description":"Add new or update existing host identifier with the specified host company name.", "operationId":"updateHostProfile", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"

Update host profile.

\n

\n\tExample: \n

\n
{\t\"identifiers\" : [\t{\"type\": \"EDI Group ID\", \"value\": \"hostEdiGrp\"}], \"name\": \"My Company\"}
", "required":true, "schema":{ "$ref":"#/definitions/HostIdentifiersRs" } } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/HostIdentifierRs" } }, "201":{ "description":"Successful operation" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-host-post", "x-filename-id":"ic-api-b2b-v1-tpm-host-post" } }, "/ic/api/b2b/v1/tpm/host/{id}":{ "delete":{ "tags":[ "B2B/Trading Partner" ], "summary":"Delete a Host Identifier", "description":"Deletes a host identifier only when there are no association with agreements and transports.", "operationId":"deleteHostIdentifier", "produces":[ "application/json" ], "parameters":[ { "name":"id", "in":"path", "description":"

Host identifier ID.

\n

\n\tExample: \n

\n
/b2b/v1/tpm/host/11678035855650825
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/HostIdentifierRs" } }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-host-{id}-delete", "x-filename-id":"ic-api-b2b-v1-tpm-host-id-delete" } }, "/ic/api/b2b/v1/tpm/partners":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve Trading Partners", "description":"Retrieve all available trading partners.", "operationId":"getTradingPartnerList", "produces":[ "application/json" ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TradingPartnersRs" } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-get" }, "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Create a Trading Partner", "description":"Creates a trading partner with the specified name and description.", "operationId":"createTradingPartner", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"

Create trading partner request details.

\n

\n\tExample: \n

\n
{\"id\": \"TP123\",\t\"name\": \"tp123\",\t\"desc\": \"description of tp123 \"}
", "required":true, "schema":{ "$ref":"#/definitions/TradingPartnerRs" } } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/TradingPartnerRs" } }, "201":{ "description":"Successful operation" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-post", "x-filename-id":"ic-api-b2b-v1-tpm-partners-post" } }, "/ic/api/b2b/v1/tpm/partners/import":{ "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Import a Trading Partner", "description":"Imports a trading partner with the associated transport, agreements, documents, schemas and host identifiers from the previously exported trading partner zip file.", "operationId":"importTradingPartner", "consumes":[ "multipart/form-data" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"Previously exported trading partner file.", "required":true, "schema":{ "$ref":"#/definitions/InputStream" } }, { "name":"isOverwrite", "in":"query", "description":"

Overwrite flag to overwrite components in zip file. Default value is false.

\n

\n\tExample: \n

\n
ic/api/b2b/v1/tpm/partners/import?isOverwrite=true
", "required":true, "type":"boolean", "default":false } ], "responses":{ "201":{ "description":"Successful operation" }, "404":{ "description":"Not found" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-import-post", "x-filename-id":"ic-api-b2b-v1-tpm-partners-import-post" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve a Trading Partner", "description":"Retrieves a trading partner with the specified trading partner id.", "operationId":"getTradingPartner", "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"

Trading partner ID.

\n

\n\tExample: \n

\n
/b2b/v1/tpm/partners/TP123
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TradingPartnerRs" } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-get" }, "put":{ "tags":[ "B2B/Trading Partner" ], "summary":"Update a Trading Partner", "description":"Updates a trading partner with the specified trading partner id.", "operationId":"updateTPNameDesc", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"

Update trading partner request details.

\n

\n\tExample: \n

\n
{\t\"name\": \"tp123\",\t\"desc\": \"updating new description of tp123 \"}
", "required":true, "schema":{ "$ref":"#/definitions/TradingPartnerRs" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TradingPartnerRs" } }, "404":{ "description":"Not found" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-put", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-put" }, "delete":{ "tags":[ "B2B/Trading Partner" ], "summary":"Delete a Trading Partner", "description":"Deletes a trading partner with the specified trading partner id.", "operationId":"deleteTradingPartner", "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/TradingPartnerRs" } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-delete", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-delete" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/contacts":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve Trading Partner Contact Details", "description":"Retrieves trading partner contact details with the specified trading partner id.", "operationId":"getContacts", "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"

Trading partner ID.

\n

\n\tExample: \n

\n
/b2b/v1/tpm/partners/TP123/contacts
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ContactsRs" } }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-contacts-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-contacts-get" }, "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Create/Update Trading Partner Contacts", "description":"Add new contact or update existing contact details with the specified trading partner id.", "operationId":"saveContacts", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"

Update trading partner contacts request details.

\n

\n\tExample: \n

\n
{ \"contacts\" : [{ \"type\": \"firstName\", \"value\": \"John\"}]}
", "required":true, "schema":{ "$ref":"#/definitions/ContactsRs" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/ContactsRs" } }, "201":{ "description":"Successful operation" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-contacts-post", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-contacts-post" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/export":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Export a Trading Partner", "description":"Exports a trading partner with the associated agreements, documents, schemas and host identifiers as a zipped file.", "operationId":"exportTradingPartner", "produces":[ "application/octet-stream" ], "parameters":[ { "name":"tpId", "in":"path", "description":"

Trading partner ID.

\n

\n\tExample: \n

\n
/b2b/v1/tpm/partners/TP1/export
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-export-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-export-get" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/identifiers":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve B2B Identifiers", "description":"Retrieves all available b2b identifiers with the specified trading partner id.", "operationId":"getIdentifiers", "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"

Trading partner ID.

\n

\n\tExample: \n

\n
/b2b/v1/tpm/partners/TP123/identifiers
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/IdentifiersRs" } }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-identifiers-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-identifiers-get" }, "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Create/Update B2B Identifiers", "description":"Add new or update existing b2b identifier with the specified trading partner id.", "operationId":"saveIdentifiers", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"

Update b2b identifier request details.

\n

\n\tExample: \n

\n
{\t\"identifiers\" : [\t{\"type\": \"EDI Interchange\", \"value\": \"tpediinter\"}]}
", "required":true, "schema":{ "$ref":"#/definitions/IdentifiersRs" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/IdentifiersRs" } }, "201":{ "description":"Successful operation" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-identifiers-post", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-identifiers-post" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/identifiers/{identifierId}":{ "delete":{ "tags":[ "B2B/Trading Partner" ], "summary":"Delete a B2B Identifier", "description":"Deletes a b2b identifier only when there are no association with agreements and transports.", "operationId":"deleteTPIdentifier", "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner Id.", "required":true, "type":"string" }, { "name":"identifierId", "in":"path", "description":"

Trading partner ID.

\n

\n\tExample: \n

\n
/b2b/v1/tpm/partners/TP123/identifiers/1990020336714597
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/ResponseStatus" } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-identifiers-{identifierId}-delete", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-identifiers-identifierid-delete" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve Inbound Agreements", "description":"Retrieves all inbound agreements with the specified trading partner id.", "operationId":"getInboundAgreements", "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/InboundAgrRs" } }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-inboundagrs-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-inboundagrs-get" }, "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Create an Inbound Agreement", "description":"Creates an inbound agreement for trading partner. The request body must contain atleast name and docId fields.", "operationId":"createInboundAgreement", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"

Create trading partner inbound agreement request.

\n

\n\tExample: \n

\n
{ \"name\": \"inagr\",     \"desc\": \"inagr desc\",    \"docId\":\"DOC1\",     \"params\":{       \"validate\":true,        \"fa\":true    },\t\"backendIntgCode\": \"EDI_INTG\",\t\"backendIntgVersion\": \"01.02.0000\"}
", "required":true, "schema":{ "$ref":"#/definitions/InboundAgrRs" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/InboundAgrsRs" } }, "201":{ "description":"Successful operation" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-inboundagrs-post", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-inboundagrs-post" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve an Inbound Agreement", "description":"Retrieves an inbound agreement with the specified trading partner id and inbound agreement id.", "operationId":"getInboundAgreement", "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner Id.", "required":true, "type":"string" }, { "name":"agrId", "in":"path", "description":"

Trading partner inbound agreement ID.

\n

\n\tExample: \n

\n
/b2b/v1/tpm/partners/TP123/inboundagrs/INAGR1604824600539
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/InboundAgrRs" } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-inboundagrs-{agrId}-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-inboundagrs-agrid-get" }, "put":{ "tags":[ "B2B/Trading Partner" ], "summary":"Update an Inbound Agreement", "description":"Updates an inbound agreement with the specified trading partner id and inbound agreement id.", "operationId":"updateInboundAgreement", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"

Update trading partner inbound agreement request.

\n

\n\tExample: \n

\n
{ \"name\": \"inagr\",     \"desc\": \"inagr description updated \",    \"docId\":\"DOC2\",     \"params\":{       \"validate\":false,        \"fa\":true    },\t\"backendIntgCode\": \"EDI_B2B_INTG\",\t\"backendIntgVersion\": \"01.03.0000\"}
", "required":true, "schema":{ "$ref":"#/definitions/InboundAgrRs" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "type":"string" }, { "name":"agrId", "in":"path", "description":"Inbound agreement ID.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/InboundAgrRs" } }, "404":{ "description":"Not found" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-inboundagrs-{agrId}-put", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-inboundagrs-agrid-put" }, "delete":{ "tags":[ "B2B/Trading Partner" ], "summary":"Delete an Inbound Agreement", "description":"Deletes an inbound agreement with the specified trading partner id and inbound agreement id.", "operationId":"deleteInboundAgreement", "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner Id.", "required":true, "type":"string" }, { "name":"agrId", "in":"path", "description":"Trading partner inbound agreement ID.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/InboundAgrRs" } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-inboundagrs-{agrId}-delete", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-inboundagrs-agrid-delete" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}/deploy":{ "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Deploy an Inbound Agreement", "description":"Deploys an inbound agreement with active backend integration and B2B document linked to it. The deployed agreements translates and processes messages.", "operationId":"deployInboundAgreements", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"

Trading partner ID.

\n", "required":true, "type":"string" }, { "name":"agrId", "in":"path", "description":"

Inbound agreement ID.

\n

\n\tExample: \n

\n
/b2b/v1/tpm/partners/TP123/inboundagrs/INAGR12333344/deploy
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/DeployUndeployRs" } }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-inboundagrs-{agrId}-deploy-post", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-inboundagrs-agrid-deploy-post" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/inboundagrs/{agrId}/undeploy":{ "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Undeploy an Inbound Agreement", "description":"Undeploys an inbound agreement to disallow acceptance of new messages by the agreement. However, all in-flight messages will be processed successfully.", "operationId":"unDeployInboundAgreements", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"

Trading partner ID.

\n", "required":true, "type":"string" }, { "name":"agrId", "in":"path", "description":"

Inbound agreement ID.

\n

\n\tExample: \n

\n
/b2b/v1/tpm/partners/TP123/inboundagrs/INAGR12333344/undeploy
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/DeployUndeployRs" } }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-inboundagrs-{agrId}-undeploy-post", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-inboundagrs-agrid-undeploy-post" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve Outbound Agreements", "description":"Retrieves all available outbound agreements with the specified trading partner id.", "operationId":"getOutboundAgreements", "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"

Trading partner ID.

\n

\n\tExample: \n

\n
/b2b/v1/tpm/partners/TP123/outboundagrs
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/OutboundAgrRs" } }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-outboundagrs-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-outboundagrs-get" }, "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Create an Outbound Agreement", "description":"Creates an outbound agreement with the specified trading partner id. The request body must contain atleast name, transportId and docId fields.", "operationId":"createOutboundAgreement", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"

Create trading partner outbound agreement request.

\n

\n\tExample: \n

\n
{ \"name\": \"outagr\", \"desc\": \"out agr\",\t\"docId\":\"DOC1\",  \"transportId\":\"TRANS123456\",  \"params\":{      \"validate\":true,         \"fa\":true    }, \"hostIdentifiersRef\": [ {\"id\": 3730642141264966 }],        \"tpIdentifiersRef\": [{\"id\": 3710624275162543 }, {\"id\": 3710624275252203}]}
", "required":true, "schema":{ "$ref":"#/definitions/OutboundAgrRs" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"successful operation", "schema":{ "$ref":"#/definitions/OutboundAgrRs" } }, "201":{ "description":"Successful operation" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-outboundagrs-post", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-outboundagrs-post" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve an Outbound Agreement", "description":"Retrieves an outbound agreement with the specified trading partner id and agrrement id.", "operationId":"getOutboundAgreement", "produces":[ "application/json" ], "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner Id.", "required":true, "type":"string" }, { "name":"agrId", "in":"path", "description":"

Trading partner outbound agreement ID.

\n

\n\tExample: \n

\n
/b2b/v1/tpm/partners/TP123/outboundagrs/OUTAGR1604824600539
", "required":true, "type":"string" } ], "responses":{ "200":{ "description":"Successful operation", "schema":{ "$ref":"#/definitions/OutboundAgrRs" } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-outboundagrs-{agrId}-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-outboundagrs-agrid-get" }, "put":{ "tags":[ "B2B/Trading Partner" ], "summary":"Update an Outbound Agreement", "description":"Updates an outbound agreement with the specified trading partner id and agrrement id.", "operationId":"updateOutboundAgreement", "consumes":[ "application/json" ], "produces":[ "application/json" ], "parameters":[ { "in":"body", "name":"body", "description":"

Update trading partner outbound agreement request.

\n

\n\tExample: \n

\n
{ \"name\": \"outagr\", \"desc\": \"out agr desc updated \",\t\"docId\":\"DOC2\",   \"transportId\":\"TRANS212222\",    \"params\":{      \"validate\":false,         \"fa\":true    }, \"hostIdentifiersRef\": [],        \"tpIdentifiersRef\": [\"id\": 8621624275162543 }]}",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/OutboundAgrRs"
                        }
                    },
                    {
                        "name":"tpId",
                        "in":"path",
                        "description":"Trading partner Id.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"agrId",
                        "in":"path",
                        "description":"Trading partner outbound agreement ID.",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"successful operation",
                        "schema":{
                            "$ref":"#/definitions/OutboundAgrRs"
                        }
                    },
                    "201":{
                        "description":"Successful operation"
                    },
                    "404":{
                        "description":"Not found"
                    },
                    "409":{
                        "description":"Duplicate data error"
                    },
                    "412":{
                        "description":"Pre condition failure"
                    },
                    "500":{
                        "description":"Server error"
                    }
                },
                "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-outboundagrs-{agrId}-put",
                "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-outboundagrs-agrid-put"
            },
            "delete":{
                "tags":[
                    "B2B/Trading Partner"
                ],
                "summary":"Delete an Outbound Agreement",
                "description":"Deletes an Outbound Agreement with the specified trading partner id and outbound agreement id.",
                "operationId":"deleteOutboundAgreement",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"tpId",
                        "in":"path",
                        "description":"Trading partner Id.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"agrId",
                        "in":"path",
                        "description":"Trading partner outbound agreement ID.",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Successful operation",
                        "schema":{
                            "$ref":"#/definitions/OutboundAgrRs"
                        }
                    },
                    "404":{
                        "description":"Not found"
                    },
                    "412":{
                        "description":"Pre condition failure"
                    },
                    "500":{
                        "description":"Server error"
                    }
                },
                "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-outboundagrs-{agrId}-delete",
                "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-outboundagrs-agrid-delete"
            }
        },
        "/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}/deploy":{
            "post":{
                "tags":[
                    "B2B/Trading Partner"
                ],
                "summary":"Deploy an Outbound Agreement",
                "description":"Deploys an outbound agreement. The deployed agreements translates and processes messages.",
                "operationId":"deployOutboundAgreements",
                "consumes":[
                    "application/json"
                ],
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"tpId",
                        "in":"path",
                        "description":"
Trading partner ID.
\n",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"agrId",
                        "in":"path",
                        "description":"
Outbound agreement ID.
\n
\n\tExample: \n
 \n
/b2b/v1/tpm/partners/TP123/outboundagrs/OUTAGR12333344/deploy
",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"successful operation",
                        "schema":{
                            "$ref":"#/definitions/DeployUndeployRs"
                        }
                    },
                    "412":{
                        "description":"Pre condition failure"
                    },
                    "500":{
                        "description":"Server error"
                    }
                },
                "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-outboundagrs-{agrId}-deploy-post",
                "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-outboundagrs-agrid-deploy-post"
            }
        },
        "/ic/api/b2b/v1/tpm/partners/{tpId}/outboundagrs/{agrId}/undeploy":{
            "post":{
                "tags":[
                    "B2B/Trading Partner"
                ],
                "summary":"Undeploy an Outbound Agreement",
                "description":"Undeploys an outbound agreement to disallow acceptance of new messages by the agreement. However, all in-flight messages will be processed successfully.",
                "operationId":"unDeployOutboundAgreements",
                "consumes":[
                    "application/json"
                ],
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"tpId",
                        "in":"path",
                        "description":"
Trading partner ID.
\n
\n\tExample: \n
 \n
/b2b/v1/tpm/partners/TP123/outboundagrs/OUTAGR12333344/undeploy
",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"agrId",
                        "in":"path",
                        "description":"
Outbound agreement ID.
\n",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"successful operation",
                        "schema":{
                            "$ref":"#/definitions/DeployUndeployRs"
                        }
                    },
                    "412":{
                        "description":"Pre condition failure"
                    },
                    "500":{
                        "description":"Server error"
                    }
                },
                "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-outboundagrs-{agrId}-undeploy-post",
                "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-outboundagrs-agrid-undeploy-post"
            }
        },
        "/ic/api/process/v1/analyticsdataobjects":{
            "get":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Retrieve DataObject names",
                "description":"Retrieves application specific DataObjects when application name is provided",
                "operationId":"getDataObjects",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"applicationName",
                        "in":"query",
                        "description":"application name",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"totalResults",
                        "in":"query",
                        "description":"total results",
                        "required":false,
                        "type":"boolean"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Collection"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"No data objects found"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsdataobjects-get",
                "x-filename-id":"ic-api-process-v1-analyticsdataobjects-get"
            }
        },
        "/ic/api/process/v1/analyticsdataobjects/{dataObjectName}":{
            "get":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Retrieve DataObject's Metadata",
                "description":"Retrieve DataObject's metadata details",
                "operationId":"getDataObjectMetaData",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"dataObjectName",
                        "in":"path",
                        "description":"dataObject name",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/DataObjectMetadata"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"No metadata found"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsdataobjects-{dataObjectName}-get",
                "x-filename-id":"ic-api-process-v1-analyticsdataobjects-dataobjectname-get"
            }
        },
        "/ic/api/process/v1/analyticsdataobjects/{dataObjectName}/data":{
            "get":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Retrieve DataObject's data",
                "description":"Retrieve the data of given DataObject",
                "operationId":"fetchDataRecords",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"dataObjectName",
                        "in":"path",
                        "description":"dataobject name",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"offset",
                        "in":"query",
                        "description":"offset",
                        "required":false,
                        "type":"integer",
                        "default":0,
                        "format":"int32"
                    },
                    {
                        "name":"limit",
                        "in":"query",
                        "description":"limit",
                        "required":false,
                        "type":"integer",
                        "default":3000,
                        "format":"int32"
                    },
                    {
                        "name":"since",
                        "in":"query",
                        "description":"since date in ISO-8601 format YYYY-MM-DDTHH:MM:SS[.sss]Z",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"totalResults",
                        "in":"query",
                        "description":"total results",
                        "required":false,
                        "type":"boolean"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Collection"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"No data found"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsdataobjects-{dataObjectName}-data-get",
                "x-filename-id":"ic-api-process-v1-analyticsdataobjects-dataobjectname-data-get"
            }
        },
        "/ic/api/process/v1/analyticsqueries":{
            "get":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Returns OOTB and Business Queries",
                "description":"Returns available ootb(out of the box) and business queries",
                "operationId":"getBusinessQueries",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"queryType",
                        "in":"query",
                        "description":"query type : business or ootb",
                        "required":false,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Collection"
                        }
                    },
                    "401":{
                        "description":"Unauthorized"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsqueries-get",
                "x-filename-id":"ic-api-process-v1-analyticsqueries-get"
            },
            "post":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Create or Execute an Analytics Query",
                "description":"Create an analytics query or Execute an analytic query without saving.",
                "operationId":"createOrExecuteBusinessQuery",
                "consumes":[
                    "application/json"
                ],
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "in":"body",
                        "name":"body",
                        "description":"Business Query Payload",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/BusinessQuery"
                        }
                    },
                    {
                        "name":"action",
                        "in":"query",
                        "description":"action value to execute or not",
                        "required":false,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"successful operation",
                        "schema":{
                            "$ref":"#/definitions/Link"
                        }
                    },
                    "201":{
                        "description":"Created",
                        "schema":{
                            "$ref":"#/definitions/AnalyticsResult"
                        }
                    },
                    "400":{
                        "description":"Bad Request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsqueries-post",
                "x-filename-id":"ic-api-process-v1-analyticsqueries-post"
            }
        },
        "/ic/api/process/v1/analyticsqueries-aggregateoperations":{
            "get":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Retrieve Supported Aggregate Operations",
                "description":"Retrieves list of supported aggregate operations.",
                "operationId":"getAggregateOperations",
                "produces":[
                    "application/json"
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Collection"
                        }
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"No result found"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsqueries-aggregateoperations-get",
                "x-filename-id":"ic-api-process-v1-analyticsqueries-aggregateoperations-get"
            }
        },
        "/ic/api/process/v1/analyticsqueries-comparisonoperators":{
            "get":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Retrieve Supported Comparison Operators",
                "description":"Retrieves list of supported comparison operators for a given column data type.",
                "operationId":"getComparisonOperators",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"columnDataType",
                        "in":"query",
                        "description":"column Data Type",
                        "required":false,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Collection"
                        }
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"No result found"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsqueries-comparisonoperators-get",
                "x-filename-id":"ic-api-process-v1-analyticsqueries-comparisonoperators-get"
            }
        },
        "/ic/api/process/v1/analyticsqueries-datasources":{
            "get":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Retrieve Data Sources",
                "description":"Retrieves list of available analytics data sources.",
                "operationId":"getDataSources",
                "produces":[
                    "application/json"
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Collection"
                        }
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"No result found"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsqueries-datasources-get",
                "x-filename-id":"ic-api-process-v1-analyticsqueries-datasources-get"
            }
        },
        "/ic/api/process/v1/analyticsqueries-datasources/{dataSource}":{
            "get":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Return Links of DataSource Columns",
                "description":"Returns links of dataSource columns for given dataSource.",
                "operationId":"getDataSourceChildResourceLink",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"dataSource",
                        "in":"path",
                        "description":"DataSource value",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Link"
                        }
                    },
                    "401":{
                        "description":"Unauthorized"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsqueries-datasources-{dataSource}-get",
                "x-filename-id":"ic-api-process-v1-analyticsqueries-datasources-datasource-get"
            }
        },
        "/ic/api/process/v1/analyticsqueries-datasources/{dataSource}/columns":{
            "get":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Retrieve Available Columns for Data Source",
                "description":"Retrieves list of available Columns for a given datasource and application name. Determines the available columns by inspecting the corresponding analytics datasource.",
                "operationId":"getDataSourceColumns",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"dataSource",
                        "in":"path",
                        "description":"DataSource value",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"applicationName",
                        "in":"query",
                        "description":"application name",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Collection"
                        }
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"No result found"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsqueries-datasources-{dataSource}-columns-get",
                "x-filename-id":"ic-api-process-v1-analyticsqueries-datasources-datasource-columns-get"
            }
        },
        "/ic/api/process/v1/analyticsqueries/{businessQueryId}":{
            "get":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Retrieve Analytics Query Definition or Execution Result",
                "description":"Retrieve query definition or execution result of a saved analytics query.",
                "operationId":"getAnalyticsQuery",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"businessQueryId",
                        "in":"path",
                        "description":"ootbquery name or businessquery id",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"processNames",
                        "in":"query",
                        "description":"Process name",
                        "required":false,
                        "type":"array",
                        "items":{
                            "type":"string"
                        },
                        "collectionFormat":"multi"
                    },
                    {
                        "name":"assigneeType",
                        "in":"query",
                        "description":"Assignee type",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"topN",
                        "in":"query",
                        "description":"topN",
                        "required":false,
                        "type":"integer",
                        "format":"int32"
                    },
                    {
                        "name":"since",
                        "in":"query",
                        "description":"since",
                        "required":false,
                        "type":"integer",
                        "format":"int32"
                    },
                    {
                        "name":"applicationName",
                        "in":"query",
                        "description":"application name",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"action",
                        "in":"query",
                        "description":"Set action parameter to 'execute' for retrieving execution result",
                        "required":false,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/BusinessQuery"
                        }
                    },
                    "400":{
                        "description":"Bad Request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"No result found for query"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsqueries-{businessQueryId}-get",
                "x-filename-id":"ic-api-process-v1-analyticsqueries-businessqueryid-get"
            },
            "put":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Update Business Query",
                "description":" Update a saved business query with given business query Id.",
                "operationId":"updateBusinessQuery",
                "consumes":[
                    "application/json"
                ],
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"businessQueryId",
                        "in":"path",
                        "description":"BusinessQuery id",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "in":"body",
                        "name":"body",
                        "description":"Business Query payload",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/BusinessQuery"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Link"
                        }
                    },
                    "400":{
                        "description":"Bad Request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsqueries-{businessQueryId}-put",
                "x-filename-id":"ic-api-process-v1-analyticsqueries-businessqueryid-put"
            },
            "delete":{
                "tags":[
                    "Process/Process Analytics"
                ],
                "summary":"Delete a Business Query",
                "description":"Deletes a business query.",
                "operationId":"deleteBusinessQuery",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"businessQueryId",
                        "in":"path",
                        "description":"BusinessQuery id",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "type":"object",
                            "additionalProperties":{
                                "type":"object"
                            }
                        }
                    },
                    "400":{
                        "description":"Bad Request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"No business query found with provided id"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-analyticsqueries-{businessQueryId}-delete",
                "x-filename-id":"ic-api-process-v1-analyticsqueries-businessqueryid-delete"
            }
        },
        "/ic/api/process/v1/identities":{
            "get":{
                "tags":[
                    "Process/Identities"
                ],
                "summary":"Retrieve Identities",
                "description":" Retrieves roles, groups and users",
                "operationId":"getIdentities",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"searchPattern",
                        "in":"query",
                        "description":"Pattern to search for, for example identities?searchPattern=admin",
                        "required":false,
                        "type":"string",
                        "default":"*"
                    },
                    {
                        "name":"scope",
                        "in":"query",
                        "description":"Search scope - all (default), user, group, role",
                        "required":false,
                        "type":"array",
                        "items":{
                            "type":"string",
                            "default":"all"
                        },
                        "collectionFormat":"multi"
                    },
                    {
                        "name":"firstname",
                        "in":"query",
                        "description":"First name of the identity to search",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"lastname",
                        "in":"query",
                        "description":"Last name of the identity to search",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"email",
                        "in":"query",
                        "description":"Email of the identity to search",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"limit",
                        "in":"query",
                        "description":"Maximum number of identities to be retrieved per scope - default 25 per scope",
                        "required":false,
                        "type":"integer",
                        "default":25,
                        "format":"int32"
                    },
                    {
                        "name":"offset",
                        "in":"query",
                        "description":"The offset value - default 0",
                        "required":false,
                        "type":"integer",
                        "default":0,
                        "format":"int32"
                    },
                    {
                        "name":"totalResults",
                        "in":"query",
                        "description":"Total Result - true or false",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Collection"
                        }
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"Identities not found"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-identities-get",
                "x-filename-id":"ic-api-process-v1-identities-get"
            }
        },
        "/ic/api/process/v1/identities/groups/{groupid}":{
            "get":{
                "tags":[
                    "Process/Identities"
                ],
                "summary":"Retrieve a Group",
                "description":" Retrieves a group by group ID.",
                "operationId":"getGroup",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"groupid",
                        "in":"path",
                        "description":"The value of the group ID",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"includeDirectReporteesFlag",
                        "in":"query",
                        "description":"If true details of the direct reportees of participant will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    },
                    {
                        "name":"includeManagerFlag",
                        "in":"query",
                        "description":"If true details of the participant's manager name will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/GroupResponse"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"Group not found for ID"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-identities-groups-{groupid}-get",
                "x-filename-id":"ic-api-process-v1-identities-groups-groupid-get"
            }
        },
        "/ic/api/process/v1/identities/groups/{groupid}/users":{
            "get":{
                "tags":[
                    "Process/Identities"
                ],
                "summary":"Retrieve users in a group",
                "description":" Retrieves user details of a group by group ID",
                "operationId":"getUsersInGroup",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"searchPattern",
                        "in":"query",
                        "description":"User pattern to search for, for example searchPattern=*b*",
                        "required":false,
                        "type":"string",
                        "default":"*"
                    },
                    {
                        "name":"firstname",
                        "in":"query",
                        "description":"First name of the user to search",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"lastname",
                        "in":"query",
                        "description":"Last name of the user to search",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"email",
                        "in":"query",
                        "description":"Email of the identity to search",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"groupid",
                        "in":"path",
                        "description":"The value of the group ID",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"includeDirectReporteesFlag",
                        "in":"query",
                        "description":"If true details of the direct reportees will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    },
                    {
                        "name":"includeManagerFlag",
                        "in":"query",
                        "description":"If true details of the user's manager name will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    },
                    {
                        "name":"totalResults",
                        "in":"query",
                        "description":"Total Result - true or false",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Collection"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"Users not found for group ID"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-identities-groups-{groupid}-users-get",
                "x-filename-id":"ic-api-process-v1-identities-groups-groupid-users-get"
            }
        },
        "/ic/api/process/v1/identities/loggedInUser":{
            "get":{
                "tags":[
                    "Process/Identities"
                ],
                "summary":"Retrieve a Logged in User",
                "description":" Retrieves user details of a logged in user.",
                "operationId":"loggedInUser",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"includeGrantedRolesFlag",
                        "in":"query",
                        "description":"If true details of the roles granted to the user will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    },
                    {
                        "name":"includeAssignedGroupsFlag",
                        "in":"query",
                        "description":"If true details of the groups the user belongs to will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    },
                    {
                        "name":"includeDirectReporteesFlag",
                        "in":"query",
                        "description":"If true details of the direct reportees will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    },
                    {
                        "name":"includeManagerFlag",
                        "in":"query",
                        "description":"If true details of the user's manager name will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/User"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"User not found"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-identities-loggedInUser-get",
                "x-filename-id":"ic-api-process-v1-identities-loggedinuser-get"
            }
        },
        "/ic/api/process/v1/identities/roles/{roleid}":{
            "get":{
                "tags":[
                    "Process/Identities"
                ],
                "summary":"Retrieve a Role",
                "description":" Retrieves a role by role ID.",
                "operationId":"getRole",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"roleid",
                        "in":"path",
                        "description":"The value of the role ID",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/RoleResponse"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"Role not found for ID"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-identities-roles-{roleid}-get",
                "x-filename-id":"ic-api-process-v1-identities-roles-roleid-get"
            },
            "delete":{
                "tags":[
                    "Process/Identities"
                ],
                "summary":"Delete an Application Role",
                "description":"Delete application role by role ID.",
                "operationId":"deleteRole",
                "produces":[
                    "application/json",
                    "text/plain"
                ],
                "parameters":[
                    {
                        "name":"roleid",
                        "in":"path",
                        "description":"The value of the role ID",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "type":"string"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"Role not found for ID"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-identities-roles-{roleid}-delete",
                "x-filename-id":"ic-api-process-v1-identities-roles-roleid-delete"
            }
        },
        "/ic/api/process/v1/identities/roles/{roleid}/members":{
            "get":{
                "tags":[
                    "Process/Identities"
                ],
                "summary":"Retrieve Members in a Role",
                "description":" Retrieves member details of an app role by role ID. Returns Collection of Members - User and Group or AppRole",
                "operationId":"getMembersInRole",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"roleid",
                        "in":"path",
                        "description":"The value of the app role ID",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"totalResults",
                        "in":"query",
                        "description":"Total Result - true or false",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Collection"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"Identity not found for given RoleId"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-identities-roles-{roleid}-members-get",
                "x-filename-id":"ic-api-process-v1-identities-roles-roleid-members-get"
            },
            "post":{
                "tags":[
                    "Process/Identities"
                ],
                "summary":"Add a Member to a Role/Remove a Member from a Role",
                "description":" Grants a role to a member (user/group/app-role) OR Removes a member (user/group/app-role) from an app role. Response is returned in Plain Text format if role is granted to member OR revoked from member. Response is returned in JSON format if role is granted to member OR revoked from member. Response is JSON format for any validation issues. ",
                "operationId":"addOrRemoveMemberToRole",
                "produces":[
                    "application/json",
                    "text/plain"
                ],
                "parameters":[
                    {
                        "name":"roleid",
                        "in":"path",
                        "description":"The value of the role ID",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"operation",
                        "in":"query",
                        "description":"Operation - grant OR revoke. Default operation is grant",
                        "required":false,
                        "type":"string",
                        "default":"grant"
                    },
                    {
                        "in":"body",
                        "name":"body",
                        "description":"Member with id and type",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/Member"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "type":"string"
                        }
                    },
                    "400":{
                        "description":"Bad request for any of following reasons - 1)Invalid Operation in Query Parameter. 2) Application Role already granted to member 3) Unable to revoke application role for this member   4)Invalid member type  in payload. USER or GROUP or APPROLE should be used"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"Identities not found error - Please check RoleId in request Parameter / MemberId in Payload is valid"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-identities-roles-{roleid}-members-post",
                "x-filename-id":"ic-api-process-v1-identities-roles-roleid-members-post"
            }
        },
        "/ic/api/process/v1/identities/users/{userid}":{
            "get":{
                "tags":[
                    "Process/Identities"
                ],
                "summary":"Retrieve a User",
                "description":" Retrieve a user by user ID.",
                "operationId":"getUser",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"userid",
                        "in":"path",
                        "description":"The value of the user ID",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"includeGrantedRolesFlag",
                        "in":"query",
                        "description":"If true details of the roles granted to the user will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    },
                    {
                        "name":"includeAssignedGroupsFlag",
                        "in":"query",
                        "description":"If true details of the groups the user belongs to will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    },
                    {
                        "name":"includeDirectReporteesFlag",
                        "in":"query",
                        "description":"If true details of the direct reportees will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    },
                    {
                        "name":"includeManagerFlag",
                        "in":"query",
                        "description":"If true details of the user's manager name will be returned, if false- not, default is true",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/User"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"User not found for ID"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-identities-users-{userid}-get",
                "x-filename-id":"ic-api-process-v1-identities-users-userid-get"
            }
        },
        "/ic/api/process/v1/identities/{scope}":{
            "get":{
                "tags":[
                    "Process/Identities"
                ],
                "summary":"Retrieve All Users, Groups or Roles",
                "description":"Retrieves all users, groups or app role details.",
                "operationId":"getAllScopedIdentities",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"scope",
                        "in":"path",
                        "required":true,
                        "type":"string",
                        "enum":[
                            "users",
                            "groups",
                            "roles"
                        ]
                    },
                    {
                        "name":"totalResults",
                        "in":"query",
                        "description":"Total Result - true or false",
                        "required":false,
                        "type":"boolean",
                        "default":true
                    },
                    {
                        "name":"processDefinitionId",
                        "in":"query",
                        "description":"Process Definition Id. (This QueryParam is applicable only for application roles) ",
                        "required":false,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/Collection"
                        }
                    },
                    "400":{
                        "description":"Bad request "
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "404":{
                        "description":"Not_Found"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-identities-{scope}-get",
                "x-filename-id":"ic-api-process-v1-identities-scope-get"
            }
        },
        "/ic/api/process/v1/preferences":{
            "get":{
                "tags":[
                    "Process/Preferences"
                ],
                "summary":"Get User and Application Preferences for the Logged in User",
                "description":"Get user and application preferences for the logged in user. Also allows admin to list preferences of other users",
                "operationId":"getAllPreferences",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"key",
                        "in":"query",
                        "description":"Preference key. 
Valid values for keys with preference type USER:
 
Valid values for keys with preference type APPLICATION:
   ",
                        "required":false,
                        "type":"string"
                    },
                    {
                        "name":"type",
                        "in":"query",
                        "description":"Preference type. Valid values: USER, APPLICATION, ALL.",
                        "required":false,
                        "type":"string",
                        "default":"ALL",
                        "enum":[
                            "USER",
                            "APPLICATION",
                            "ALL"
                        ]
                    },
                    {
                        "name":"user",
                        "in":"query",
                        "description":"User Id",
                        "required":false,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/PreferencesResponse"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-preferences-get",
                "x-filename-id":"ic-api-process-v1-preferences-get"
            },
            "post":{
                "tags":[
                    "Process/Preferences"
                ],
                "summary":"Grant or Revoke Preferences for the Logged in User",
                "description":"Grant or revoke user preferences and application preferences for the logged in user. You must be an administrator to grant or revoke application preferences ",
                "operationId":"setPreferences",
                "consumes":[
                    "application/json"
                ],
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"operation",
                        "in":"query",
                        "description":"Operation - grant OR revoke. Default operation is grant",
                        "required":false,
                        "type":"string",
                        "default":"grant"
                    },
                    {
                        "in":"body",
                        "name":"body",
                        "description":"PreferenceRequest Object",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/PreferenceRequest"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/PreferencesResponse"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-preferences-post",
                "x-filename-id":"ic-api-process-v1-preferences-post"
            },
            "delete":{
                "tags":[
                    "Process/Preferences"
                ],
                "summary":"Delete User and Application Preferences for the Logged in User ",
                "description":"Delete user and application preferences for the logged in user. You must be an administrator to delete application preferences.",
                "operationId":"deletePreference",
                "consumes":[
                    "application/json"
                ],
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "in":"body",
                        "name":"body",
                        "description":"PreferenceDeleteRequest Object",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/PreferenceDeleteRequest"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/PreferencesResponse"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-preferences-delete",
                "x-filename-id":"ic-api-process-v1-preferences-delete"
            }
        },
        "/ic/api/process/v1/preferences/bulk":{
            "put":{
                "tags":[
                    "Process/Preferences"
                ],
                "summary":"Grant or Revoke Preferences for Users",
                "description":"Grant or revoke preferences for one or more users. You must be an administrator to use this API.",
                "operationId":"setBulkUserPreferences",
                "consumes":[
                    "application/json"
                ],
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"operation",
                        "in":"query",
                        "description":"Operation - grant OR revoke. Default operation is grant",
                        "required":false,
                        "type":"string",
                        "default":"grant"
                    },
                    {
                        "in":"body",
                        "name":"body",
                        "description":"PreferenceBulkRequest Object",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/PreferenceBulkRequest"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/PreferencesResponse"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-preferences-bulk-put",
                "x-filename-id":"ic-api-process-v1-preferences-bulk-put"
            },
            "delete":{
                "tags":[
                    "Process/Preferences"
                ],
                "summary":"Delete User Preferences for Users",
                "description":"Delete user preferences for mulitple users. You must be an administrator to use this API.",
                "operationId":"deletePreferences",
                "consumes":[
                    "application/json"
                ],
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "in":"body",
                        "name":"body",
                        "description":"PreferenceBulkDeleteRequest Object",
                        "required":true,
                        "schema":{
                            "$ref":"#/definitions/PreferenceBulkDeleteRequest"
                        }
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/PreferencesResponse"
                        }
                    },
                    "400":{
                        "description":"Bad request"
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "500":{
                        "description":"Internal Server Error"
                    }
                },
                "x-internal-id":"ic-api-process-v1-preferences-bulk-delete",
                "x-filename-id":"ic-api-process-v1-preferences-bulk-delete"
            }
        },
        "/ic/api/process/v1/process-definitions":{
            "get":{
                "tags":[
                    "Process/Process Definitions"
                ],
                "summary":"Retrieve Process Definitions",
                "description":" Retrieves process definitions.",
                "operationId":"getDefinitions",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"interfaceFilter",
                        "in":"query",
                        "description":"Retrieves those with forms, without, or both - form, noForm, doc, folder or all",
                        "required":false,
                        "type":"string",
                        "default":"all"
                    },
                    {
                        "name":"showProcessInstancesCount",
                        "in":"query",
                        "description":"True to get processcount else false",
                        "required":false,
                        "type":"string",
                        "default":"false"
                    },
                    {
                        "name":"filterDefaultVersion",
                        "in":"query",
                        "description":"True to fetch only default process definition versions else false",
                        "required":false,
                        "type":"string",
                        "default":"false"
                    },
                    {
                        "name":"processDefId",
                        "in":"query",
                        "description":"Process Definition Id to filter the results on",
                        "required":false,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/ProcessDefs"
                        }
                    },
                    "500":{
                        "description":"Error in retrieving the process definitions"
                    }
                },
                "x-internal-id":"ic-api-process-v1-process-definitions-get",
                "x-filename-id":"ic-api-process-v1-process-definitions-get"
            },
            "put":{
                "tags":[
                    "Process/Process Definitions"
                ],
                "summary":"Update the Interface Type for Process Definitions (Deprecated)",
                "description":"Update the interface type for process definitions to improve the performance of the process definitions API. You must be an administrator to use this API. This API has been deprecated since November 2022.",
                "operationId":"updateInterfaceTypeForDefinitions",
                "produces":[
                    "application/json"
                ],
                "responses":{
                    "200":{
                        "description":"Success",
                        "schema":{
                            "$ref":"#/definitions/ProcessDefITypeUpdateRes"
                        }
                    },
                    "500":{
                        "description":"Error in updating  interface types"
                    }
                },
                "x-internal-id":"ic-api-process-v1-process-definitions-put",
                "x-filename-id":"ic-api-process-v1-process-definitions-put"
            }
        },
        "/ic/api/process/v1/process-definitions/{processDefId}/conversations":{
            "get":{
                "tags":[
                    "Process/Process Definitions"
                ],
                "summary":"Retrieve Conversations",
                "description":" Retrieves the conversations metadata associated with this process, if any.",
                "operationId":"getConversations",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"processDefId",
                        "in":"path",
                        "description":"Value of process definition ID.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"name",
                        "in":"query",
                        "description":"Retrieves only the conversation for the specified conversation name",
                        "required":false,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success. Returns the conversations metadata or empty list when there aren't any.",
                        "schema":{
                            "$ref":"#/definitions/Conversation"
                        }
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "500":{
                        "description":"Error in retrieving the folder information"
                    }
                },
                "x-internal-id":"ic-api-process-v1-process-definitions-{processDefId}-conversations-get",
                "x-filename-id":"ic-api-process-v1-process-definitions-processdefid-conversations-get"
            }
        },
        "/ic/api/process/v1/process-definitions/{processDefId}/conversations/{conversationName}":{
            "get":{
                "tags":[
                    "Process/Process Definitions"
                ],
                "summary":"Retrieve Conversation Metadata",
                "description":" Retrieves the conversation metadata for a conversation associated with this process, if any.",
                "operationId":"getConversation",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"processDefId",
                        "in":"path",
                        "description":"Value of process definition ID.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"conversationName",
                        "in":"path",
                        "description":"conversation name",
                        "required":true,
                        "type":"string"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success. Returns the conversations or empty list when there aren't any.",
                        "schema":{
                            "$ref":"#/definitions/Conversation"
                        }
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "500":{
                        "description":"Error in retrieving the folder information"
                    }
                },
                "x-internal-id":"ic-api-process-v1-process-definitions-{processDefId}-conversations-{conversationName}-get",
                "x-filename-id":"ic-api-process-v1-process-definitions-processdefid-conversations-conversationname-get"
            }
        },
        "/ic/api/process/v1/process-definitions/{processDefId}/documents":{
            "get":{
                "tags":[
                    "Process/Process Definitions"
                ],
                "summary":"Retrieve Document Metadata",
                "description":" Retrieves the folders metadata information for a given process definition ID",
                "operationId":"getDocuments",
                "produces":[
                    "application/json"
                ],
                "parameters":[
                    {
                        "name":"processDefId",
                        "in":"path",
                        "description":"Value of process definition ID.",
                        "required":true,
                        "type":"string"
                    },
                    {
                        "name":"expanded",
                        "in":"query",
                        "description":"Retrieves only the folder for the specified folder name",
                        "required":false,
                        "type":"string",
                        "default":"none"
                    }
                ],
                "responses":{
                    "200":{
                        "description":"Success. Returns the documents.",
                        "schema":{
                            "$ref":"#/definitions/Documents"
                        }
                    },
                    "401":{
                        "description":"Unauthorized"
                    },
                    "500":{
                        "description":"Error in retrieving the folder information"
                    }
                },
                "x-internal-id":"ic-api-process-v1-process-definitions-{processDefId}-documents-get",
                "x-filename-id":"ic-api-process-v1-process-definitions-processdefid-documents-get"
            }
        },
        "/ic/api/process/v1/process-definitions/{processDefId}/documents/incoming-documents":{
            "get":{
                "tags":[
                    "Process/Process Definitions"
                ],
                "summary":"Retrieve Incoming Document Metadata",
                "description":"
Retrieves the folders metadata information for a given process definition ID.
NOTE:
Whether a process application uses documents or attachments depends on the application configuration.