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.
\n\n", "version":"2026.02.26", "x-summary":"Use the Developer API for Oracle Integration to 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. Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results." }, { "name":"B2B/Projects/B2B Documents", "description":"The operations from the B2B/Projects category." }, { "name":"B2B/Projects/Schemas", "description":"The operations from the B2B/Projects category." }, { "name":"B2B/Projects/Standards", "description":"The operations from the B2B/Projects category." }, { "name":"B2B/Projects/Trading Partners", "description":"The operations from the B2B/Projects category." }, { "name":"B2B/Trading Partner", "description":"The operations from the B2B/Trading Partner category." }, { "name":"B2B/Trading Partner Migration from SOA-B2B", "description":"The operations from the B2B/Trading Partner Migration from SOA-B2B category." }, { "name":"Clone Instance", "description":"The operations from the Clone Instance category." }, { "name":"Environment", "description":"Oracle Integration applications allow authenticated access from Oracle domains like oracle.com, oraclecorp.com, oracleonsrcloud.com, oc.scloud, oci.scloud, oracleiaas.com, and oraclecloud.com. All domains belonging to arbitrary origins need to be registered in the allowed list of sites for cross-origin resource sharing (CORS) processing. Use this API only if you want to allow access from non-Oracle cloud domains. You need Administrator permissions to use CORS related API functions." }, { "name":"Integrations/Certificates", "description":"The operations from the Integrations/Certificates category." }, { "name":"Integrations/Connections", "description":"The operations from the Integrations/Connections category." }, { "name":"Integrations/Event Types", "description":"The operations from the Integrations/Event Types category." }, { "name":"Integrations/Integrations", "description":"The operations from the Integrations/Integrations category." }, { "name":"Integrations/Integrations/Scheduled Integrations", "description":"The operations from the Integrations/Integrations/Scheduled Integrations category." }, { "name":"Integrations/Libraries", "description":"The operations from the Integrations/Libraries category." }, { "name":"Integrations/Lookups", "description":"The operations from the Integrations/Lookups category." }, { "name":"Integrations/Monitoring", "description":"The operations from the Integrations/Monitoring category." }, { "name":"Integrations/Packages", "description":"The operations from the Integrations/Packages category." }, { "name":"Integrations/Projects", "description":"The operations from the Integrations/Projects category." }, { "name":"Integrations/Projects/AI Agents", "description":"The operations from the Integrations/Projects/AI Agents category." }, { "name":"Integrations/Projects/AI Agents/Agent Patterns", "description":"The operations from the Integrations/Projects/AI Agents/Agent Patterns category." }, { "name":"Integrations/Projects/AI Agents/Agent Tools", "description":"The operations from the Integrations/Projects/AI Agents/Agent Tools category." }, { "name":"Integrations/Projects/AI Agents/Prompt Templates", "description":"The operations from the Integrations/Projects/AI Agents/Prompt Templates category." }, { "name":"Integrations/Projects/Connections", "description":"The operations from the Integrations/Projects/Connections category." }, { "name":"Integrations/Projects/Deployments", "description":"The operations from the Integrations/Projects/Deployments category." }, { "name":"Integrations/Projects/Integrations", "description":"The operations from the Integrations/Projects/Integrations category." }, { "name":"Integrations/Projects/Integrations/Scheduled Integrations", "description":"The operations from the Integrations/Projects/Integrations/Scheduled Integrations category." }, { "name":"Integrations/Projects/Libraries", "description":"The operations from the Integrations/Projects/Libraries category." }, { "name":"Integrations/Projects/Lookups", "description":"The operations from the Integrations/Projects/Lookups category." }, { "name":"Integrations/Projects/RBAC", "description":"The operations from the Integrations/Projects/RBAC category." }, { "name":"Integrations/Usages", "description":"The operations from the Integrations/Usages category." }, { "name":"Rapid Adapter Builder" } ], "paths":{ "/ic/api/integration/v1/certificates":{ "get":{ "tags":[ "Integrations/Certificates" ], "summary":"Retrieve Certificates", "description":"Retrieves information about all the certificates.", "operationId":"getCertificates", "parameters":[ { "name":"q", "in":"query", "description":"Filters certificates by name, status, and type.
Valid parameters:
q={name:'My Certificate Name'}.q={name: /Oracle/}For example, to retrieve all certificates that contain PGP and have the status configured, specify:
{name : /PGP/, status : 'CONFIGURED'}Valid values: DIGITALSIGNATURE, PGP, SAML, SIGNKEY, X509.
Lists certificates ordered by name, or expiry.
Valid values:
Filters AI Agents by name and status.
Valid parameters:
q={name: /ORDER/}For example, to retrieve all AI Agents that contain ORDER and have the status ACTIVATED, specify:
{name : /ORDER/, status : 'ACTIVATED'}Lists AI Agents ordered by name, last updated time.
Valid values:
Filters Agent Patterns by name.
Valid parameters:
q={name: /ORDER/}Lists Agent Patterns ordered by name, last updated time.
Valid values:
Filters Prompt Templates by name.
Valid parameters:
q={name: /ORDER/}Lists Prompt Templates ordered by name, last updated time.
Valid values:
Filters Agent Tools by name.
Valid parameters:
q={name: /ORDER/}Lists Agent Tools ordered by name, last updated time.
Valid values:
Filters connections by name, status, and role.
Valid parameters:
q={name:'My Connection Name'}.q={name: /Oracle/}For example, to retrieve all connections that contain RN and have the status configured, specify:
{name : /RN/, status : 'CONFIGURED'}Valid values: SOURCE, SOURCE_AND_TARGET, TARGET. Values are case-sensitive. In the graphical user interface: SOURCE is displayed as trigger, SOURCE_AND_TARGET is displayed as trigger and invoke, and TARGET is displayed as invoke.
Lists connections ordered by name, last updated time, or adapter type.
Valid values:
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", "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } }, { "name":"X-HTTP-Method-Override", "in":"header", "description":"HTTP Method override in the header", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Connection resource", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/ConnectionRs" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8, application/vnd.oracle.resource+json;type=singular":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "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", "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "schema":{ "type":"string" } }, { "name":"connPropName", "in":"path", "description":"Connection property name. For example: targetWSDLURL", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/octet-stream":{ "schema":{ "type":"array", "items":{ "type":"string" } } } } }, "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", "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "schema":{ "type":"string" } }, { "name":"connPropName", "in":"path", "description":"Connection property name. For example: targetWSDLURL", "required":true, "schema":{ "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, "schema":{ "type":"string", "nullable":true } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "description":"Upload connection attachment.", "format":"binary" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "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", "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ } } }, "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", "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "schema":{ "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, "schema":{ "type":"boolean", "nullable":true } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } }, { "name":"X-HTTP-Method-Override", "in":"header", "description":"HTTP Method override in the header", "required":true, "schema":{ "type":"string" } }, { "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, "schema":{ "type":"string", "nullable":true } } ], "requestBody":{ "description":"List of actions that have to be run during testing.", "content":{ "multipart/form-data":{ } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/ConnectionRs" } } } }, "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", "parameters":[ { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } }, { "name":"X-HTTP-Method-Override", "in":"header", "description":"HTTP Method override in the header", "required":true, "schema":{ "type":"string" } }, { "name":"patchAttachments", "in":"query", "description":"Param to determine whether this partial update of attachments case.", "required":false, "schema":{ "type":"boolean", "nullable":true } } ], "requestBody":{ "description":"List of actions that have to be run during testing.", "content":{ "multipart/form-data":{ } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ } } }, "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/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", "parameters":[ { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"getCorsDomains 200 response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Object" } } } }, "204":{ "description":"Successful operation" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-environment-corsdomains-get", "x-filename-id":"ic-api-integration-v1-environment-corsdomains-get" }, "put":{ "tags":[ "Environment" ], "summary":"Update the List of Allowed Domains for CORS Processing", "description":"To modify 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\"].", "operationId":"updateCorsDomains", "parameters":[ { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "corsDomainsRs":{ "$ref":"#/components/schemas/CorsDomainsRs" } } } } }, "required":true }, "responses":{ "200":{ "description":"updateCorsDomains 200 response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Object" } } } }, "204":{ "description":"Successful operation" }, "400":{ "description":"Bad request, missing required data" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-environment-corsdomains-put", "x-filename-id":"ic-api-integration-v1-environment-corsdomains-put" }, "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\"].
Note: Oracle Integration applications allow authenticated access from Oracle domains like oracle.com, oraclecorp.com, oracleonsrcloud.com, oc.scloud, oci.scloud, oracleiaas.com, and oraclecloud.com. All domains belonging to arbitrary origins need to be registered in the allowed list of sites for cross-origin resource sharing (CORS) processing. Use this API only if you want to allow access from non-Oracle cloud domains. You need Administrator permissions to use CORS related API functions.
", "operationId":"createCorsDomains", "parameters":[ { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "corsDomainsRs":{ "$ref":"#/components/schemas/CorsDomainsRs" } } } } }, "required":true }, "responses":{ "200":{ "description":"createCorsDomains 200 response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Object" } } } }, "204":{ "description":"Successful operation" }, "400":{ "description":"Bad request, missing required data" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-environment-corsdomains-post", "x-filename-id":"ic-api-integration-v1-environment-corsdomains-post" }, "delete":{ "tags":[ "Environment" ], "summary":"Delete the List of Domains Supported for CORS Processing", "description":"Deletes all the allowed domains for CORS processing.", "operationId":"deleteCorsDomains", "parameters":[ { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"deleteCorsDomains 200 response", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Object" } } } }, "204":{ "description":"Successful operation" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-environment-corsdomains-delete", "x-filename-id":"ic-api-integration-v1-environment-corsdomains-delete" } }, "/ic/api/integration/v1/eventTypes":{ "get":{ "tags":[ "Integrations/Event Types" ], "summary":"Retrieve Event Types", "description":"Retrieves information about all the event types ordered by the last updated time. Retrieves the latest revision of each event type.", "operationId":"getEventTypes", "parameters":[ { "name":"q", "in":"query", "description":"Filters event types by name and code.
Valid parameters:
q={name:'My Event Type'}q={name:'My_Event_Type'}Orders results by event type name or created time.
Valid values:
An event type describes the schema or structure of data contained in an event. This API function creates an event type. The request body must contain:
If the resource creation is successful, the response header contains the Location header that includes the location URL for the new resource created.
", "operationId":"createEventType", "parameters":[ { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Event type resource", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/EventTypeCreateRs" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ } } }, "400":{ "description":"Bad request, missing required data" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-eventTypes-post", "x-filename-id":"ic-api-integration-v1-eventtypes-post" } }, "/ic/api/integration/v1/eventTypes/{code}":{ "delete":{ "tags":[ "Integrations/Event Types" ], "summary":"Delete an Event Type", "description":"Deletes all the revisions of the event type with the specified code.", "operationId":"deleteEventType", "parameters":[ { "name":"code", "in":"path", "description":"Event type code", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ } } }, "404":{ "description":"Event type not found" }, "412":{ "description":"Precondition failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-eventTypes-{code}-delete", "x-filename-id":"ic-api-integration-v1-eventtypes-code-delete" } }, "/ic/api/integration/v1/eventTypes/{id}":{ "get":{ "tags":[ "Integrations/Event Types" ], "summary":"Retrieve an Event Type", "description":"Retrieves detailed information about the event type with the specified code and revision.", "operationId":"getEventType", "parameters":[ { "name":"id", "in":"path", "description":"Event type composite identifier. The ID consists of the code and the revision separated by the | (vertical line) character. Format: code%7Crevision. Example: MY_EVENT_TYPE%7C1. When using cURL, substitute the %7C code for the vertical line.", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8, application/vnd.oracle.resource+json,type=singular":{ "schema":{ "$ref":"#/components/schemas/EventTypeRs" } } } }, "404":{ "description":"Event type not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-eventTypes-{id}-get", "x-filename-id":"ic-api-integration-v1-eventtypes-id-get" } }, "/ic/api/integration/v1/eventTypes/{id}/clone":{ "post":{ "tags":[ "Integrations/Event Types" ], "summary":"Clone an Event Type", "operationId":"cloneEventType", "description":"Clones the event type with the specified code and revision.If the resource creation is successful, the response header contains the Location header that includes the location URL for the new resource created.
", "parameters":[ { "name":"id", "in":"path", "description":"Event type composite identifier. The ID consists of the code and the revision separated by the | (vertical line) character. Format: code%7Crevision. Example: MY_EVENT_TYPE%7C1. When using cURL, substitute the %7C code for the vertical line.", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Event type resource with values populated for the fields: name, code, description (optional)", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EventTypeCloneRs" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ } } }, "400":{ "description":"Bad request, missing required data" }, "404":{ "description":"Event type not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-eventTypes-{id}-clone-post", "x-filename-id":"ic-api-integration-v1-eventtypes-id-clone-post" } }, "/ic/api/integration/v1/eventTypes/{id}/update":{ "post":{ "tags":[ "Integrations/Event Types" ], "summary":"Update an Event Type", "description":"Updates an event type with the code and revision specified in the request URL. The request body must contain:
If the resource creation is successful, the response header contains the Location header that includes the location URL for the new resource created.
", "operationId":"updateEventType", "parameters":[ { "name":"id", "in":"path", "description":"Event type composite identifier. The ID consists of the code and the revision separated by the | (vertical line) character. Format: code%7Crevision. Example: MY_EVENT_TYPE%7C1. When using cURL, substitute the %7C code for the vertical line.", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Event type resource", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/EventTypeUpdateRs" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ } } }, "400":{ "description":"Bad request, missing required data" }, "404":{ "description":"Event type not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-eventTypes-{id}-update-post", "x-filename-id":"ic-api-integration-v1-eventtypes-id-update-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", "parameters":[ { "name":"q", "in":"query", "description":"Filters integrations by status, type, and integration style.
Valid parameters:
q={name: /Oracle/}For example, to retrieve all integrations that contain SC2RN and have the status configured, specify:
{name : /SC2RN/, status : 'CONFIGURED'}Valid values: PREBUILT, CUSTOM, DEVELOPED.
freeform_mapmydata- Application-Driven Orchestrated Integration
freeform_scheduled- Scheduled Orchestration Integration
template_mapmydata- Basic Routing Map My Data Integration
template_subscribetooic- Subscribe to OIC Integration
template_publishtooic- Publish to OIC Integration
Orders results by integration name or last updated time.
Valid values:
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", "parameters":[ { "name":"includeRecordingFlag", "in":"query", "description":"Include recording flag", "required":false, "schema":{ "type":"string", "nullable":true } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "description":"Previously exported integration file", "format":"binary" } } } } }, "required":true }, "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" } }, "/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", "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, "schema":{ "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, "schema":{ "type":"string", "nullable":true } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8, application/vnd.oracle.resource+json;type=singular":{ "schema":{ "$ref":"#/components/schemas/IntegrationListRs" } } } }, "404":{ "description":"Integration 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.
Note that the version number matters when activating integrations:
Valid parameters:
q={name: /library/}For example, to retrieve all libraries that contain the string myLibrary and have the status preinstalled, specify:
q={name : /myLibrary/, type : 'preinstalled'}Lists libraries ordered by name or last updated time.
Valid value:
Filters lookups by name and status.
Valid parameters:
q={name:'MyLookup'}q={name: /MyLookup/}For example, to retrieve all lookups that contain Lookup and have the status LOCKED, specify:
q={name : /Lookup/, status : 'LOCKED'}Lists lookups ordered by name.
Valid value:
Creates a lookup. The request body must contain:
\"name\":\"myLookup\"
\"columns\":[\"rightnow\",\"soap\"]
\"rows\":[{\"rowData\":[\"RN1\",\"SOAP1\"]},{\"rowData\":[\"RN2\",\"SOAP2\"]}]Updates a lookup with the name and values specified in the request body. The request body must contain:
\"name\":\"myLookup\"
\"columns\":[\"rightnow\",\"soap\"]
\"rows\":[{\"rowData\":[\"RN1\",\"SOAP1\"]},{\"rowData\":[\"RN2\",\"SOAP2\"]}]Filter parameters:
Examples:
{startdate:'2025-09-13 07:07:07',enddate:'2025-09-20 08:17:07'}{timewindow:'3d'}",
"required":false,
"schema":{
"type":"string",
"nullable":true
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/zip":{
"schema":{
"$ref":"#/components/schemas/Object"
}
}
}
},
"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/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",
"parameters":[
{
"name":"q",
"in":"query",
"description":"Filters results by agent group name.
\n\n Example:\n
\n{name:'Execution Agents Group'}",
"required":false,
"schema":{
"type":"string",
"nullable":true
}
},
{
"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, "schema":{ "type":"string", "nullable":true } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"id", "in":"path", "description":"
Agent group identifier.
\n\n Example:\n
\nagentgroups/EXECUTION_AGENT_GROUP", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"id", "in":"path", "description":"
Agent group identifier.
\n\n Example:\n
\nagentgroups/EXECUTION_AGENT_GROUP/agents", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"id", "in":"path", "description":"Agent group identifier.", "required":true, "schema":{ "type":"string" } }, { "name":"key", "in":"path", "description":"Agent identifier.", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"q", "in":"query", "description":"
Filter parameters.
\n\n
\nExample: \n
\n{limit: '10', type:/ICS_AppInstance/, distinct: 'true'}",
"required":false,
"schema":{
"type":"string",
"nullable":true
}
},
{
"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,
"schema":{
"type":"integer",
"format":"int32",
"nullable":true
}
},
{
"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,
"schema":{
"type":"integer",
"format":"int32",
"nullable":true
}
},
{
"name":"integrationInstance",
"in":"query",
"description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.",
"required":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json; charset=utf-8":{
"schema":{
"$ref":"#/components/schemas/MonitoringAuditResource"
}
}
}
},
"404":{
"description":"Audit Records 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. You can perform multi-word value search using the businessIDValue, primaryValue, secondaryValue, and tertiaryValue attributes in query filter parameters. To perform multi-word searches, encapsulate the search values in double quotation marks followed by single quotation marks. Search includes error messages and detailed error messages. For example, '\"Test-instance1\"', and '\"Testing instance2\"'. You can also search primaryValue, secondaryValue, and tertiaryValue values against the specified primaryName, secondaryName, and tertiaryName variable names.",
"operationId":"getErrors",
"parameters":[
{
"name":"q",
"in":"query",
"description":"Filter parameters.
\n\n\t
\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,
"schema":{
"type":"string",
"nullable":true
}
},
{
"name":"groupBy",
"in":"query",
"description":"\n\t
\n", "required":false, "schema":{ "type":"string", "nullable":true } }, { "name":"expand", "in":"query", "description":"
\n\t
Information about the instances to discard or abort.
\n\nExamples: \n
\n{flowCode: 'MON_ERRORS_INT_AUTO', flowVersion: '01.00.0000', timewindow: '1h'}\nids: ['4', '3', '2', '1']\n
{connectionCode: 'RIGHTNOW', startDate: '2020-07-21 00:00:00', endDate: '2020-07-27 12:55:00'}",
"content":{
"application/json;charset=utf-8":{
"schema":{
"$ref":"#/components/schemas/ErrorsBulkRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json; charset=utf-8":{
"schema":{
"$ref":"#/components/schemas/ErrorBulkDiscardRs"
}
}
}
},
"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",
"parameters":[
{
"name":"q",
"in":"query",
"description":"Filter parameters.
\n\n
\n\tExample: \n
\n{primaryValue:'4', startdate:'2020-07-15 07:00:00', enddate:'2020-07-08 21:10:00'}",
"required":false,
"schema":{
"type":"string",
"nullable":true
}
},
{
"name":"expand",
"in":"query",
"description":"\n\t
Criteria for which instances to resubmit.
\n\nExamples: \n
\n{flowCode: 'MON_ERRORS_INT_AUTO', flowVersion: '01.00.0000', timewindow: '1h'}\nids: ['4', '3', '2', '1']\n
{connectionCode: 'RIGHTNOW', startDate: '2020-07-21 00:00:00', endDate: '2020-07-27 12:55:00'}",
"content":{
"application/json;charset=utf-8":{
"schema":{
"$ref":"#/components/schemas/ErrorsBulkRequest"
}
}
},
"required":true
},
"responses":{
"202":{
"description":"Request accepted",
"content":{
"application/json; charset=utf-8":{
"schema":{
"$ref":"#/components/schemas/ErrorsBulkResubmitRs"
}
}
}
},
"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",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Errored integration instance identifier.",
"required":true,
"schema":{
"type":"string"
}
},
{
"name":"return",
"in":"query",
"description":"Controls the response data. Valid value is minimal. For example, return=minimal. When this value is specified, minimal information of the instance data is added in the response thus making the response time quicker than the default API call. Response does not contain connection details like appTypeDisplayName, appTypeName, and appTypeVersion and in this response, the attributes integration.name and integrationDeleted are set to their default and should not be relied upon. This URL parameter is recommended if performance is preferred instead of the availability of complete instance data.",
"required":false,
"schema":{
"type":"string",
"nullable":true
}
},
{
"name":"integrationInstance",
"in":"query",
"description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.",
"required":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json; charset=utf-8":{
"schema":{
"$ref":"#/components/schemas/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",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Errored integration instance identifier.",
"required":true,
"schema":{
"type":"string"
}
},
{
"name":"integrationInstance",
"in":"query",
"description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.",
"required":true,
"schema":{
"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":"Resubmits the errored integration instance with the specified identifier. Additionally, to change the trace level of the resubmission, use the \"recoveryTraceLevel\" attribute in the request body. For example, \"recoveryTraceLevel\" : \"Audit\".",
"operationId":"errorResubmit",
"parameters":[
{
"name":"id",
"in":"path",
"description":"Errored instance identifier.",
"required":true,
"schema":{
"type":"string"
}
},
{
"name":"integrationInstance",
"in":"query",
"description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.",
"required":true,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"description":"Attribute name is \"recoveryTraceLevel\". Supported values are Debug, Production and Audit.
\n\nExamples:\n
\n{ \"recoveryTraceLevel\":\"Audit\"}",
"content":{
"application/json;charset=utf-8":{
"schema":{
"$ref":"#/components/schemas/ErrorsBulkRequest"
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Request accepted with response",
"content":{
"application/json; charset=utf-8":{
"schema":{
"$ref":"#/components/schemas/ErrorResubmitRs"
}
}
}
},
"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/futureruns":{
"get":{
"tags":[
"Integrations/Monitoring"
],
"summary":"Retrieve Future Runs for a Schedule",
"description":"Retrieves the future runs for a scheduled integration.",
"operationId":"getFutureRuns",
"parameters":[
{
"name":"timezone",
"in":"query",
"description":"Timezone identifier.
\n\nExamples: \n
\nAmerica/New_York, Asia/Calcutta, Europe/London", "required":false, "schema":{ "type":"string", "nullable":true } }, { "name":"returnAll", "in":"query", "description":"Valid values - true, false (default). If true, will return each future run. Else, will aggregate the count of future runs on a daily basis.", "required":false, "schema":{ "type":"boolean", "nullable":true } }, { "name":"q", "in":"query", "description":"
Filter parameters.
\n\n\t
Filter parameter.
\n\n
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, "schema":{ "type":"string", "nullable":true } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/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/instances":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Integration Instances", "description":"Retrieve information about integration instances for the past hour ordered by last updated time. You can perform multi-word value search using the businessIDValue, primaryValue, secondaryValue, and tertiaryValue attributes in query filter parameters. To perform multi-word searches, encapsulate the search values in double quotation marks followed by single quotation marks. For example, '\"Test-instance1\"', and '\"Testing instance2\"'. You can also search primaryValue, secondaryValue, and tertiaryValue values against the specified primaryName, secondaryName, and tertiaryName variable names.", "operationId":"getInstances", "parameters":[ { "name":"q", "in":"query", "description":"
Filter parameters.
\n\n\t
\n\tExample: \n
\n{timewindow:'1h', id:'118', status:'FAILED', code:'ERROR', version:'01.00.0000', requestId:'2432', jobid:'18'}",
"required":false,
"schema":{
"type":"string",
"nullable":true
}
},
{
"name":"groupBy",
"in":"query",
"description":"\n\t
\n", "required":false, "schema":{ "type":"string", "nullable":true } }, { "name":"orderBy", "in":"query", "description":"
\n\t
\n", "required":false, "schema":{ "type":"string", "nullable":true } }, { "name":"fields", "in":"query", "description":"Limit query results to a few fields. Valid values are runId, id and all.", "required":false, "schema":{ "type":"string", "nullable":true } }, { "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, "schema":{ "type":"integer", "format":"int32", "nullable":true } }, { "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, "schema":{ "type":"integer", "format":"int32", "nullable":true } }, { "name":"return", "in":"query", "description":"Controls the response data. Valid URL parameter values are:\n
\n\t
Integration instance identifier.
\n\nExample: \n
\n100001", "required":true, "schema":{ "type":"string" } }, { "name":"order", "in":"query", "description":"
Order identifier.
\n\nExamples: \n
\nasc, desc", "required":false, "schema":{ "type":"string", "nullable":true } }, { "name":"timezone", "in":"query", "description":"
Timezone identifier.
\n\nExamples: \n
\nAmerica/New_York, Asia/Calcutta, Europe/London", "required":false, "schema":{ "type":"string", "nullable":true } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/InstanceRs" } } } }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Instance not found" }, "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/instances/{id}/activityStreamDetails":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Retrieve Integration Instance Activity Stream Details", "description":"Retrieves activity stream data of an integration instance with specified identifier. The response includes the sequence of actions, invokes and error messages if any, along with their timestamps.", "operationId":"getActivityStreamDetails", "parameters":[ { "name":"id", "in":"path", "description":"
Integration instance identifier.
\n\nExample: \n
\nXkDtR_wnEeypSFfBhM5b3Q", "required":true, "schema":{ "type":"string" } }, { "name":"timezone", "in":"query", "description":"
Timezone identifier.
\n\nExamples: \n
\nAmerica/New_York, Asia/Calcutta, Europe/London", "required":false, "schema":{ "type":"string", "nullable":true } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Instance not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-instances-{id}-activityStreamDetails-get", "x-filename-id":"ic-api-integration-v1-monitoring-instances-id-activitystreamdetails-get" } }, "/ic/api/integration/v1/monitoring/instances/{id}/activityStreamDetails/{+key}":{ "get":{ "tags":[ "Integrations/Monitoring" ], "summary":"Download Large Payload in an Integration Instance", "description":"Downloads a large payload (payload size is more than 32 KB) in an integration instance with a specified identifier. The response is a payload with the specified identifier.", "operationId":"getActivityStreamLargePayload", "parameters":[ { "name":"id", "in":"path", "description":"
Integration instance identifier.
\n\nExample: \n
\nXkDtR_wnEeypSFfBhM5b3Q", "required":true, "schema":{ "type":"string" } }, { "name":"key", "in":"path", "description":"
Large payload identifier.
\n\nExample: \n
\ntracking-data/debug/X5YdCvwnEeypSFfBhM5b3Q", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Instance not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-monitoring-instances-{id}-activityStreamDetails-{+key}-get", "x-filename-id":"ic-api-integration-v1-monitoring-instances-id-activitystreamdetails-key-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", "parameters":[ { "name":"q", "in":"query", "description":"
Filter parameters.
\n\n\t
\n\tExample: \n
\n{timewindow:'2d', status:'CONFIGURED', style:'freeform_scheduled'}",
"required":false,
"schema":{
"type":"string",
"nullable":true
}
},
{
"name":"orderBy",
"in":"query",
"description":"Valid values:
\n\n\t
\n\tExample:\n\t
To order the records by name
\n\norderBy='name'", "required":false, "schema":{ "type":"string", "nullable":true } }, { "name":"offset", "in":"query", "description":"Start index for pagination support. Default value is 0.", "required":false, "schema":{ "type":"integer", "format":"int32", "nullable":true } }, { "name":"limit", "in":"query", "description":"Number of integrations to fetch.", "required":false, "schema":{ "type":"integer", "format":"int32", "nullable":true } }, { "name":"return", "in":"query", "description":"Type of records to return.", "required":false, "schema":{ "type":"string", "nullable":true } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"id", "in":"path", "description":"Integration identifier and version.", "required":true, "schema":{ "type":"string" } }, { "name":"q", "in":"query", "description":"
Filter parameter.
\n\n
Returns a filtered list of packages based on the specified parameters.
Valid parameters:
q={name:'PackageName'}.q={name: /pack/}Returns a filtered list of projects based on the specified parameters.
Valid parameters:
q={name:'ProjectName'}.q={name: /pack/}Orders results by project name or last updated time.
Valid values:
Creates a project. The request body must contain name and code.
Imports a new project that was previously exported. To submit an import request, the project must not be present in the environment.
", "operationId":"importAsNewProject", "parameters":[ { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "description":"Previously exported project file", "format":"binary" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"No file is uploaded" }, "409":{ "description":"Project already exists" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-projects-archive-post", "x-filename-id":"ic-api-integration-v1-projects-archive-post" } }, "/ic/api/integration/v1/projects/{id}":{ "get":{ "tags":[ "Integrations/Projects" ], "summary":"Retrieve a Project", "description":"Retrieves detailed information about the project.", "operationId":"getProject", "parameters":[ { "name":"id", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json;charset=utf-8, application/vnd.oracle.model+json;type=singular":{ "schema":{ "$ref":"#/components/schemas/ProjectTypeRs" } } } }, "404":{ "description":"Project not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-projects-{id}-get", "x-filename-id":"ic-api-integration-v1-projects-id-get" }, "post":{ "tags":[ "Integrations/Projects" ], "summary":"Update a Project", "description":"Updates a project with the provided details, including project-level configurations such as MCP enablement.", "operationId":"updateProject", "parameters":[ { "name":"id", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Project details", "required":true, "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/ProjectTypeRs" } } } }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json;charset=utf-8, application/vnd.oracle.model+json;type=singular":{ "schema":{ "$ref":"#/components/schemas/ProjectTypeRs" } } } }, "404":{ "description":"Project not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-projects-{id}-post", "x-filename-id":"ic-api-integration-v1-projects-id-post" }, "delete":{ "tags":[ "Integrations/Projects" ], "summary":"Delete a Project", "description":"Deletes a project.", "operationId":"deleteProject", "parameters":[ { "name":"id", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Project not found" }, "412":{ "description":"Project can't be deleted if any integration belonging to the project is ACTIVE or LOCKED." }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-projects-{id}-delete", "x-filename-id":"ic-api-integration-v1-projects-id-delete" } }, "/ic/api/integration/v1/projects/{id}/acl":{ "get":{ "tags":[ "Integrations/Projects/RBAC" ], "summary":"Retrieve Project RBAC Details", "description":"Retrieves Role-Based Access Control information about the project.", "operationId":"getProjectACL", "parameters":[ { "name":"id", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json;charset=utf-8, application/vnd.oracle.model+json;type=singular":{ "schema":{ "$ref":"#/components/schemas/AccessControlledRs" } } } }, "404":{ "description":"Project not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-projects-{id}-acl-get", "x-filename-id":"ic-api-integration-v1-projects-id-acl-get" }, "put":{ "tags":[ "Integrations/Projects/RBAC" ], "summary":"Update Project RBAC Details", "description":"Updates Role-Based Access Control details of the project. The request body must contain:
\"administrators\":{\"allowAll\":false,\"allowed\":[{\"id\":\"123456abcdef\",\"displayName\":\"test admin user\",\"type\":\"user\"},{\"id\":\"654321abcdef\",\"displayName\":\"ServiceAdministrator\",\"type\": \"group\"}]}\"editors\":{\"allowAll\":false,\"allowed\":[{\"id\":\"234561abcdef\",\"displayName\":\"test developer user\",\"type\":\"user\"},{\"id\":\"123456abcdef\",\"displayName\":\"test admin user\",\"type\": \"user\"}]}\"viewers\":{\"allowAll\":true,\"allowed\":[]}\"monitors\":{\"allowAll\":true,\"allowed\":[]}Creates a copy of a project with identical resources. The request body must contain name and code.
Filters connections by name, status, and role.
Valid parameters:
q={name:'My Connection Name'}.q={name: /Oracle/}For example, to retrieve all connections that contain RN and have the status configured, specify:
{name : /RN/, status : 'CONFIGURED'}Valid values: SOURCE, SOURCE_AND_TARGET, TARGET. Values are case-sensitive. In the graphical user interface: SOURCE is displayed as trigger, SOURCE_AND_TARGET is displayed as trigger and invoke, and TARGET is displayed as invoke.
Lists connections ordered by name, last updated time, or adapter type.
Valid values:
Updates the security properties, connection properties, agentGroupId, or securityPolicy of a connection in a project. 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":"updateProjectConnection", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } }, { "name":"X-HTTP-Method-Override", "in":"header", "description":"HTTP Method override in the header", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Project connection resource", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/ConnectionRs" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json;charset=utf-8, application/vnd.oracle.model+json;type=singular":{ "schema":{ "$ref":"#/components/schemas/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-projects-{projectId}-connections-{id}-post", "x-filename-id":"ic-api-integration-v1-projects-projectid-connections-id-post" }, "delete":{ "tags":[ "Integrations/Projects/Connections" ], "summary":"Delete a Connection in a Project", "description":"Deletes the connection with the specified ID in a project.", "operationId":"deleteProjectConnection", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "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-projects-{projectId}-connections-{id}-delete", "x-filename-id":"ic-api-integration-v1-projects-projectid-connections-id-delete" } }, "/ic/api/integration/v1/projects/{projectId}/connections/{id}/test":{ "post":{ "tags":[ "Integrations/Projects/Connections" ], "summary":"Test a Connection in a Project", "description":"Tests a connection in a project by doing a ping test. Can be used to check the status of the connection.
", "operationId":"testProjectConnection", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"id", "in":"path", "description":"Connection identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ } } }, "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-projects-{projectId}-connections-{id}-test-post", "x-filename-id":"ic-api-integration-v1-projects-projectid-connections-id-test-post" } }, "/ic/api/integration/v1/projects/{projectId}/deployments":{ "get":{ "tags":[ "Integrations/Projects/Deployments" ], "summary":"Retrieve Deployments in a Project", "description":"Retrieves information about all the deployments in a project.", "operationId":"getDeployments", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "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 deployments starting at the 4th item, and the list will contain 16 items.", "required":false, "schema":{ "type":"integer", "format":"int32", "nullable":true } }, { "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 deployments starting at the 4th item, and the list will contain 16 items.", "required":false, "schema":{ "type":"integer", "format":"int32", "nullable":true } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json;charset=utf-8, application/vnd.oracle.model+json;type=collection":{ "schema":{ "$ref":"#/components/schemas/LabelsRs" } } } }, "400":{ "description":"Malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-projects-{projectId}-deployments-get", "x-filename-id":"ic-api-integration-v1-projects-projectid-deployments-get" }, "post":{ "tags":[ "Integrations/Projects/Deployments" ], "summary":"Create a Deployment in a Project", "description":"Creates a deployment in a project. The request body must contain name and code.
\"integrations\":[{\"code\":\"TEST_INT1\",\"version\":\"01.00.0000\"}, {\"code\":\"TEST_INT2\",\"version\":\"02.00.0000\"}]\"robots\":[{\"identifier\":\"TEST_RPA1\",\"version\":\"01.00.0000\"}, {\"identifier\":\"TEST_RPA2\",\"version\":\"02.00.0000\"}]\"decisions\":[{\"identifier\":\"TEST_DEC1\",\"version\":\"01.00.0000\"}, {\"identifier\":\"TEST_DEC2\",\"version\":\"02.00.0000\"}]\"b2btradingpartners\":[{\"code\":\"TEST_B2BTP1\",\"version\":\"01.00.0000\"}, {\"code\":\"TEST_B2BTP2\",\"version\":\"02.00.0000\"}]Updates a deployment using the ID and values specified in the request body. The request body must contain name and code.
\"integrations\":[{\"code\":\"TEST_INT1\",\"version\":\"01.00.0000\"}, {\"code\":\"TEST_INT2\",\"version\":\"02.00.0000\"}]\"robots\":[{\"identifier\":\"TEST_RPA1\",\"version\":\"01.00.0000\"}, {\"identifier\":\"TEST_RPA2\",\"version\":\"02.00.0000\"}]\"decisions\":[{\"identifier\":\"TEST_DEC1\",\"version\":\"01.00.0000\"}, {\"identifier\":\"TEST_DEC2\",\"version\":\"02.00.0000\"}]\"b2btradingpartners\":[{\"code\":\"TEST_B2BTP1\",\"version\":\"01.00.0000\"}, {\"code\":\"TEST_B2BTP2\",\"version\":\"02.00.0000\"}]Filters integrations by integration name, status, type, and integration style.
Valid parameters:
q={name:'My Integration Name'}q={name: /Oracle/}For example, to retrieve all integrations that contain SC2RN and have the status configured, specify:
{name : /SC2RN/, status : 'CONFIGURED'}Valid values: PREBUILT, CUSTOM, DEVELOPED.
freeform_mapmydata- Application-Driven Orchestrated Integration
freeform_scheduled- Scheduled Orchestration Integration
template_mapmydata- Basic Routing Map My Data Integration
template_subscribetooic- Subscribe to OIC Integration
template_publishtooic- Publish to OIC Integration
Orders results by integration name or last updated time.
Valid values:
Imports a new integration in a project that was previously exported. To submit an import request, the integration must not be present in the environment.
If you are using cURL, use the -F option to specify the file to import.
", "operationId":"importAsNewProjectIntegration", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "description":"Previously exported integration file", "format":"binary" } } } } }, "required":true }, "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-projects-{projectId}-integrations-archive-post", "x-filename-id":"ic-api-integration-v1-projects-projectid-integrations-archive-post" } }, "/ic/api/integration/v1/projects/{projectId}/integrations/copy":{ "post":{ "tags":[ "Integrations/Projects/Integrations" ], "summary":"Copy an Integration in a Project", "description":"Copies an integration into a project. The integration to copy can be either in a different project (as long as it is marked as globally available) or outside of any project. The request body must include the integration's code and version. If the integration belongs to another project, the projectCode field in the request body should specify the project's code.", "operationId":"copyProjectIntegration", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Integration Details", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IntegrationImportFromRs" } } }, "required":true }, "responses":{ "204":{ "description":"Successful operation" }, "400":{ "description":"Bad request, missing required data" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-projects-{projectId}-integrations-copy-post", "x-filename-id":"ic-api-integration-v1-projects-projectid-integrations-copy-post" } }, "/ic/api/integration/v1/projects/{projectId}/integrations/{id}":{ "get":{ "tags":[ "Integrations/Projects/Integrations" ], "summary":"Retrieve an Integration in a Project", "description":"Retrieves detailed information about the integration in a project.", "operationId":"getProjectIntegration", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "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, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json;charset=utf-8, application/vnd.oracle.model+json;type=singular":{ "schema":{ "$ref":"#/components/schemas/IntegrationListRs" } } } }, "404":{ "description":"Integration not found" }, "412":{ "description":"Precondition failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-projects-{projectId}-integrations-{id}-get", "x-filename-id":"ic-api-integration-v1-projects-projectid-integrations-id-get" }, "post":{ "tags":[ "Integrations/Projects/Integrations" ], "summary":"Update an Integration in a Project", "description":"Activates or deactivates an integration in a project. To modify an active integration, you need to deactivate it first.
Note that the version number matters when activating integrations:
Updates integration property of an integration in a project.
", "operationId":"updateProjectIntegration", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "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, "schema":{ "type":"string" } }, { "name":"X-HTTP-Method-Override", "in":"header", "description":"X-HTTP-Method-Override request header", "required":false, "schema":{ "type":"string", "nullable":true } }, { "name":"deleteEventSubscriptionFlag", "in":"query", "description":"Delete Event Subscription Flag", "required":false, "schema":{ "type":"string", "nullable":true } }, { "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, "schema":{ "type":"string", "nullable":true } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "description":"Project integration resource", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/IntegrationRs" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/IntegrationListRs" } } } }, "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-projects-{projectId}-integrations-{id}-post", "x-filename-id":"ic-api-integration-v1-projects-projectid-integrations-id-post" }, "delete":{ "tags":[ "Integrations/Projects/Integrations" ], "summary":"Delete an Integration Version in a Project", "description":"Deletes the integration with the specified ID in a project. Make sure the integration you want to delete is not active. To deactivate an integration, use Update an Integration in a Project.", "operationId":"deleteProjectIntegration", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "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, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation" }, "404":{ "description":"Integration not found" }, "423":{ "description":"Deletion not allowed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-projects-{projectId}-integrations-{id}-delete", "x-filename-id":"ic-api-integration-v1-projects-projectid-integrations-id-delete" } }, "/ic/api/integration/v1/projects/{projectId}/integrations/{id}/activationErrors":{ "get":{ "tags":[ "Integrations/Projects/Integrations" ], "summary":"Retrieve Integration Activation Errors in a Project", "description":"Retrieves integration activation errors for the specified integration ID within a project.", "operationId":"getProjectDeploymentErrors", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "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, "schema":{ "type":"string" } }, { "name":"integrationInstance", "in":"query", "description":"This is the name of the service instance. You can get this value from the About page where it is specified in the Service instance field.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json; charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/IntegrationActivationErrorRs" } } } }, "404":{ "description":"Integration not found" }, "412":{ "description":"Precondition failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-integration-v1-projects-{projectId}-integrations-{id}-activationErrors-get", "x-filename-id":"ic-api-integration-v1-projects-projectid-integrations-id-activationerrors-get" } }, "/ic/api/integration/v1/projects/{projectId}/integrations/{id}/activationStatus":{ "get":{ "tags":[ "Integrations/Projects/Integrations" ], "summary":"Retrieve Integration Activation Status in a Project", "description":"Retrieves progress of integration activation within a project. The responses can be:Filters lookups by name and status.
Valid parameters:
q={name:'MyLookup'}q={name: /MyLookup/}For example, to retrieve all lookups that contain Lookup and have the status LOCKED, specify:
q={name : /Lookup/, status : 'LOCKED'}Lists lookups ordered by name.
Valid value:
Creates a lookup in a project. The request body must contain:
\"name\":\"myLookup\"
\"columns\":[\"rightnow\",\"soap\"]
\"rows\":[{\"rowData\":[\"RN1\",\"SOAP1\"]},{\"rowData\":[\"RN2\",\"SOAP2\"]}]Updates a lookup in a project with the name and values specified in the request body. The request body must contain:
\"name\":\"myLookup\"
\"columns\":[\"rightnow\",\"soap\"]
\"rows\":[{\"rowData\":[\"RN1\",\"SOAP1\"]},{\"rowData\":[\"RN2\",\"SOAP2\"]}]Valid parameters:
q={name: /library/}For example, to retrieve all libraries that contain the string myLibrary and have the status preinstalled, specify:
q={name : /myLibrary/, type : 'preinstalled'}Lists libraries ordered by name or last updated time.
Valid value:
Schema ID.
\n\n\tExample: \n
\n/b2b/v1/schemas/SCHEMA-123/export?includeDoc=true", "required":true, "schema":{ "type":"string" } }, { "name":"includeDoc", "in":"query", "description":"
Use the includeDoc flag to include all its documents in the zip file along with the schema. Default value is false.
\n\n\tExample: \n
\n/b2b/v1/schemas/SCHEMA-123/export?includeDoc=true", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/octet-stream":{ "schema":{ "type":"string", "format":"binary" } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-schemas-{schemaId}-export-get", "x-filename-id":"ic-api-b2b-v1-schemas-schemaid-export-get" } }, "/ic/api/b2b/v1/schemas/import":{ "post":{ "tags":[ "B2B/Document Customization" ], "summary":"Import a B2B Schema", "description":"Import a B2B Schema from the previously exported schema zipped file.", "operationId":"importSchema", "parameters":[ { "name":"isOverwrite", "in":"query", "description":"
Overwrite flag to overwrite components in the zip file. Default value is false.
\n\n\tExample: \n
\n/b2b/v1/schemas/import?isOverwrite=true", "required":true, "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "description":"Previously exported Schema ZIP file.", "format":"binary" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ImportDocRs" } } } }, "404":{ "description":"Not found" }, "409":{ "description":"Duplicate data error" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-schemas-import-post", "x-filename-id":"ic-api-b2b-v1-schemas-import-post" } }, "/ic/api/b2b/v1/b2bdocuments/{documentId}/export":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Export a B2B Document", "description":"Exports a B2B Document with its associated schemas as a zipped file.", "operationId":"exportDocument", "parameters":[ { "name":"documentId", "in":"path", "description":"
Document ID.
\n\n\tExample: \n
\n/b2b/v1/b2bdocuments/DOC123/export", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/octet-stream":{ "schema":{ "type":"string", "format":"binary" } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-b2bdocuments-{documentId}-export-get", "x-filename-id":"ic-api-b2b-v1-b2bdocuments-documentid-export-get" } }, "/ic/api/b2b/v1/b2bdocuments/import":{ "post":{ "tags":[ "B2B/Document Customization" ], "summary":"Import a B2B Document", "description":"Imports a B2B Document with its associated schemas from the previously exported document zip file.", "operationId":"importDocument", "parameters":[ { "name":"isOverwrite", "in":"query", "description":"
Overwrite flag to overwrite components in the zip file. Default value is false.
\n\n\tExample: \n
\n/b2b/v1/b2bdocuments/import?isOverwrite=true", "required":true, "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "description":"Previously exported Document ZIP file.", "format":"binary" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ImportDocRs" } } } }, "404":{ "description":"Not found" }, "409":{ "description":"Duplicate data error" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-b2bdocuments-import-post", "x-filename-id":"ic-api-b2b-v1-b2bdocuments-import-post" } }, "/ic/api/b2b/v1/migration/partners/import":{ "post":{ "tags":[ "B2B/Trading Partner Migration from SOA-B2B" ], "summary":"Migrate Trading Partners from SOA-B2B", "description":"Imports one or more trading partners with the associated B2B related artifacts such as agreements, documents, schemas, and host identifiers from the exported SOA-B2B design-time repository zip file.", "operationId":"migrateB2BTradingPartner", "parameters":[ { "name":"isOverwrite", "in":"query", "description":"
To overwrite an existing trading partner and replace it with the new trading partner imported from the zip file, then set this boolean flag to true. The default value is false.
\n\nExample: \n
\nic/api/b2b/v1/migration/partners/import?isOverwrite=true", "required":true, "schema":{ "type":"boolean", "default":false } }, { "name":"isFileZipOfZip", "in":"query", "description":"
If the imported zip file contains multiple zip files, then set this boolean value to true. The default value is false.
\n\nExample: \n
\nic/api/b2b/v1/migration/partners/import?isFileZipOfZip=true", "required":true, "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "description":"Exported SOA-B2B trading partner zip file.", "format":"binary" }, "option":{ "type":"string", "description":"
This is an optional property. Use this property to specify how you want to display the filenames of the imported files. The following options are available:
\nshowDescription: Set this value to true to display the description.
\ndescription: Specify the description that you want to show for the imported trading partner.
\ndocumentPrefix: Specify a value if you want to prefix any text to the filenames of the imported documents.
\nschemaPrefix: Specify a value if you want to prefix any text to the file names of the imported schemas.
\nfilter: You have include and exclude filter options. To include TP/TPA files from the zip file, use the include parameter. To exclude TP/TPA files from the zip file, use the exclude parameter.
\n\nExample: \n
\n{\"showDescription\":\"true\",\"description\":\"IMPORT FROM SOA-B2b \",\"schemaPrefix\":\"SCH\",\"documentPrefix\":\"DOC\",\"filter\":{\"exclude\":{\"tpId\":[\"tp_1\",\"tp_2\"],\"tpa\":[\"tpa_1\",\"tpa_2\"]},\"include\":{\"tpId\":[],\"tpa\":[]}}}",
"nullable":true
}
}
}
}
},
"required":true
},
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/TPMigrationImportRestResponse"
}
}
}
},
"400":{
"description":"Bad request"
},
"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-migration-partners-import-post",
"x-filename-id":"ic-api-b2b-v1-migration-partners-import-post"
}
},
"/ic/api/b2b/v1/import":{
"post":{
"tags":[
"B2B/Document Customization"
],
"summary":"Create a B2B Schema from an SEF File",
"description":"Creates a B2B schema by importing a Standard Exchange Format (SEF) file. The SEF file format is used to exchange EDI implementation guidelines in a machine-readable format.",
"operationId":"importSEFSchema",
"parameters":[
],
"requestBody":{
"content":{
"multipart/form-data":{
"schema":{
"type":"object"
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Successful operation"
},
"400":{
"description":"Bad request, corrupted SEF schema"
},
"500":{
"description":"Server error"
}
},
"x-internal-id":"ic-api-b2b-v1-import-post",
"x-filename-id":"ic-api-b2b-v1-import-post"
}
},
"/ic/api/b2b/v1/projects/{projectId}/b2bdocuments":{
"get":{
"tags":[
"B2B/Projects/B2B Documents"
],
"summary":"Retrieve B2B Documents",
"description":"Retrieves available B2B documents in project context.",
"operationId":"getDocumentsInProject",
"parameters":[
{
"name":"projectId",
"in":"path",
"description":"Project identifier",
"required":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DocumentsUI"
}
}
}
},
"400":{
"description":"Bad request"
},
"500":{
"description":"Server error"
}
},
"x-internal-id":"ic-api-b2b-v1-projects-{projectId}-b2bdocuments-get",
"x-filename-id":"ic-api-b2b-v1-projects-projectid-b2bdocuments-get"
},
"post":{
"tags":[
"B2B/Projects/B2B Documents"
],
"summary":"Create a B2B Document",
"description":"Creates a B2B document with the specified ID, name, description, standard, txId and version in project context. Examples of standard values are X12, EDIFACT. Examples of version for EDIFACT are D00A, D00B, etc. and examples for X12 are 4010. 4011, etc. Examples of txId (or transaction type) for EDIFACT are APERAK, AUTHOR, etc. and examples for X12 are 100, 850, etc.",
"operationId":"createDocumentInProject",
"parameters":[
{
"name":"projectId",
"in":"path",
"description":"Project identifier",
"required":true,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"type":"object",
"properties":{
"documentUi":{
"$ref":"#/components/schemas/DocumentUI"
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/DocumentUI"
}
}
}
},
"400":{
"description":"Bad request, malformed parameters or missing required data"
},
"409":{
"description":"Duplicate data error"
},
"412":{
"description":"Pre-condition failure. Ensure that the length of name does not exceed 50 characters, length of identifier does not exceed 32 characters, length of decsription does not exceed 1024 characters, and the length of identifier does not exceed 32 characters. Ensure that name and identifier are not named as Standard or Default. Ensure that there is a valid combination of std, version and txId."
},
"500":{
"description":"Server error"
}
},
"x-internal-id":"ic-api-b2b-v1-projects-{projectId}-b2bdocuments-post",
"x-filename-id":"ic-api-b2b-v1-projects-projectid-b2bdocuments-post"
}
},
"/ic/api/b2b/v1/projects/{projectId}/b2bdocuments/import":{
"post":{
"tags":[
"B2B/Projects/B2B Documents"
],
"summary":"Import a B2B Document",
"description":"Imports a B2B Document with its associated schemas from the previously exported document zip file in project context.",
"operationId":"importDocumentInProject",
"parameters":[
{
"name":"projectId",
"in":"path",
"description":"Project identifier",
"required":true,
"schema":{
"type":"string"
}
},
{
"name":"isOverwrite",
"in":"query",
"description":"Overwrite flag to overwrite components in the zip file. Default value is false.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/b2bdocuments/import?isOverwrite=true", "required":true, "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "description":"Previously exported Document ZIP file.", "format":"binary" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ImportDocRs" } } } }, "404":{ "description":"Not found" }, "409":{ "description":"Duplicate data error" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-b2bdocuments-import-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-b2bdocuments-import-post" } }, "/ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}":{ "get":{ "tags":[ "B2B/Projects/B2B Documents" ], "summary":"Retrieve a B2B Document", "description":"Retrieves detailed information about the B2B Document with the specified ID in project context.", "operationId":"getDocumentInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"documentId", "in":"path", "description":"
B2B document ID.
\n\n Example: \n
\n/b2b/v1/projects/PROJECTID/b2bdocuments/DOC123", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DocumentUI" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-b2bdocuments-{documentId}-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-b2bdocuments-documentid-get" }, "put":{ "tags":[ "B2B/Projects/B2B Documents" ], "summary":"Update a B2B Document", "description":"Updates a B2B Document with the specified document ID in project context. To modify a document used by an active agreement, you need to deactivate it first.", "operationId":"updateDocumentInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"documentId", "in":"path", "description":"
B2B document ID.
\n\n Example: \n
\n/b2b/v1/projects/PROJECTID/b2bdocuments/DOC123", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "documentUi":{ "$ref":"#/components/schemas/DocumentUI" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DocumentUI" } } } }, "400":{ "description":"Bad request, malformed parameters or missing required data" }, "412":{ "description":"Pre-condition failure. Ensure that the length of name does not exceed 50 characters, length of identifier does not exceed 32 characters, length of decsription does not exceed 1024 characters, and the length of identifier does not exceed 32 characters. Ensure that name and identifier are not named as Standard or Default. Ensure that there is a valid combination of std, version and txId." }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-b2bdocuments-{documentId}-put", "x-filename-id":"ic-api-b2b-v1-projects-projectid-b2bdocuments-documentid-put" }, "delete":{ "tags":[ "B2B/Projects/B2B Documents" ], "summary":"Delete a B2B Document", "description":"Deletes the B2B Document with the specified ID in project context. Ensure that the B2B Document you want to delete is not in use by any integration or trading partner in that project. Before deleting it, remove any references to the document in the project.", "operationId":"deleteDocumentInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"documentId", "in":"path", "description":"B2B Document ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request" }, "409":{ "description":"Not allowed, document in use" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-b2bdocuments-{documentId}-delete", "x-filename-id":"ic-api-b2b-v1-projects-projectid-b2bdocuments-documentid-delete" } }, "/ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}/clone":{ "post":{ "tags":[ "B2B/Projects/B2B Documents" ], "summary":"Clone a B2B Document", "description":"Creates a copy of a B2B document with identical metadata in project context. The request body must contain at least the name and identifier fields.", "operationId":"cloneDocumentInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"documentId", "in":"path", "description":"
B2B document ID.
\n\n Example: \n
\n/b2b/v1/projects/PROJECTID/b2bdocuments/DOC123/clone", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "documentUi":{ "$ref":"#/components/schemas/DocumentUI" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation" }, "400":{ "description":"Bad request, malformed parameters or missing required data" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-b2bdocuments-{documentId}-clone-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-b2bdocuments-documentid-clone-post" } }, "/ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}/export":{ "get":{ "tags":[ "B2B/Projects/B2B Documents" ], "summary":"Export a B2B Document", "description":"Exports a B2B Document with its associated schemas as a zip file in project context.", "operationId":"exportDocumentInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"documentId", "in":"path", "description":"
Document ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/b2bdocuments/DOC123/export", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/octet-stream":{ "schema":{ "type":"string", "format":"binary" } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-b2bdocuments-{documentId}-export-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-b2bdocuments-documentid-export-get" } }, "/ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}/integrations":{ "get":{ "tags":[ "B2B/Projects/B2B Documents" ], "summary":"Retrieve Integrations That Use a B2B Document", "description":"Retrieves available integrations that are using the specified B2B Document in project context.", "operationId":"getLinkedIntegrationsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"documentId", "in":"path", "description":"
Integrations associated with b2b document.
\n\n Example: \n
\n/b2b/v1/projects/PROJECTID/b2bdocuments/DOC123/integrations", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-b2bdocuments-{documentId}-integrations-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-b2bdocuments-documentid-integrations-get" } }, "/ic/api/b2b/v1/projects/{projectId}/b2bdocuments/{documentId}/partners":{ "get":{ "tags":[ "B2B/Projects/B2B Documents" ], "summary":"Retrieve Trading Partners of a B2B Document", "description":"Retrieves the available trading partners that are using the specified B2B Document in project context.", "operationId":"getLinkedPartnersInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"documentId", "in":"path", "description":"
Trading partners using the B2B document.
\n\n Example: \n
\n/b2b/v1/projects/PROJECTID/b2bdocuments/DOC123/partners", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-b2bdocuments-{documentId}-partners-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-b2bdocuments-documentid-partners-get" } }, "/ic/api/b2b/v1/projects/{projectId}/import":{ "post":{ "tags":[ "B2B/Projects/Schemas" ], "summary":"Create a B2B Schema by Importing SEF File", "description":"Creates a B2B schema by importing a Standard Exchange Format (SEF) File or non-EDI schema format. The SEF file format is used to exchange EDI implementation guidelines in a machine-readable format.", "operationId":"importSEFSchemaInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "description":"Standard sef schema.", "format":"binary", "nullable":true }, "schema":{ "type":"string", "description":"
Import B2B Schema request details.
\n\n\tExample: \n
\n{\"id\": \"SCH123\",\t\"name\": \"Sch123\", \"std\": \"X12\", \"version\": \"4010\", \"txId\": \"850\" }"
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Successful operation"
},
"400":{
"description":"Bad request, corrupted SEF schema"
},
"500":{
"description":"Server error"
}
},
"x-internal-id":"ic-api-b2b-v1-projects-{projectId}-import-post",
"x-filename-id":"ic-api-b2b-v1-projects-projectid-import-post"
}
},
"/ic/api/b2b/v1/projects/{projectId}/schemas":{
"get":{
"tags":[
"B2B/Projects/Schemas"
],
"summary":"Retrieve B2B Schemas",
"description":"Retrieves all the available B2B schemas in project context.",
"operationId":"getSchemasInProject",
"parameters":[
{
"name":"projectId",
"in":"path",
"description":"Project identifier",
"required":true,
"schema":{
"type":"string"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/SchemasUI"
}
}
}
},
"400":{
"description":"Bad request"
},
"500":{
"description":"Server error"
}
},
"x-internal-id":"ic-api-b2b-v1-projects-{projectId}-schemas-get",
"x-filename-id":"ic-api-b2b-v1-projects-projectid-schemas-get"
},
"post":{
"tags":[
"B2B/Projects/Schemas"
],
"summary":"Create a B2B Schema",
"description":"Creates a B2B schema with the specified ID, name, description, standard, txId and version in project context. Examples of standard values are X12, EDIFACT, etc. Examples of version for EDIFACT are D00A, D00B, etc. Examples for X12 are 4010, 4011, etc. Examples for txId (or transaction type) for EDIFACT are APERAK, AUTHOR, etc. Examples for X12 are 100, 850, etc.",
"operationId":"createSchemaInProject",
"parameters":[
{
"name":"projectId",
"in":"path",
"description":"Project identifier",
"required":true,
"schema":{
"type":"string"
}
}
],
"requestBody":{
"content":{
"application/json":{
"schema":{
"type":"object",
"properties":{
"schemaUi":{
"$ref":"#/components/schemas/SchemaUI"
}
}
}
}
},
"required":true
},
"responses":{
"201":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"type":"array",
"items":{
"$ref":"#/components/schemas/Object"
}
}
}
}
},
"400":{
"description":"Bad request, malformed parameters or missing required data"
},
"409":{
"description":"Duplicate data error"
},
"412":{
"description":"Pre-condition failure. Ensure that the length of name does not exceed 50 characters, length of identifier does not exceed 32 characters, length of description does not exceed 1024 characters, length of identifier does not exceed 32 characters, Name and Identifier is not named as 'Standard' or 'Default', and there must be a valid combination of std, version and txId."
},
"500":{
"description":"Server error"
}
},
"x-internal-id":"ic-api-b2b-v1-projects-{projectId}-schemas-post",
"x-filename-id":"ic-api-b2b-v1-projects-projectid-schemas-post"
}
},
"/ic/api/b2b/v1/projects/{projectId}/schemas/import":{
"post":{
"tags":[
"B2B/Projects/Schemas"
],
"summary":"Import a B2B Schema",
"description":"Import a B2B schema from the previously exported schema zip file in project context.",
"operationId":"importSchemaInProject",
"parameters":[
{
"name":"projectId",
"in":"path",
"description":"Project identifier",
"required":true,
"schema":{
"type":"string"
}
},
{
"name":"isOverwrite",
"in":"query",
"description":"Overwrite flag to overwrite components in the zip file. Default value is false.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/schemas/import?isOverwrite=true", "required":true, "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "description":"Previously exported Schema ZIP file.", "format":"binary" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ImportDocRs" } } } }, "404":{ "description":"Not found" }, "409":{ "description":"Duplicate data error" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-schemas-import-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-schemas-import-post" } }, "/ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}":{ "get":{ "tags":[ "B2B/Projects/Schemas" ], "summary":"Retrieve a B2B Schema", "description":"Retrieves detailed information about the B2B schema with the specified ID in project context.", "operationId":"getSchemaInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"schemaId", "in":"path", "description":"B2B schema ID.", "required":true, "schema":{ "type":"string" } }, { "name":"standard", "in":"query", "description":"Document standard.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"version", "in":"query", "description":"Document version.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"transactionId", "in":"query", "description":"
Document transaction ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/schemas/SCH2", "required":true, "schema":{ "type":"string", "nullable":true } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-schemas-{schemaId}-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-schemas-schemaid-get" }, "put":{ "tags":[ "B2B/Projects/Schemas" ], "summary":"Update a B2B Schema", "description":"Updates a B2B schema with the specified schema ID in project context. Before you modify a schema used by an active agreement, deactivate it.", "operationId":"updateSchemaInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"schemaId", "in":"path", "description":"
B2B schema ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/schemas/SCH123", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "schemaUi":{ "$ref":"#/components/schemas/SchemaUI" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } }, "400":{ "description":"Bad request, malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-schemas-{schemaId}-put", "x-filename-id":"ic-api-b2b-v1-projects-projectid-schemas-schemaid-put" }, "delete":{ "tags":[ "B2B/Projects/Schemas" ], "summary":"Delete a B2B Schema", "description":"Deletes the B2B Schema with the specified ID in project context. Ensure that the B2B schema that you want to delete is not in use by any B2B document in that project. Before deleting the B2B schema, remove any references to it in the project.", "operationId":"deleteSchemaInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"schemaId", "in":"path", "description":"
Delete B2B schema.
\n\nExample: \n
\n/b2b/v1/projects/PROJECTID/b2bdocuments/SCH123", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } }, "400":{ "description":"Bad request" }, "409":{ "description":"Not allowed, schema in use" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-schemas-{schemaId}-delete", "x-filename-id":"ic-api-b2b-v1-projects-projectid-schemas-schemaid-delete" } }, "/ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}/clone":{ "post":{ "tags":[ "B2B/Projects/Schemas" ], "summary":"Clone a B2B Schema", "description":"Creates a copy of a B2B schema with identical metadata in project context. The request body must contain at least the name and identifier fields.", "operationId":"cloneSchemaInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"schemaId", "in":"path", "description":"
B2B schema ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/schemas/SCH123/clone", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "schemaUi":{ "$ref":"#/components/schemas/SchemaUI" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } }, "400":{ "description":"Bad request, malformed parameters or missing required data" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-schemas-{schemaId}-clone-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-schemas-schemaid-clone-post" } }, "/ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}/documents":{ "get":{ "tags":[ "B2B/Projects/Schemas" ], "summary":"Retrieve Documents for a B2B Schema", "description":"Retrieves documents associated with the B2B schema in project context.", "operationId":"getLinkedDocumentsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"schemaId", "in":"path", "description":"
Schema ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/schemas/SCH123/documents", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-schemas-{schemaId}-documents-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-schemas-schemaid-documents-get" } }, "/ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}/export":{ "get":{ "tags":[ "B2B/Projects/Schemas" ], "summary":"Export a B2B Schema", "description":"Exports a B2B Schema as a zip file in project context.", "operationId":"exportSchemaInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"schemaId", "in":"path", "description":"
Schema ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/schemas/SCHEMA-123/export?includeDoc=true", "required":true, "schema":{ "type":"string" } }, { "name":"includeDoc", "in":"query", "description":"
includeDoc flag to include all its documents in the zip file along with the schema. Default value is false.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/schemas/export?includeDoc=true", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/octet-stream":{ "schema":{ "type":"string", "format":"binary" } } } }, "400":{ "description":"Bad request" }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-schemas-{schemaId}-export-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-schemas-schemaid-export-get" } }, "/ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}/guide":{ "get":{ "tags":[ "B2B/Projects/Schemas" ], "summary":"Generate a Schema Implementation Guide", "description":"Generates implementation guide for the schema.", "operationId":"generateEDIGuidelineInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"schemaId", "in":"path", "description":"B2B schema ID.", "required":true, "schema":{ "type":"string" } }, { "name":"format", "in":"query", "description":"Document format.", "required":true, "schema":{ "type":"string", "default":"html" } }, { "name":"standardId", "in":"query", "description":"Document standard ID.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"versionId", "in":"query", "description":"Document version ID.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"transactionId", "in":"query", "description":"
Document transaction ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/schemas/STANDARD/guide?format=html&standardId=X12&versionId=4010&transactionId=100", "required":true, "schema":{ "type":"string", "nullable":true } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "text/plain":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-schemas-{schemaId}-guide-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-schemas-schemaid-guide-get" } }, "/ic/api/b2b/v1/projects/{projectId}/schemas/{schemaId}/{elementId}/codes":{ "get":{ "tags":[ "B2B/Projects/Schemas" ], "summary":"Retrieve an Element's Code List", "description":"Retrieves the code list of an element using the element ID in project context.", "operationId":"getCodesInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"schemaId", "in":"path", "description":"B2B schema ID.", "required":true, "schema":{ "type":"string" } }, { "name":"standardId", "in":"query", "description":"Document standard ID.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"versionId", "in":"query", "description":"Document version ID.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"transactionId", "in":"query", "description":"Document transaction ID.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"elementId", "in":"path", "description":"
Element ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/schemas/SCH2/92/codes", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CodeUI" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-schemas-{schemaId}-{elementId}-codes-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-schemas-schemaid-elementid-codes-get" } }, "/ic/api/b2b/v1/projects/{projectId}/standards":{ "get":{ "tags":[ "B2B/Projects/Standards" ], "summary":"Retrieve B2B Document Standards", "description":"Retrieves the available document standards supported by B2B in project context.", "operationId":"getDocumentStandardsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-standards-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-standards-get" } }, "/ic/api/b2b/v1/projects/{projectId}/standards/{standardId}":{ "get":{ "tags":[ "B2B/Projects/Standards" ], "summary":"Retrieve Document Versions", "description":"Retrieves available document versions with the specified document standard in project context.", "operationId":"getDocumentVersionInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"standardId", "in":"path", "description":"
Standard ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/standards/X12", "required":true, "schema":{ "type":"string" } }, { "name":"isDocumentSearch", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-standards-{standardId}-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-standards-standardid-get" } }, "/ic/api/b2b/v1/projects/{projectId}/standards/{standardId}/{versionId}":{ "get":{ "tags":[ "B2B/Projects/Standards" ], "summary":"Retrieve Document Transactions", "description":"Retrieves available document transactions with the specified document standard and version in project context.", "operationId":"getAllDocumentsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"standardId", "in":"path", "description":"Standard ID.", "required":true, "schema":{ "type":"string" } }, { "name":"versionId", "in":"path", "description":"
Version ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/standards/X12/4010", "required":true, "schema":{ "type":"string" } }, { "name":"isDocumentSearch", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DocumentTypeUI" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-standards-{standardId}-{versionId}-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-standards-standardid-versionid-get" } }, "/ic/api/b2b/v1/projects/{projectId}/standards/{standardId}/{versionId}/{transactionId}":{ "get":{ "tags":[ "B2B/Projects/Standards" ], "summary":"Retrieve B2B Document Types", "description":"Retrieve all B2B document types in project context.", "operationId":"getTxSpecificDocumentInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"standardId", "in":"path", "description":"B2B document standard ID.", "required":true, "schema":{ "type":"string" } }, { "name":"versionId", "in":"path", "description":"Document version ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transactionId", "in":"path", "description":"Document transaction ID.", "required":true, "schema":{ "type":"string" } }, { "name":"isDocument", "in":"query", "description":"
isDocument Flag
\n\n Example: \n
\n/b2b/v1/projects/PROJECTID/standards/X12/4010/100?isDocument=true", "required":true, "schema":{ "type":"boolean", "default":true } } ], "responses":{ "200":{ "description":"Successful operation" }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-standards-{standardId}-{versionId}-{transactionId}-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-standards-standardid-versionid-transactionid-get" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/errorCodeLookup":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve Transports", "description":"Get all error details mapped per category in project context", "operationId":"getErrorCodeLookupInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"object", "additionalProperties":true } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-errorCodeLookup-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-errorcodelookup-get" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve Trading Partners", "description":"Retrieve all available trading partners in project context.", "operationId":"getTradingPartnerListInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TradingPartnersRs" } } } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-get" }, "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Create a Trading Partner", "description":"Creates a trading partner with the specified name and description in project context.", "operationId":"createTradingPartnerInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TradingPartnerRs" } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TradingPartnerRs" } } } }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/import":{ "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Import a Trading Partner", "description":"Imports a trading partner with the associated agreements, documents, schemas, and host identifiers from the previously exported trading partner zip file in project context.", "operationId":"importTradingPartnerInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"isOverwrite", "in":"query", "description":"
Overwrite flag to overwrite components in the zip file. Default value is false.
\n\n\tExample: \n
\nic/api/b2b/v1/projects/PROJECTID/tpm/partners/import?isOverwrite=true", "required":true, "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object", "properties":{ "file":{ "type":"string", "description":"Previously exported trading partner file.", "format":"binary" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ImportTPRs" } } } }, "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-projects-{projectId}-tpm-partners-import-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-import-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve a Trading Partner", "description":"Retrieves a trading partner with the specified trading partner ID in project context.", "operationId":"getTradingPartnerInProject", "parameters":[ { "name":"tpId", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TradingPartnerRs" } } } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-get" }, "put":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Update a Trading Partner", "description":"Updates a trading partner with the specified trading partner ID in project context.", "operationId":"updateTPNameDescInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "tradingPartnerRs":{ "$ref":"#/components/schemas/TradingPartnerRs" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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-projects-{projectId}-tpm-partners-{tpId}-put", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-put" }, "delete":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Delete a Trading Partner", "description":"Deletes a trading partner with the specified trading partner ID in project context.", "operationId":"deleteTradingPartnerInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TradingPartnerRs" } } } }, "404":{ "description":"Not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-delete", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-delete" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/contacts":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve Trading Partner Contact Details", "description":"Retrieves trading partner contact details with the specified trading partner ID in project context.", "operationId":"getContactsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/contacts", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ContactsRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-contacts-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-contacts-get" }, "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Create or Update Trading Partner Contacts", "description":"Adds a new contact or update an existing contact details with the specified trading partner ID in project context.", "operationId":"saveContactsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "contactUI":{ "$ref":"#/components/schemas/ContactsRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ContactsRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-contacts-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-contacts-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/controlNumbers":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve Control Numbers of a Trading Partner", "description":"Gets the control numbers of a trading partner in project context.", "operationId":"getControlNumbersInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ControlNumbers" } } } }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-controlNumbers-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-controlnumbers-get" }, "put":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Set Control Numbers for a Trading Partner", "description":"Sets the control numbers for a trading partner in project context.", "operationId":"setControlNumbersInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ControlNumbers" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-controlNumbers-put", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-controlnumbers-put" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/errorGroups":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve Transports", "description":"Retrieves all the available errorGroupss with the specified trading partner ID in project context.", "operationId":"getErrorGroupsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/errorGroups", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorGroupsRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-errorGroups-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-errorgroups-get" }, "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Create or Update errorGroups for Trading Partner", "description":"Add a new or update existing errorGroup with the specified trading partner ID in project context.", "operationId":"saveErrorGroupInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "errorGroupRs":{ "$ref":"#/components/schemas/ErrorGroupRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorGroupRs" } } } }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-errorGroups-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-errorgroups-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/errorGroups/{errorGroupId}":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve an ErrorGroup", "description":"Retrieves an ErrorGroup with the specified trading partner ID and ErrorGroup ID in project context.", "operationId":"getErrorGroupInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"errorGroupId", "in":"path", "description":"
Trading partner errorGroups ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/errorGroup/ERRORGROUP1604824600539", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorGroupRs" } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-errorGroups-{errorGroupId}-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-errorgroups-errorgroupid-get" }, "put":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Update errorGroups for Trading Partner", "description":"Add a new or update existing errorGroup with the specified trading partner ID in project context.", "operationId":"updateErrorGroupInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"errorGroupId", "in":"path", "description":"ErrorGroup ID. e.g. /b2b/v1/tpm/partners/TP123/transports/ERRORGROUP1604824600539", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "errorGroupRs":{ "$ref":"#/components/schemas/ErrorGroupRs" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ErrorGroupRs" } } } }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-errorGroups-{errorGroupId}-put", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-errorgroups-errorgroupid-put" }, "delete":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Delete an ErrorGroup", "description":"Deletes a ErrorGroup with the specified trading partner ID and ErrorGroup ID in that project context. Ensure that the ErrorGroup you want to delete is not in use by any in/outbound agreement. You may want to remove any reference it has before deleting.", "operationId":"deleteErrorGroupInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"errorGroupId", "in":"path", "description":"
Trading partner ErrorGroup ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/errorGroups/ERRORGROUP1604824600539", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-errorGroups-{errorGroupId}-delete", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-errorgroups-errorgroupid-delete" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/errorGroups/{errorGroupId}/usage":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve an ErrorGroup Usage", "description":"Retrieves an ErrorGroup usage with the specified trading partner ID and ErrorGroup ID in project context.", "operationId":"getErrorGroupUsageInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"errorGroupId", "in":"path", "description":"
Trading partner errorGroups ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/errorGroup/ERRORGROUP1604824600539", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"object", "additionalProperties":true } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-errorGroups-{errorGroupId}-usage-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-errorgroups-errorgroupid-usage-get" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/export":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Export a Trading Partner", "description":"Exports a trading partner with the associated agreements, documents, schemas and host identifiers as a zipped file in project context.", "operationId":"exportTradingPartnerInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP1/export", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/octet-stream":{ "schema":{ "type":"string", "format":"binary" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-export-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-export-get" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/identifiers":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve B2B Identifiers", "description":"Retrieves all available B2B identifiers with the specified trading partner ID in project context.", "operationId":"getIdentifiersInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/identifiers", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IdentifiersRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-identifiers-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-identifiers-get" }, "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Create or Update B2B Identifiers", "description":"Add a new or update existing B2B identifier with the specified trading partner ID in project context.", "operationId":"saveIdentifiersInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "identifierUI":{ "$ref":"#/components/schemas/IdentifiersRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IdentifiersRs" } } } }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-identifiers-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-identifiers-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/identifiers/{identifierId}":{ "delete":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Delete a B2B Identifier", "description":"Deletes a B2B identifier only when there are no associations with agreements and transports in project context.", "operationId":"deleteTPIdentifierInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"identifierId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/identifiers/1990020336714597", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ResponseStatus" } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-identifiers-{identifierId}-delete", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-identifiers-identifierid-delete" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve Inbound Agreements", "description":"Retrieves all inbound agreements with the specified trading partner ID in project context.", "operationId":"getInboundAgreementsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InboundAgrsRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-inboundagrs-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-inboundagrs-get" }, "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Create an Inbound Agreement", "description":"Creates an inbound agreement for trading partner in project context. The request body must contain atleast name and docId fields.", "operationId":"createInboundAgreementInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "inboundAgrUI":{ "$ref":"#/components/schemas/InboundAgrRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InboundAgrRs" } } } }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-inboundagrs-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-inboundagrs-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs/{agrId}":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve an Inbound Agreement", "description":"Retrieves an inbound agreement with the specified trading partner ID and inbound agreement ID in project context.", "operationId":"getInboundAgreementInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"
Trading partner inbound agreement ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/inboundagrs/INAGR1604824600539", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InboundAgrRs" } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-inboundagrs-{agrId}-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-inboundagrs-agrid-get" }, "put":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Update an Inbound Agreement", "description":"Updates an inbound agreement with the specified trading partner ID and inbound agreement ID in project context.", "operationId":"updateInboundAgreementInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"Inbound agreement ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "inboundAgrUI":{ "$ref":"#/components/schemas/InboundAgrRs" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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-projects-{projectId}-tpm-partners-{tpId}-inboundagrs-{agrId}-put", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-inboundagrs-agrid-put" }, "delete":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Delete an Inbound Agreement", "description":"Deletes an inbound agreement with the specified trading partner ID and inbound agreement ID in project context.", "operationId":"deleteInboundAgreementInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"Trading partner inbound agreement ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InboundAgrRs" } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-inboundagrs-{agrId}-delete", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-inboundagrs-agrid-delete" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs/{agrId}/deploy":{ "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Deploy an Inbound Agreement", "description":"Deploys an inbound agreement with active backend integration and B2B document linked to it in project context. The deployed agreements translates and processes messages.", "operationId":"deployInboundAgreementsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"Inbound agreement ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/inboundagrs/INAGR12333344/deploy", "required":true, "schema":{ "type":"string" } }, { "name":"isProceedWithWarnings", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeployUndeployRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-inboundagrs-{agrId}-deploy-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-inboundagrs-agrid-deploy-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/inboundagrs/{agrId}/undeploy":{ "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Undeploy an Inbound Agreement", "description":"Undeploys an inbound agreement to disallow acceptance of new messages by the agreement in project context. However, all in-flight messages are processed successfully.", "operationId":"unDeployInboundAgreementsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"Inbound agreement ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/inboundagrs/INAGR12333344/undeploy", "required":true, "schema":{ "type":"string" } }, { "name":"isProceedWithWarnings", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeployUndeployRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-inboundagrs-{agrId}-undeploy-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-inboundagrs-agrid-undeploy-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/outboundagrs":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve Outbound Agreements", "description":"Retrieves all available outbound agreements with the specified trading partner ID in project context.", "operationId":"getOutboundAgreementsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/outboundagrs", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutboundAgrsRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-outboundagrs-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-outboundagrs-get" }, "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Create an Outbound Agreement", "description":"Creates an outbound agreement with the specified trading partner ID in project context. The request body must contain at least the name and docId fields.", "operationId":"createOutboundAgreementInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "outboundAgrUI":{ "$ref":"#/components/schemas/OutboundAgrRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutboundAgrRs" } } } }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-outboundagrs-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-outboundagrs-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/outboundagrs/{agrId}":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve an Outbound Agreement", "description":"Retrieves an outbound agreement with the specified trading partner ID and agreement ID in project context.", "operationId":"getOutboundAgreementInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"
Trading partner outbound agreement ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/outboundagrs/OUTAGR1604824600539", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutboundAgrRs" } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-outboundagrs-{agrId}-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-outboundagrs-agrid-get" }, "put":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Update an Outbound Agreement", "description":"Updates an outbound agreement with the specified trading partner ID and agreement ID in project context.", "operationId":"updateOutboundAgreementInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"Trading partner outbound agreement ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "outboundAgrUI":{ "$ref":"#/components/schemas/OutboundAgrRs" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutboundAgrRs" } } } }, "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-projects-{projectId}-tpm-partners-{tpId}-outboundagrs-{agrId}-put", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-outboundagrs-agrid-put" }, "delete":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Delete an Outbound Agreement", "description":"Deletes an outbound agreement with the specified trading partner ID and outbound agreement ID in project context.", "operationId":"deleteOutboundAgreementInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"Trading partner outbound agreement ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutboundAgrRs" } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-outboundagrs-{agrId}-delete", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-outboundagrs-agrid-delete" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/outboundagrs/{agrId}/deploy":{ "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Deploy an Outbound Agreement", "description":"Deploys an outbound agreement in project context. The deployed agreements translates and processes messages.", "operationId":"deployOutboundAgreementsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"Outbound agreement ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/outboundagrs/OUTAGR12333344/deploy", "required":true, "schema":{ "type":"string" } }, { "name":"isProceedWithWarnings", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeployUndeployRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-outboundagrs-{agrId}-deploy-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-outboundagrs-agrid-deploy-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/outboundagrs/{agrId}/undeploy":{ "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Undeploy an Outbound Agreement", "description":"Undeploys an outbound agreement to disallow acceptance of new messages by the agreement in project context. However, all in-flight messages are processed successfully.", "operationId":"unDeployOutboundAgreementsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/outboundagrs/OUTAGR12333344/undeploy", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"
Outbound agreement ID.
\n", "required":true, "schema":{ "type":"string" } }, { "name":"isProceedWithWarnings", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DeployUndeployRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-outboundagrs-{agrId}-undeploy-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-outboundagrs-agrid-undeploy-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/transports":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve Transports", "description":"Retrieves all the available transports with the specified trading partner ID in project context.", "operationId":"getTransportsInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/transports", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportsRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-transports-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-transports-get" }, "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Create a Transport", "description":"Creates a transport with the specified trading partner ID in project context. The request body must contain at least the name, transportType, connectionId, integrationNamePrefix, and integrationIdentifierPrefix fields.", "operationId":"createTransportInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "transportRs":{ "$ref":"#/components/schemas/TransportRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-transports-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-transports-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/transports/{transportId}":{ "get":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Retrieve a Transport", "description":"Retrieves a Transport with the specified trading partner ID and transport ID in project context.", "operationId":"getTransportInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transportId", "in":"path", "description":"
Trading partner transport ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/transports/TRANSPORT1604824600539", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-transports-{transportId}-get", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-transports-transportid-get" }, "put":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Update a Transport", "description":"Updates a transport with the specified trading partner ID and transport ID in project context.", "operationId":"updateTransportInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transportId", "in":"path", "description":"
Trading partner transport ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/transports/TRANSPORT1604824600539", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "transportRs":{ "$ref":"#/components/schemas/TransportRs" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "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-projects-{projectId}-tpm-partners-{tpId}-transports-{transportId}-put", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-transports-transportid-put" }, "delete":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Delete a Transport", "description":"Deletes a Transport with the specified trading partner ID and transport ID in project context. Ensure that the transport you want to delete is not in use by any outbound agreement. You may want to remove any reference it has before deleting.", "operationId":"deleteTransportInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transportId", "in":"path", "description":"
Trading partner transport ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/transports/TRANSPORT1604824600539", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-transports-{transportId}-delete", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-transports-transportid-delete" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/transports/{transportId}/deploy":{ "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Deploy a Transport", "description":"Deploys a transport in project context. The deployed transport helps to generate messages.", "operationId":"deployTransportInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transportId", "in":"path", "description":"
Trading partner transport ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/transports/TRANSPORT1604824600539/deploy", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-transports-{transportId}-deploy-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-transports-transportid-deploy-post" } }, "/ic/api/b2b/v1/projects/{projectId}/tpm/partners/{tpId}/transports/{transportId}/undeploy":{ "post":{ "tags":[ "B2B/Projects/Trading Partners" ], "summary":"Undeploy a Transport", "description":"Undeploys a transport to disallow acceptance of new messages in project context. However, all in-flight messages are processed successfully.", "operationId":"undeployTransportInProject", "parameters":[ { "name":"projectId", "in":"path", "description":"Project identifier", "required":true, "schema":{ "type":"string" } }, { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transportId", "in":"path", "description":"
Trading partner transport ID.
\n\n\tExample: \n
\n/b2b/v1/projects/PROJECTID/tpm/partners/TP123/transports/TRANSPORT1604824600539/undeploy", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-projects-{projectId}-tpm-partners-{tpId}-transports-{transportId}-undeploy-post", "x-filename-id":"ic-api-b2b-v1-projects-projectid-tpm-partners-tpid-transports-transportid-undeploy-post" } }, "/ic/api/b2b/v1/monitoring/wiremessages":{ "get":{ "tags":[ "B2B/Monitoring" ], "summary":"Retrieve Wire Messages", "description":"
Retrieves a list of wire messages with information like message type, state, direction, protocol and trading partner. Wire messages represent the technical exchange of messages between the host company and trading partners. These messages can be encrypted and signed AS2.
\n\n\tNote: \n
Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results.
", "operationId":"wireMessages", "parameters":[ { "name":"q", "in":"query", "description":"Filter parameters.
\n\n\t
\n\tExample: \n
\n{startdate:'2020-07-09 07:00:00', enddate:'2020-07-09 21:25:00', id:'0AC415941776251CB5E0000026D27C45', direction:'INBOUND', messagetype:'WIRE'} ",
"required":false,
"schema":{
"type":"string"
}
},
{
"name":"offset",
"in":"query",
"description":"Use with the offset parameter for paginating through the returned results. Default value is 0. This limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list wire messages starting at the 4th item, and the list will contain 16 items.",
"required":false,
"schema":{
"type":"integer",
"format":"int32"
}
},
{
"name":"limit",
"in":"query",
"description":"Use 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 wire messages starting at the 4th item, and the list will contain 16 items.",
"required":false,
"schema":{
"type":"integer",
"format":"int32"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/WireMessagesRs"
}
}
}
},
"400":{
"description":"Malformed parameters"
},
"412":{
"description":"Pre-condition failed"
},
"500":{
"description":"Server error"
}
},
"x-internal-id":"ic-api-b2b-v1-monitoring-wiremessages-get",
"x-filename-id":"ic-api-b2b-v1-monitoring-wiremessages-get"
}
},
"/ic/api/b2b/v1/monitoring/wiremessages/{id}":{
"get":{
"tags":[
"B2B/Monitoring"
],
"summary":"Retrieve Wire Message Details",
"description":"Retrieves detailed information about the wire message with the specified identifier. Retrieves information such as message type, state, direction, protocol and properties.
\n\n\tNote: \n
Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results.
", "operationId":"wireMessage", "parameters":[ { "name":"id", "in":"path", "description":"Wire message identifier.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/WireMessageRs" } } } }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Wire message not found" }, "412":{ "description":"Pre-condition failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-monitoring-wiremessages-{id}-get", "x-filename-id":"ic-api-b2b-v1-monitoring-wiremessages-id-get" } }, "/ic/api/b2b/v1/monitoring/wiremessages/{id}/payload/download":{ "get":{ "tags":[ "B2B/Monitoring" ], "summary":"Download B2B Wire Message Payload", "description":"Retrieves the payload file for a given message identifier.
\n\n\tNote: \n
Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results.
", "operationId":"downloadPayload", "parameters":[ { "name":"id", "in":"path", "description":"Message identifier.", "required":true, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Message payload type. Valid values are packed and unpacked.", "required":false, "schema":{ "type":"string", "nullable":true, "default":"packed" } }, { "name":"payloadId", "in":"query", "description":"Payload identifier", "required":false, "schema":{ "type":"string", "nullable":true } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/octet-stream":{ "schema":{ "$ref":"#/components/schemas/Object" } } } }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Payload not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-monitoring-wiremessages-{id}-payload-download-get", "x-filename-id":"ic-api-b2b-v1-monitoring-wiremessages-id-payload-download-get" } }, "/ic/api/b2b/v1/monitoring/wiremessages/{id}/payload":{ "get":{ "tags":[ "B2B/Monitoring" ], "summary":"Retrieve the Wire Message Payload", "description":"Retrieves the payload file of the specified message identifier. The maximum size that this API function retrieves is 500 KB.
\n\n\tNote: \n
Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results.
", "operationId":"viewPayload", "parameters":[ { "name":"id", "in":"path", "required":true, "schema":{ "type":"string" } }, { "name":"payloadId", "in":"query", "required":false, "schema":{ "type":"string", "nullable":true } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/PayloadRs" } } } }, "404":{ "description":"Payload not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-monitoring-wiremessages-{id}-payload-get", "x-filename-id":"ic-api-b2b-v1-monitoring-wiremessages-id-payload-get" } }, "/ic/api/b2b/v1/monitoring/businessmessages":{ "get":{ "tags":[ "B2B/Monitoring" ], "summary":"Retrieve Business Messages", "description":"Retrieves a list of business messages with information such as message type, state, direction and trading partner. Business messages represent individual documents or business transactions such as a purchase order.
\n\n\tNote: \n
Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results.
", "operationId":"businessMessages", "parameters":[ { "name":"q", "in":"query", "description":"Filter parameter.
\n\n\t
\n\tExample: \n
\n{startdate:'2020-07-09 07:00:00', enddate:'2020-07-09 21:25:00', id:'0AC415941776251CB5E0000026D27C45', direction:'INBOUND', messagetype:'FA'} ",
"required":false,
"schema":{
"type":"string"
}
},
{
"name":"offset",
"in":"query",
"description":"Use with the offset parameter for paginating through the returned results. Default value is 0. The limit is the maximum number of items to return at one time. For example, offset=3&limit=16 indicates to list business messages starting at the 4th item, and the list will contain 16 items.",
"required":false,
"schema":{
"type":"integer",
"format":"int32"
}
},
{
"name":"limit",
"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 business messages starting at the 4th item, and the list will contain 16 items.",
"required":false,
"schema":{
"type":"integer",
"format":"int32"
}
}
],
"responses":{
"200":{
"description":"Successful operation",
"content":{
"application/json":{
"schema":{
"$ref":"#/components/schemas/BusinessMessagesRs"
}
}
}
},
"400":{
"description":"Malformed parameters"
},
"412":{
"description":"Pre condition failed"
},
"500":{
"description":"Server error"
}
},
"x-internal-id":"ic-api-b2b-v1-monitoring-businessmessages-get",
"x-filename-id":"ic-api-b2b-v1-monitoring-businessmessages-get"
}
},
"/ic/api/b2b/v1/monitoring/businessmessages/{id}":{
"get":{
"tags":[
"B2B/Monitoring"
],
"summary":"Retrieve Business Message Details",
"description":"Retrieves detailed information about the business message with the specified identifier. Retrieves information such as message type, state, direction and properties.
\n\n\tNote: \n
Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results.
", "operationId":"businessMessage", "parameters":[ { "name":"id", "in":"path", "description":"Business message identifier.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/BusinessMessageRs" } } } }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Business message not found" }, "412":{ "description":"Pre-condition failed" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-monitoring-businessmessages-{id}-get", "x-filename-id":"ic-api-b2b-v1-monitoring-businessmessages-id-get" } }, "/ic/api/b2b/v1/monitoring/businessmessages/{id}/payload":{ "get":{ "tags":[ "B2B/Monitoring" ], "summary":"View Business Message Payload", "description":"Displays the business message payload up to a maximum size of 500 KB. To view the complete content, use the Download B2B Business Message Payload API function to download the complete payload, and then view it.
\n\n\tNote: \n
Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results.
", "operationId":"viewBusinessPayload", "parameters":[ { "name":"id", "in":"path", "description":"Business message payload ID.", "required":true, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Business message payload type.", "required":false, "schema":{ "type":"string", "nullable":true, "default":"native" } }, { "name":"payloadId", "in":"query", "description":"Payload ID.", "required":false, "schema":{ "type":"string", "nullable":true } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json;charset=utf-8":{ "schema":{ "$ref":"#/components/schemas/PayloadRs" } } } }, "404":{ "description":"Payload not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-monitoring-businessmessages-{id}-payload-get", "x-filename-id":"ic-api-b2b-v1-monitoring-businessmessages-id-payload-get" } }, "/ic/api/b2b/v1/monitoring/businessmessages/{id}/payload/download":{ "get":{ "tags":[ "B2B/Monitoring" ], "summary":"Download B2B Business Message Payload", "description":"Downloads the payload file of the B2B business message using the message identifier.
\n\n\tNote: \n
Tracking information is asynchronously persisted to improve system throughput, and hence B2B Monitoring APIs may intermittently return inconsistent results. If a business use case demands consistent monitoring results, the user can implement a software design that uses a retry mechanism till the API returns consistent results.
", "operationId":"downloadBusinessPayload", "parameters":[ { "name":"id", "in":"path", "description":"Message identifier.", "required":true, "schema":{ "type":"string" } }, { "name":"type", "in":"query", "description":"Message payload type.", "required":false, "schema":{ "type":"string", "nullable":true, "default":"native" } }, { "name":"payloadId", "in":"query", "description":"Payload identifier.", "required":false, "schema":{ "type":"string", "nullable":true } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/octet-stream":{ "schema":{ "$ref":"#/components/schemas/Object" } } } }, "400":{ "description":"Malformed parameters" }, "404":{ "description":"Payload not found" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-monitoring-businessmessages-{id}-payload-download-get", "x-filename-id":"ic-api-b2b-v1-monitoring-businessmessages-id-payload-download-get" } }, "/ic/api/b2b/v1/schemas":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve B2B Schemas", "description":"Retrieves all the available B2B schemas.", "operationId":"getSchemas", "parameters":[ ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/SchemasUI" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-schemas-get", "x-filename-id":"ic-api-b2b-v1-schemas-get" }, "post":{ "tags":[ "B2B/Document Customization" ], "summary":"Create a B2B Schema", "description":"Creates a B2B schema with the specified ID, name, description, standard, txId and version. Examples of standard values are X12 and EDIFACT. Examples of version for EDIFACT are D00A and D00B. Examples for X12 are 4010 and 4011. Examples of txId (or transaction type) for EDIFACT are APERAK and AUTHOR, and the examples for X12 are 100, 850, etc.", "operationId":"createSchema", "parameters":[ ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "schemaUi":{ "$ref":"#/components/schemas/SchemaUI" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } }, "400":{ "description":"Bad request, malformed parameters or missing required data" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre-condition failure. Ensure that the length of name does not exceed 50 characters, length of identifier does not exceed 32 characters, length of description does not exceed 1024 characters, length of identifier does not exceed 32 characters, Name and Identifier is not named as 'Standard' or 'Default', and there must be a valid combination of std, version and txId." }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-schemas-post", "x-filename-id":"ic-api-b2b-v1-schemas-post" } }, "/ic/api/b2b/v1/schemas/{schemaId}/{elementId}/codes":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve an Element's Code List", "description":"Retrieves the code list of an element using the element ID.", "operationId":"getCodes", "parameters":[ { "name":"schemaId", "in":"path", "description":"B2B schema ID.", "required":true, "schema":{ "type":"string" } }, { "name":"standardId", "in":"query", "description":"Document standard ID.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"versionId", "in":"query", "description":"Document version ID.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"transactionId", "in":"query", "description":"Document transaction ID.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"elementId", "in":"path", "description":"Element ID.
\n\n\tExample: \n
\n/b2b/v1/schemas/SCH2/92/codes", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/CodeUI" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-schemas-{schemaId}-{elementId}-codes-get", "x-filename-id":"ic-api-b2b-v1-schemas-schemaid-elementid-codes-get" } }, "/ic/api/b2b/v1/schemas/{schemaId}":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve a B2B Schema", "description":"Retrieves detailed information about the B2B Schema with the specified ID.", "operationId":"getSchema", "parameters":[ { "name":"schemaId", "in":"path", "description":"B2B schema ID.", "required":true, "schema":{ "type":"string" } }, { "name":"standard", "in":"query", "description":"Document standard.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"version", "in":"query", "description":"Document version.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"transactionId", "in":"query", "description":"
Document transaction ID.
\n\n\tExample: \n
\n/b2b/v1/schemas/SCH2", "required":true, "schema":{ "type":"string", "nullable":true } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-schemas-{schemaId}-get", "x-filename-id":"ic-api-b2b-v1-schemas-schemaid-get" }, "put":{ "tags":[ "B2B/Document Customization" ], "summary":"Update a B2B Schema", "description":"Updates a B2B schema with the specified schema ID. Before you modify a schema used by an active agreement, deactivate it.", "operationId":"updateSchema", "parameters":[ { "name":"schemaId", "in":"path", "description":"
B2B schema ID.
\n\n\tExample: \n
\n/b2b/v1/schemas/SCH123", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "schemaUi":{ "$ref":"#/components/schemas/SchemaUI" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } }, "400":{ "description":"Bad request, malformed parameters" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-schemas-{schemaId}-put", "x-filename-id":"ic-api-b2b-v1-schemas-schemaid-put" }, "delete":{ "tags":[ "B2B/Document Customization" ], "summary":"Delete a B2B Schema", "description":"Deletes the B2B Schema with the specified ID. Ensure that the B2B schema that you want to delete is not in use by any B2B document. Before deleting the B2B schema, remove any references to it.", "operationId":"deleteSchema", "parameters":[ { "name":"schemaId", "in":"path", "description":"
Delete B2B schema.
\n\nExample: \n
\n/b2b/v1/b2bdocuments/SCH123", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } }, "400":{ "description":"Bad request" }, "409":{ "description":"Not allowed, schema in use" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-schemas-{schemaId}-delete", "x-filename-id":"ic-api-b2b-v1-schemas-schemaid-delete" } }, "/ic/api/b2b/v1/schemas/{schemaId}/clone":{ "post":{ "tags":[ "B2B/Document Customization" ], "summary":"Clone a B2B Schema", "description":"Creates a copy of a B2B schema with identical metadata. The request body must contain at least the name and identifier fields.", "operationId":"cloneSchema", "parameters":[ { "name":"schemaId", "in":"path", "description":"
B2B schema ID.
\n\n\tExample: \n
\n/b2b/v1/schemas/SCH123/clone", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "schemaUi":{ "$ref":"#/components/schemas/SchemaUI" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } }, "400":{ "description":"Bad request, malformed parameters or missing required data" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-schemas-{schemaId}-clone-post", "x-filename-id":"ic-api-b2b-v1-schemas-schemaid-clone-post" } }, "/ic/api/b2b/v1/schemas/{schemaId}/documents":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve Documents for a B2B Schema", "description":"Retrieves documents associated with the B2B schema.", "operationId":"getLinkedDocuments", "parameters":[ { "name":"schemaId", "in":"path", "description":"
Schema ID.
\n\n\tExample: \n
\n/b2b/v1/schemas/SCH123/documents", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Object" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-schemas-{schemaId}-documents-get", "x-filename-id":"ic-api-b2b-v1-schemas-schemaid-documents-get" } }, "/ic/api/b2b/v1/schemas/{schemaId}/guide":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Generate a Schema Implementation Guide", "description":"Generates implementation guide for the schema.", "operationId":"generateEDIGuideline", "parameters":[ { "name":"schemaId", "in":"path", "description":"B2B schema ID.", "required":true, "schema":{ "type":"string" } }, { "name":"format", "in":"query", "description":"document format.", "required":true, "schema":{ "type":"string", "default":"html" } }, { "name":"standardId", "in":"query", "description":"Document standard ID.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"versionId", "in":"query", "description":"Document version ID.", "required":true, "schema":{ "type":"string", "nullable":true } }, { "name":"transactionId", "in":"query", "description":"
Document transaction ID.
\n\n\tExample: \n
\n/b2b/v1/schemas/STANDARD/guide?format=html&standardId=X12&versionId=4010&transactionId=100", "required":true, "schema":{ "type":"string", "nullable":true } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "text/plain":{ "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-schemas-{schemaId}-guide-get", "x-filename-id":"ic-api-b2b-v1-schemas-schemaid-guide-get" } }, "/ic/api/b2b/v1/b2bdocuments":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve B2B Documents", "description":"Retrieves available B2B documents.", "operationId":"getDocuments", "parameters":[ ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DocumentsUI" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-b2bdocuments-get", "x-filename-id":"ic-api-b2b-v1-b2bdocuments-get" }, "post":{ "tags":[ "B2B/Document Customization" ], "summary":"Create a B2B Document", "description":"Creates a B2B document with the specified ID, name description, standard, txId and version. Examples of standard values are X12, EDIFACT. Examples of version for EDIFACT are D00A, D00B, etc. Examples for X12 are 4010 and 4011. Examples of txId (or transaction type) for EDIFACT are APERAK, AUTHOR, and examples for X12 are 100, 850, etc.", "operationId":"createDocument", "parameters":[ ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DocumentUI" } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DocumentUI" } } } }, "400":{ "description":"Bad request, malformed parameters or missing required data" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre-condition failure. Ensure that the length of name does not exceed 50 characters, length of identifier does not exceed 32 characters, length of decsription does not exceed 1024 characters, and the length of identifier does not exceed 32 characters. Ensure that name and identifier are not named as Standard or Default. Ensure that there is a valid combination of std, version and txId." }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-b2bdocuments-post", "x-filename-id":"ic-api-b2b-v1-b2bdocuments-post" } }, "/ic/api/b2b/v1/b2bdocuments/{documentId}":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve a B2B Document", "description":"Retrieves detailed information about the B2B Document with the specified ID.", "operationId":"getDocument", "parameters":[ { "name":"documentId", "in":"path", "description":"
B2B document ID.
\n\n Example: \n
\n/b2b/v1/b2bdocuments/DOC123", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DocumentUI" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-b2bdocuments-{documentId}-get", "x-filename-id":"ic-api-b2b-v1-b2bdocuments-documentid-get" }, "put":{ "tags":[ "B2B/Document Customization" ], "summary":"Update a B2B Document", "description":"Updates a B2B Document with the specified document ID. To modify a document used by an active agreement, you need to deactivate it first.", "operationId":"updateDocument", "parameters":[ { "name":"documentId", "in":"path", "description":"
B2B document ID.
\n\n Example: \n
\n/b2b/v1/b2bdocuments/DOC123", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "documentUi":{ "$ref":"#/components/schemas/DocumentUI" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DocumentUI" } } } }, "400":{ "description":"Bad request, malformed parameters or missing required data" }, "412":{ "description":"Pre-condition failure. Ensure that the length of name does not exceed 50 characters, length of identifier does not exceed 32 characters, length of decsription does not exceed 1024 characters, and the length of identifier does not exceed 32 characters. Ensure that name and identifier are not named as Standard or Default. Ensure that there is a valid combination of std, version and txId." }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-b2bdocuments-{documentId}-put", "x-filename-id":"ic-api-b2b-v1-b2bdocuments-documentid-put" }, "delete":{ "tags":[ "B2B/Document Customization" ], "summary":"Delete a B2B Document", "description":"Deletes the B2B Document with the specified ID. Ensure that the B2B Document you want to delete is not in use by any integration or trading partner. Before deleting it, remove any references to the document.", "operationId":"deleteDocument", "parameters":[ { "name":"documentID", "in":"path", "description":"B2B document ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad request" }, "409":{ "description":"Not allowed, document in use" }, "500":{ "description":"Server Error" } }, "x-internal-id":"ic-api-b2b-v1-b2bdocuments-{documentId}-delete", "x-filename-id":"ic-api-b2b-v1-b2bdocuments-documentid-delete" } }, "/ic/api/b2b/v1/b2bdocuments/{documentId}/clone":{ "post":{ "tags":[ "B2B/Document Customization" ], "summary":"Clone a B2B Document", "description":"Creates a copy of a B2B document with identical metadata. The request body must contain at least the name and identifier fields.", "operationId":"cloneDocument", "parameters":[ { "name":"documentId", "in":"path", "description":"
B2B document ID.
\n\n Example: \n
\n/b2b/v1/b2bdocuments/DOC123/clone", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "documentUi":{ "$ref":"#/components/schemas/DocumentUI" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation" }, "400":{ "description":"Bad request, malformed parameters or missing required data" }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-b2bdocuments-{documentId}-clone-post", "x-filename-id":"ic-api-b2b-v1-b2bdocuments-documentid-clone-post" } }, "/ic/api/b2b/v1/b2bdocuments/{documentId}/integrations":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve Integrations Using a B2B Document", "description":"Retrieves available integrations that are using the specified B2B Document.", "operationId":"getLinkedIntegrations", "parameters":[ { "name":"documentId", "in":"path", "description":"
Integrations associated with b2b document.
\n\n Example: \n
\n/b2b/v1/b2bdocuments/DOC123/integrations", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-b2bdocuments-{documentId}-integrations-get", "x-filename-id":"ic-api-b2b-v1-b2bdocuments-documentid-integrations-get" } }, "/ic/api/b2b/v1/b2bdocuments/{documentId}/partners":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve Trading Partners using a B2B Document", "description":"Retrieves the available trading partners that are using the specified B2B Document.", "operationId":"getLinkedPartners", "parameters":[ { "name":"documentId", "in":"path", "description":"
Trading partners using the B2B document.
\n\n Example: \n
\n/b2b/v1/b2bdocuments/DOC123/partners", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "type":"string" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-b2bdocuments-{documentId}-partners-get", "x-filename-id":"ic-api-b2b-v1-b2bdocuments-documentid-partners-get" } }, "/ic/api/b2b/v1/standards":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve B2B Document Standards", "description":"Retrieves the available document standards supported by B2B.", "operationId":"getDocumentStandards", "parameters":[ ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Object" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-standards-get", "x-filename-id":"ic-api-b2b-v1-standards-get" } }, "/ic/api/b2b/v1/standards/{standardId}":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve Document Versions", "description":"Retrieves available document versions with the specified document standard.", "operationId":"getDocumentVersion", "parameters":[ { "name":"standardId", "in":"path", "description":"
Standard ID.
\n\n\tExample: \n
\n/b2b/v1/standards/X12", "required":true, "schema":{ "type":"string" } }, { "name":"isDocumentSearch", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Object" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-standards-{standardId}-get", "x-filename-id":"ic-api-b2b-v1-standards-standardid-get" } }, "/ic/api/b2b/v1/standards/{standardId}/{versionId}":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve Document Transactions", "description":"Retrieves available document transactions with the specified document standard and version.", "operationId":"getAllDocuments", "parameters":[ { "name":"standardId", "in":"path", "description":"Standard ID.", "required":true, "schema":{ "type":"string" } }, { "name":"versionId", "in":"path", "description":"
Version ID.
\n\n\tExample: \n
\n/b2b/v1/standards/X12/4010", "required":true, "schema":{ "type":"string" } }, { "name":"isDocumentSearch", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/DocumentTypeUI" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-standards-{standardId}-{versionId}-get", "x-filename-id":"ic-api-b2b-v1-standards-standardid-versionid-get" } }, "/ic/api/b2b/v1/standards/{standardId}/{versionId}/{transactionId}":{ "get":{ "tags":[ "B2B/Document Customization" ], "summary":"Retrieve B2B Document Types", "description":"Retrieve all B2B document types.", "operationId":"getTxSpecificDocument", "parameters":[ { "name":"standardId", "in":"path", "description":"B2B document standard ID.", "required":true, "schema":{ "type":"string" } }, { "name":"versionId", "in":"path", "description":"Document version ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transactionId", "in":"path", "description":"Document transaction ID.", "required":true, "schema":{ "type":"string" } }, { "name":"isDocument", "in":"query", "description":"
isDocument Flag
\n\n Example: \n
\n/b2b/v1/standards/X12/4010/100?isDocument=true", "required":true, "schema":{ "type":"boolean", "default":true } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Object" } } } }, "400":{ "description":"Bad request" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-standards-{standardId}-{versionId}-{transactionId}-get", "x-filename-id":"ic-api-b2b-v1-standards-standardid-versionid-transactionid-get" } }, "/ic/api/b2b/v1/tpm/partners":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve Trading Partners", "description":"Retrieve all available trading partners.", "operationId":"getTradingPartnerList", "parameters":[ ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TradingPartnerRs" } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TradingPartnerRs" } } } }, "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/{tpId}":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve a Trading Partner", "description":"Retrieves a trading partner with the specified trading partner ID.", "operationId":"getTradingPartner", "parameters":[ { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "tradingPartnerRs":{ "$ref":"#/components/schemas/TradingPartnerRs" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123/contacts", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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":"Adda a new contact or update an existing contact details with the specified trading partner ID.", "operationId":"saveContacts", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "contactUI":{ "$ref":"#/components/schemas/ContactsRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ContactsRs" } } } }, "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}/inboundagrs":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve Inbound Agreements", "description":"Retrieves all inbound agreements with the specified trading partner id.", "operationId":"getInboundAgreements", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InboundAgrsRs" } } } }, "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 the trading partner. The request body must contain at least the name and docId fields.", "operationId":"createInboundAgreement", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "inboundAgrUI":{ "$ref":"#/components/schemas/InboundAgrRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/InboundAgrRs" } } } }, "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", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "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, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"Inbound agreement ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "inboundAgrUI":{ "$ref":"#/components/schemas/InboundAgrRs" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"Trading partner inbound agreement ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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}/outboundagrs":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve Outbound Agreements", "description":"Retrieves all available outbound agreements with the specified trading partner ID.", "operationId":"getOutboundAgreements", "parameters":[ { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123/outboundagrs", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutboundAgrsRs" } } } }, "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 at least the name and docId fields.", "operationId":"createOutboundAgreement", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "outboundAgrUI":{ "$ref":"#/components/schemas/OutboundAgrRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutboundAgrRs" } } } }, "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", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "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, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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 agreement ID.", "operationId":"updateOutboundAgreement", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"Trading partner outbound agreement ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "outboundAgrUI":{ "$ref":"#/components/schemas/OutboundAgrRs" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/OutboundAgrRs" } } } }, "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", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"Trading partner outbound agreement ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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/host":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve the Host Profile", "description":"Retrieves the host company name and host Identifiers.", "operationId":"getHostProfile", "parameters":[ ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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", "parameters":[ ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "identifierUI":{ "$ref":"#/components/schemas/HostIdentifiersRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/HostIdentifiersRs" } } } }, "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 associations with agreements and transports.", "operationId":"deleteHostIdentifier", "parameters":[ { "name":"id", "in":"path", "description":"
Host identifier ID.
\n\n Example: \n
\n/b2b/v1/tpm/host/11678035855650825", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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/{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", "parameters":[ { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n", "required":true, "schema":{ "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, "schema":{ "type":"string" } }, { "name":"isProceedWithWarnings", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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 are processed successfully.", "operationId":"unDeployInboundAgreements", "parameters":[ { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n", "required":true, "schema":{ "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, "schema":{ "type":"string" } }, { "name":"isProceedWithWarnings", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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/{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", "parameters":[ { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n", "required":true, "schema":{ "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, "schema":{ "type":"string" } }, { "name":"isProceedWithWarnings", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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 are processed successfully.", "operationId":"unDeployOutboundAgreements", "parameters":[ { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123/outboundagrs/OUTAGR12333344/undeploy", "required":true, "schema":{ "type":"string" } }, { "name":"agrId", "in":"path", "description":"
Outbound agreement ID.
\n", "required":true, "schema":{ "type":"string" } }, { "name":"isProceedWithWarnings", "in":"query", "required":true, "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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/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", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123/identifiers", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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 a new or update existing B2B identifier with the specified trading partner ID.", "operationId":"saveIdentifiers", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "identifierUI":{ "$ref":"#/components/schemas/IdentifiersRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/IdentifiersRs" } } } }, "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 associations with agreements and transports.", "operationId":"deleteTPIdentifier", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"identifierId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123/identifiers/1990020336714597", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/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}/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", "parameters":[ { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP1/export", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/octet-stream":{ "schema":{ "$ref":"#/components/schemas/InputStream" } } } }, "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/import":{ "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Import a Trading Partner", "description":"Imports a trading partner with the associated agreements, documents, schemas, and host identifiers from the previously exported trading partner zip file.", "operationId":"importTradingPartner", "parameters":[ { "name":"isOverwrite", "in":"query", "description":"
Overwrite flag to overwrite components in the zip file. Default value is false.
\n\n\tExample: \n
\nic/api/b2b/v1/tpm/partners/import?isOverwrite=true", "required":true, "schema":{ "type":"boolean", "default":false } } ], "requestBody":{ "content":{ "multipart/form-data":{ "schema":{ "type":"object" } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ImportTPRs" } } } }, "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}/transports":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve Transports", "description":"Retrieves all the available transports with the specified trading partner ID.", "operationId":"getTransports", "parameters":[ { "name":"tpId", "in":"path", "description":"
Trading partner ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123/transports", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportsRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-transports-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-transports-get" }, "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Create a Transport", "description":"Creates a transport with the specified trading partner ID. The request body must contain at least the name, transportType, connectionId, integrationNamePrefix, and integrationIdentifierPrefix fields.", "operationId":"createTransport", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "transportRs":{ "$ref":"#/components/schemas/TransportRs" } } } } }, "required":true }, "responses":{ "201":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "409":{ "description":"Duplicate data error" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-transports-post", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-transports-post" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/transports/{transportId}":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve a Transport", "description":"Retrieves a Transport with the specified trading partner ID and transport ID.", "operationId":"getTransport", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transportId", "in":"path", "description":"
Trading partner transport ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123/transports/TRANSPORT1604824600539", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-transports-{transportId}-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-transports-transportid-get" }, "put":{ "tags":[ "B2B/Trading Partner" ], "summary":"Update a Transport", "description":"Updates a transport with the specified trading partner ID and transport ID.", "operationId":"updateTransport", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transportId", "in":"path", "description":"
Trading partner transport ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123/transports/TRANSPORT1604824600539", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object", "properties":{ "transportRs":{ "$ref":"#/components/schemas/TransportRs" } } } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "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}-transports-{transportId}-put", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-transports-transportid-put" }, "delete":{ "tags":[ "B2B/Trading Partner" ], "summary":"Delete a Transport", "description":"Deletes a Transport with the specified trading partner ID and transport ID. Ensure that the transport you want to delete is not in use by any outbound agreement. Remove any references it has before deleting.", "operationId":"deleteTransport", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transportId", "in":"path", "description":"
Trading partner transport ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123/transports/TRANSPORT1604824600539", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "404":{ "description":"Not found" }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-transports-{transportId}-delete", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-transports-transportid-delete" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/transports/{transportId}/deploy":{ "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Deploy a Transport", "description":"Deploys a transport. The deployed transport helps to generate messages.", "operationId":"deployTransport", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transportId", "in":"path", "description":"
Trading partner transport ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123/transports/TRANSPORT1604824600539/deploy", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-transports-{transportId}-deploy-post", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-transports-transportid-deploy-post" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/transports/{transportId}/undeploy":{ "post":{ "tags":[ "B2B/Trading Partner" ], "summary":"Undeploy a Transport", "description":"Undeploys a transport to disallow acceptance of new messages. However, all in-flight messages are processed successfully.", "operationId":"undeployTransport", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } }, { "name":"transportId", "in":"path", "description":"
Trading partner transport ID.
\n\n\tExample: \n
\n/b2b/v1/tpm/partners/TP123/transports/TRANSPORT1604824600539/undeploy", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "type":"object" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/TransportRs" } } } }, "412":{ "description":"Pre-condition failure" }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-transports-{transportId}-undeploy-post", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-transports-transportid-undeploy-post" } }, "/ic/api/b2b/v1/tpm/partners/{tpId}/controlNumbers":{ "get":{ "tags":[ "B2B/Trading Partner" ], "summary":"Retrieve Control Numbers of a Trading Partner", "description":"Gets the control numbers of a trading partner.", "operationId":"getControlNumbers", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ControlNumbers" } } } }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-controlNumbers-get", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-controlnumbers-get" }, "put":{ "tags":[ "B2B/Trading Partner" ], "summary":"Set Control Numbers for a Trading Partner", "description":"Sets the control numbers for a trading partner.", "operationId":"setControlNumbers", "parameters":[ { "name":"tpId", "in":"path", "description":"Trading partner ID.", "required":true, "schema":{ "type":"string" } } ], "requestBody":{ "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/ControlNumbers" } } }, "required":true }, "responses":{ "200":{ "description":"Successful operation", "content":{ "application/json":{ "schema":{ "$ref":"#/components/schemas/Object" } } } }, "500":{ "description":"Server error" } }, "x-internal-id":"ic-api-b2b-v1-tpm-partners-{tpId}-controlNumbers-put", "x-filename-id":"ic-api-b2b-v1-tpm-partners-tpid-controlnumbers-put" } } }, "components":{ "securitySchemes":{ "oauth2":{ "type":"oauth2", "flows":{ "authorizationCode":{ "authorizationUrl":"https://idcs-78cbeca57ade40fb804f71678fe75ab0.identity.oraclecloud.com/oauth2/v1/authorize", "tokenUrl":"{{oauth-access-token-url}}", "scopes":{ "{{oauth-scope}}":"{{oauth-scope}}" } } } } }, "schemas":{ "API":{ "type":"object", "properties":{ "classification":{ "$ref":"#/components/schemas/APIClassification" }, "multiple-classification":{ "type":"array", "items":{ "$ref":"#/components/schemas/APIClassification" } }, "inputs":{ "type":"array", "items":{ "$ref":"#/components/schemas/APIParam" } }, "outputs":{ "type":"array", "items":{ "$ref":"#/components/schemas/APIParam" } }, "kids":{ "type":"array", "items":{ "$ref":"#/components/schemas/INode" } }, "func-name":{ "type":"string" }, "api-id":{ "type":"string" }, "library-name":{ "type":"string" }, "library-version":{ "type":"string" }, "library-code":{ "type":"string" }, "file-name":{ "type":"string" }, "name":{ "type":"string" }, "type":{ "type":"string" }, "classified":{ "type":"boolean" }, "orchestration-classified":{ "type":"boolean" }, "xpath-classified":{ "type":"boolean" }, "input-completed":{ "type":"boolean" }, "output-completed":{ "type":"boolean" }, "configured":{ "type":"boolean" }, "annotation-set":{ "type":"boolean" }, "func-annotation":{ "type":"string" }, "parent":{ "$ref":"#/components/schemas/API" }, "status":{ "type":"string" }, "duplicate-fn-flag":{ "type":"boolean" }, "unsupported-syntax":{ "type":"boolean" }, "unsupported-syntax-type":{ "type":"string" } } }, "APIClassification":{ "type":"string", "enum":[ "ADAPTER", "ORCHESTRATION", "XPATH" ] }, "APILibrary":{ "type":"object", "properties":{ "name":{ "type":"string" }, "automation-id":{ "type":"string" }, "description":{ "type":"string" }, "code":{ "type":"string" }, "version":{ "type":"string" }, "impl-type":{ "$ref":"#/components/schemas/APILibraryType" }, "search-by-name":{ "type":"string" }, "functions-size":{ "type":"integer", "format":"int32" }, "selected-file":{ "$ref":"#/components/schemas/APILibraryFile" }, "filter-by-config-type":{ "type":"string" }, "kids":{ "type":"array", "items":{ "$ref":"#/components/schemas/INode" } }, "files":{ "type":"array", "items":{ "$ref":"#/components/schemas/APILibraryFile" } }, "impl-files":{ "type":"array", "items":{ "type":"string", "format":"binary" } }, "type":{ "type":"string" }, "all-apis":{ "type":"array", "items":{ "$ref":"#/components/schemas/API" } } } }, "APILibraryFile":{ "type":"object", "properties":{ "api-id-list":{ "type":"array", "items":{ "type":"string" } }, "function-list":{ "type":"array", "items":{ "type":"string" } }, "last-func":{ "$ref":"#/components/schemas/API" }, "functions":{ "type":"array", "items":{ "$ref":"#/components/schemas/API" } }, "file-name":{ "type":"string" }, "path":{ "type":"string" }, "search-by-name":{ "type":"string" }, "selected-function":{ "$ref":"#/components/schemas/API" }, "function-configured":{ "type":"boolean" }, "selected-file-name":{ "type":"string" }, "filter-by-config-type":{ "type":"string" }, "duplicate-functions-checked":{ "type":"boolean" }, "kids":{ "type":"array", "items":{ "$ref":"#/components/schemas/INode" } }, "current-func":{ "type":"string" }, "library-name":{ "type":"string" }, "library-version":{ "type":"string" }, "library-code":{ "type":"string" }, "name":{ "type":"string" }, "type":{ "type":"string" }, "api-count":{ "type":"integer", "format":"int32" } } }, "APILibraryType":{ "type":"string", "enum":[ "JAVASCRIPT", "JAVA" ] }, "APIParam":{ "type":"object", "properties":{ "name":{ "type":"string" }, "type":{ "type":"string" }, "desc":{ "type":"string" }, "described":{ "type":"string" }, "icon":{ "type":"string" } } }, "AccessControlledRs":{ "type":"object", "properties":{ "updated-by":{ "type":"string", "description":"Updated By" }, "created-by":{ "type":"string", "description":"Created By" }, "created-date":{ "type":"string", "description":"Created Date", "format":"date-time" }, "updated-date":{ "type":"string", "description":"Updated Date", "format":"date-time" }, "administrators":{ "description":"Administrators List", "$ref":"#/components/schemas/AclRoleRs" }, "editors":{ "description":"Editors List", "$ref":"#/components/schemas/AclRoleRs" }, "viewers":{ "description":"Viewers List", "$ref":"#/components/schemas/AclRoleRs" }, "monitors":{ "description":"Monitors List", "$ref":"#/components/schemas/AclRoleRs" } } }, "AclRoleItem":{ "required":[ "display-name", "id", "type" ], "type":"object", "properties":{ "display-name":{ "type":"string", "description":"User/Group Display Name" }, "id":{ "type":"string", "description":"User/Group Identifier" }, "type":{ "type":"string", "description":"Type - User/Group" }, "id-not-found":{ "type":"boolean", "description":"User/Group Id Not Found Flag" } } }, "AclRoleRs":{ "required":[ "allow-all", "allowed" ], "type":"object", "properties":{ "allow-all":{ "type":"boolean", "description":"Allow All Flag" }, "allowed":{ "type":"array", "description":"Allowed List", "items":{ "$ref":"#/components/schemas/AclRoleItem" } } } }, "ActivityRs":{ "type":"object", "properties":{ "id":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/SuiteLink" } }, "location":{ "$ref":"#/components/schemas/ActivityRs.Location" }, "blueprint-type":{ "$ref":"#/components/schemas/OrchestrationTypeEnum" } } }, "ActivityRs.Location":{ "type":"object", "properties":{ "rpi":{ "$ref":"#/components/schemas/RelativePositionIndicator" }, "anchor-element-id":{ "type":"string" } } }, "ActivityStreamLoggerRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "logWhenTraceEnabled":{ "type":"boolean" }, "logMessage":{ "$ref":"#/components/schemas/ExpressionBuilderRs" } } } ] }, "AdapterIconsRs":{ "type":"object", "properties":{ "small-icon-url":{ "type":"string" }, "medium-icon-url":{ "type":"string" }, "large-icon-url":{ "type":"string" }, "medium-gray-icon-url":{ "type":"string" }, "medium-white-icon-url":{ "type":"string" } } }, "AdapterIntegrationRole":{ "type":"string", "enum":[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ] }, "AdapterKey":{ "type":"object", "properties":{ "display-name":{ "type":"string" }, "key-name":{ "type":"string" }, "scope":{ "$ref":"#/components/schemas/AdapterIntegrationRole" } } }, "AdapterPropertyGroup":{ "type":"string", "enum":[ "CREDENTIALS", "SOURCE_ARTIFACTS", "CONNECTION_PROPS", "CUSTOM", "OTHER" ] }, "AdapterPropertyType":{ "type":"string", "enum":[ "STRING", "NUMBER", "URL", "WSDL_URL", "XSD_URL", "WADL_URL", "FILE", "PASSWORD", "URL_OR_FILE", "LIST", "MAP", "TEXT", "CHOICE", "BOOLEAN", "ARTIFACT_URL", "LIST_OF_MAPS", "CONCRETE_WSDL" ] }, "AdapterTypeBaseRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "displayName":{ "type":"string" }, "type":{ "type":"string" } } } ] }, "AdapterTypeRs":{ "allOf":[ { "$ref":"#/components/schemas/AdapterTypeBaseRs" }, { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "otherVersions":{ "type":"string" }, "customSecurityPolicyDescription":{ "type":"string" }, "oAuth3LeggedSupport":{ "type":"array", "items":{ "$ref":"#/components/schemas/SecurityPolicy" } }, "genericAuthSupport":{ "type":"array", "items":{ "$ref":"#/components/schemas/SecurityPolicy" } }, "testKey":{ "type":"string" }, "validateAndTestKey":{ "type":"string" }, "testMessage":{ "type":"string" }, "validateAndTestMessage":{ "type":"string" }, "infoMessage":{ "type":"string" }, "wsdlvalidation":{ "type":"boolean" }, "vendorInfo":{ "$ref":"#/components/schemas/AdapterVendorInfo" }, "supportedSecurityPolicies":{ "type":"string" }, "features":{ "type":"string" }, "version":{ "type":"string" }, "description":{ "type":"string" }, "integrationRole":{ "$ref":"#/components/schemas/AdapterIntegrationRole" }, "defaultSecurityPolicies":{ "type":"string" }, "icons":{ "$ref":"#/components/schemas/AdapterIconsRs" } } } ] }, "AdapterVendorInfo":{ "type":"object", "properties":{ "support-url":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "contact-us":{ "type":"string" }, "documentation-url":{ "type":"string" }, "release-notes":{ "type":"string" } } }, "AdaptersRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/AdapterTypeRs" } }, "totalResults":{ "type":"integer", "format":"int32" } } } ] }, "AgentEnvironmentRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "agentInstallerMajorVersionNumber":{ "type":"string" }, "agentInstallerMinorVersionNumber":{ "type":"string" }, "editionPurchased":{ "type":"string" }, "connectionsPurchased":{ "type":"string" } } } ] }, "AgentGroupMonitoringRs":{ "type":"object", "properties":{ "version":{ "type":"string", "description":"Version" }, "name":{ "type":"string", "description":"Name" }, "description":{ "type":"string", "description":"Description" }, "created-date":{ "type":"string", "description":"Created Date", "format":"date-time" }, "created-by":{ "type":"string", "description":"Created By" }, "last-updated-date":{ "type":"string", "description":"Last Updated Date", "format":"date-time" }, "last-updated-by":{ "type":"string", "description":"Last Updated By" }, "type":{ "$ref":"#/components/schemas/AgentType" }, "status":{ "$ref":"#/components/schemas/AgentGroupStatus" }, "display-status":{ "type":"string", "description":"Display Status" }, "agents":{ "type":"array", "description":"List of Agents", "items":{ "$ref":"#/components/schemas/AgentMonitoringRs" } } } }, "AgentGroupStatus":{ "type":"string", "enum":[ "AVAILABLE", "UNAVAILABLE", "PARTIALLY_AVAILABLE" ] }, "AgentGroupTypeBaseRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "displayName":{ "type":"string" }, "type":{ "type":"string" } } } ] }, "AgentGroupTypeRs":{ "allOf":[ { "$ref":"#/components/schemas/AgentGroupTypeBaseRs" }, { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "agentsCount":{ "type":"integer", "format":"int32" }, "description":{ "type":"string" }, "lastUpdated":{ "type":"string", "format":"date-time" }, "lastUpdatedBy":{ "type":"string" }, "created":{ "type":"string", "format":"date-time" }, "createdBy":{ "type":"string" }, "agents":{ "type":"array", "items":{ "$ref":"#/components/schemas/AgentTypeBaseRs" } }, "lockedFlag":{ "type":"boolean" }, "lockedBy":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" } } } ] }, "AgentGroupsMonitoringRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Agent Group", "items":{ "$ref":"#/components/schemas/AgentGroupMonitoringRs" } }, "total-results":{ "type":"integer", "description":"Total Results", "format":"int32" }, "limit":{ "type":"integer", "description":"Limit", "format":"int32" }, "has-more":{ "type":"boolean", "description":"Has More" } } }, "AgentGroupsRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/AgentGroupTypeRs" } }, "totalResults":{ "type":"integer", "format":"int32" } } } ] }, "AgentMetricsRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "metrics":{ "type":"object", "additionalProperties":{ "type":"string" } } } } ] }, "AgentMonitoringRs":{ "type":"object", "properties":{ "version":{ "type":"string", "description":"Version" }, "name":{ "type":"string", "description":"Name" }, "description":{ "type":"string", "description":"Description" }, "created-date":{ "type":"string", "description":"Created Date", "format":"date-time" }, "created-by":{ "type":"string", "description":"Created By" }, "last-updated-date":{ "type":"string", "description":"Last Updated Date", "format":"date-time" }, "last-updated-by":{ "type":"string", "description":"Last Updated By" }, "last-locked-date":{ "type":"string", "description":"Last Locked Date", "format":"date-time" }, "last-locked-by":{ "type":"string", "description":"Last Locked By" }, "agent-group-code":{ "type":"string", "description":"Agent Group Code" }, "type":{ "$ref":"#/components/schemas/AgentType" }, "status":{ "$ref":"#/components/schemas/AgentStatus" }, "display-status":{ "type":"string", "description":"Display Status" } } }, "AgentStatus":{ "type":"string", "enum":[ "REGISTERED", "ACTIVE", "UNAVAILABLE" ] }, "AgentType":{ "type":"string", "enum":[ "ADAPTER_AGENT", "EXECUTION_AGENT" ] }, "AgentTypeBaseRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "required":[ "agentGroupCode" ], "type":"object", "properties":{ "name":{ "type":"string" }, "displayName":{ "type":"string" }, "type":{ "type":"string" }, "agentGroupCode":{ "type":"string" } } } ] }, "AgentsMonitoringRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Agent", "items":{ "$ref":"#/components/schemas/AgentMonitoringRs" } }, "total-results":{ "type":"integer", "description":"Total Results", "format":"int32" }, "limit":{ "type":"integer", "description":"Limit", "format":"int32" }, "has-more":{ "type":"boolean", "description":"Has More" }, "agent-group-code":{ "type":"string", "description":"Agent Group code" } } }, "AgentsRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "required":[ "agentGroupCode" ], "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/AgentTypeBaseRs" } }, "totalResults":{ "type":"integer", "format":"int32" }, "agentGroupCode":{ "type":"string" } } } ] }, "AIAgentsRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Agents", "items":{ "$ref":"#/components/schemas/AIAgentListRs" } }, "totalResults":{ "type":"integer", "format":"int32", "description":"Total Results" }, "hasMore":{ "type":"boolean", "description":"Flag to Check if More Records Exists" }, "limit":{ "type":"integer", "format":"int32", "description":"Limit of Records to be Displayed" } } } ] }, "AIAgentRs":{ "allOf":[ { "$ref":"#/components/schemas/AIAgentListRs" }, { "type":"object", "properties":{ "description":{ "type":"string", "description":"Description" }, "guidelines":{ "type":"string", "description":"AI Guidelines" }, "role":{ "type":"string", "description":"Agent role" }, "dependencies":{ "$ref":"#/components/schemas/AIAgentResourceDependencyRs", "description":"Associated resources" }, "endpointURI":{ "type":"string", "description":"Endpoint URI used to invoke agent" } } } ] }, "AIAgentListRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"AI Agent name" }, "code":{ "type":"string", "description":"AI Agent code" }, "version":{ "type":"string", "description":"AI Agent version" }, "status":{ "type":"string", "description":"AI Agent Status" }, "description":{ "type":"string", "description":"AI Agent description" }, "projectId":{ "type":"string", "description":"Project id which agent is part of" }, "created":{ "type":"string", "format":"date-time", "description":"Created" }, "createdBy":{ "type":"string", "description":"Created By" }, "lastUpdatedBy":{ "type":"string", "description":"Last Updated By" }, "lastUpdated":{ "type":"string", "format":"date-time", "description":"Last Updated" } } } ] }, "AIAgentResourceDependencyRs":{ "type":"object", "properties":{ "thinkingPattern":{ "$ref":"#/components/schemas/PatternDependencyRs" }, "tools":{ "type":"array", "items":{ "$ref":"#/components/schemas/ToolDependencyRs" } }, "templates":{ "type":"array", "items":{ "$ref":"#/components/schemas/TemplateDependencyRs" } } } }, "AlertRequest":{ "type":"object", "properties":{ "alert-name":{ "type":"string" }, "from-address":{ "type":"string" }, "to-addresses":{ "type":"string" } } }, "AnalyzeCustomActionRespRs":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/SuiteLink" } }, "action-analysis":{ "type":"array", "items":{ "$ref":"#/components/schemas/AnalyzeCustomActionRespRs.ActionCount" } } } }, "AnalyzeCustomActionRespRs.ActionCount":{ "type":"object", "properties":{ "name":{ "type":"string" }, "count":{ "type":"string" }, "adapter":{ "type":"string" } } }, "Assets":{ "type":"object", "properties":{ "integrations":{ "$ref":"#/components/schemas/IntegrationsRs" }, "connections":{ "$ref":"#/components/schemas/ConnectionsRs" }, "lookups":{ "$ref":"#/components/schemas/LookupRs" }, "libraries":{ "$ref":"#/components/schemas/LibraryRs" }, "certificates":{ "$ref":"#/components/schemas/CertificatesRs" }, "labels-rs":{ "$ref":"#/components/schemas/LabelsRs" } } }, "AssignmentRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "typeDef":{ "type":"string" }, "operation":{ "type":"string" }, "expression":{ "$ref":"#/components/schemas/ExpressionBuilderRs" }, "xslUri":{ "type":"string" }, "stateInfoUri":{ "type":"string" }, "targetRootElementUserFriendlyName":{ "$ref":"#/components/schemas/JMRootElementUserFriendlyDetailsRs" }, "sourceRootElementUserFriendlyNames":{ "type":"array", "items":{ "$ref":"#/components/schemas/JMSourceRootElemUFDetailsRs" } } } } ] }, "AuxTrackingVariableRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "groupName":{ "type":"string" }, "auxTrackingVarExp":{ "$ref":"#/components/schemas/ExpressionBuilderRs" } } } ] }, "AuxTrackingVariablesRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "auxTrackingVariables":{ "type":"array", "items":{ "$ref":"#/components/schemas/AuxTrackingVariableRs" } } } } ] }, "BaseAttachmentRs":{ "type":"object", "properties":{ "property-name":{ "type":"string" }, "attachment-name":{ "type":"string" }, "content":{ "type":"string" }, "local-file-path":{ "type":"string" }, "signature":{ "type":"string" } } }, "BulkScheduleRs":{ "type":"object", "properties":{ "integration-id":{ "type":"string" }, "run-as-user":{ "type":"string" } } }, "CalloutFunctionRs":{ "type":"object", "properties":{ "library-name":{ "type":"string" }, "library-version":{ "type":"string" }, "function-api-id":{ "type":"string" }, "function-name":{ "type":"string" }, "function-file-name":{ "type":"string" }, "input-params":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExpressionBuilderRs" } }, "output-params":{ "type":"array", "items":{ "$ref":"#/components/schemas/ExpressionBuilderRs" } }, "error-messages":{ "type":"array", "items":{ "type":"string" } }, "warning-messages":{ "type":"array", "items":{ "type":"string" } } } }, "CalloutRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "function":{ "$ref":"#/components/schemas/CalloutFunctionRs" } } } ] }, "CatchAllRs":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/ActivityRs" } ] }, "CatchRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "elementName":{ "type":"string" }, "nameSpace":{ "type":"string" }, "connectionCode":{ "type":"string" }, "faultName":{ "type":"string" }, "messageContextURIs":{ "type":"array", "items":{ "type":"string" } } } } ] }, "CertificateRs":{ "allOf":[ { "$ref":"#/components/schemas/IdResource" }, { "$ref":"#/components/schemas/GenericRestResource" }, { "type":"object", "properties":{ "keystore":{ "type":"string", "description":"Keystore" }, "keyStoreDescription":{ "type":"string", "description":"Keystore description" }, "name":{ "type":"string", "description":"Certificate alias name" }, "description":{ "type":"string", "description":"Certificate description" }, "type":{ "type":"string", "description":"Certificate type. Valid values - DIGITALSIGNATURE, PGP, SAML, SIGNKEY & X509" }, "installedType":{ "type":"string", "description":"Certificate installed by. Ex - USER" }, "typeDescription":{ "type":"string", "description":"Certificate type description" }, "keyPasswords":{ "type":"string", "description":"Key password(s). Valid only for type - X509 and category - IDENTITY" }, "keystorePassword":{ "type":"string", "description":"Keystore password. Valid only for type - X509 and category - IDENTITY" }, "passPhrase":{ "type":"string", "description":"Private key password. Valid only for type - PGP & SIGNKEY and category - PRIVATE" }, "asciiArmored":{ "type":"boolean", "description":"ASCII-Armor encryption flag. Valid only for type - PGP and category - PUBLIC" }, "cipherAlgorithm":{ "type":"string", "description":"Cipher algorithm. Valid only for type - PGP and category - PUBLIC" }, "issued":{ "type":"string", "description":"Certificate issued date", "format":"date-time" }, "expires":{ "type":"string", "description":"Certificate expiry date", "format":"date-time" }, "status":{ "type":"string", "description":"Certificate status. Ex. - CONFIGURED or INPROGRESS" }, "createdBy":{ "type":"string", "description":"Certificate created by" }, "created":{ "type":"string", "description":"Certificate created date", "format":"date-time" }, "lastUpdatedBy":{ "type":"string", "description":"Certificate updated by" }, "lastUpdated":{ "type":"string", "description":"Certificate updated date", "format":"date-time" }, "metaData":{ "type":"object", "additionalProperties":{ "type":"string" } }, "hash":{ "type":"string" }, "content":{ "type":"array", "items":{ "type":"string", "format":"byte" } }, "secretOCID":{ "type":"string" } } } ] }, "CertificatesRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Certificates", "items":{ "$ref":"#/components/schemas/CertificateRs" } }, "totalResults":{ "type":"integer", "description":"Total Results", "format":"int32" }, "hasMore":{ "type":"boolean", "description":"Flag to Check if More Records Exists" }, "limit":{ "type":"integer", "description":"Limit of Records to be Displayed", "format":"int32" } } } ] }, "CloudAdapterFilterRs":{ "type":"object", "properties":{ "view-mode":{ "type":"boolean" }, "application-instance-code":{ "type":"string" }, "cloud-adapter-artifacts":{ "$ref":"#/components/schemas/CloudAdapterFilterRs.CloudAdapterArtifactsRs" }, "inbound":{ "type":"boolean" }, "user-name":{ "type":"string" }, "preview-mode":{ "type":"boolean" }, "early-uptake":{ "type":"boolean" }, "is-mvrp-configured":{ "type":"boolean" }, "schemas":{ "type":"array", "items":{ "$ref":"#/components/schemas/CloudAdapterFilterRs.SourceSchemasRs" } }, "custom-ui-objects-map":{ "type":"array", "items":{ "$ref":"#/components/schemas/CloudAdapterFilterRs.ExpressionBuilderObjectRs" } } } }, "CloudAdapterFilterRs.CloudAdapterArtifactsRs":{ "type":"object", "properties":{ "wsdl-operations-map":{ "type":"object", "additionalProperties":{ "type":"array", "items":{ "type":"string" } } }, "jca-byte-array-map":{ "type":"object", "additionalProperties":{ "type":"array", "items":{ "type":"string", "format":"byte" } } }, "wsdl-byte-array-map":{ "type":"object", "additionalProperties":{ "type":"array", "items":{ "type":"string", "format":"byte" } } }, "adapter-plugin-context":{ "type":"string" }, "generated-artifacts":{ "type":"object", "additionalProperties":{ "type":"array", "items":{ "$ref":"#/components/schemas/CloudAdapterFilterRs.CloudAdapterArtifactsRs.CloudAdapterArtifactRs" } } }, "reference-name":{ "type":"string" }, "description":{ "type":"string" }, "csf-key-store-name":{ "type":"string" } } }, "CloudAdapterFilterRs.CloudAdapterArtifactsRs.CloudAdapterArtifactRs":{ "type":"object", "properties":{ "proxy-artifact":{ "type":"boolean" }, "url":{ "type":"string", "format":"url" }, "key-name":{ "type":"string" }, "internal-ref-name":{ "type":"string" }, "bytes":{ "type":"array", "items":{ "type":"string", "format":"byte" } }, "operation-name":{ "type":"string" }, "operation-description":{ "type":"string" }, "change-log":{ "type":"string" }, "resource-url":{ "type":"string" }, "verb":{ "type":"string" } } }, "CloudAdapterFilterRs.ExpressionBuilderObjectRs":{ "type":"object", "properties":{ "id":{ "type":"string" }, "place-holder-text":{ "type":"string" }, "expression":{ "type":"string" }, "user-friendly-xpath":{ "type":"string" }, "namespace-pairs":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "CloudAdapterFilterRs.SourceSchemasRs":{ "type":"object", "properties":{ "param-name":{ "type":"string" }, "root-element":{ "type":"string" }, "data-type":{ "type":"string" }, "uri":{ "type":"string" }, "namespace-uri":{ "type":"string" } } }, "CommonSearchRequest":{ "type":"object", "properties":{ "id":{ "type":"string" }, "timewindow":{ "type":"string" }, "start-date":{ "type":"string" }, "end-date":{ "type":"string" }, "offset":{ "type":"integer", "format":"int32" }, "limit":{ "type":"integer", "format":"int32" }, "code":{ "type":"string" }, "version":{ "type":"string" }, "primary-value":{ "type":"string" }, "secondary-value":{ "type":"string" }, "tertiary-value":{ "type":"string" } } }, "ConnectionAttachmentRs":{ "type":"object", "properties":{ "attachment":{ "$ref":"#/components/schemas/BaseAttachmentRs" }, "property-name":{ "type":"string" }, "attachment-name":{ "type":"string" }, "signature":{ "type":"string" } } }, "ConnectionBaseRs":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/IdResource" }, { "$ref":"#/components/schemas/GenericRestResource" } ] }, "ConnectionErrorRs":{ "allOf":[ { "$ref":"#/components/schemas/ConnectionBaseRs" }, { "$ref":"#/components/schemas/IdResource" }, { "$ref":"#/components/schemas/GenericRestResource" }, { "type":"object", "properties":{ "displayName":{ "type":"string" }, "majorVersion":{ "type":"string" }, "appTypeDisplayName":{ "type":"string" }, "appTypeName":{ "type":"string" }, "appTypeVersion":{ "type":"string" } } } ] }, "ConnectionPropertyRs":{ "type":"object", "properties":{ "property-description":{ "type":"string" }, "property-short-desc":{ "type":"string" }, "acceptable-keys":{ "type":"array", "items":{ "$ref":"#/components/schemas/AdapterKey" } }, "integration-role":{ "$ref":"#/components/schemas/AdapterIntegrationRole" }, "property-name":{ "type":"string" }, "property-value":{ "type":"string" }, "display-name":{ "type":"string" }, "required-flag":{ "type":"boolean" }, "hidden-flag":{ "type":"boolean" }, "property-type":{ "$ref":"#/components/schemas/AdapterPropertyType" }, "property-group":{ "$ref":"#/components/schemas/AdapterPropertyGroup" }, "attachment":{ "$ref":"#/components/schemas/ConnectionAttachmentRs" }, "has-attachment":{ "type":"boolean" }, "default-property-value":{ "type":"string" } } }, "ConnectionRs":{ "type":"object", "properties":{ "test-status":{ "type":"boolean", "description":"Test Status" }, "wsdl-list-dir":{ "type":"array", "description":"List of WSDL", "items":{ "type":"string" } }, "security-policy-info":{ "type":"array", "description":"List of Security Policies", "items":{ "$ref":"#/components/schemas/SecurityPolicyInfoRs" } }, "metadata-download-supported-flag":{ "type":"boolean", "description":"Metadata Download Supported Flag" }, "metadata-download-state":{ "type":"string", "description":"Metadata Download State" }, "adapter-type":{ "$ref":"#/components/schemas/AdapterTypeBaseRs" }, "status":{ "type":"string", "description":"Connection Status" }, "connection-properties":{ "type":"array", "description":"List of Connection Properties", "items":{ "$ref":"#/components/schemas/ConnectionPropertyRs" } }, "security-properties":{ "type":"array", "description":"List of Security Properties", "items":{ "$ref":"#/components/schemas/ConnectionPropertyRs" } }, "name":{ "type":"string", "description":"Connection Name" }, "percentage-complete":{ "type":"number", "description":"Connection Completion Percentage" }, "security-policy":{ "$ref":"#/components/schemas/SecurityPolicy" }, "last-updated-by":{ "type":"string", "description":"Last Updated By" }, "last-updated":{ "type":"string", "description":"Last Updated", "format":"date-time" }, "agent-group-id":{ "type":"string", "description":"Agent Group Identifier" }, "role":{ "$ref":"#/components/schemas/AdapterIntegrationRole" }, "locked-flag":{ "type":"boolean", "description":"Locked Flag" }, "description":{ "type":"string", "description":"Description" }, "created":{ "type":"string", "description":"Created", "format":"date-time" }, "created-by":{ "type":"string", "description":"Created By" }, "adapter":{ "$ref":"#/components/schemas/AdapterTypeRs" }, "usage":{ "type":"integer", "description":"Usage", "format":"int32" }, "usage-active":{ "type":"integer", "description":"Active Usage", "format":"int32" }, "admin-email":{ "type":"string", "description":"Administrator's Email" }, "agent-supported":{ "type":"boolean", "description":"Agent Supported" }, "agent-required":{ "type":"boolean", "description":"Agent Required" }, "keywords":{ "type":"string", "description":"Keywords" }, "locked-by":{ "type":"string", "description":"Locked By" }, "locked-date":{ "type":"string", "description":"Locked Date", "format":"date-time" }, "last-refreshed-date":{ "type":"string", "description":"Last Refresh Date", "format":"date-time" }, "refreshed-status":{ "type":"string", "description":"Refreshed Status" }, "project-id":{ "type":"string" } } }, "ConnectionUsageRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "status":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/SuiteLink" } } } }, "ConnectionsRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Connections", "items":{ "$ref":"#/components/schemas/ConnectionRs" } }, "links":{ "type":"array", "description":"Suite Link List", "items":{ "$ref":"#/components/schemas/SuiteLink" } }, "total-results":{ "type":"integer", "description":"Total Results", "format":"int32" }, "limit":{ "type":"integer", "description":"Limit of Records to be Displayed", "format":"int32" }, "has-more":{ "type":"boolean", "description":"Flag to Check if More Records Exists" } } }, "CorsDomainsRs":{ "type":"object", "properties":{ "corsDomains":{ "type":"array", "items":{ "type":"string" } } } }, "CustomerTenancyInfo":{ "type":"object", "properties":{ "validated":{ "type":"boolean" }, "system-notification-from-address":{ "type":"string" }, "credentials":{ "$ref":"#/components/schemas/SMTPCredentials" } } }, "DataTypesForActivityCustomActionReqRs":{ "type":"object", "properties":{ "element-id":{ "type":"string" }, "for-insight-flag":{ "type":"boolean" } } }, "DataTypesForLocationCustomActionReqRs":{ "type":"object", "properties":{ "location":{ "$ref":"#/components/schemas/ActivityRs.Location" }, "element-type":{ "type":"string" } } }, "DecisionDeploymentFlow":{ "type":"object", "properties":{ "identifier":{ "type":"string", "description":"Decision Identifier" }, "version":{ "type":"string", "description":"Decision Version" }, "displayName":{ "type":"string", "description":"Decision Name" }, "status":{ "type":"string", "description":"Decision Status" } } }, "EhStopRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" } } } ] }, "EndPointRs":{ "required":[ "name" ], "type":"object", "properties":{ "name":{ "type":"string" }, "connection":{ "$ref":"#/components/schemas/ConnectionBaseRs" }, "role":{ "type":"string" } } }, "ErrorBaseRs":{ "allOf":[ { "$ref":"#/components/schemas/TrackingBaseRs" }, { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "projectCode":{ "type":"string" }, "projectName":{ "type":"string" }, "errorMessage":{ "type":"string" }, "errorDetails":{ "type":"string" }, "instanceId":{ "type":"string" }, "faultId":{ "type":"string" }, "errorCode":{ "type":"string" }, "retryCount":{ "type":"integer", "format":"int32" }, "errorLocation":{ "type":"string" }, "invokedBy":{ "type":"string" }, "endPointName":{ "type":"string" }, "endPointType":{ "type":"string" }, "endPointOperation":{ "type":"string" }, "errorActionName":{ "type":"string" }, "errorActionType":{ "type":"string" }, "milestone":{ "type":"string" }, "integration":{ "$ref":"#/components/schemas/IntegrationBaseRs" }, "connection":{ "$ref":"#/components/schemas/ConnectionErrorRs" }, "opcRequestId":{ "type":"string" }, "isPurged":{ "type":"boolean" }, "instanceReportingLevel":{ "type":"string" } } } ] }, "ErrorBulkDiscardRs":{ "type":"object", "properties":{ "invalid-ids":{ "type":"array", "description":"List of Invalid Ids", "items":{ "type":"string" } }, "accepted-ids":{ "type":"array", "description":"List of Accepted Ids", "items":{ "type":"string" } }, "non-discardable-ids":{ "type":"array", "description":"List of Non Discardable Ids", "items":{ "type":"string" } }, "discard-requested":{ "type":"boolean", "description":"Discard Requested" }, "aborted-instances-count":{ "type":"integer", "description":"Aborted Instance Count", "format":"int64" }, "abort-job-id":{ "type":"string", "description":"Abort Job Id" }, "message":{ "type":"string", "description":"Message" } } }, "ErrorResubmitRs":{ "type":"object", "properties":{ "resubmit-successful":{ "type":"boolean", "description":"Resubmit Successful" }, "redirect-url":{ "type":"string", "description":"RedirectURL" }, "message":{ "type":"string", "description":"Message" }, "resubmitted-failed-instances":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResubmittedFailedInstances" } }, "recovery-job-id":{ "type":"string" } } }, "ErrorRs":{ "allOf":[ { "$ref":"#/components/schemas/ErrorBaseRs" }, { "$ref":"#/components/schemas/TrackingBaseRs" }, { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "recoveryMinTime":{ "type":"string", "format":"date-time" }, "isDataAccurate":{ "type":"boolean" }, "runId":{ "type":"string" }, "recoverable":{ "type":"boolean" }, "integrationDeleted":{ "type":"boolean" } } } ] }, "ErrorSearchRequest":{ "allOf":[ { "$ref":"#/components/schemas/CommonSearchRequest" }, { "type":"object", "properties":{ "groupBy":{ "type":"string" } } } ] }, "ErrorsBulkRequest":{ "type":"object", "properties":{ "ids":{ "type":"array", "items":{ "type":"string" } }, "timewindow":{ "type":"string" }, "flow-code":{ "type":"string" }, "flow-version":{ "type":"string" }, "connection-code":{ "type":"string" }, "start-date":{ "type":"string" }, "end-date":{ "type":"string" }, "recoveryTraceLevel":{ "type":"string" }, "project-code":{ "type":"string" } } }, "ErrorsBulkResubmitRs":{ "type":"object", "properties":{ "resubmitted-failed-instances":{ "type":"array", "items":{ "$ref":"#/components/schemas/ResubmittedFailedInstances" } }, "message":{ "type":"string", "description":"Message" }, "recovery-job-id":{ "type":"string" }, "accepted-ids":{ "type":"array", "description":"List of Accepted Ids", "items":{ "type":"string" } }, "non-recoverable-ids":{ "type":"array", "description":"List of Non Recoverable Ids", "items":{ "type":"string" } }, "invalid-ids":{ "type":"array", "description":"List of Invalid Ids", "items":{ "type":"string" } }, "resubmitted-instances-count":{ "type":"integer", "description":"Resubmitted Instances Count", "format":"int64" }, "resubmit-requested":{ "type":"boolean", "description":"Is Resubmit Requested" } } }, "ErrorsRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Errors", "items":{ "$ref":"#/components/schemas/ErrorRs" } }, "total-results":{ "type":"integer", "description":"Total Results", "format":"int64" }, "time-window":{ "type":"string", "description":"Time Window" }, "data-fetch-time":{ "type":"string", "description":"Date Fetch Time", "format":"date-time" }, "total-records-count":{ "type":"integer", "description":"Total Records Count", "format":"int64" }, "opcRequestId":{ "type":"string", "description":"opc Request Id" }, "instanceReportingLevel":{ "type":"string", "description":"Instance Reporting Level" }, "isPurged":{ "type":"boolean", "description":"Purged Instances" } } }, "EventTypeBaseRs":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Event type name" }, "description":{ "type":"string", "description":"Event type description" }, "created":{ "type":"string", "description":"Event type created date", "format":"date-time" }, "created-by":{ "type":"string", "description":"Event type CreatedBy user name" }, "usage-count":{ "type":"integer", "description":"Number of integrations using the event type. Includes the usage across all revisions of the event type.", "format":"int32" }, "id":{ "type":"string" }, "revision":{ "type":"string", "description":"Event type revision" }, "code":{ "type":"string", "description":"Event type code" } } }, "EventTypeCloneRs":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Event type name" }, "description":{ "type":"string", "description":"Event type description" }, "code":{ "type":"string", "description":"Event type code" } } }, "EventTypeCreateRs":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Event type name" }, "description":{ "type":"string", "description":"Event type description" }, "code":{ "type":"string", "description":"Event type code" }, "schema-type":{ "type":"string", "description":"Type of schema associated with the event type. For example: json" }, "schema":{ "type":"string", "description":"Schema associated with the event type." } } }, "EventTypeUpdateRs":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Event type name" }, "description":{ "type":"string", "description":"Event type description" }, "code":{ "type":"string", "description":"Event type code" }, "schema-type":{ "type":"string", "description":"Type of schema associated with the event type. For example: json" }, "schema":{ "type":"string", "description":"Schema associated with the event type." } } }, "EventTypeRefRs":{ "type":"object", "properties":{ "revision":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" } } }, "EventTypeRs":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Event type name" }, "description":{ "type":"string", "description":"Event type description" }, "created":{ "type":"string", "description":"Event type created date", "format":"date-time" }, "created-by":{ "type":"string", "description":"Event type CreatedBy user name" }, "usage-count":{ "type":"integer", "description":"Number of integrations using the event type. Includes the usage across all revisions of the event type.", "format":"int32" }, "id":{ "type":"string" }, "revision":{ "type":"string", "description":"Event type revision" }, "code":{ "type":"string", "description":"Event type code" }, "schema-type":{ "type":"string", "description":"Type of schema associated with the event type. For example: json" }, "schema":{ "type":"string", "description":"Schema associated with the event type." }, "usage-details":{ "$ref":"#/components/schemas/EventTypeUsageRs" } } }, "EventTypeUsageRs":{ "type":"object", "properties":{ "publishing-integrations":{ "type":"array", "items":{ "$ref":"#/components/schemas/IntegrationUsageRs" } }, "subscribing-integrations":{ "type":"array", "items":{ "$ref":"#/components/schemas/IntegrationUsageRs" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/SuiteLink" } }, "name":{ "type":"string" } } }, "EventTypesRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of event types", "items":{ "$ref":"#/components/schemas/EventTypeBaseRs" } }, "total-results":{ "type":"integer", "description":"Total results", "format":"int32" }, "has-more":{ "type":"boolean", "description":"Flag to check if more records exists" }, "limit":{ "type":"integer", "description":"Limit of records to be displayed", "format":"int32" } } }, "ExpressionBuilderRs":{ "type":"object", "properties":{ "expression-name":{ "type":"string" }, "text-expression":{ "type":"string" }, "xpath-expression":{ "type":"string" }, "namespace-contexts":{ "type":"array", "items":{ "$ref":"#/components/schemas/NamespaceContextRs" } }, "variable-name":{ "type":"string" }, "description":{ "type":"string" }, "variable-type":{ "type":"string" }, "variable-type-namespace":{ "type":"string" }, "number-of-errors":{ "type":"integer", "format":"int32" }, "number-of-warnings":{ "type":"integer", "format":"int32" }, "error-messages":{ "type":"array", "items":{ "type":"string" } }, "warning-messages":{ "type":"array", "items":{ "type":"string" } } } }, "FilmstripRs":{ "required":[ "code", "name", "role" ], "type":"object", "properties":{ "icon-url":{ "type":"string" }, "code":{ "type":"string" }, "name":{ "type":"string" }, "status":{ "type":"string" }, "role":{ "type":"string" } } }, "FlowStatus":{ "type":"string", "enum":[ "IN_PROGRESS", "SCHEDULE_WAITING", "QUEUED", "SCHEDULE_PAUSED", "PAUSED", "FAILED", "COMPLETED", "ABORTED", "UNKNOWN", "RESUBMITTED", "BLOCKED" ] }, "ForRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "parallel":{ "type":"boolean" }, "expression":{ "$ref":"#/components/schemas/ExpressionBuilderRs" }, "parallelAllowedFlag":{ "type":"boolean" } } } ] }, "FutureRunsForIntegrationListRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/FutureRunsForIntegrationTO" } }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/SuiteLink" } } } } ] }, "FutureRunsForIntegrationTO":{ "type":"object", "properties":{ "integration-id":{ "type":"string" }, "schedule-id":{ "type":"string" }, "code":{ "type":"string" }, "version":{ "type":"string" }, "schedule-name":{ "type":"string" }, "future-runs":{ "type":"array", "items":{ "$ref":"#/components/schemas/FutureRunTO" } }, "integration-name":{ "type":"string" }, "project-id":{ "type":"string" } } }, "FutureRunTO":{ "type":"object", "properties":{ "run-type":{ "type":"string" }, "run-time":{ "type":"string" }, "state":{ "type":"string" }, "request-id":{ "type":"integer", "format":"int64" }, "submitter-name":{ "type":"string" }, "run-count":{ "type":"integer", "format":"int32" } } }, "GenericRestResource":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/Link" } }, "processing-time":{ "type":"number", "format":"float" } } }, "GenericRestRs":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/SuiteLink" } } } }, "GitRequest":{ "type":"object", "properties":{ "operation":{ "type":"string" }, "download-url":{ "type":"string" }, "sha-key":{ "type":"string" }, "label":{ "type":"string" } } }, "GitProjectRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "path":{ "type":"string" }, "sha":{ "type":"string" }, "size":{ "type":"integer", "format":"int32" }, "url":{ "type":"string" }, "download_url":{ "type":"string" }, "type":{ "type":"string" }, "id":{ "type":"string" } } }, "GitProjectsRs":{ "type":"object", "properties":{ "total-records-count":{ "type":"integer", "format":"int64" }, "time-window":{ "type":"string" }, "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/GitProjectRs" } } } }, "GlobalTryRs":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/ActivityRs" } ] }, "GlobalVariableRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "dataType":{ "type":"string" }, "nodeName":{ "type":"string" }, "rootNodeName":{ "type":"string" }, "nodeNameSpace":{ "type":"string" }, "inputSourceName":{ "type":"string" }, "nameSpaces":{ "type":"array", "items":{ "$ref":"#/components/schemas/NamespaceContextRs" } }, "xpath":{ "type":"string" }, "numberOfErrors":{ "type":"integer", "format":"int32" }, "numberOfWarnings":{ "type":"integer", "format":"int32" }, "errorMessages":{ "type":"array", "items":{ "type":"string" } }, "warningMessages":{ "type":"array", "items":{ "type":"string" } } } } ] }, "GroupRs":{ "required":[ "display-name", "id", "type" ], "type":"object", "properties":{ "display-name":{ "type":"string" }, "id":{ "type":"string" }, "type":{ "type":"string" } } }, "HistoryItemRs":{ "type":"object", "properties":{ "total-instances-by-updated-time":{ "type":"integer", "description":"Total Instances By UpdatedTime", "format":"int64" }, "audit-instances-count":{ "type":"integer", "description":"Audit Instances Count", "format":"int64" }, "production-instances-count":{ "type":"integer", "description":"Production Instances Count", "format":"int64" }, "debug-instances-count":{ "type":"integer", "description":"Debug Instances Count", "format":"int64" }, "start-time":{ "type":"string", "description":"Start Time" }, "end-time":{ "type":"string", "description":"End Time" }, "total-messages-created":{ "type":"integer", "description":"Total Messages Created", "format":"int64" }, "total-messages-received":{ "type":"integer", "description":"Total Messages Received", "format":"int64" }, "total-messages-processed":{ "type":"integer", "description":"Total Messages Processed", "format":"int64" }, "aborted-messages":{ "type":"integer", "description":"Aborted Messages", "format":"int64" }, "successful-messages":{ "type":"integer", "description":"Successful Messages", "format":"int64" }, "failed-messages":{ "type":"integer", "description":"Failed Messages", "format":"int64" }, "inflight-messages":{ "type":"integer", "description":"Inflight Messages", "format":"int64" }, "success-rate":{ "type":"number", "format":"double" } } }, "HistoryItemsRs":{ "type":"object", "properties":{ "records":{ "type":"array", "description":"List of History Items", "items":{ "$ref":"#/components/schemas/HistoryItemRs" } } } }, "ICalResource":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "icalExpression":{ "type":"string" }, "isValid":{ "type":"boolean" } } } ] }, "INode":{ "type":"object", "properties":{ "name":{ "type":"string" }, "type":{ "type":"string" }, "kids":{ "type":"array", "items":{ "$ref":"#/components/schemas/INode" } } } }, "IdResource":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestResource" }, { "type":"object", "properties":{ "projectId":{ "type":"string" }, "projectName":{ "type":"string" }, "id":{ "type":"string" } } } ] }, "IdRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "id":{ "type":"string" } } } ] }, "InsightModelRs":{ "type":"object", "properties":{ "status":{ "type":"string" }, "error":{ "type":"object", "additionalProperties":true }, "has-errors":{ "type":"boolean" } } }, "InstanceAbortRs":{ "type":"object", "properties":{ "status":{ "$ref":"#/components/schemas/FlowStatus" }, "message":{ "type":"string", "description":"Message" }, "abort-job-id":{ "type":"string", "description":"Abort Job Id" } } }, "InstanceRs":{ "type":"object", "properties":{ "project-code":{ "type":"string", "description":"Project Code" }, "instance-reporting-level":{ "type":"string", "description":"Instance Reporting Level" }, "isPurged":{ "type":"boolean", "description":"Purged instances" }, "integration":{ "type":"string", "description":"Integration" }, "instance-id":{ "type":"string", "description":"Instance Id" }, "invoked-by":{ "type":"string", "description":"Invoked By" }, "integration-id":{ "type":"string", "description":"Integration Id" }, "integration-version":{ "type":"string", "description":"Integration Version" }, "status":{ "$ref":"#/components/schemas/FlowStatus" }, "pk-name":{ "type":"string", "description":"Primary Key name" }, "pk-value":{ "type":"string", "description":"Primary Key Value" }, "date":{ "type":"string", "description":"Date", "format":"date-time" }, "secondary-tracking-name":{ "type":"string", "description":"Secondary Key Name" }, "secondary-tracking-value":{ "type":"string", "description":"Secondary Key Value" }, "has-recoverable-faults":{ "type":"boolean" }, "tertiary-tracking-name":{ "type":"string", "description":"Tertiary Key Name" }, "tertiary-tracking-value":{ "type":"string", "description":"Tertiary Key Value" }, "integration-name":{ "type":"string", "description":"Integration Name" }, "audit-trail":{ "type":"array", "description":"Audit Trails", "items":{ "type":"string" } }, "activity-stream":{ "type":"array", "description":"Activity Streams", "items":{ "type":"string" } }, "trackings":{ "type":"array", "description":"List of Trackings Data", "items":{ "$ref":"#/components/schemas/TrackingDataRs" } }, "run-id":{ "type":"string", "description":"Run Id" }, "creation-date":{ "type":"string", "description":"Creation Date", "format":"date-time" }, "last-tracked-time":{ "type":"string", "description":"Last Tracked Time", "format":"date-time" }, "mep-type":{ "type":"string", "description":"MEP Type" }, "is-data-accurate":{ "type":"boolean", "description":"Data Accuracy" }, "litmus-description":{ "type":"string" }, "litmus-recording-id":{ "type":"string" }, "is-litmus-flow":{ "type":"boolean" }, "is-litmus-supported":{ "type":"boolean" }, "litmus-result-status":{ "type":"string" }, "non-schedule-async":{ "type":"boolean" }, "project-found":{ "type":"boolean", "description":"Project Found" }, "parent-instance-id":{ "type":"string", "description":"Parent Instance Id" }, "request-id":{ "type":"string", "description":"Request Id" }, "flow-milestones":{ "type":"string", "description":"Flow Milestones" }, "invoke-event-ids":{ "type":"string", "description":"Invoke Event Ids" }, "error-milestones":{ "type":"string", "description":"Error Milestones" }, "received-date":{ "type":"string", "description":"Received Date", "format":"date-time" }, "duration":{ "type":"integer", "description":"Duration", "format":"int64" }, "scheduled-time":{ "type":"string", "description":"Scheduled Time", "format":"date-time" }, "processing-end-date":{ "type":"string", "description":"Processing End Date", "format":"date-time" }, "tracing-level":{ "type":"string", "description":"Tracing Level" }, "opc-request-id":{ "type":"string", "description":"opc Request Id" } } }, "InstanceSearchRequest":{ "allOf":[ { "$ref":"#/components/schemas/CommonSearchRequest" }, { "type":"object", "properties":{ "invokedBy":{ "type":"string" }, "status":{ "type":"string" }, "parentInstanceId":{ "type":"string" }, "businessIDValue":{ "type":"string" }, "eventId":{ "type":"string" } } } ] }, "InstancesRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Instance", "items":{ "$ref":"#/components/schemas/InstanceRs" } }, "integration-items":{ "type":"array", "description":"List of Integration Instances", "items":{ "$ref":"#/components/schemas/Object" } }, "total-results":{ "type":"integer", "description":"Total Results", "format":"int64" }, "time-window":{ "type":"string", "description":"Time Window" }, "data-fetch-time":{ "type":"string", "description":"Data Fetch Time", "format":"date-time" }, "total-records-count":{ "type":"integer", "description":"Total Records Count", "format":"int64" }, "limit":{ "type":"integer", "description":"Limit", "format":"int32" }, "has-more":{ "type":"boolean", "description":"Has More" } } }, "IntegrationActivationErrorRs":{ "type":"object", "properties":{ "code":{ "type":"string", "description":"Integration Code" }, "hasErrors":{ "type":"boolean", "description":"Flag to Check if Error Exists" }, "errorMessage":{ "type":"string", "description":"Integration Activation Error Message" }, "version":{ "type":"string", "description":"Integration Version" }, "shortSummaryMessage":{ "type":"string", "description":"Short Summary Message" } } }, "IntegrationActivationStatusRs":{ "type":"object", "properties":{ "activationStatus":{ "type":"string", "description":"Integration Activation Status" } } }, "IntegrationBaseResource":{ "allOf":[ { "$ref":"#/components/schemas/IdResource" }, { "$ref":"#/components/schemas/GenericRestResource" }, { "type":"object", "properties":{ "status":{ "type":"string" }, "version":{ "type":"string" }, "name":{ "type":"string" }, "code":{ "type":"string" }, "dependencies":{ "$ref":"#/components/schemas/IntegrationDependencyRs" }, "lockedFlag":{ "type":"boolean" }, "style":{ "type":"string" }, "styleDescription":{ "type":"string" }, "pattern":{ "type":"string" }, "patternDescription":{ "type":"string" }, "scheduleApplicable":{ "type":"boolean" }, "scheduleDefined":{ "type":"boolean" }, "description":{ "type":"string" }, "endPointURI":{ "type":"string" }, "createdBy":{ "type":"string" }, "created":{ "type":"string", "format":"date-time" }, "lockedBy":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" }, "lastUpdatedBy":{ "type":"string" }, "lastUpdated":{ "type":"string", "format":"date-time" }, "proxyWSDL":{ "type":"string" }, "filmstrip":{ "type":"array", "items":{ "$ref":"#/components/schemas/FilmstripRs" } }, "keywords":{ "type":"string" }, "docUrl":{ "type":"string" }, "smartTags":{ "type":"string" }, "apipId":{ "type":"string" }, "warningMsg":{ "type":"string" }, "publishFlag":{ "type":"boolean" }, "tracingEnabledFlag":{ "type":"boolean" }, "payloadTracingEnabledFlag":{ "type":"boolean" }, "eventSubscriptionFlag":{ "type":"boolean" }, "tempCopyExists":{ "type":"boolean" }, "reactivationStatus":{ "type":"string" } } } ] }, "IntegrationBaseRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "version":{ "type":"string" }, "name":{ "type":"string" }, "projectCode":{ "type":"string" }, "code":{ "type":"string" }, "mepType":{ "type":"string" }, "status":{ "type":"string" } } } ] }, "IntegrationCloneRs":{ "required":[ "code", "name", "version" ], "type":"object", "properties":{ "code":{ "required":[ "true" ], "type":"string", "description":"Integration Code" }, "description":{ "type":"string", "description":"Integration Description" }, "keywords":{ "type":"string", "description":"Keywords" }, "name":{ "required":[ "true" ], "type":"string", "description":"Integration Name" }, "packageName":{ "type":"string", "description":"Integration Description" }, "version":{ "required":[ "true" ], "type":"string", "description":"Integration Version" } } }, "IntegrationDependencyRs":{ "type":"object", "properties":{ "connections":{ "type":"array", "items":{ "$ref":"#/components/schemas/IntegrationDependencyRs.ConnectionDependencyRs" } }, "lookups":{ "type":"array", "items":{ "$ref":"#/components/schemas/IntegrationDependencyRs.LookupDependencyRs" } }, "libraries":{ "type":"array", "items":{ "$ref":"#/components/schemas/IntegrationDependencyRs.LibraryDependencyRs" } }, "certificates":{ "type":"array", "items":{ "$ref":"#/components/schemas/IntegrationDependencyRs.CertificateDependencyRs" } } } }, "IntegrationDependencyRs.CertificateDependencyRs":{ "required":[ "id", "name", "status", "usage" ], "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "usage":{ "type":"integer", "format":"int32" }, "status":{ "type":"string" } } }, "IntegrationDependencyRs.ConnectionDependencyRs":{ "required":[ "id" ], "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "display-name":{ "type":"string" }, "type":{ "type":"string" }, "status":{ "type":"string" }, "role":{ "type":"string" }, "usage":{ "type":"integer", "format":"int32" }, "locked-flag":{ "type":"boolean" }, "locked-by":{ "type":"string" }, "locked-date":{ "type":"string", "format":"date-time" } } }, "IntegrationDependencyRs.LibraryDependencyRs":{ "type":"object", "properties":{ "display-name":{ "type":"string" }, "version":{ "type":"string" }, "description":{ "type":"string" }, "code":{ "type":"string" }, "last-updated-date":{ "type":"string", "format":"date-time" }, "status":{ "type":"string" }, "usage":{ "type":"integer", "format":"int32" }, "locked-flag":{ "type":"boolean" }, "locked-by":{ "type":"string" }, "locked-date":{ "type":"string", "format":"date-time" } } }, "IntegrationDependencyRs.LookupDependencyRs":{ "required":[ "description", "name", "status", "usage" ], "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "usage":{ "type":"integer", "format":"int32" }, "status":{ "type":"string" }, "locked-flag":{ "type":"boolean" }, "locked-by":{ "type":"string" }, "locked-date":{ "type":"string", "format":"date-time" } } }, "IntegrationImportFromRs":{ "type":"object", "properties":{ "project-code":{ "type":"string", "description":"Project Identifier" }, "integrations":{ "type":"array", "description":"Integration Details", "items":{ "$ref":"#/components/schemas/Integration" } } } }, "IntegrationListRs":{ "type":"object", "properties":{ "scope":{ "type":"string" }, "description":{ "type":"string", "description":"Integration Description" }, "created-by":{ "type":"string", "description":"Created By" }, "created":{ "type":"string", "description":"Created Date", "format":"date-time" }, "last-updated-by":{ "type":"string", "description":"Last Updated By" }, "last-updated":{ "type":"string", "description":"Last Updated Date", "format":"date-time" }, "end-point-uri":{ "type":"string", "description":"Integration Endpoint URI" }, "pattern":{ "type":"string", "description":"Pattern" }, "project-type":{ "type":"string", "description":"Project Type" }, "compatible":{ "type":"boolean", "description":"Compatible" }, "package-name":{ "type":"string", "description":"Package Name" }, "locked-flag":{ "type":"boolean", "description":"Locked Flag" }, "style":{ "type":"string", "description":"Style" }, "style-description":{ "type":"string", "description":"Style Description" }, "pattern-description":{ "type":"string", "description":"Pattern Description" }, "tracing-enabled-flag":{ "type":"boolean", "description":"Tracing Enabled Flag" }, "payload-tracing-enabled-flag":{ "type":"boolean", "description":"Payload Tracing Enabled Flag" }, "percentage-complete":{ "type":"number", "description":"Percentage Complete" }, "schedule-applicable-flag":{ "type":"boolean", "description":"Schedule Applicable Flag" }, "schedule-defined-flag":{ "type":"boolean", "description":"Schedule Defined Flag" }, "end-points":{ "type":"array", "description":"Endpoints", "items":{ "$ref":"#/components/schemas/EndPointRs" } }, "filmstrip":{ "type":"array", "description":"Filmstrip", "items":{ "$ref":"#/components/schemas/FilmstripRs" } }, "total-end-points":{ "type":"integer", "format":"int32" }, "record-enabled-flag":{ "type":"boolean", "description":"Record Enabled Flag" }, "tracking-variables":{ "type":"array", "description":"Tracking Variables List", "items":{ "$ref":"#/components/schemas/TrackingVariableTypeRs" } }, "mep-type":{ "type":"string", "description":"MEP Type" }, "locked-by":{ "type":"string", "description":"Locked By" }, "locked-date":{ "type":"string", "description":"Locked Date", "format":"date-time" }, "dependencies":{ "$ref":"#/components/schemas/IntegrationDependencyRs" }, "proxy-wsdl":{ "type":"string", "description":"Proxy WSDL" }, "keywords":{ "type":"string", "description":"Keywords" }, "doc-url":{ "type":"string", "description":"Documentation URL" }, "smart-tags":{ "type":"string", "description":"Smart Tags" }, "properties":{ "type":"array", "description":"Integration Properties List", "items":{ "$ref":"#/components/schemas/IntegrationPropRs" } }, "barta-built-by":{ "type":"string", "description":"BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator) builtBy" }, "is-view-allowed":{ "type":"boolean", "description":"Flag to Check if View Allowed" }, "is-clone-allowed":{ "type":"boolean", "description":"Flag to Check if Clone Allowed" }, "original-integration-code":{ "type":"string", "description":"Original Integration Code" }, "temp-copy-exists":{ "type":"boolean", "description":"Temp Copy Exists Flag" }, "reactivation-status":{ "type":"string", "description":"Reactivation Status" }, "project-id":{ "type":"string" }, "activation-status":{ "type":"string" } } }, "IntegrationMergeRs":{ "type":"object", "properties":{ "source-code":{ "type":"string", "description":"Source Code" }, "source-version":{ "type":"string", "description":"Source Version" }, "target-code":{ "type":"string", "description":"Target Code" }, "target-version":{ "type":"string", "description":"Target Version" } } }, "IntegrationPrimaryInfoRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "scope":{ "type":"string" }, "description":{ "type":"string" }, "package-name":{ "type":"string" }, "keywords":{ "type":"string" }, "doc-url":{ "type":"string" } } }, "IntegrationPropRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "default-value":{ "type":"string" }, "current-value":{ "type":"string" } } }, "IntegrationPropertiesRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "integrationProperties":{ "type":"array", "items":{ "$ref":"#/components/schemas/IntegrationPropertyParameterRs" } } } } ] }, "IntegrationPropertyParameterRs":{ "type":"object", "properties":{ "variable-name":{ "type":"string" }, "description":{ "type":"string" }, "text-expression":{ "type":"string" } } }, "IntegrationRole":{ "type":"string", "enum":[ "SOURCE", "TARGET", "SOURCE_AND_TARGET" ] }, "IntegrationRs":{ "type":"object", "properties":{ "scope":{ "type":"string", "description":"Scope of the integration" }, "locked-by":{ "type":"string", "description":"Locked By" }, "locked-date":{ "type":"string", "description":"Locked Date", "format":"date-time" }, "submit-now-uri":{ "type":"string", "description":"SubmitNow URI" }, "tracking-instance-name":{ "type":"string", "description":"Tracking Instance Name" }, "schedule-params":{ "type":"object", "additionalProperties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "description":"Schedule Parameters" }, "project-model-version":{ "type":"string", "description":"Project Model Version" }, "security-policy":{ "type":"string", "description":"Security Policy" }, "apip-id":{ "type":"string", "description":"Application Identifier" }, "warning-msg":{ "type":"string", "description":"Warning Message" }, "publish-flag":{ "type":"boolean", "description":"Publish Flag" }, "event-subscription-flag":{ "type":"boolean", "description":"Event Subscription Flag" }, "skip-event-subscription":{ "type":"boolean", "description":"Skip Event Subscription" } } }, "IntegrationUsageRs":{ "type":"object", "properties":{ "code":{ "type":"string" }, "version":{ "type":"string" }, "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/SuiteLink" } }, "name":{ "type":"string" }, "status":{ "type":"string" }, "is-locked":{ "type":"boolean" }, "reactivation-status":{ "type":"string" } } }, "Integration":{ "type":"object", "properties":{ "code":{ "type":"string", "description":"Integration Code" }, "version":{ "type":"string", "description":"Integration Version" }, "name":{ "type":"string", "description":"Integration Name" }, "status":{ "type":"string", "description":"Integration Status" }, "type":{ "type":"string", "description":"Integration Type" } } }, "Integrations":{ "type":"object", "properties":{ "id":{ "type":"string" }, "status":{ "type":"string" }, "message":{ "type":"string" }, "response-code":{ "type":"string" }, "name":{ "type":"string" } } }, "IntegrationsRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Integrations", "items":{ "$ref":"#/components/schemas/IntegrationListRs" } }, "total-results":{ "type":"integer", "description":"Total Results", "format":"int32" }, "has-more":{ "type":"boolean", "description":"Flag to Check if More Records Exists" }, "limit":{ "type":"integer", "description":"Limit of Records to be Displayed", "format":"int32" } } }, "InvokeRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "cloudAdapterFilterId":{ "type":"string" }, "cloudAdapterArtifactsId":{ "type":"string" }, "applicationInstanceCode":{ "type":"string" }, "closed":{ "type":"boolean" } } } ] }, "JMBaseRs":{ "type":"object", "properties":{ "error":{ "type":"string" } } }, "JMRootElementUserFriendlyDetailsRs":{ "allOf":[ { "$ref":"#/components/schemas/JMBaseRs" }, { "type":"object", "properties":{ "rootElementUserFriendlyName":{ "type":"string" }, "rootElementUserFriendlyIcon":{ "type":"string" }, "adapterId":{ "type":"string" } } } ] }, "JMSourceRootElemUFDetailsRs":{ "allOf":[ { "$ref":"#/components/schemas/JMBaseRs" }, { "type":"object", "properties":{ "sourceName":{ "type":"string" }, "rootElementUserFriendlyDetails":{ "$ref":"#/components/schemas/JMRootElementUserFriendlyDetailsRs" } } } ] }, "LabelRs":{ "required":[ "name", "code" ], "type":"object", "properties":{ "name":{ "required":[ "true" ], "type":"string", "description":"Deployment Name" }, "code":{ "required":[ "true" ], "type":"string", "description":"Deployment Identifier" }, "description":{ "type":"string", "description":"Deployment Description" }, "lastUpdated":{ "type":"string", "description":"Last Updated Date", "format":"date-time" }, "integrations":{ "type":"array", "description":"Integration List", "items":{ "$ref":"#/components/schemas/Integration" } }, "robots":{ "type":"array", "description":"Robot List", "items":{ "$ref":"#/components/schemas/RPADeploymentFlow" } }, "decisions":{ "type":"array", "description":"Decision List", "items":{ "$ref":"#/components/schemas/DecisionDeploymentFlow" } }, "b2btradingpartners":{ "type":"array", "description":"B2BTradingPartner List", "items":{ "$ref":"#/components/schemas/TradingPartner" } } } }, "LabelsRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Deployments", "items":{ "$ref":"#/components/schemas/LabelRs" } } } }, "LayoutRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "projectName":{ "type":"string" }, "projectCode":{ "type":"string" }, "projectVersion":{ "type":"string" }, "projectDescription":{ "type":"string" }, "packageName":{ "type":"string" }, "layoutModel":{ "type":"string" } } } ] }, "LibraryRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Libraries", "items":{ "$ref":"#/components/schemas/LibraryTypeRs" } }, "total-results":{ "type":"integer", "description":"Total Results", "format":"int32" }, "has-more":{ "type":"boolean", "description":"Flag to Check if More Records Exists" }, "limit":{ "type":"integer", "description":"Limit of Records to be Displayed", "format":"int32" } } }, "LibraryTypeRs":{ "type":"object", "properties":{ "status":{ "type":"string", "description":"Library Status" }, "last-updated-date":{ "type":"string", "description":"Library Last Updated Date", "format":"date-time" }, "last-updated-by":{ "type":"string", "description":"Library Last Updated By" }, "created-date":{ "type":"string", "description":"Library Created Date", "format":"date-time" }, "created-by":{ "type":"string", "description":"Library Created By" }, "library-type":{ "type":"string", "description":"Library Type" }, "callout-type":{ "type":"string", "description":"Callout Type" }, "id":{ "type":"string", "description":"Library Identifier" }, "code":{ "type":"string", "description":"Library Code" }, "display-name":{ "type":"string", "description":"Library Name" }, "version":{ "type":"string", "description":"Library Version" }, "description":{ "type":"string", "description":"Library Description" }, "usage":{ "type":"integer", "description":"Library Usage", "format":"int32" }, "locked-flag":{ "type":"boolean", "description":"Locked Flag" }, "locked-by":{ "type":"string", "description":"Locked By" }, "locked-date":{ "type":"string", "description":"Locked Date", "format":"date-time" }, "project-id":{ "type":"string" } } }, "Link":{ "type":"object", "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" }, "media-type":{ "type":"string" } } }, "LookupCloneRs":{ "required":[ "name" ], "type":"object", "properties":{ "description":{ "type":"string", "description":"Lookup Description" }, "keywords":{ "type":"string", "description":"Keywords" }, "name":{ "required":[ "true" ], "type":"string", "description":"Lookup Name" } } }, "LookupCreateRs":{ "required":[ "name", "columns", "rows" ], "type":"object", "properties":{ "name":{ "required":[ "true" ], "type":"string", "description":"Lookup Name" }, "description":{ "type":"string", "description":"Lookup Description" }, "keywords":{ "type":"string", "description":"Keywords" }, "columns":{ "required":[ "true" ], "type":"array", "description":"Column List", "items":{ "type":"string" } }, "rows":{ "required":[ "true" ], "type":"array", "description":"Row List", "items":{ "$ref":"#/components/schemas/SuiteLookupRowData" } } } }, "LookupRs":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Lookup Name" }, "description":{ "type":"string", "description":"Lookup Description" }, "row-count":{ "type":"integer", "description":"Lookup Row Count", "format":"int32" }, "status":{ "type":"string", "description":"Lookup Status" }, "last-updated-by":{ "type":"string", "description":"Last Updated By" }, "last-updated":{ "type":"string", "description":"Last Updated", "format":"date-time" }, "locked-by":{ "type":"string", "description":"Locked By" }, "locked-date":{ "type":"string", "description":"Locked Date", "format":"date-time" }, "locked-dvm-flag":{ "type":"boolean", "description":"Locked DVM Flag" }, "columns":{ "type":"array", "description":"Column List", "items":{ "type":"string" } }, "created":{ "type":"string", "description":"Created Date", "format":"date-time" }, "created-by":{ "type":"string", "description":"Created By" }, "locked-flag":{ "type":"boolean", "description":"Locked Flag" }, "adapters":{ "type":"array", "description":"Adapter List", "items":{ "$ref":"#/components/schemas/AdapterTypeRs" } }, "usage":{ "type":"integer", "description":"Lookup Usage", "format":"int32" }, "usage-active":{ "type":"integer", "description":"Lookup Active Usage", "format":"int32" }, "rows":{ "type":"array", "description":"Row List", "items":{ "$ref":"#/components/schemas/SuiteLookupRowData" } }, "rows-as-array":{ "type":"array", "items":{ "type":"array", "items":{ "type":"string" } } }, "resource-path":{ "type":"string", "description":"Resource Path" }, "keywords":{ "type":"string", "description":"Keywords" } } }, "LookupsRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Lookups", "items":{ "$ref":"#/components/schemas/LookupRs" } }, "total-results":{ "type":"integer", "description":"Total Results", "format":"int32" }, "has-more":{ "type":"boolean", "description":"Flag to Check if More Records Exists" }, "limit":{ "type":"integer", "description":"Limit of Records to be Displayed", "format":"int32" }, "project-id":{ "type":"string" } } }, "MessageCountRs":{ "type":"object", "properties":{ "data-fetch-time":{ "type":"string", "description":"Data Fetch Time", "format":"date-time" }, "message-summary":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int64" }, "description":"Map of Message Summary" } } }, "MonitoringAuditRecordResource":{ "type":"object", "properties":{ "user-name":{ "type":"string" }, "time-stamp":{ "type":"string", "format":"date-time" }, "operation-name":{ "type":"string" }, "resource-type":{ "type":"string" }, "resource-code":{ "type":"string" }, "resource-version":{ "type":"string" }, "resource-name":{ "type":"string" }, "message":{ "type":"string" }, "audit-trail-message":{ "type":"string" }, "job-id":{ "type":"string" }, "status":{ "type":"string" } } }, "MonitoringAuditResource":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Agent", "items":{ "$ref":"#/components/schemas/MonitoringAuditRecordResource" } }, "total-results":{ "type":"string", "description":"Total Results" } } }, "MonitoringIntegrationBaseRs":{ "allOf":[ { "$ref":"#/components/schemas/IntegrationBaseRs" }, { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "noOfMsgsReceived":{ "type":"integer" }, "noOfMsgsProcessed":{ "type":"integer" }, "noOfErrors":{ "type":"integer" }, "noOfSuccess":{ "type":"integer" }, "successRate":{ "type":"number" }, "scheduleApplicable":{ "type":"boolean" }, "scheduleDefined":{ "type":"boolean" }, "mepType":{ "type":"string" }, "lastUpdated":{ "type":"string", "format":"date-time" }, "optimizedVersion":{ "type":"string" }, "lastUpdatedString":{ "type":"string" }, "noOfAborted":{ "type":"integer" }, "scheduleStatus":{ "type":"string" }, "nextRunDateString":{ "type":"string" }, "flowStatus":{ "type":"string" } } } ] }, "MonitoringIntegrationNextRunRs":{ "allOf":[ { "$ref":"#/components/schemas/IntegrationBaseRs" }, { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "scheduleApplicable":{ "type":"boolean" }, "scheduleStatus":{ "type":"string" }, "nextRunDateString":{ "type":"string" }, "flowStatus":{ "type":"string" } } } ] }, "MonitoringIntegrationsRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Monitoring Integration", "items":{ "$ref":"#/components/schemas/MonitoringIntegrationBaseRs" } }, "total-results":{ "type":"integer", "description":"Total Results", "format":"int64" }, "time-window":{ "type":"string", "description":"Time Window" }, "data-fetch-time":{ "type":"string", "description":"Data Fetch Time", "format":"date-time" } } }, "MoveCustomActionReqRs":{ "type":"object", "properties":{ "element-i-ds":{ "type":"array", "items":{ "type":"string" } }, "location":{ "$ref":"#/components/schemas/ActivityRs.Location" } } }, "NamespaceContextRs":{ "type":"object", "properties":{ "prefix":{ "type":"string" }, "namespace":{ "type":"string" } } }, "NoteRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" } } } ] }, "NotificationRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "from":{ "$ref":"#/components/schemas/ExpressionBuilderRs" }, "to":{ "$ref":"#/components/schemas/ExpressionBuilderRs" }, "subject":{ "$ref":"#/components/schemas/ExpressionBuilderRs" }, "body":{ "type":"string" }, "parameters":{ "type":"array", "items":{ "$ref":"#/components/schemas/NotificationRs.ParameterRs" } }, "attachments":{ "type":"array", "items":{ "$ref":"#/components/schemas/NotificationRs.ParameterRs" } }, "bodyCmplx":{ "$ref":"#/components/schemas/NotificationRs.BodyRs" } } } ] }, "NotificationRs.BodyRs":{ "type":"object", "properties":{ "body-text":{ "type":"string" }, "error-messages":{ "type":"array", "items":{ "type":"string" } }, "warning-messages":{ "type":"array", "items":{ "type":"string" } }, "number-of-errors":{ "type":"integer", "format":"int32" }, "number-of-warnings":{ "type":"integer", "format":"int32" } } }, "NotificationRs.ParameterRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "expression":{ "$ref":"#/components/schemas/ExpressionBuilderRs" } } }, "NotificationSenderDetails":{ "type":"object", "properties":{ "sender-email-address":{ "type":"string" }, "approval-status":{ "type":"string" }, "system-notification-sender-flag":{ "type":"boolean" }, "sender-domain":{ "type":"string" }, "spf-configured":{ "type":"boolean" }, "dkimconfirmed":{ "type":"boolean" } } }, "NotificationTO":{ "type":"object", "properties":{ "customer-tenancy":{ "type":"boolean" }, "customer-tenancy-info":{ "$ref":"#/components/schemas/CustomerTenancyInfo" }, "service-failure-enabled":{ "type":"boolean" }, "hourly-detailed-report-enabled":{ "type":"boolean" }, "daily-detailed-report-enabled":{ "type":"boolean" }, "integration-error-detailed-report-enabled":{ "type":"boolean" }, "emails":{ "type":"string" }, "sender-address-details":{ "type":"array", "items":{ "$ref":"#/components/schemas/NotificationSenderDetails" } }, "dkimconfirmed":{ "type":"boolean" }, "default-from-address":{ "type":"string" }, "spf-record":{ "type":"string" } } }, "Object":{ "type":"object" }, "OrchestrationTypeEnum":{ "type":"string", "enum":[ "ORCHESTRATION", "RECEIVE", "ROUTER", "ROUTER_ROUTE", "TRANSFORMER", "TRY", "TRY_CATCH", "INVOKE", "REPLY", "LABEL", "ASSIGNMENT", "FOR", "PARALLEL_FOR", "PARALLEL_FOR_BATCH", "STOP", "SCHEDULERECEIVE", "STAGEFILE", "STAGEFILE_SEGMENTS_SEQUENTIAL", "STAGEFILE_SEGMENTS_SEQUENTIAL_BATCH", "STAGEFILE_SEGMENTS_PARALLEL", "STAGEFILE_SEGMENTS_PARALLEL_BATCH", "PARALLEL", "PARALLEL_BRANCH", "FAULTREPLY", "ABORTREPLY", "CALLOUT", "WHILE", "WAIT", "NOTE", "GLOBAL_VARIABLE", "GLOBAL_TRY", "GLOBAL_CATCH_ALL", "CATCH_ALL", "EHSTOP", "NOTIFICATION", "ACTIVITY_STREAM_LOGGER", "STITCH", "THROW", "PICK", "PICKRECEIVE", "TRACKING_VARIABLE", "REJECT", "INTEGRATION_METADATA", "AUXILIARY_TRACKING_VARIABLE", "PUBLISHER", "SUBSCRIBER", "INTEGRATION_PROPERTIES", "SCHEDULE_DEFINED", "SCHEDULE_BLOCK", "SCHEDULE_PAUSE", "SCHEDULE_RESUME", "SCHEDULE_EXECUTE", "SCHEDULE_RETRY", "SCHEDULE_CANCEL", "SCHEDULE_SUCCESS", "SCHEDULE_WARNING", "ABORT", "RESUBMIT" ] }, "Origin":{ "type":"object", "properties":{ "tenant-id":{ "type":"string" }, "service-instance":{ "type":"string" }, "project":{ "type":"string" }, "version":{ "type":"string" }, "type":{ "type":"string" }, "built-by":{ "type":"string" }, "code":{ "type":"string" } } }, "PackageCloneMetadataRs":{ "type":"object", "properties":{ "package-name":{ "type":"string", "description":"Package Name" }, "version":{ "type":"string", "description":"Package Version" }, "list-of-integrations-id":{ "type":"array", "description":"Integration List", "items":{ "type":"string" } } } }, "PackageRs":{ "type":"object", "properties":{ "integrations":{ "type":"array", "description":"Integration List", "items":{ "$ref":"#/components/schemas/IntegrationBaseResource" } }, "name":{ "type":"string", "description":"Package Name" }, "count-of-integrations":{ "type":"integer", "description":"Number of Integrations", "format":"int32" }, "type":{ "type":"string", "description":"Package type" }, "barta-built-by":{ "type":"string", "description":"BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator) builtBy" }, "barta-type":{ "type":"string", "description":"Accelerator type BA (Business Accelerator) | R (Recipe) | TA (Technical Accelerator)" }, "is-view-allowed":{ "type":"boolean", "description":"Flag to Check if View Allowed" }, "is-clone-allowed":{ "type":"boolean", "description":"Flag to Check if Clone Allowed" } } }, "PackagesRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Packages", "items":{ "$ref":"#/components/schemas/PackageRs" } }, "total-results":{ "type":"integer", "description":"Total Results", "format":"int32" }, "has-more":{ "type":"boolean", "description":"Flag to Check if More Records Exists" }, "limit":{ "type":"integer", "description":"Limit of Records to be Displayed", "format":"int32" } } }, "PatternRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Pattern Name" }, "description":{ "type":"string", "description":"Pattern Description" }, "status":{ "type":"string", "description":"Pattern Status" }, "lastUpdatedBy":{ "type":"string", "description":"Last Updated By" }, "lastUpdated":{ "type":"string", "format":"date-time", "description":"Last Updated" }, "created":{ "type":"string", "format":"date-time", "description":"Created Date" }, "createdBy":{ "type":"string", "description":"Created By" }, "code":{ "type":"string", "description":"Code" }, "version":{ "type":"string", "description":"Version" }, "updateBy":{ "type":"string", "description":"Updated By" }, "createdDate":{ "type":"string", "format":"date-time", "description":"Created Date" }, "updatedDate":{ "type":"string", "format":"date-time", "description":"Updated Date" }, "patternRoles":{ "type":"array", "description":"Pattern Roles", "items":{ "$ref":"#/components/schemas/PatternRoles" } }, "dependencies":{ "$ref":"#/components/schemas/PatternDependencies", "description":"Pattern Dependencies" }, "usageCount":{ "type":"integer", "format":"int32", "description":"Usage Count" }, "projectId":{ "type":"string", "description":"Automation id" }, "lockedBy":{ "type":"string", "description":"Locked By" }, "lockedDate":{ "type":"string", "format":"date-time", "description":"Locked Date" }, "lockedFlag":{ "type":"boolean", "description":"Locked Flag" }, "id":{ "type":"string", "description":"Pattern id" }, "recipeSource":{ "$ref":"#/components/schemas/RecipeSource", "description":"Recipe Source (System or Source)" }, "maxIteration":{ "type":"integer", "format":"int32" }, "guidelines":{ "type":"string" } } } ] }, "PatternRoles":{ "type":"object", "properties":{ "role":{ "type":"string" }, "temperature":{ "type":"string" }, "maxIteration":{ "type":"integer", "format":"int32" }, "guidelines":{ "type":"string" }, "connectionList":{ "type":"array", "items":{ "$ref":"#/components/schemas/PatternRoleConnection" } } } }, "PatternDependencies":{ "type":"object", "properties":{ "project":{ "$ref":"#/components/schemas/PatternDependencyProject", "description":"Recipe Details" }, "integrations":{ "type":"array", "description":"Integration id's", "items":{ "$ref":"#/components/schemas/Integration" } }, "primaryIntegration":{ "$ref":"#/components/schemas/Integration", "description":"Primary Integration id" } } }, "PatternDependencyProject":{ "type":"object", "properties":{ "id":{ "type":"string" }, "acceleratorId":{ "type":"string" }, "acceleratorLabel":{ "type":"string" } } }, "PatternDependencyConnectionMetadata":{ "type":"object", "properties":{ "id":{ "type":"string" }, "type":{ "type":"string" }, "name":{ "type":"string" }, "metadata":{ "$ref":"#/components/schemas/PatternDependencyMetadata" } } }, "PatternDependencyMetadata":{ "type":"object", "properties":{ "apiKey":{ "type":"string" }, "baseUrl":{ "type":"string" }, "temperature":{ "type":"string" }, "modelNumber":{ "type":"string" } } }, "PatternDependencyRs":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" } } }, "PatternRoleConnection":{ "type":"object", "properties":{ "connectionId":{ "type":"string" }, "adapterType":{ "type":"string" }, "status":{ "type":"string" }, "name":{ "type":"string" }, "llmModel":{ "type":"string" } } }, "PatternsRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "description":"List of patterns", "items":{ "$ref":"#/components/schemas/PatternRs" } }, "totalResults":{ "type":"integer", "format":"int32", "description":"Total Results" }, "hasMore":{ "type":"boolean", "description":"Flag to Check if More Records Exists" }, "limit":{ "type":"integer", "format":"int32", "description":"Limit of Records to be Displayed" }, "projectId":{ "type":"string" } } } ] }, "PickRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "cloudAdapterFilterId":{ "type":"string" }, "caf":{ "$ref":"#/components/schemas/CloudAdapterFilterRs" }, "cloudAdapterArtifactsId":{ "type":"string" }, "applicationInstanceCode":{ "type":"string" } } } ] }, "PredictionsForLocationCustomActionReqRs":{ "type":"object", "properties":{ "location":{ "$ref":"#/components/schemas/ActivityRs.Location" } } }, "ProjectActivationRs":{ "type":"object", "properties":{ "status":{ "type":"string" }, "trace-type":{ "$ref":"#/components/schemas/TraceTypeEnum" }, "integrations":{ "type":"array", "items":{ "$ref":"#/components/schemas/Integrations" } }, "label":{ "type":"string" } } }, "ProjectTypeBaseResource":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestResource" }, { "type":"object", "properties":{ "id":{ "type":"string" } } } ] }, "ProjectTypeRs":{ "allOf":[ { "$ref":"#/components/schemas/ProjectTypeBaseResource" }, { "$ref":"#/components/schemas/GenericRestResource" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Project Name" }, "code":{ "type":"string", "description":"Project Identifier" }, "keyword":{ "type":"string", "description":"Project Keyword" }, "type":{ "type":"string", "description":"Project Type" }, "access":{ "type":"string", "description":"Project Access" }, "builtBy":{ "type":"string", "description":"Project BuiltBy" }, "origin":{ "$ref":"#/components/schemas/Origin", "description":"Project Origin" }, "state":{ "$ref":"#/components/schemas/State", "description":"Project State" }, "smartTags":{ "type":"array", "items":{ "type":"string" }, "description":"Project Smart Tags" }, "description":{ "type":"string", "description":"Project Description" }, "label":{ "type":"string", "description":"Project Deployment" } } } ] }, "ProjectsRs":{ "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Projects", "items":{ "$ref":"#/components/schemas/ProjectTypeRs" } }, "total-results":{ "type":"integer", "description":"Total Results", "format":"int32" }, "has-more":{ "type":"boolean", "description":"Flag to Check if More Records Exists" }, "limit":{ "type":"integer", "description":"Limit of Records to be Displayed", "format":"int32" } } }, "PromptTemplateRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Prompt Template Name" }, "status":{ "type":"string", "description":"Status" }, "description":{ "type":"string", "description":"Prompt Template Description" }, "lastUpdatedBy":{ "type":"string", "description":"Last Updated By" }, "lastUpdated":{ "type":"string", "format":"date-time", "description":"Last Updated" }, "created":{ "type":"string", "format":"date-time", "description":"Created Date" }, "createdBy":{ "type":"string", "description":"Created By" }, "content":{ "type":"string", "description":"Content" }, "code":{ "type":"string", "description":"Code" }, "version":{ "type":"string", "description":"Version" }, "mapped":{ "type":"boolean", "description":"Mapped" }, "usage":{ "type":"integer", "format":"int32", "description":"Prompt Template Usage" }, "lockedBy":{ "type":"string", "description":"Locked By" }, "lockedDate":{ "type":"string", "format":"date-time", "description":"Locked Date" }, "lockedFlag":{ "type":"boolean", "description":"Locked Flag" }, "projectId":{ "type":"string", "description":"Project id" }, "typeId":{ "type":"string", "description":"Type id" } } } ] }, "PromptTemplatesRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Prompt Templates", "items":{ "$ref":"#/components/schemas/PromptTemplateRs" } }, "totalResults":{ "type":"integer", "format":"int32", "description":"Total Results" }, "hasMore":{ "type":"boolean", "description":"Flag to Check if More Records Exists" }, "limit":{ "type":"integer", "format":"int32", "description":"Limit of Records to be Displayed" }, "projectId":{ "type":"string" } } } ] }, "RecipeSource":{ "type":"string", "description":"Source of the recipe.", "enum":[ "System", "Store" ], "example":"System" }, "ReceiveRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "cloudAdapterFilterId":{ "type":"string" }, "caf":{ "allOf":[ { "$ref":"#/components/schemas/CloudAdapterFilterRs" }, { "type":"object", "deprecated":true } ] }, "cloudAdapterArtifactsId":{ "type":"string" }, "applicationInstanceCode":{ "type":"string" }, "closed":{ "type":"boolean" } } } ] }, "RecoveryJobRs":{ "type":"object", "properties":{ "created-date":{ "type":"string", "description":"Created Date", "format":"date-time" }, "total-count":{ "type":"integer", "description":"Total Count", "format":"int64" }, "recovered-count":{ "type":"integer", "description":"Recovered Count", "format":"int64" }, "in-progress-count":{ "type":"integer", "description":"inProgress Count", "format":"int64" }, "failed-count":{ "type":"integer", "description":"Failed Count", "format":"int64" } } }, "RecoveryJobsRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/RecoveryJobRs" } }, "totalResults":{ "type":"integer", "format":"int32" } } } ] }, "RegenerationConnectionRs":{ "type":"object", "properties":{ "plugin-id":{ "type":"string" }, "connection-status":{ "type":"string" }, "app-instance-code":{ "type":"string" }, "app-instance-name":{ "type":"string" }, "connection-regeneration-status":{ "type":"string" }, "connection-regenstarted-date":{ "type":"string", "format":"date-time" }, "connection-regenupdated-date":{ "type":"string", "format":"date-time" }, "endpoints":{ "type":"array", "items":{ "$ref":"#/components/schemas/RegenerationEndpointRs" } } } }, "RegenerationEndpointRs":{ "type":"object", "properties":{ "inbound":{ "type":"boolean" }, "element-regenstarted-date":{ "type":"string", "format":"date-time" }, "element-regenupdated-date":{ "type":"string", "format":"date-time" }, "old-endpoint-artifact":{ "type":"string" }, "new-endpoint-artifact":{ "type":"string" }, "endpoint":{ "type":"string" }, "element-id":{ "type":"string" }, "message":{ "type":"string" }, "orchestration-type":{ "type":"string" }, "element-regen-status":{ "type":"string" } } }, "RegenerationRs":{ "type":"object", "properties":{ "integration-status-after-regen":{ "type":"string" }, "regeneration-status":{ "type":"string" }, "integration-status-before-regen":{ "type":"string" }, "regenerated-by":{ "type":"string" }, "total-connections":{ "type":"integer", "format":"int32" }, "regenstarted-date":{ "type":"string", "format":"date-time" }, "integration-regenupdated-date":{ "type":"string", "format":"date-time" }, "connections-rs":{ "type":"array", "items":{ "$ref":"#/components/schemas/RegenerationConnectionRs" } } } }, "RelativePositionIndicator":{ "type":"string", "enum":[ "BEFORE", "AT_END", "GLOBAL" ] }, "ReplyRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "refUri":{ "type":"string" }, "type":{ "type":"string" }, "addTransformerFlag":{ "type":"boolean" } } } ] }, "ResourceModificationAttribute":{ "type":"object", "properties":{ "by":{ "type":"string" }, "date":{ "type":"string", "format":"date-time" } } }, "Response.Status.Family":{ "type":"string", "enum":[ "INFORMATIONAL", "SUCCESSFUL", "REDIRECTION", "CLIENT_ERROR", "SERVER_ERROR", "OTHER" ] }, "Response.StatusType":{ "type":"object", "properties":{ "status-code":{ "type":"integer", "format":"int32" }, "family":{ "$ref":"#/components/schemas/Response.Status.Family" }, "reason-phrase":{ "type":"string" } } }, "ResubmittedFailedInstances":{ "type":"object", "properties":{ "recovery-job-id":{ "type":"string" }, "error-message":{ "type":"string" }, "error-id":{ "type":"string" }, "instance-id":{ "type":"string" } } }, "RouteRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "expression":{ "$ref":"#/components/schemas/ExpressionBuilderRs" } } } ] }, "RouterRs":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/ActivityRs" } ] }, "RPADeploymentFlow":{ "type":"object", "properties":{ "identifier":{ "type":"string", "description":"Robot Identifier" }, "version":{ "type":"string", "description":"Robot Version" }, "displayName":{ "type":"string", "description":"Robot Name" }, "lifecycleState":{ "type":"string", "description":"Robot Lifecycle State" } } }, "RunRequestRs":{ "allOf":[ { "$ref":"#/components/schemas/IdResource" }, { "$ref":"#/components/schemas/GenericRestResource" }, { "type":"object", "properties":{ "requestId":{ "type":"string" }, "state":{ "type":"string" }, "flowCode":{ "type":"string" }, "flowVersion":{ "type":"string" }, "submissionTime":{ "type":"string" }, "startTime":{ "type":"string" }, "parentRequestId":{ "type":"string" } } } ] }, "RunRequestsRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/RunRequestRs" } } } } ] }, "SMTPCredentials":{ "type":"object", "properties":{ "sender-address":{ "type":"string" }, "username":{ "type":"string" }, "password":{ "type":"array", "items":{ "type":"string" } } } }, "STBaseRS":{ "type":"object", "properties":{ "error":{ "type":"string" } } }, "SamplesRs":{ "type":"object", "properties":{ "packages":{ "type":"array", "description":"List of Sample Packages", "items":{ "$ref":"#/components/schemas/SamplesRs.PackageSamplesRs" } } } }, "SamplesRs.IntegrationSampleRs":{ "type":"object", "properties":{ "integration-name":{ "type":"string" }, "code":{ "type":"string" }, "version":{ "type":"string" } } }, "SamplesRs.PackageSamplesRs":{ "type":"object", "properties":{ "package-name":{ "type":"string" }, "status":{ "type":"string" }, "integrations":{ "type":"array", "items":{ "$ref":"#/components/schemas/SamplesRs.IntegrationSampleRs" } } } }, "ScheduleClassicRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "lockedFlag":{ "type":"boolean" }, "lockedBy":{ "type":"string" }, "lockedDate":{ "type":"string", "format":"date-time" }, "scheduleTZ":{ "type":"string" }, "scheduleTZDisplayName":{ "type":"string" }, "state":{ "type":"string" }, "startDate":{ "type":"string" }, "endDate":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "created":{ "type":"string", "format":"date-time" }, "updated":{ "type":"string", "format":"date-time" }, "createdBy":{ "type":"string" }, "updatedBy":{ "type":"string" }, "status":{ "type":"string" }, "frequency":{ "$ref":"#/components/schemas/ScheduleDefinitionRs" }, "scheduleType":{ "type":"string" }, "icalExpression":{ "type":"string" }, "errorCode":{ "type":"string" }, "errorMessage":{ "type":"string" } } } ] }, "ScheduleDayOfWeek":{ "type":"string", "enum":[ "MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY", "SATURDAY", "SUNDAY" ] }, "ScheduleDefinitionRs":{ "type":"object", "properties":{ "frequency-type":{ "type":"string" }, "interval":{ "type":"integer", "format":"int32" }, "days-of-week":{ "type":"array", "items":{ "$ref":"#/components/schemas/ScheduleDayOfWeek" } }, "days-of-month":{ "type":"array", "items":{ "type":"integer", "format":"int32" } }, "weeks-of-month":{ "type":"array", "items":{ "$ref":"#/components/schemas/ScheduleWeekOfMonth" } }, "months-of-year":{ "type":"array", "items":{ "$ref":"#/components/schemas/ScheduleMonthsOfYear" } } } }, "ScheduleJobRs":{ "type":"object", "properties":{ "run-as-user-name":{ "type":"string", "description":"Run as Username" }, "action":{ "$ref":"#/components/schemas/ScheduleJobRs.ScheduleEnum" }, "run-as-schedule":{ "type":"boolean", "description":"Run as Part of Schedule" }, "parameters":{ "type":"array", "description":"List of Schedule Parameters", "items":{ "$ref":"#/components/schemas/ScheduleParamRs" } } }, "description":"ScheduleJobRs" }, "ScheduleJobRs.ScheduleEnum":{ "type":"string", "enum":[ "NOW", "now" ] }, "ScheduleJobSubmitterRs":{ "type":"object", "properties":{ "old-submitter-name":{ "type":"string" }, "new-submitter-name":{ "type":"string" } } }, "ScheduleMonthsOfYear":{ "type":"string", "enum":[ "JANUARY", "FEBRUARY", "MARCH", "APRIL", "MAY", "JUNE", "JULY", "AUGUST", "SEPTEMBER", "OCTOBER", "NOVEMBER", "DECEMBER" ] }, "ScheduleParamRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" } } }, "ScheduleParameterRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "default-value":{ "type":"string" } } }, "ScheduleReceiveRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "cloudAdapterArtifactsId":{ "type":"string" }, "scheduleParameters":{ "type":"array", "items":{ "$ref":"#/components/schemas/ScheduleParameterRs" } } } } ] }, "ScheduleWeekOfMonth":{ "type":"string", "enum":[ "FIRST", "SECOND", "THIRD", "FOURTH", "LAST" ] }, "SecurityPolicy":{ "type":"string", "enum":[ "BASIC_AUTH", "USERNAME_PASSWORD_TOKEN", "USERNAME_PASSWORD_IGNORE_TIMESTAMP", "OAUTH_CLIENT_CREDENTIALS", "OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "SAML", "OAUTH", "CUSTOM", "TEMPLATE_BASED", "TOKEN_BASED", "NONE", "PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "TIMEOUT_AUTHORIZATION_CODE_CREDENTIALS", "PLUGIN_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "PLUGIN_CLIENT_CREDENTIALS", "MIN_PLUGIN_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "OAUTH20_AUTHORIZATION_CODE_CREDENTIALS", "CUSTOM_THREE_LEGGED", "CUSTOM_TWO_LEGGED", "CUSTOM_SINGLE_TOKEN", "SHOPIFY_AUTH_POLICY", "SUCCESSFACTORS", "OAUTH_ONE_TOKEN_BASED", "NETSUITE_TOKEN_BASED", "NETSUITE_3STEP_TBA_FLOW", "PAAS_INTEGRATION_USING_OWSM_OAUTH20", "FTP_PUBLIC_KEY_AUTHENTICATION", "FTP_MULTI_LEVEL_AUTHENTICATION", "OAUTH_INBOUND", "MULTI_TOKEN_INBOUND", "AWS_SIGNATURE_VERSION4", "OAUTH2_PRECONFIGURED_CLINET_ID_SECRET", "OAUTH2_CCS_ROP_PRECONFIGURED", "OAUTH2_CCS_ROP", "OAUTH2", "CCS_BASIC_AUTH", "CCS_API_KEY", "JDBC_OVER_SSL", "JDBC_OVER_SSL_WITH_OCI_SIGNATURE", "JDBC_BASIC_AUTH", "FA_OAUTH_AUTHORIZATION_CODE_CREDENTIALS", "FA_OAUTH_RESOURCE_OWNER_PASSWORD_CREDENTIALS", "ORACLE_WALLET", "OCI_SIGNATURE_VERSION1", "SASLPLAIN", "SASLPLAIN_OVER_SSL", "SASLPLAIN_OVER_SSL_OSS", "TLS", "MUTUAL_TLS", "UIPATH_CLOUD", "OCI_OBO_TOKEN", "AS2_ADVANCE_SEC_PROPS", "AS2_BASIC_SEC_PROPS", "JWT_USER_ASSERTION_FOR_OAUTH", "JWT_CLIENT_CREDENTIALS_ASSERTION_FOR_OAUTH", "OCI_SERVICE_INVOCATION" ] }, "SecurityPolicyInfoRs":{ "type":"object", "properties":{ "scope":{ "$ref":"#/components/schemas/IntegrationRole" }, "security-policy":{ "$ref":"#/components/schemas/SecurityPolicy" }, "security-properties":{ "type":"array", "items":{ "$ref":"#/components/schemas/ConnectionPropertyRs" } } } }, "SessionPropertyRs":{ "required":[ "key", "value" ], "type":"object", "properties":{ "key":{ "type":"string" }, "value":{ "type":"string" } } }, "StagefileRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "cloudAdapterArtifactsId":{ "type":"string" }, "cloudAdapterFilterId":{ "type":"string" }, "applicationInstanceCode":{ "type":"string" }, "caf":{ "$ref":"#/components/schemas/CloudAdapterFilterRs" }, "closed":{ "type":"boolean" } } } ] }, "State":{ "type":"object", "properties":{ "service-instance-id":{ "type":"integer", "format":"int32" }, "project-revision-id":{ "type":"integer", "format":"int32" }, "status":{ "type":"string" }, "assets":{ "$ref":"#/components/schemas/Assets" }, "updated":{ "$ref":"#/components/schemas/ResourceModificationAttribute" }, "created":{ "$ref":"#/components/schemas/ResourceModificationAttribute" }, "locked":{ "$ref":"#/components/schemas/ResourceModificationAttribute" }, "latest":{ "$ref":"#/components/schemas/ResourceModificationAttribute" }, "lock-status":{ "type":"boolean" } } }, "StitchActivityRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "stitchContent":{ "$ref":"#/components/schemas/StitchRs" } } } ] }, "StitchDetailsRs":{ "allOf":[ { "$ref":"#/components/schemas/StitchActivityRs" }, { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "statements":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchDetailsRs.NewStatementRs" } }, "variables":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchDetailsRs.NewVariableRs" } }, "namespaces":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchDetailsRs.NewNamespaceRs" } }, "errors":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchDetailsRs.NewMessageRs" } }, "warnings":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchDetailsRs.NewMessageRs" } } } } ] }, "StitchDetailsRs.NewDataTypeRs":{ "type":"object" }, "StitchDetailsRs.NewFromRs":{ "type":"object", "properties":{ "type":{ "type":"string" }, "expression":{ "type":"string" } } }, "StitchDetailsRs.NewMessageRs":{ "type":"object", "properties":{ "sentence-id":{ "type":"string" }, "message":{ "type":"string" }, "field":{ "type":"string" } } }, "StitchDetailsRs.NewNamespaceRs":{ "type":"object", "properties":{ "prefix":{ "type":"string" }, "value":{ "type":"string" } } }, "StitchDetailsRs.NewStatementRs":{ "type":"object", "properties":{ "operation":{ "type":"string" }, "comment":{ "type":"string" }, "from":{ "$ref":"#/components/schemas/StitchDetailsRs.NewFromRs" }, "to":{ "$ref":"#/components/schemas/StitchDetailsRs.NewToRs" } } }, "StitchDetailsRs.NewToRs":{ "type":"object", "properties":{ "type":{ "type":"string" }, "path":{ "type":"string" } } }, "StitchDetailsRs.NewVariableRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "access":{ "type":"string" }, "comment":{ "type":"string" }, "data-type":{ "$ref":"#/components/schemas/StitchDetailsRs.NewDataTypeRs" } } }, "StitchRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "statements":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchRs.StatementRs" } }, "functions":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchRs.FunctionRs" } }, "variables":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchRs.VariableRs" } }, "namespaces":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchRs.NamespaceRs" } }, "errors":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchRs.MessageRs" } }, "warnings":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchRs.MessageRs" } } } } ] }, "StitchRs.DataTypeRs":{ "type":"object" }, "StitchRs.FromRs":{ "type":"object", "properties":{ "type":{ "type":"string" }, "expression":{ "type":"string" } } }, "StitchRs.FunctionRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "hlp-url":{ "type":"string" }, "signature":{ "type":"string" }, "return-type":{ "type":"string" }, "category":{ "type":"string" }, "parameters":{ "type":"array", "items":{ "$ref":"#/components/schemas/StitchRs.ParameterRs" } }, "icon-file":{ "type":"string" }, "namespace-url":{ "type":"string" }, "preferred-prefix":{ "type":"string" } } }, "StitchRs.MessageRs":{ "type":"object", "properties":{ "sentence-id":{ "type":"string" }, "message":{ "type":"string" }, "field":{ "type":"string" } } }, "StitchRs.NamespaceRs":{ "type":"object", "properties":{ "prefix":{ "type":"string" }, "value":{ "type":"string" } } }, "StitchRs.ParameterRs":{ "type":"object", "properties":{ "data-type":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "is-repeatable":{ "type":"boolean" }, "is-required":{ "type":"boolean" } } }, "StitchRs.StatementRs":{ "type":"object", "properties":{ "operation":{ "type":"string" }, "comment":{ "type":"string" }, "from":{ "$ref":"#/components/schemas/StitchRs.FromRs" }, "to":{ "$ref":"#/components/schemas/StitchRs.ToRs" } } }, "StitchRs.ToRs":{ "type":"object", "properties":{ "type":{ "type":"string" }, "path":{ "type":"string" } } }, "StitchRs.VariableRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "access":{ "type":"string" }, "comment":{ "type":"string" }, "data-type":{ "$ref":"#/components/schemas/StitchRs.DataTypeRs" } } }, "StopRs":{ "type":"object", "allOf":[ { "$ref":"#/components/schemas/ActivityRs" } ] }, "SubscriberRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "displayName":{ "type":"string" }, "description":{ "type":"string" }, "eventTypes":{ "type":"array", "items":{ "$ref":"#/components/schemas/EventTypeRefRs" } }, "cloudAdapterArtifactsId":{ "type":"string" }, "cloudAdapterFilterId":{ "type":"string" }, "closed":{ "type":"boolean" } } } ] }, "SuiteLink":{ "type":"object", "properties":{ "rel":{ "type":"string" }, "href":{ "type":"string" }, "media-type":{ "type":"string" }, "method":{ "type":"string" } } }, "SuiteLookupRowData":{ "type":"object", "properties":{ "row-data":{ "type":"array", "items":{ "type":"string" } } } }, "TemplateDependencyRs":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "isPrimary":{ "type":"boolean" } } }, "ThrowRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "code":{ "$ref":"#/components/schemas/ExpressionBuilderRs" }, "reason":{ "$ref":"#/components/schemas/ExpressionBuilderRs" }, "details":{ "$ref":"#/components/schemas/ExpressionBuilderRs" }, "condition":{ "$ref":"#/components/schemas/ExpressionBuilderRs" } } } ] }, "TraceTypeEnum":{ "type":"string", "enum":[ "NONE", "PRODUCTION", "AUDIT" ] }, "TrackingBaseRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "creationDate":{ "type":"string", "format":"date-time" }, "lastTrackedTime":{ "type":"string", "format":"date-time" }, "status":{ "$ref":"#/components/schemas/FlowStatus" }, "primaryName":{ "type":"string" }, "primaryValue":{ "type":"string" } } } ] }, "TrackingDataRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" }, "primary":{ "type":"boolean" } } }, "TrackingVariableTypeRs":{ "type":"object", "properties":{ "role":{ "type":"string" }, "sub-role":{ "type":"string" }, "primary":{ "type":"boolean" }, "name":{ "type":"string" }, "description":{ "type":"string" }, "xpath":{ "type":"string" }, "message-context-ref":{ "$ref":"#/components/schemas/TrackingVariableTypeRs.ReferenceTypeRs" }, "property":{ "type":"array", "items":{ "$ref":"#/components/schemas/TrackingVariableTypeRs.PropertyTypeRs" } }, "output":{ "$ref":"#/components/schemas/TrackingVariableTypeRs.OutputWirepointTypeRs" }, "id":{ "type":"string" } } }, "TrackingVariableTypeRs.OutputWirepointTypeRs":{ "type":"object", "properties":{ "message-context-ref":{ "$ref":"#/components/schemas/TrackingVariableTypeRs.ReferenceTypeRs" }, "name":{ "type":"string" } } }, "TrackingVariableTypeRs.PropertyTypeRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" } } }, "TrackingVariableTypeRs.ReferenceTypeRs":{ "type":"object", "properties":{ "role":{ "type":"string" }, "sub-role":{ "type":"string" }, "property":{ "type":"array", "items":{ "$ref":"#/components/schemas/TrackingVariableTypeRs.PropertyTypeRs" } }, "ref-uri":{ "type":"string" } } }, "TrackingVariablesRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "trackingVariables":{ "type":"array", "items":{ "$ref":"#/components/schemas/TrackingVariablesRs.TrackingVariableRs" } } } } ] }, "TrackingVariablesRs.TrackingVariableRs":{ "type":"object", "properties":{ "role":{ "type":"string" }, "primary":{ "type":"string" }, "name":{ "type":"string" }, "xpath":{ "type":"string" }, "description":{ "type":"string" } } }, "TradingPartner":{ "type":"object", "properties":{ "code":{ "type":"string", "description":"TradingPartner Code" }, "name":{ "type":"string", "description":"TradingPartner Name" }, "version":{ "type":"string", "description":"TradingPartner Version", "default":"01.00.0000" }, "type":{ "type":"string", "description":"TradingPartner Type" }, "status":{ "type":"string", "description":"TradingPartner Status" }, "transports":{ "type":"array", "description":"TradingPartner Transports List", "items":{ "type":"string" } }, "inboundAgrs":{ "type":"array", "description":"TradingPartner inboundAgrs List", "items":{ "type":"string" } }, "outboundAgrs":{ "type":"array", "description":"TradingPartner outboundAgrs List", "items":{ "type":"string" } } } }, "TransformerRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "outputUri":{ "type":"string" }, "xslUri":{ "type":"string" }, "stateInfoUri":{ "type":"string" }, "targetRootElementUserFriendlyName":{ "$ref":"#/components/schemas/JMRootElementUserFriendlyDetailsRs" }, "sourceRootElementUserFriendlyNames":{ "type":"array", "items":{ "$ref":"#/components/schemas/JMSourceRootElemUFDetailsRs" } }, "errorMessages":{ "type":"array", "items":{ "type":"string" } }, "warningMessages":{ "type":"array", "items":{ "type":"string" } } } } ] }, "TryRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "extAnchorId":{ "type":"string" }, "extRpi":{ "type":"string" } } } ] }, "ToolRs":{ "allOf":[ { "$ref":"#/components/schemas/ToolListRs" }, { "type":"object", "properties":{ "guidelines":{ "type":"string", "description":"Guidelines for the tool" }, "parameters":{ "type":"object", "additionalProperties":true, "description":"Json node for the tool" }, "annotations":{ "type":"object", "additionalProperties":{ "type":"boolean" }, "description":"Annotations for the tool" }, "endpointUrl":{ "type":"string", "description":"Endpoint url for the tool" } } } ] }, "ToolConnectionRs":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "artifactLocation":{ "type":"string" }, "status":{ "type":"string" }, "adapterName":{ "type":"string" } } }, "ToolIntegrationRs":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "projectCode":{ "type":"string" }, "status":{ "type":"string" } } }, "ToolDependencyRs":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "description":{ "type":"string" } } }, "ToolsRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "description":"List of Tools", "items":{ "$ref":"#/components/schemas/ToolListRs" } }, "totalResults":{ "type":"integer", "format":"int32", "description":"Total Results" }, "hasMore":{ "type":"boolean", "description":"Flag to Check if More Records Exists" }, "limit":{ "type":"integer", "format":"int32", "description":"Limit of Records to be Displayed" } } } ] }, "ToolListRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "name":{ "type":"string", "description":"Tool name" }, "code":{ "type":"string", "description":"Tool code" }, "type":{ "type":"string", "description":"Tool type" }, "status":{ "type":"string", "description":"Tool Status" }, "description":{ "type":"string", "description":"Tool description" }, "created":{ "type":"string", "format":"date-time", "description":"Created" }, "createdBy":{ "type":"string", "description":"Created By" }, "lastUpdatedBy":{ "type":"string", "description":"Last Updated By" }, "lastUpdated":{ "type":"string", "format":"date-time", "description":"Last Updated" }, "projectId":{ "type":"string", "description":"Project id which tool is part of" }, "integration":{ "$ref":"#/components/schemas/ToolIntegrationRs", "description":"Integration in use for the tool" }, "connection":{ "$ref":"#/components/schemas/ToolConnectionRs", "description":"Connection in use for the tool" } } } ] }, "UsageMetricsRs":{ "type":"object", "properties":{ "project-state-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.ProjectStateMetricsRs" }, "project-type-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.ProjectTypeMetricsRs" }, "domain-value-map-usage-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.DVMUsageMetricsRs" }, "application-instance-usage-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.AppInstanceUsageMetricsRs" }, "integration-usage-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.IntegrationUsageMetricsRs" }, "integration-design-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.IntegrationDesignMetricsRs" }, "package-usage-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.PackageUsageMetricsRs" }, "message-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.MessageMetricsRs" }, "agent-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.AgentUsageMetricsRs" }, "adapter-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.AdapterUsageMetricsRs" }, "api-library-usage-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.APILibraryUsageMetricsRs" }, "message-system-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.MessageSystemUsageRs" }, "schedule-usage-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.ScheduleUsageMetricsRs" }, "integration-state-metrics":{ "$ref":"#/components/schemas/UsageMetricsRs.IntegrationStateMetricsRs" } } }, "UsageMetricsRs.APILibraryUsageMetricsRs":{ "type":"object", "properties":{ "total":{ "type":"integer", "format":"int64" }, "in-progress":{ "type":"integer", "format":"int64" }, "configured":{ "type":"integer", "format":"int64" } } }, "UsageMetricsRs.AdapterCountRs":{ "type":"object", "properties":{ "total-adapter-count":{ "type":"integer", "format":"int32" }, "private-adapter-count":{ "type":"integer", "format":"int32" }, "pre-installed-adapter-count":{ "type":"integer", "format":"int32" }, "market-place-adapter-count":{ "type":"integer", "format":"int32" }, "adapter-display-name-map":{ "type":"object", "additionalProperties":{ "type":"string" } } } }, "UsageMetricsRs.AdapterUsageMetricsRs":{ "type":"object", "properties":{ "adapter-count":{ "$ref":"#/components/schemas/UsageMetricsRs.AdapterCountRs" } } }, "UsageMetricsRs.AgentUsageMetricsRs":{ "type":"object", "properties":{ "total-agents":{ "type":"integer", "format":"int32" }, "number-of-down-agents":{ "type":"integer", "format":"int32" }, "count-agent-groups":{ "type":"integer", "format":"int32" }, "count-conn-agents":{ "type":"integer", "format":"int32" }, "count-exec-agents":{ "type":"integer", "format":"int32" }, "agents-by-group":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } } } }, "UsageMetricsRs.AppInstanceUsageMetricsBaseRs":{ "type":"object", "properties":{ "total":{ "type":"integer", "format":"int64" }, "in-progress":{ "type":"integer", "format":"int64" }, "configured":{ "type":"integer", "format":"int64" }, "active":{ "type":"integer", "format":"int64" } } }, "UsageMetricsRs.AppInstanceUsageMetricsRs":{ "allOf":[ { "$ref":"#/components/schemas/UsageMetricsRs.AppInstanceUsageMetricsBaseRs" }, { "type":"object", "properties":{ "used":{ "type":"integer", "format":"int64" }, "typeNumbers":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } }, "typeNumbersArray":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } } } } ] }, "UsageMetricsRs.DVMUsageMetricsBaseRs":{ "type":"object", "properties":{ "total":{ "type":"integer", "format":"int64" } } }, "UsageMetricsRs.DVMUsageMetricsRs":{ "allOf":[ { "$ref":"#/components/schemas/UsageMetricsRs.DVMUsageMetricsBaseRs" }, { "type":"object", "properties":{ "numberInUse":{ "type":"integer", "format":"int64" } } } ] }, "UsageMetricsRs.IntegrationDesignMetricsRs":{ "type":"object", "properties":{ "styles":{ "type":"array", "items":{ "$ref":"#/components/schemas/UsageMetricsRs.IntegrationMetricsStyleRs" } } } }, "UsageMetricsRs.IntegrationMetricsStyleRs":{ "type":"object", "properties":{ "patterns":{ "type":"array", "items":{ "$ref":"#/components/schemas/UsageMetricsRs.IntegrationPatternItemRs" } }, "total":{ "type":"integer", "format":"int32" }, "name":{ "type":"string" } } }, "UsageMetricsRs.IntegrationPatternItemRs":{ "type":"object", "properties":{ "name":{ "type":"string" }, "active":{ "type":"integer", "format":"int32" }, "configured":{ "type":"integer", "format":"int32" }, "draft":{ "type":"integer", "format":"int32" }, "failed":{ "type":"integer", "format":"int32" }, "total":{ "type":"integer", "format":"int32" } } }, "UsageMetricsRs.IntegrationStateMetricsRs":{ "type":"object", "properties":{ "active-integration-count":{ "type":"integer", "format":"int32" }, "activation-in-progress-count":{ "type":"integer", "format":"int32" }, "total-count":{ "type":"integer", "format":"int32" } } }, "UsageMetricsRs.IntegrationUsageMetricsBaseRs":{ "type":"object", "properties":{ "total":{ "type":"integer", "format":"int64" }, "in-progress":{ "type":"integer", "format":"int64" }, "configured":{ "type":"integer", "format":"int64" }, "activated":{ "type":"integer", "format":"int64" }, "failed-activation":{ "type":"integer", "format":"int64" }, "active-app-instance":{ "type":"integer", "format":"int64" } } }, "UsageMetricsRs.IntegrationUsageMetricsRs":{ "allOf":[ { "$ref":"#/components/schemas/UsageMetricsRs.IntegrationUsageMetricsBaseRs" }, { "type":"object", "properties":{ "intgStyles":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } }, "activedMEPs":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } }, "activeMEPsArray":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } }, "numberOfMEPTypes":{ "type":"integer", "format":"int64" }, "integrationsByAdapters":{ "type":"object", "additionalProperties":{ "type":"integer", "format":"int32" } }, "integrationsByAdaptersArray":{ "type":"array", "items":{ "$ref":"#/components/schemas/Object" } }, "scheduledIntegrations":{ "$ref":"#/components/schemas/UsageMetricsRs.ScheduledIntegrationsMetricsRs" } } } ] }, "UsageMetricsRs.MessageMetricsRs":{ "type":"object", "properties":{ "debug-instances":{ "type":"integer", "format":"int64" }, "aborted":{ "type":"integer", "format":"int64" }, "total":{ "type":"integer", "format":"int64" }, "success":{ "type":"integer", "format":"int64" }, "failed":{ "type":"integer", "format":"int64" }, "audit-instances-count":{ "type":"integer", "format":"int64" }, "production-instances-count":{ "type":"integer", "format":"int64" }, "total-instances-by-updated-time":{ "type":"integer", "format":"int64" } } }, "UsageMetricsRs.MessageSystemUsageRs":{ "type":"object", "properties":{ "jms-count":{ "type":"integer", "format":"int32" }, "oms-count":{ "type":"integer", "format":"int32" } } }, "UsageMetricsRs.PackageUsageMetricsRs":{ "type":"object", "properties":{ "total":{ "type":"integer", "format":"int64" }, "pre-built":{ "type":"integer", "format":"int64" }, "non-pre-built":{ "type":"integer", "format":"int64" }, "developed":{ "type":"integer", "format":"int64" }, "business-accelerator":{ "type":"integer", "format":"int64" }, "technical-accelerator":{ "type":"integer", "format":"int64" }, "recipe":{ "type":"integer", "format":"int64" } } }, "UsageMetricsRs.ProjectStateMetricsRs":{ "type":"object", "properties":{ "active":{ "type":"integer", "format":"int32" }, "configured":{ "type":"integer", "format":"int32" }, "draft":{ "type":"integer", "format":"int32" } } }, "UsageMetricsRs.ProjectTypeMetricsRs":{ "type":"object", "properties":{ "xba":{ "type":"integer", "format":"int32" }, "developed":{ "type":"integer", "format":"int32" }, "recipe":{ "type":"integer", "format":"int32" }, "business-accelerator":{ "type":"integer", "format":"int32" } } }, "UsageMetricsRs.ScheduleUsageMetricsRs":{ "type":"object", "properties":{ "total":{ "type":"integer", "format":"int64" }, "in-use":{ "type":"integer", "format":"int64" }, "active":{ "type":"integer", "format":"int64" }, "stopped":{ "type":"integer", "format":"int64" } } }, "UsageMetricsRs.ScheduledIntegrationsMetricsRs":{ "type":"object", "properties":{ "running":{ "type":"integer", "format":"int64" }, "stopped":{ "type":"integer", "format":"int64" } } }, "UsageRs":{ "type":"object", "properties":{ "name":{ "type":"string", "description":"Resource Name" }, "links":{ "type":"array", "description":"Suite Link List", "items":{ "$ref":"#/components/schemas/SuiteLink" } }, "integration-usage":{ "type":"array", "description":"Integration Usage List", "items":{ "$ref":"#/components/schemas/IntegrationUsageRs" } }, "connection-usage":{ "type":"array", "description":"Connection Usage List", "items":{ "$ref":"#/components/schemas/ConnectionUsageRs" } }, "project-id":{ "type":"string" } } }, "UserRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "id":{ "type":"string" }, "userName":{ "type":"string" }, "userDisplayName":{ "type":"string" }, "userEmailAddress":{ "type":"string" }, "userRoles":{ "type":"array", "items":{ "type":"string" } }, "properties":{ "type":"array", "items":{ "$ref":"#/components/schemas/SessionPropertyRs" } }, "userGroups":{ "type":"array", "items":{ "$ref":"#/components/schemas/GroupRs" } } } } ] }, "Void":{ "type":"object" }, "WaitRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "waitExpression":{ "$ref":"#/components/schemas/ExpressionBuilderRs" } } } ] }, "WhileRs":{ "allOf":[ { "$ref":"#/components/schemas/ActivityRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "description":{ "type":"string" }, "expression":{ "$ref":"#/components/schemas/ExpressionBuilderRs" } } } ] }, "AgreementUI":{ "allOf":[ { "$ref":"#/components/schemas/ViewModel" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "deployStatus":{ "type":"string" }, "direction":{ "type":"string" }, "agrID":{ "type":"string" }, "tpId":{ "type":"string" }, "docId":{ "type":"string" }, "agrName":{ "type":"string" } } } ] }, "BusinessIdentifierUI":{ "type":"object", "properties":{ "bizIdName1":{ "type":"string" }, "bizIdXpath1":{ "type":"string" }, "bizIdName2":{ "type":"string" }, "bizIdXpath2":{ "type":"string" }, "bizIdName3":{ "type":"string" }, "bizIdXpath3":{ "type":"string" } } }, "BusinessMessageBasicRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "resubmitStatus":{ "type":"string" }, "resubmitParentId":{ "type":"string" }, "resubmitSystemNotation":{ "type":"string" }, "applicationMessageId":{ "type":"string" }, "identifiers":{ "type":"object", "additionalProperties":{ "type":"string" } }, "state":{ "type":"string" }, "direction":{ "type":"string" }, "tradingPartner":{ "type":"string" }, "creationDate":{ "type":"string" }, "updatedDate":{ "type":"string" }, "updatedBy":{ "type":"string" }, "messageType":{ "type":"string" }, "errorCode":{ "type":"string" }, "errorSummary":{ "type":"string" }, "errorDetail":{ "type":"string" }, "referenceToId":{ "type":"string" }, "userDefinedId":{ "type":"string" }, "documentType":{ "type":"string" }, "payloadName":{ "type":"string" }, "canonicalPayloadId":{ "type":"string" }, "b2bPayloadId":{ "type":"string" }, "canonicalPayloadSize":{ "type":"string" }, "b2bPayloadSize":{ "type":"string" }, "createdBy":{ "type":"string" }, "wireMessageId":{ "type":"string" }, "documentStandard":{ "type":"string" }, "documentVersion":{ "type":"string" }, "documentId":{ "type":"string" }, "delimiter":{ "type":"string" }, "instanceId":{ "type":"string" }, "pipId":{ "type":"string" }, "refToCollab":{ "type":"string" }, "resubmitType":{ "type":"string" }, "resubmittable":{ "type":"boolean" }, "resubmitErrorCode":{ "type":"string" }, "projectCode":{ "type":"string" } } } ] }, "BusinessMessageRs":{ "allOf":[ { "$ref":"#/components/schemas/BusinessMessageBasicRs" }, { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "transportProperties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "processingResults":{ "type":"array", "items":{ "type":"string" } }, "payload":{ "$ref":"#/components/schemas/BusinessMessageRs.Payload" }, "correlatedMessages":{ "type":"array", "items":{ "$ref":"#/components/schemas/BusinessMessageRs.CorrelatedMessage" } } } } ] }, "BusinessMessageRs.CorrelatedMessage":{ "required":[ "count", "label" ], "type":"object", "properties":{ "label":{ "type":"string" }, "count":{ "type":"integer", "format":"int32" } } }, "BusinessMessageRs.Payload":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/SuiteLink" } } } }, "BusinessMessagesRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/BusinessMessageRs" } }, "totalResults":{ "type":"integer", "format":"int32" }, "totalRecordsCount":{ "type":"integer", "format":"int32" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int32" }, "dataFetchTime":{ "type":"string", "format":"date-time" } } } ] }, "CodeUI":{ "type":"object", "properties":{ "c":{ "type":"string" }, "d":{ "type":"string" }, "n":{ "type":"string" }, "r":{ "type":"boolean" } } }, "CodesPartitionUI":{ "type":"object", "properties":{ "codes":{ "type":"array", "items":{ "$ref":"#/components/schemas/CodeUI" } } } }, "CompositeUI":{ "allOf":[ { "$ref":"#/components/schemas/DocumentModelUI" }, { "type":"object", "properties":{ "elem":{ "type":"string" }, "type":{ "type":"string" }, "min":{ "type":"integer", "format":"int32" }, "max":{ "type":"integer", "format":"int32" }, "synRl":{ "type":"array", "items":{ "$ref":"#/components/schemas/SyntaxRuleUI" } } } } ] }, "ContactRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "id":{ "type":"string" }, "contactType":{ "type":"string" }, "contactValue":{ "type":"string" } } } ] }, "ContactsRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ContactRs" } } } } ] }, "ControlNumbers":{ "type":"object", "properties":{ "interchangeControlNumberStart":{ "type":"string" }, "groupControlNumberStart":{ "type":"string" }, "transactionControlNumberStart":{ "type":"string" } } }, "DeployUndeployRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "responseStatus":{ "$ref":"#/components/schemas/ResponseStatus" } } } ] }, "DocumentModelUI":{ "type":"object", "properties":{ "objId":{ "type":"string" }, "name":{ "type":"string" }, "req":{ "type":"string" }, "purpose":{ "type":"string" }, "objType":{ "type":"string" }, "rptCnt":{ "type":"string" }, "usage":{ "type":"string" }, "msk":{ "type":"boolean" }, "posNo":{ "type":"string" }, "notes":{ "type":"string" }, "r":{ "type":"boolean" }, "cmnts":{ "type":"string" }, "var":{ "type":"integer", "format":"int32" } }, "discriminator":{ "propertyName":"objType", "mapping":{ "CELMS":"#/components/schemas/ElementUI", "SEGS":"#/components/schemas/SegmentUI", "SEG_LOOP":"#/components/schemas/SegLoopUI", "ELMS":"#/components/schemas/ElementUI", "COMS":"#/components/schemas/CompositeUI" } }, "oneOf":[ { "$ref":"#/components/schemas/SegmentUI" }, { "$ref":"#/components/schemas/SegLoopUI" }, { "$ref":"#/components/schemas/ElementUI" }, { "$ref":"#/components/schemas/ElementUI" }, { "$ref":"#/components/schemas/CompositeUI" } ] }, "DocumentNode":{ "required":[ "attr", "children" ], "type":"object", "properties":{ "attr":{ "$ref":"#/components/schemas/DocumentModelUI" }, "children":{ "type":"array", "items":{ "$ref":"#/components/schemas/DocumentNode" } } } }, "DocumentTypeUI":{ "required":[ "desc", "txId" ], "type":"object", "properties":{ "desc":{ "type":"string" }, "txId":{ "type":"string" } } }, "DocumentUI":{ "allOf":[ { "$ref":"#/components/schemas/ViewModel" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "activeAgr":{ "type":"array", "items":{ "$ref":"#/components/schemas/AgreementUI" } }, "inActiveAgr":{ "type":"array", "items":{ "$ref":"#/components/schemas/AgreementUI" } }, "parameters":{ "type":"string" }, "businessIdentifiers":{ "$ref":"#/components/schemas/BusinessIdentifierUI" }, "partnerCnt":{ "type":"integer", "format":"int32" }, "schema":{ "type":"string" }, "state":{ "type":"string" }, "schemaName":{ "type":"string" }, "active":{ "type":"array", "items":{ "$ref":"#/components/schemas/IntegrationResourceUI" } }, "inActive":{ "type":"array", "items":{ "$ref":"#/components/schemas/IntegrationResourceUI" } } } } ] }, "DocumentsUI":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/DocumentUI" } }, "size":{ "type":"integer", "format":"int32" } } } ] }, "ElementUI":{ "allOf":[ { "$ref":"#/components/schemas/DocumentModelUI" }, { "type":"object", "properties":{ "type":{ "type":"string" }, "min":{ "type":"integer", "format":"int32" }, "max":{ "type":"integer", "format":"int32" }, "elem":{ "type":"string" }, "part":{ "type":"array", "items":{ "$ref":"#/components/schemas/CodesPartitionUI" } }, "codeId":{ "type":"string" }, "ln":{ "type":"integer", "format":"int32" } } } ] }, "Error":{ "type":"object", "properties":{ "code":{ "type":"string" }, "category":{ "type":"string" }, "summary":{ "type":"string" }, "location":{ "type":"string" } } }, "ErrorGroupRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "usage":{ "type":"integer", "format":"int32" }, "desc":{ "type":"string" }, "updatedDate":{ "type":"string" }, "createdDate":{ "type":"string" }, "id":{ "type":"string" }, "name":{ "type":"string" }, "tradingPartnerId":{ "type":"string" }, "errorCodes":{ "type":"array", "items":{ "type":"string" } } } } ] }, "ErrorGroupsRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "required":[ "partnerId" ], "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/ErrorGroupRs" } }, "size":{ "type":"integer", "format":"int32" }, "partnerId":{ "type":"string" } } } ] }, "HeaderProperty":{ "type":"object", "properties":{ "name":{ "type":"string" }, "value":{ "type":"string" } } }, "Headers":{ "type":"object", "properties":{ "properties":{ "type":"array", "items":{ "$ref":"#/components/schemas/HeaderProperty" } } } }, "HostIdentifierRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "id":{ "type":"string" }, "identifierType":{ "type":"string" }, "identifierValue":{ "type":"string" } } } ] }, "HostIdentifiersRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/HostIdentifierRs" } }, "name":{ "type":"string" }, "supported_identifiers_types":{ "type":"array", "items":{ "$ref":"#/components/schemas/HostIdentifiersRs.IdentifierSuggestions" } } } } ] }, "HostIdentifiersRs.IdentifierSuggestions":{ "type":"object", "properties":{ "label":{ "type":"string" }, "type":{ "type":"string" }, "desc":{ "type":"string" } } }, "IdentifierRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "id":{ "type":"string" }, "identifierType":{ "type":"string" }, "identifierValue":{ "type":"string" } } } ] }, "IdentifiersRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/IdentifierRs" } }, "supported_identifiers_types":{ "type":"array", "items":{ "$ref":"#/components/schemas/IdentifiersRs.IdentifierSuggestions" } } } } ] }, "IdentifiersRs.IdentifierSuggestions":{ "type":"object", "properties":{ "label":{ "type":"string" }, "type":{ "type":"string" }, "desc":{ "type":"string" } } }, "ImportDocRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "required":[ "documents", "schemas" ], "type":"object", "properties":{ "documents":{ "type":"array", "items":{ "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus" } }, "schemas":{ "type":"array", "items":{ "$ref":"#/components/schemas/ImportDocRs.ImportDocStatus" } } } } ] }, "ImportDocRs.ImportDocStatus":{ "required":[ "id", "name", "status" ], "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "status":{ "type":"string" } } }, "ImportOption":{ "type":"object", "properties":{ "debug":{ "type":"string" }, "showDescription":{ "type":"string" }, "description":{ "type":"string" }, "schemaPrefix":{ "type":"string" }, "documentPrefix":{ "type":"string" }, "filter":{ "$ref":"#/components/schemas/ImportOption.Filter" } } }, "ImportOption.Attribute":{ "type":"object", "properties":{ "tpId":{ "type":"array", "items":{ "type":"string" } }, "tpa":{ "type":"array", "items":{ "type":"string" } } } }, "ImportOption.Filter":{ "type":"object", "properties":{ "exclude":{ "$ref":"#/components/schemas/ImportOption.Attribute" }, "include":{ "$ref":"#/components/schemas/ImportOption.Attribute" } } }, "InputStream":{ "type":"object" }, "ImportTPRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "required":[ "documents", "hostIdentifiers", "schemas" ], "type":"object", "properties":{ "tradingPartner":{ "type":"array", "items":{ "$ref":"#/components/schemas/ImportTPRs.ImportStatus" } }, "documents":{ "type":"array", "items":{ "$ref":"#/components/schemas/ImportTPRs.ImportStatus" } }, "schemas":{ "type":"array", "items":{ "$ref":"#/components/schemas/ImportTPRs.ImportStatus" } }, "hostIdentifiers":{ "type":"array", "items":{ "$ref":"#/components/schemas/ImportTPRs.ImportStatus" } } } } ] }, "ImportTPRs.ImportStatus":{ "required":[ "id", "name", "status" ], "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "status":{ "type":"string" } } }, "InboundAgr.Params":{ "type":"object", "properties":{ "acceptGroupName":{ "type":"string" }, "rejectGroupName":{ "type":"string" }, "validate":{ "type":"boolean", "description":"Gets the value of the validate property.\n \n possible object is\n Boolean" }, "fa":{ "type":"boolean", "description":"Gets the value of the fa property.\n \n possible object is\n Boolean" }, "duplicateCtrlNumCheck":{ "type":"boolean", "description":"Gets the value of the duplicateCtrlNumCheck property.\n \n possible object is\n Boolean" }, "acceptGroup":{ "type":"string" }, "rejectGroup":{ "type":"string" } } }, "InboundAgrRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "desc":{ "type":"string" }, "docStd":{ "type":"string" }, "docVersion":{ "type":"string" }, "docTxId":{ "type":"string" }, "docDef":{ "type":"string" }, "docId":{ "type":"string" }, "status":{ "type":"string" }, "createdDate":{ "type":"string" }, "lastDeployed":{ "type":"string" }, "updatedDate":{ "type":"string" }, "backendIntgName":{ "type":"string" }, "backendIntgCode":{ "type":"string" }, "backendIntgVersion":{ "type":"string" }, "backendIntgProjectcode":{ "type":"string" }, "warning":{ "type":"array", "items":{ "type":"string" } }, "params":{ "$ref":"#/components/schemas/InboundAgr.Params" }, "tpmVerson":{ "type":"string" } } } ] }, "InboundAgrsRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/InboundAgrRs" } }, "size":{ "type":"integer", "format":"int32" } } } ] }, "IntegrationResourceUI":{ "allOf":[ { "$ref":"#/components/schemas/ViewModel" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "id":{ "type":"string" }, "status":{ "type":"string" }, "version":{ "type":"string" } } } ] }, "MaxSize":{ "type":"object", "properties":{ "purpose":{ "type":"integer", "format":"int32" }, "notes":{ "type":"integer", "format":"int32" }, "steps":{ "type":"integer", "format":"int32" }, "cmnts":{ "type":"integer", "format":"int32" }, "desc":{ "type":"integer", "format":"int32" }, "txt":{ "type":"integer", "format":"int32" }, "ver":{ "type":"number", "format":"float" }, "pos":{ "type":"boolean" } } }, "OutboundAgr.Params":{ "type":"object", "properties":{ "validate":{ "type":"boolean", "description":"Gets the value of the validate property.\n \n possible object is\n Boolean" }, "fa":{ "type":"boolean", "description":"Gets the value of the fa property.\n \n possible object is\n Boolean" }, "acceptGroup":{ "type":"string" }, "rejectGroup":{ "type":"string" }, "acceptGroupName":{ "type":"string" }, "rejectGroupName":{ "type":"string" } } }, "OutboundAgr.Schedule":{ "type":"object", "properties":{ "name":{ "type":"string" }, "startDate":{ "type":"string" }, "endDate":{ "type":"string" }, "scheduleTZDisplayName":{ "type":"string" }, "scheduleTZ":{ "type":"string" }, "frequency":{ "$ref":"#/components/schemas/OutboundAgr.Schedule.Frequency" } } }, "OutboundAgr.Schedule.Frequency":{ "type":"object", "properties":{ "frequencyType":{ "type":"string" }, "interval":{ "type":"string" } } }, "OutboundAgrRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "desc":{ "type":"string" }, "docStd":{ "type":"string" }, "docVersion":{ "type":"string" }, "docTxId":{ "type":"string" }, "docDef":{ "type":"string" }, "docId":{ "type":"string" }, "status":{ "type":"string" }, "createdDate":{ "type":"string" }, "lastDeployed":{ "type":"string" }, "updatedDate":{ "type":"string" }, "tpIdentifiersRef":{ "type":"array", "items":{ "$ref":"#/components/schemas/IdentifierRs" } }, "hostIdentifiersRef":{ "type":"array", "items":{ "$ref":"#/components/schemas/HostIdentifierRs" } }, "transportName":{ "type":"string" }, "params":{ "$ref":"#/components/schemas/OutboundAgr.Params" }, "transportId":{ "type":"string" }, "tpmVerson":{ "type":"string" }, "batchEnabled":{ "type":"string" }, "scheduleOperation":{ "type":"string" }, "schedule":{ "$ref":"#/components/schemas/OutboundAgr.Schedule" } } } ] }, "OutboundAgrsRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/OutboundAgrRs" } }, "size":{ "type":"integer", "format":"int32" } } } ] }, "PayloadRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "content":{ "type":"string" }, "truncated":{ "type":"boolean" }, "title":{ "type":"string" } } } ] }, "ProcessingReport":{ "type":"object", "properties":{ "tpId":{ "type":"string" }, "tpName":{ "type":"string" }, "artifacts":{ "$ref":"#/components/schemas/ProcessingReport.State" }, "status":{ "type":"string" }, "summary":{ "type":"string" } } }, "ProcessingReport.State":{ "type":"object", "properties":{ "transport":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProcessingReport.Status" } }, "inboundAgreement":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProcessingReport.Status" } }, "outboundAgreement":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProcessingReport.Status" } }, "document":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProcessingReport.Status" } }, "schema":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProcessingReport.Status" } }, "hostIdentifier":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProcessingReport.Status" } }, "error":{ "type":"array", "items":{ "$ref":"#/components/schemas/Error" } }, "ignoredAgreement":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProcessingReport.Status" } } } }, "ProcessingReport.Status":{ "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "status":{ "type":"string" }, "reason":{ "type":"string" } } }, "ResponseStatus":{ "type":"object", "properties":{ "msg":{ "type":"array", "description":"Gets the value of the msg property.\n \n \n This accessor method returns a reference to the live list,\n not a snapshot. Therefore any modification you make to the\n returned list will be present inside the JAXB object.\n This is why there is not a set method for the msg property.\n \n \n For example, to add a new item, do as follows:\n \n getMsg().add(newItem);\n \n \n \n \n Objects of the following type(s) are allowed in the list\n String", "items":{ "type":"string" } }, "status":{ "type":"string", "description":"Gets the value of the status property.\n \n possible object is\n String" }, "code":{ "type":"string", "description":"Gets the value of the code property.\n \n possible object is\n String" } } }, "ResubmitReq":{ "type":"object", "properties":{ "resubmitType":{ "type":"string" }, "messageType":{ "type":"string" }, "direction":{ "type":"string" }, "wireMessageId":{ "type":"string" }, "instanceId":{ "type":"string" }, "flowCodeBarVersion":{ "type":"string" } } }, "RoutingInfo":{ "type":"object", "properties":{ "docType":{ "type":"string" }, "docVersion":{ "type":"string" }, "docDefintion":{ "type":"string" }, "icsenderIdQualifier":{ "type":"string" }, "icSenderId":{ "type":"string" }, "icReceiverIdQualifier":{ "type":"string" }, "icReceiverId":{ "type":"string" }, "icControlNumber":{ "type":"string" }, "grpIdenfierId":{ "type":"string" }, "grpApplicationSenderCode":{ "type":"string" }, "grpApplicationRecieverCode":{ "type":"string" }, "grpControlNumber":{ "type":"string" }, "txnControlNumber":{ "type":"string" }, "segDelimiter":{ "type":"string" }, "elemDelimiter":{ "type":"string" }, "compositeDelimiter":{ "type":"string" }, "repetitionDelimiter":{ "type":"string" } } }, "SchemaUI":{ "allOf":[ { "$ref":"#/components/schemas/ViewModel" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "segmentDelimiter":{ "type":"string" }, "elementDelimiter":{ "type":"string" }, "activeAgr":{ "type":"array", "items":{ "$ref":"#/components/schemas/AgreementUI" } }, "inActiveAgr":{ "type":"array", "items":{ "$ref":"#/components/schemas/AgreementUI" } }, "docNode":{ "type":"array", "items":{ "$ref":"#/components/schemas/DocumentNode" } }, "state":{ "type":"string" }, "active":{ "type":"array", "items":{ "$ref":"#/components/schemas/DocumentUI" } }, "inActive":{ "type":"array", "items":{ "$ref":"#/components/schemas/DocumentUI" } }, "maxSize":{ "$ref":"#/components/schemas/MaxSize" }, "parameters":{ "type":"string" }, "chars":{ "type":"integer", "format":"int32" }, "encoding":{ "type":"string" } } } ] }, "SchemasUI":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/SchemaUI" } }, "size":{ "type":"integer", "format":"int32" } } } ] }, "SegLoopUI":{ "allOf":[ { "$ref":"#/components/schemas/DocumentModelUI" }, { "type":"object", "properties":{ "tableArea":{ "type":"string" } } } ] }, "SegmentUI":{ "allOf":[ { "$ref":"#/components/schemas/DocumentModelUI" }, { "type":"object", "properties":{ "tableArea":{ "type":"string" }, "synRl":{ "type":"array", "items":{ "$ref":"#/components/schemas/SyntaxRuleUI" } } } } ] }, "SyntaxRuleUI":{ "type":"object", "properties":{ "elems":{ "type":"array", "items":{ "type":"string" } }, "rule":{ "type":"string" }, "r":{ "type":"boolean" } } }, "TPMigrationImportRestResponse":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "required":[ "option", "response" ], "type":"object", "properties":{ "response":{ "type":"array", "items":{ "$ref":"#/components/schemas/TPMigrationService.ServiceResponse" } }, "option":{ "$ref":"#/components/schemas/ImportOption" } } } ] }, "TPMigrationService.ServiceResponse":{ "required":[ "importStatus", "report" ], "type":"object", "properties":{ "importStatus":{ "type":"string" }, "report":{ "type":"array", "items":{ "$ref":"#/components/schemas/ProcessingReport" } }, "zipfileName":{ "type":"string" }, "_execution":{ "$ref":"#/components/schemas/TPMigrationService.Summary" } } }, "TPMigrationService.Summary":{ "type":"object", "properties":{ "noOfTransportImported":{ "type":"string" }, "noOfInboundAgreementImported":{ "type":"string" }, "noOfOutboundAgreementImported":{ "type":"string" }, "noOfDocumentImported":{ "type":"string" }, "noOfSchemaImported":{ "type":"string" }, "parseTimeInMillis":{ "type":"integer", "format":"int64" }, "importTimeInMillis":{ "type":"integer", "format":"int64" }, "totalTimeInMillis":{ "type":"integer", "format":"int64" } } }, "Tags":{ "type":"object", "properties":{ "tag":{ "type":"array", "description":"Gets the value of the tag property.\n \n \n This accessor method returns a reference to the live list,\n not a snapshot. Therefore any modification you make to the\n returned list will be present inside the JAXB object.\n This is why there is not a set method for the tag property.\n \n \n For example, to add a new item, do as follows:\n \n getTag().add(newItem);\n \n \n \n \n Objects of the following type(s) are allowed in the list\n String", "items":{ "type":"string" } } } }, "TradingPartnerRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "desc":{ "type":"string" }, "status":{ "type":"string" }, "inboundAgreementCount":{ "type":"integer" }, "outboundAgreementCount":{ "type":"integer" }, "tags":{ "$ref":"#/components/schemas/Tags" }, "createdBy":{ "type":"string" }, "createdDate":{ "type":"string" }, "updatedBy":{ "type":"string" }, "updatedDate":{ "type":"string" }, "inboundActiveAgreementCount":{ "type":"integer" }, "outboundActiveAgreementCount":{ "type":"integer" }, "deployedTransportCount":{ "type":"integer" }, "activatedTransportIntgCount":{ "type":"integer" } } } ] }, "TradingPartnersRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/TradingPartnerRs" } }, "size":{ "type":"integer", "format":"int32" } } } ] }, "TranslationInput":{ "type":"object", "properties":{ "validationError":{ "$ref":"#/components/schemas/ValidationErrors" }, "useCachedSchema":{ "type":"boolean" }, "inputSourceContent":{ "type":"string" }, "routingInfo":{ "$ref":"#/components/schemas/RoutingInfo" }, "acceptedErrors":{ "type":"string" }, "rejectedErrors":{ "type":"string" }, "encoding":{ "type":"string" }, "functionalAckRequired":{ "type":"boolean" }, "trackingInfo":{ "type":"string" }, "icControlNum":{ "type":"string" }, "grpControlNum":{ "type":"string" }, "txnControlNum":{ "type":"string" }, "icSender":{ "type":"string" }, "icReceiver":{ "type":"string" }, "transactionIdx":{ "type":"integer", "format":"int32" }, "transactionCount":{ "type":"integer", "format":"int32" }, "validationRequired":{ "type":"boolean" }, "overrideLogging":{ "type":"boolean" }, "headers":{ "$ref":"#/components/schemas/Headers" }, "payload":{ "type":"string" } } }, "TransportIntegrations":{ "type":"object", "properties":{ "integrationNamePrefix":{ "type":"string" }, "integrationIdentifierPrefix":{ "type":"string" }, "sendIntegration":{ "$ref":"#/components/schemas/TransportIntegrations.Integration" }, "receivedIntegration":{ "$ref":"#/components/schemas/TransportIntegrations.Integration" } } }, "TransportIntegrations.Integration":{ "type":"object", "properties":{ "name":{ "type":"string" }, "state":{ "type":"string" }, "reason":{ "type":"string" }, "code":{ "type":"string" }, "version":{ "type":"string" }, "scheduleDefined":{ "type":"boolean" } } }, "TransportParams.Params":{ "type":"object", "properties":{ "param":{ "type":"array", "description":"Gets the value of the param property.\n \n \n This accessor method returns a reference to the live list,\n not a snapshot. Therefore any modification you make to the\n returned list will be present inside the JAXB object.\n This is why there is not a set method for the param property.\n \n \n For example, to add a new item, do as follows:\n \n getParam().add(newItem);\n \n \n \n \n Objects of the following type(s) are allowed in the list\n Transport.Params.Param", "items":{ "$ref":"#/components/schemas/TransportParams.Params.Param" } } } }, "TransportParams.Params.Param":{ "type":"object", "properties":{ "value":{ "type":"string", "description":"Gets the value of the value property.\n \n possible object is\n String" }, "name":{ "type":"string", "description":"Gets the value of the type property.\n \n possible object is\n String" } } }, "TransportRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "id":{ "type":"string" }, "name":{ "type":"string" }, "desc":{ "type":"string" }, "transportType":{ "type":"string" }, "connectionId":{ "type":"string" }, "connectionName":{ "type":"string" }, "direction":{ "type":"string" }, "updatedBy":{ "type":"string" }, "createdBy":{ "type":"string" }, "deployedBy":{ "type":"string" }, "status":{ "type":"string" }, "createdDate":{ "type":"string" }, "deployedDate":{ "type":"string" }, "updatedDate":{ "type":"string" }, "characterEncoding":{ "type":"string" }, "params":{ "$ref":"#/components/schemas/TransportParams.Params" }, "tradingPartnerId":{ "type":"string" }, "b2bIntegrations":{ "$ref":"#/components/schemas/TransportIntegrations" } } } ] }, "TransportsRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "required":[ "partnerId" ], "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/TransportRs" } }, "size":{ "type":"integer", "format":"int32" }, "partnerId":{ "type":"string" } } } ] }, "ValidationErrors":{ "type":"object", "properties":{ "validationErrorReport":{ "type":"string" }, "error":{ "type":"array", "items":{ "$ref":"#/components/schemas/Error" } } } }, "ViewModel":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "name":{ "type":"string" }, "createdBy":{ "type":"string" }, "updatedBy":{ "type":"string" }, "createdDate":{ "type":"string" }, "updatedDate":{ "type":"string" }, "txName":{ "type":"string" }, "id":{ "type":"string" }, "txId":{ "type":"string" }, "std":{ "type":"string" }, "version":{ "type":"string" }, "desc":{ "type":"string" }, "count":{ "type":"integer", "format":"int32" } } } ] }, "WireMessageBasicRs":{ "allOf":[ { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "state":{ "type":"string" }, "transportProtocol":{ "type":"string" }, "url":{ "type":"string" }, "protocolMessageId":{ "type":"string" }, "resubmitStatus":{ "type":"string" }, "resubmitCount":{ "type":"integer", "format":"int32" }, "direction":{ "type":"string" }, "tradingPartner":{ "type":"string" }, "source":{ "type":"string" }, "creationDate":{ "type":"string" }, "payloadName":{ "type":"string" }, "messageType":{ "type":"string" }, "userDefinedId":{ "type":"string" }, "instanceId":{ "type":"string" }, "errorCode":{ "type":"string" }, "errorSummary":{ "type":"string" }, "errorDetail":{ "type":"string" }, "referenceToId":{ "type":"string" }, "updatedDate":{ "type":"string" }, "updatedBy":{ "type":"string" }, "packedPayloadId":{ "type":"string" }, "packedPayloadSize":{ "type":"string" }, "unpackedPayloadId":{ "type":"string" }, "unpackedPayloadSize":{ "type":"string" }, "createdBy":{ "type":"string" }, "ackState":{ "type":"string" }, "transportName":{ "type":"string" }, "resubmitParentId":{ "type":"string" }, "resubmitSystemNotation":{ "type":"string" }, "comments":{ "type":"string" }, "resubmitType":{ "type":"string" }, "projectCode":{ "type":"string" }, "resubmittable":{ "type":"boolean" }, "resubmitErrorCode":{ "type":"string" } } } ] }, "WireMessageRs":{ "allOf":[ { "$ref":"#/components/schemas/WireMessageBasicRs" }, { "$ref":"#/components/schemas/IdRs" }, { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "transportProperties":{ "type":"object", "additionalProperties":{ "type":"string" } }, "processingResults":{ "type":"array", "items":{ "type":"string" } }, "payload":{ "$ref":"#/components/schemas/WireMessageRs.Payload" }, "correlatedMessages":{ "type":"array", "items":{ "$ref":"#/components/schemas/WireMessageRs.CorrelatedMessage" } } } } ] }, "WireMessageRs.CorrelatedMessage":{ "required":[ "count", "label" ], "type":"object", "properties":{ "label":{ "type":"string" }, "count":{ "type":"integer", "format":"int32" } } }, "WireMessageRs.Payload":{ "type":"object", "properties":{ "links":{ "type":"array", "items":{ "$ref":"#/components/schemas/SuiteLink" } } } }, "WireMessagesRs":{ "allOf":[ { "$ref":"#/components/schemas/GenericRestRs" }, { "type":"object", "properties":{ "items":{ "type":"array", "items":{ "$ref":"#/components/schemas/WireMessageRs" } }, "totalResults":{ "type":"integer", "format":"int32" }, "hasMore":{ "type":"boolean" }, "limit":{ "type":"integer", "format":"int32" }, "dataFetchTime":{ "type":"string", "format":"date-time" }, "totalRecordsCount":{ "type":"integer", "format":"int32" } } } ] } } } }