Submit the source and target fields of a transformation to have mappings between them generated\nfor you. The request is processed asynchronously: a successful response returns the request's unique\nidentifier rather than the mappings themselves.
\nTo retrieve the generated mappings, see\nGet an AI-assisted mapping request.
\nmicro_integrations:*:* ]","operationId":"submitToAiAssistant","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AiAssistant"}}},"required":true},"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AiAssistantResponseDTO","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrations/aiAssistant/{id}":{"get":{"tags":["Micro-Integration AI Assistant"],"summary":"(Beta) Get an AI-assisted mapping request","description":"Get an AI-assisted mapping request using its unique identifier. While the request is still being\nprocessed the response reports its state; once processing is complete the response also contains the\ngenerated mappings.
\nmicro_integrations:get:* ]","operationId":"retrieveAiAssistantResponse","parameters":[{"name":"id","in":"path","description":"The unique identifier of the AI-assisted mapping request.","required":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/AiAssistantResponseDTO","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrationCategories":{"get":{"tags":["Micro-Integration Types"],"summary":"(Beta) Get a list of micro-integration categories","description":"Use this API to get a list of available micro-integration categories.micro_integrations:get:* ]","operationId":"getMicroIntegrationCategories","responses":{"200":{"description":"A list of micro-integration categories.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ResponseListString"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrationTypes":{"get":{"tags":["Micro-Integration Types"],"summary":"(Beta) Get a list of Micro-Integration types","description":"Get a listing of Micro-Integration types that are available in the account that match the specified criteria such as the name, direction, and category.micro_integrations:get:* or micro_integration_types:get:* ]","operationId":"getMicroIntegrationTypes","parameters":[{"name":"nameContains","in":"query","description":"The full or partial name of the Micro-Integration types that you can use to filter the query results.\n For example, you can use:
\nIBMAmazongcppubsubaThe direction specifies whether the Micro-Integration is a source or target that you can use to filter the query results. The directions are:
source-A source Micro-Integration is where data flows from the event broker service through the Micro-Integration to the external system.target-A target Micro-Integration is where data flows from the external system through the Micro-Integration to the event broker service.Messaging/Eventing that you can use to filter the query results.","required":false,"schema":{"type":"string","default":""}},{"name":"pageNumber","in":"query","description":"The page number to retrieve.","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"name":"pageSize","in":"query","description":"The number of Micro-Integration types to return per page.","required":false,"schema":{"type":"integer","default":100,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationTypesResponse","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrationTypes/{id}":{"get":{"tags":["Micro-Integration Types"],"summary":"(Beta) Get a Micro-Integration type","description":"Get the details of a specific Micro-Integration type using its unique identifier.micro_integrations:get:* or micro_integration_types:get:* ]","operationId":"getMicroIntegrationType","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration type, such as awssns-target.","required":true,"schema":{"type":"string","default":""},"example":"awssns-target"}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationTypeResponse","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrationTypes/{id}/templates":{"get":{"tags":["Micro-Integration Types"],"summary":"(Beta) Get a list of Micro-Integration templates","description":"Get a list of Micro-Integration templates. Micro-Integration templates describe how to correctly provide configurationValues when you create or update a Micro-Integration.micro_integrations:get:* ]","operationId":"getMicroIntegrationTemplates","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration type, such as awssns-target.","required":true,"schema":{"type":"string","default":""},"example":"awssns-target"}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationTemplatesResponse","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrationTypes/{id}/transformationFunctions":{"get":{"tags":["Micro-Integration Types"],"summary":"(Beta) Get a list of Micro-Integration functions","description":"Get a list of Micro-Integration functions. The list describes the structure and purpose of each available function that is supported by the specified Micro-Integration type. You can specify id of a function as a value for the methodId object in the transformation property when you create or update a Micro-Integration.micro_integrations:get:* ]","operationId":"getMicroIntegrationFunctions","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration type, such as awssns-target.","required":true,"schema":{"type":"string","default":""},"example":"awssns-target"},{"name":"version","in":"query","description":"The version of the Micro-Integration type to get functions for, such as 1.0.0. When omitted, the functions supported by the latest version of the Micro-Integration type are returned.","required":false,"schema":{"type":"string","default":""},"example":"1.0.0"}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationFunctionsResponse","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrationFlows":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Get a list of Micro-Integration Flows","description":"Get a listing of Micro-Integration Flows that are available for the account (or organization). You can filter the list of Flows on matching criteria such as the Flow's name, state, and associated parent Micro-Integrationmicro_integrations:get:* ]","operationId":"getMicroIntegrationFlows","parameters":[{"name":"microIntegrationId","in":"query","description":"The unique identifier of the parent Micro-Integration that you can use to filter the query results.","required":false,"schema":{"type":"string","default":"","example":"mmxd33zro5c"}},{"name":"nameContains","in":"query","description":"The full or partial name of the Micro-Integration that you can use to filter the query results. For example, you can use:
\nIBMAmazongcppubsubaCreate a Micro-Integration Flow configuration.
\nYou must specify the Micro-Integration that the Flow will belong to,\n in addition to the configuration and connection details for the flow. Flows are created\n in 'notdeployed' state regardless of parent state for safe editing.
\nYou can also upload one or more files as required to supplement the configuration details mentioned above.\n To successfully upload files, you must supply the name of the file in the appropriate configuration field\n (for example, client-keystore.jks), and ensure that a file with the matching name is also supplied in the request
micro_integrations:*:* ]","operationId":"createMicroIntegrationFlow","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"microIntegrationFlow":{"$ref":"#/components/schemas/MicroIntegrationFlowCreationConfiguration"},"files":{"type":"array","description":"The files to be uploaded to use for client certificate authentication. The key store formats that are supported are JKS (Java KeyStore) and PKCS12.","items":{"type":"string","format":"binary"}}},"required":["microIntegrationFlow"]},"encoding":{"microIntegrationFlow":{"contentType":"application/json"}}}}},"responses":{"201":{"description":"Created.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationFlowResponse","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrationFlows/{id}":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Get a Micro-Integration Flow","description":"Get the details of a Micro-Integration Flow using its unique identifier.micro_integrations:get:* ]","operationId":"getMicroIntegrationFlow","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration Flow.","required":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationFlowResponse","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}},"delete":{"tags":["Micro-Integrations"],"summary":"(Beta) Delete a Micro-Integration Flow","description":"Delete a Micro-Integration Flow using its unique identifier. Flow must be in 'notdeployed' or 'error' state to delete.micro_integrations:*:* ]","operationId":"deleteMicroIntegrationFlow","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration Flow.","required":true,"schema":{"type":"string","default":""}}],"responses":{"204":{"description":"No content."},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}},"patch":{"tags":["Micro-Integrations"],"summary":"(Beta) Update a Micro-Integration Flow","description":"Update the configuration of an existing Micro-Integration Flow. You can provide any combination of supported fields. If a required field is not provided, then the Flow is not updated. This request fails if the specified Flow is not in a state of notdeployed or error. You can also upload one or more files needed to supplement the configuration details mentioned above.micro_integrations:*:* ]","operationId":"updateMicroIntegrationFlow","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration Flow.","required":true,"schema":{"type":"string","default":""}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"microIntegrationFlow":{"$ref":"#/components/schemas/MicroIntegrationFlowUpdateConfiguration"},"files":{"type":"array","description":"The files to be uploaded to use for client certificate authentication. The key store formats that are supported are JKS (Java KeyStore) and PKCS12.","items":{"type":"string","format":"binary"}}},"required":["microIntegrationFlow"]},"encoding":{"microIntegrationFlow":{"contentType":"application/json"}}}}},"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationFlowResponse","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrationFlows/{id}/realtimeMetrics":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Get realtime metrics for a Micro-Integration Flow","description":"Returns realtime Prometheus metrics for a Micro-Integration Flow. Returns status IN_PROGRESS while metrics are being collected, and COMPLETED with metric values once available.micro_integrations:get:* ]","operationId":"getRealtimeMetrics","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration Flow.","required":true,"schema":{"type":"string","default":""}},{"name":"includedNames","in":"query","description":"Comma-separated Prometheus metric names to include. If omitted, all metrics are returned.","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealtimeMetricsResponse"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrations":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Get a list of Micro-Integrations","description":"Get a listing of Micro-Integrations that are available for the account (or organization). You can filter the list of Micro-Integrations on matching criteria such as the Micro-Integration's name, state, and associated event broker servicemicro_integrations:get:* ]","operationId":"getMicroIntegrationsV2","parameters":[{"name":"nameContains","in":"query","description":"The full or partial name of the Micro-Integration that you can use to filter the query results. For example, you can use:
\nIBMAmazongcppubsubaThe states of the Micro-Integration that you can use to filter the query results. You can filter the results using the following states:
\nnotdeployed-A Micro-Integration starts in the Not Deployed state when it's first created. In the Not Deployed state, data does not flow between your external system and the event broker service.deploying-A transient state that indicates that the Micro-Integration is in the process of being deployed.running-In the Running state, data flows between your external system and the event broker service.undeploying-A transient state that indicates that the Micro-Integration is in the process of being undeployed.error-An error condition occurred with the Micro-Integration and recovery is not possible. The reasons for the errors are displayed in the error text.The name of the Micro-Integration types that you can filter the query results. For example, you can use:
\nIBMAWSgcppubsubThe direction specifies whether the Micro-Integration is a source or target that you can use to filter the query results. The directions are:
source-A source Micro-Integration is where data flows from the event broker service through the Micro-Integration to the external system.target-A target Micro-Integration is where data flows from the external system through the Micro-Integration to the event broker service.The sorting criteria for the list of Micro-Integrations.
\nYou can use the following value formats for the sort order:
\nattributes-namesattributes-names:sort-orderUse the sort-order to sort the attributes using one of the following values:
asc-ascending orderdesc-descending orderIf you do not define a sort order, it will default to ascending order.\n These are the supported attribute names you can sort by:
\nFor example, if you want to sort the list of Micro-Integrations by name in ascending order, you can use:\n name:asc
Create a Micro-Integration configuration.
\nYou must specify the event broker service that the Micro-Integration will\n connect with, in addition to the configuration and connection details for both the event broker service and\n the external system connection. For information about on how to structure the configurationValues field,\n see Get a list of Micro-Integration templates.
After successful creation of a Micro-Integration, it defaults to a state of\n undeployed to indicate that the configuration you have provided has been saved\n but has not yet been deployed. To start a deployment, you change the state of the\n Micro-Integration to deploying as indicated in\n Update the state of a Micro-Integration.
You can also upload one or more files as required to supplement the configuration details mentioned above.\n To successfully upload files, you must supply the name of the file in the appropriate configuration field\n (for example, client-keystore.jks), and ensure that a file with the matching name is also supplied in the request
micro_integrations:*:* ]","operationId":"createMicroIntegrationV2","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"microIntegration":{"$ref":"#/components/schemas/MicroIntegrationV2CreationConfiguration"},"files":{"type":"array","description":"The files to be uploaded to use for client certificate authentication. The key store formats that are supported are JKS (Java KeyStore) and PKCS12.","items":{"type":"string","format":"binary"}}},"required":["microIntegration"]},"encoding":{"microIntegration":{"contentType":"application/json"}}}}},"responses":{"201":{"description":"Created.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationV2Response","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrations/diagnose":{"post":{"tags":["Micro-Integrations"],"summary":"(Beta) Create an AI-assisted diagnosis request","description":"Create a request for the AI Assistant to analyze the Micro-Integration and identify runtime or\nconfiguration issues. This can be performed on the Micro-Integration in any state, and will generate\na report that identifies the root cause of problems encountered by the latest deployment.
\nTo retrieve the report, see\nGet an AI-assisted diagnosis request.
\nmicro_integrations:*:* ]","operationId":"triggerMiFailureDiagnosis","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MiFailureDiagnosisRequest"}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MiFailureDiagnosisResponse","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrations/diagnose/{diagnosisRequestId}":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Get an AI-assisted diagnosis request","description":"Get an AI-assisted diagnosis request using its unique identifier. While the request is still\nbeing processed the response reports its state; once processing is complete the response also\ncontains the diagnosis report.
\nmicro_integrations:get:* ]","operationId":"getMiFailureDiagnosis","parameters":[{"name":"diagnosisRequestId","in":"path","description":"The unique identifier of the AI-assisted diagnosis request.","required":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MiFailureDiagnosisResponse","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrations/{id}":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Get a Micro-Integration","description":"Get the details of a Micro-Integration using its unique identifier. Additional information about the latest deployment of the Micro-Integration can optionally be included in the query result using the include parameter.micro_integrations:get:* ]","operationId":"getMicroIntegrationV2","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration.","required":true,"schema":{"type":"string","default":""}},{"name":"include","in":"query","description":"Comma-separated list of additional information to include. Options: deployment, flows","required":false,"schema":{"type":"string","default":"","example":"deployment,flows"}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationV2Response","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}},"delete":{"tags":["Micro-Integrations"],"summary":"(Beta) Delete a Micro-Integration","description":"Delete a Micro-Integration using its unique identifier. As part of the deletion, the associated configuration is removed, and any existing deployments are undeployed.micro_integrations:*:* ]","operationId":"deleteMicroIntegrationV2","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration.","required":true,"schema":{"type":"string","default":""}}],"responses":{"204":{"description":"No content."},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}},"patch":{"tags":["Micro-Integrations"],"summary":"(Beta) Update a Micro-Integration","description":"Update the configuration of an existing undeployed Micro-Integration. You can provide any combination of supported fields. If a required field is not provided, then the Micro-Integration is not updated. This request fails if the specified Micro-Integration is not in a state of undeployed or error. You can also upload one or more files needed to supplement the configuration details mentioned above. For more details, see Create a Micro-Integration.micro_integrations:*:* ]","operationId":"updateMicroIntegrationV2","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration.","required":true,"schema":{"type":"string","default":""}}],"requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"microIntegration":{"$ref":"#/components/schemas/MicroIntegrationV2UpdateConfiguration"},"files":{"type":"array","description":"The files to be uploaded to use for client certificate authentication. The key store formats that are supported are JKS (Java KeyStore) and PKCS12.","items":{"type":"string","format":"binary"}}},"required":["microIntegration"]},"encoding":{"microIntegration":{"contentType":"application/json"}}}}},"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationV2Response","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrations/{id}/deploymentRequests":{"post":{"tags":["Micro-Integrations"],"summary":"(Beta) Create a deployment request for a Micro-Integration","description":"Create a deployment or undeployment request for a Micro-Integration. Use deploying\nto start a (re)deployment, or undeploying to undeploy. Check the Micro-Integration's\nstate to track progress.
studio_resource:update:* or micro_integrations:*:* ]","operationId":"createDeploymentRequest","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration.","required":true,"schema":{"type":"string","default":""}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeploymentRequestDTO","additionalProperties":{"default":""},"default":""}}},"required":true},"responses":{"202":{"description":"Accepted.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/DeploymentRequestResponseDTO","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrations/{id}/logs":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Get the logs for a Micro-Integration","description":"Get the logs for a Micro-Integration using its unique identifier. You can retrieve the logs for warnings and errors that are useful to identify potential issues for a Micro-Integration.micro_integrations:get:* ]","operationId":"getMicroIntegrationV2ErrorLogs","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration.","required":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationLogResponse"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrations/{id}/realtimeMetrics":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Get realtime metrics for a Micro-Integration","description":"Returns realtime Prometheus metrics for a Micro-Integration. Returns status IN_PROGRESS while metrics are being collected, and COMPLETED with metric values once available.micro_integrations:get:* ]","operationId":"getMiRealtimeMetrics","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration.","required":true,"schema":{"type":"string","default":""}},{"name":"includedNames","in":"query","description":"Comma-separated Prometheus metric names to include. If omitted, all metrics are returned.","required":false,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/RealtimeMetricsResponse"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrations/{id}/state":{"patch":{"tags":["Micro-Integrations"],"summary":"(Beta) Update the state of a Micro-Integration","description":"Update the state of an existing Micro-Integration. You can specify the following states:
\ndeploying-Start the deployment of the Micro-Integration. A valid state to set when the\n Micro-Integration is in a state of undeployed or error.undeploying-Start the undeployment of the Micro-Integration. A valid state to set when the\n Micro-Integration is the running state.micro_integrations:*:* ]","operationId":"updateMicroIntegrationStateV2","parameters":[{"name":"id","in":"path","description":"The unique identifier of the Micro-Integration.","required":true,"schema":{"type":"string","default":""}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MicroIntegrationV2StateUpdate","additionalProperties":{"default":""},"default":""}}},"required":true},"responses":{"204":{"description":"No content."},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrations/{miId}/microIntegrationType":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Retrieves an existing Micro-Integration's Micro-Integration Type","description":"nullmicro_integrations:get:* ]","operationId":"getTypeForMicroIntegration","parameters":[{"name":"miId","in":"path","description":"The unique identifier of the Micro-Integration.","required":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationTypeResponse","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/microIntegrations/{miId}/templates":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Retrieves an existing Micro-Integration's Templates","description":"nullmicro_integrations:get:* ]","operationId":"getTemplatesForMicroIntegration","parameters":[{"name":"miId","in":"path","description":"The unique identifier of the Micro-Integration.","required":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/MicroIntegrationTypeResponse","additionalProperties":{"default":""},"default":""}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/transformationFiles":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Get a list of uploaded Micro-Integration transformation payloads","description":"Get a list of schema details for uploaded sample payloads used in Micro-Integration transformations.micro_integrations:get:* or agentic_ai:get:* ]","operationId":"getGraphSchemas","parameters":[{"name":"pageNumber","in":"query","description":"The page number to retrieve.","required":false,"schema":{"type":"integer","default":1,"minimum":1}},{"name":"pageSize","in":"query","description":"The number of Micro-Integration transformation payloads to return on page.","required":false,"schema":{"type":"integer","default":10,"maximum":100,"minimum":1}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TransformationPayloadsResponse"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}},"post":{"tags":["Micro-Integrations"],"summary":"(Beta) Upload a sample payload for use in Micro-Integration transformations","description":"Upload a sample payload to generate a schema used in Micro-Integration transformations. The response from this API includes a unique identifier that can be used when creating or updating a Micro-Integration to specify the uploaded sample as a source or target payload for transformations. Sample data is converted to a data model representation and is not stored in any storage system.micro_integrations:*:* or agentic_ai:*:* or standalone_agents:*:* ]","operationId":"uploadTransformationSampleFile","requestBody":{"content":{"multipart/form-data":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary","description":"The file to be uploaded for use in Micro-Integration transformations."}},"required":["file"]},"encoding":{"file":{"contentType":"application/octet-stream"}}}}},"responses":{"201":{"description":"Created.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TransformationPayloadResponse"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/transformationFiles/{id}":{"get":{"tags":["Micro-Integrations"],"summary":"(Beta) Get an uploaded Micro-Integration transformation payload","description":"Get the processed payload's schema details of an uploaded sample payload using its unique identifier. These payloads are used for Micro-Integration transformations.micro_integrations:get:* or agentic_ai:get:* ]","operationId":"getGraphSchema","parameters":[{"name":"id","in":"path","description":"The unique identifier of the uploaded sample payload","required":true,"schema":{"type":"string","default":""}}],"responses":{"200":{"description":"OK.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/TransformationPayloadResponse"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/limits":{"get":{"tags":["Micro-Integrations Limits"],"summary":"(Beta) Get the micro-integration deployment limits","description":"Get the current organization's micro-integration limitsmicro_integrations:get:* or agentic_ai:get:* ]","operationId":"getCustomerMicroIntegrationLimits","responses":{"200":{"description":"The organization's micro-integration limits","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrganizationIntegrationLimitResponse"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}},"/api/v2/integration/organizations":{"get":{"tags":["Organizations"],"summary":"(Beta) Get an organization of current logged in user","description":"Use this API to get an organization of current logged in useriam_org:get ]","operationId":"getOrganizationOfCurrentUser","responses":{"200":{"description":"The organization.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/OrganizationResponse"}}}},"400":{"description":"Bad Request.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}},"*/*":{"schema":{"$ref":"#/components/schemas/ErrorResponse"}}}},"401":{"description":"Unauthorized.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"403":{"description":"Forbidden.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}},"404":{"description":"Not Found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorResponse","additionalProperties":{"default":""},"default":""}}}}}}}},"components":{"schemas":{"ErrorResponse":{"type":"object","default":null,"discriminator":{"propertyName":"errorType"},"properties":{"message":{"type":"string","default":"","description":"A user-friendly message that describes the error.","example":"An error occurred."},"errorId":{"type":"string","default":"","description":"The UUID (Universally Unique Identifier) that is logged with an appropriate stack trace for a WARN or ERROR log that allows support to better determine what cause the error.","example":"123e4567-e89b-12d3-a456-426655440000"},"meta":{"type":"object","additionalProperties":{},"default":"","example":"'object': { 'field': 'description' }"},"validationDetails":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string"}},"default":"","description":"When applicable, these are the details of issues with the fields provided for the REST call.","example":"'name': ['Not unique']"},"errorType":{"type":"string","writeOnly":true}}},"TransformationNode":{"type":"object","default":null,"description":"The details of a transformation node.","properties":{"solGraphNodeId":{"type":"string","default":"","description":"The unique identifier of the node.","example":"/schema/address","minLength":1},"parentId":{"type":"string","default":"","description":"The unique identifier of the parent node.","example":"/schema"},"fields":{"type":"array","default":"","description":"A list of child nodes nested under the current transformation node.","example":[{"solGraphNodeId":"/schema/address/street","dataType":"string","name":"street","parentId":"/schema/address","nodePath":["address","street"]},{"solGraphNodeId":"/schema/address/city","dataType":"string","name":"city","parentId":"/schema/address","nodePath":["address","city"]},{"solGraphNodeId":"/schema/address/state","dataType":"string","name":"state","parentId":"/schema/address","nodePath":["address","state"]},{"solGraphNodeId":"/schema/address/zip","dataType":"string","name":"zip","parentId":"/schema/address","nodePath":["address","zip"]},{"solGraphNodeId":"/schema/address/country","dataType":"string","name":"country","parentId":"/schema/address","nodePath":["address","country"]}],"items":{}},"required":{"type":"boolean","default":false,"description":"Indicates whether the field is optional. A value of true indicates that the field is required.","example":false},"isTypeUndefined":{"type":"boolean","default":false,"description":"Indicates whether there is valid type for field in the sample payload. A value of true indicates that a field in the payload is `null`, and false indicates that there is valid type.","example":false},"nodePath":{"type":"array","default":"","description":"The property names of the ancestor nodes from the most distant ancestor (root) to the most immediate ancestor (parent).","example":["address"],"items":{"type":"string"}},"parentArrayFields":{"type":"array","default":"","description":"The solGraphNodeIds of the ancestor nodes that are arrays, from the most distant to the nearest. Empty if no ancestor is an array.","example":["/schema/phoneNumbers"],"items":{"type":"string"}},"dataType":{"type":"string","default":"","description":"The data type of the node.","example":"object"},"name":{"type":"string","default":"","description":"The name of the node.","example":"address"}},"required":["dataType","name","solGraphNodeId"]},"TransformationPayload":{"type":"object","default":null,"description":"The details of an uploaded sample payload.","properties":{"id":{"type":"string","default":"","description":"The unique identifier of the uploaded sample payload.","example":"4f0awkmmtna"},"filename":{"type":"string","default":"","description":"The original filename of the uploaded payload.","example":"audit-log-sample.json"},"state":{"type":"string","default":"","description":"The state of the upload process, each of which are described below:
INPROGRESS-A state that indicates that the sample payload is still being uploaded.SUCCEEDED-A state that indicates that the sample payload was uploaded successfully.FAILED-A state that indicates that the sample payload failed to upload.includeLatestDeployment query parameter is set to true.","properties":{"createdBy":{"type":"string","default":"","description":"The unique identifier representing the user who created the Micro-Integration.","example":"4f0awkmmtna","readOnly":true},"createdTime":{"type":"string","format":"date-time","default":"","description":"The time that the Micro-Integration was created, in ISO 8601 date/time format.","example":"2023-06-24T15:30:00","readOnly":true},"updatedBy":{"type":"string","default":"","description":"The unique identifier representing the user who last updated the Micro-Integration.","example":"4f0awkmmtna","readOnly":true},"updatedTime":{"type":"string","format":"date-time","default":"","description":"The time of the last update that was performed on the Micro-Integration, in ISO 8601 date/time format.","example":"2023-06-24T15:30:00","readOnly":true},"id":{"type":"string","default":"","description":"The unique identifier of the deployment for the Micro-Integration","example":"4f0awkmmtna","readOnly":true},"action":{"type":"string","default":"","description":"The type of deployment action performed, each of which are described below:
\ncreate - A new deployment will be createdupdate- The existing deployment will be updated.disable- The existing deployment will be deleted, but no configuration will be lost.The current status of the deployment for the Micro-Integration. The following are the valid statuses for the deployment:
\nACCEPTED - The deployment request was accepted and is in progress.REJECTED - The deployment request was rejected by the deployment engine and could not complete.COMPLETED - The Micro-Integration deployment was completed successfully.FAILED - The Micro-Integration failed to deploy.The state of the Micro-Integration Flow, each of which are described below:
notdeployed-A Micro-Integration Flow starts in the Not Deployed state when it's first created. In the Not Deployed state, data does not flow between your external system and the event broker service.deploying-A transient state that indicates that the Micro-Integration Flow is in the process of being deployed.running-In the Running state, data flows between your external system and the event broker service.undeploying-A transient state that indicates that the Micro-Integration Flow is in the process of being undeployed.error-An error condition occurred with the Micro-Integration Flow and recovery is not possible. The reasons for the errors are displayed in the error text.down-If an error condition occurs with a Micro-Integration Flow and recovery is not possible, the Micro-Integration Flow moves to the Down state. When you view the Micro-Integration Flow, the reasons for the errors are displayed in the error text.The configuration details for the Micro-Integration Flow. For example, the configuration values specified for Amazon SNS is a follows:
\n\n{\n \"awssns-solace-consumer\": {\n \"binder\": \"solace\",\n \"destination\": \"YOUR_SOLACE_SOURCE_QUEUE\"\n },\n \"awssns-vendor-producer\": {\n \"binder\": \"sns\",\n \"destination\": \"YOUR_SNS_DESTINATION\"\n }\n}\n\n","example":{"awssns-solace-consumer":{"binder":"solace","destination":"YOUR_SOLACE_SOURCE_QUEUE"},"awssns-vendor-producer":{"binder":"sns","destination":"YOUR_SNS_DESTINATION"}}},"transformation":{"$ref":"#/components/schemas/MicroIntegrationTransformation"},"type":{"type":"string","default":"","description":"The type of object for informational purposes.","example":"microIntegrationFlow","readOnly":true}}},"MicroIntegrationTransformation":{"type":"object","default":null,"description":"The transformations details for the Micro-Integration.
\n\n{\n \"sourceFileId\": \"sourceFile1\",\n \"targetFileId\": \"targetFile1\",\n \"edges\": [\n {\n \"source\": {\n \"solGraphNodeId\": \"/function/joinString\",\n \"propertyName\": \"result\"\n },\n \"target\": {\n \"solGraphNodeId\": \"/schema/notes\"\n }\n },\n {\n \"source\": {\n \"solGraphNodeId\": \"/constant/ih3nvj\"\n },\n \"target\": {\n \"solGraphNodeId\": \"/function/joinString\",\n \"propertyName\": \"delimiter\"\n }\n },\n {\n \"source\": {\n \"solGraphNodeId\": \"customField/header/cu5kz\"\n },\n \"target\": {\n \"solGraphNodeId\": \"/function/joinString\",\n \"propertyName\": \"inputs\",\n \"propertyIndex\": 0\n }\n },\n {\n \"source\": {\n \"solGraphNodeId\": \"/schema/additionalNotes\"\n },\n \"target\": {\n \"solGraphNodeId\": \"/function/joinString\",\n \"propertyName\": \"inputs\",\n \"propertyIndex\": 1\n }\n }\n ],\n \"functions\": [\n {\n \"solGraphNodeId\": \"/function/joinString\",\n \"methodId\": \"joinString\",\n \"returnVariables\": [\n {\n \"name\": \"result\",\n \"dataType\": \"String\"\n }\n ]\n }\n ],\n \"customFields\": {\n \"source\": {\n \"header\": [\n {\n \"solGraphNodeId\": \"customField/header/cu5kz\",\n \"dataType\": \"string\",\n \"name\": \"my_solace_header\",\n \"required\": false,\n \"nodePath\": [\n \"my_solace_header\"\n ]\n }\n ]\n }\n },\n \"constants\": [\n {\n \"solGraphNodeId\": \"/constant/ih3nvj\",\n \"dataType\": \"string\",\n \"constantValue\": \"-\"\n }\n ]\n}\n\n","example":{"sourceFileId":"sourceFile1","targetFileId":"targetFile1","edges":[{"source":{"solGraphNodeId":"/function/joinString","propertyName":"result"},"target":{"solGraphNodeId":"/schema/notes"}},{"source":{"solGraphNodeId":"/constant/ih3nvj"},"target":{"solGraphNodeId":"/function/joinString","propertyName":"delimiter"}},{"source":{"solGraphNodeId":"customField/header/cu5kz"},"target":{"solGraphNodeId":"/function/joinString","propertyName":"inputs","propertyIndex":0}},{"source":{"solGraphNodeId":"/schema/additionalNotes"},"target":{"solGraphNodeId":"/function/joinString","propertyName":"inputs","propertyIndex":1}}],"functions":[{"solGraphNodeId":"/function/joinString","methodId":"joinString","returnVariables":[{"name":"result","dataType":"String"}]}],"customFields":{"source":{"header":[{"solGraphNodeId":"customField/header/cu5kz","dataType":"string","name":"my_solace_header","required":false,"nodePath":["my_solace_header"]}]}},"constants":[{"solGraphNodeId":"/constant/ih3nvj","dataType":"string","constantValue":"-"}]},"properties":{"sourceFileId":{"type":"string","default":"","description":"The unique identifier of the uploaded source sample payload.","example":"4f0awkmmtna"},"targetFileId":{"type":"string","default":"","description":"The unique identifier of the uploaded target sample payload.","example":"4f0awkmmtna"},"updatedPayloadFields":{"$ref":"#/components/schemas/MicroIntegrationTransformationUpdatedFields"},"edges":{"type":"array","default":"","description":"The edge or connection between source and target nodes. Source nodes can be constants, headers, payload fields or transformation\nfunction outputs. Target nodes can be headers, payload fields, smart topics or transformation function inputs.
\n\n[\n {\n \"source\": {\n \"solGraphNodeId\": \"/function/joinString\",\n \"propertyName\": \"result\"\n },\n \"target\": {\n \"solGraphNodeId\": \"/schema/notes\"\n }\n },\n {\n \"source\": {\n \"solGraphNodeId\": \"/constant/ih3nvj\"\n },\n \"target\": {\n \"solGraphNodeId\": \"/function/joinString\",\n \"propertyName\": \"delimiter\"\n }\n },\n {\n \"source\": {\n \"solGraphNodeId\": \"customField/header/cu5kz\"\n },\n \"target\": {\n \"solGraphNodeId\": \"/function/joinString\",\n \"propertyName\": \"inputs\",\n \"propertyIndex\": 0\n }\n },\n {\n \"source\": {\n \"solGraphNodeId\": \"/schema/additionalNotes\"\n },\n \"target\": {\n \"solGraphNodeId\": \"/function/joinString\",\n \"propertyName\": \"inputs\",\n \"propertyIndex\": 1\n }\n }\n]\n\n","example":[{"source":{"solGraphNodeId":"/function/joinString","propertyName":"result"},"target":{"solGraphNodeId":"/schema/notes"}},{"source":{"solGraphNodeId":"/constant/ih3nvj"},"target":{"solGraphNodeId":"/function/joinString","propertyName":"delimiter"}},{"source":{"solGraphNodeId":"customField/header/cu5kz"},"target":{"solGraphNodeId":"/function/joinString","propertyName":"inputs","propertyIndex":0}},{"source":{"solGraphNodeId":"/schema/additionalNotes"},"target":{"solGraphNodeId":"/function/joinString","propertyName":"inputs","propertyIndex":1}}],"items":{"$ref":"#/components/schemas/MicroIntegrationTransformationEdge"}},"functions":{"type":"array","default":"","description":"The list of functions applied within the transformation. Each method contains the method identifier,\n its input parameters, and return variables.
\n\n[\n {\n \"solGraphNodeId\": \"/function/joinString\",\n \"methodId\": \"joinString\",\n \"returnVariables\": [\n {\n \"name\": \"result\",\n \"dataType\": \"String\"\n }\n ]\n }\n]\n\n New: Inputless functions are also supported. These functions do not require any input parameters.\n For example, the now() function can be declared as follows:
\n [\n {\n \"solGraphNodeId\": \"now\",\n \"methodId\": \"now\",\n \"returnVariables\": [\n {\n \"name\": \"result\",\n \"dataType\": \"String\"\n }\n ]\n }\n ]\n \n","example":[{"solGraphNodeId":"/function/joinString","methodId":"joinString","returnVariables":[{"name":"result","dataType":"String"}]}],"items":{"$ref":"#/components/schemas/MicroIntegrationTransformationFunction"}},"customFields":{"$ref":"#/components/schemas/MicroIntegrationTransformationCustomFields"},"constants":{"type":"array","items":{"$ref":"#/components/schemas/MicroIntegrationTransformationConstant"}}}},"MicroIntegrationTransformationConstant":{"type":"object","default":null,"description":"A constant node defined for use within the Micro-Integration's transformations.
\n\n {\n \"solGraphNodeId\": \"/constant/ih3nvj\",\n \"dataType\": \"string\",\n \"constantValue\": \"-\"\n }\n\n","example":{"solGraphNodeId":"/constant/ih3nvj","dataType":"string","constantValue":"-"},"properties":{"solGraphNodeId":{"type":"string","default":"","description":"The unique identifier of the node.","example":"/schema/address","minLength":1},"constantValue":{"default":"","description":"The constant value of the node.","example":"-"},"dataType":{"type":"string","default":"","description":"The data type of the node.","example":"object"}},"required":["constantValue","dataType","solGraphNodeId"]},"MicroIntegrationTransformationCustomFields":{"type":"object","default":null,"description":"A map of source and target custom fields defined for use within the Micro-Integration's transformations.
\n\n {\n \"source\": {\n \"header\": [\n {\n \"solGraphNodeId\": \"customField/header/cu5kz\",\n \"dataType\": \"string\",\n \"name\": \"my_solace_header\",\n \"required\": false,\n \"nodePath\": [\n \"my_solace_header\"\n ]\n }\n ]\n }\n }\n\n","example":{"source":{"header":[{"solGraphNodeId":"customField/header/cu5kz","dataType":"string","name":"my_solace_header","required":false,"nodePath":["my_solace_header"]}]}},"properties":{"source":{"$ref":"#/components/schemas/MicroIntegrationTransformationCustomFieldsSection","default":"","description":"Custom fields for the source side of the transformation."},"target":{"$ref":"#/components/schemas/MicroIntegrationTransformationCustomFieldsSection","default":"","description":"Custom fields for the target side of the transformation."}}},"MicroIntegrationTransformationCustomFieldsSection":{"type":"object","default":null,"description":"A map of custom header and payload fields used in either the source or target side of the transformation.
\n\n {\n \"payload\": [\n {\n \"solGraphNodeId\": \"customField/schema/customNameField\",\n \"name\": \"customNameField\",\n \"dataType\": \"String\",\n \"required\": true\n }\n ],\n \"header\": [\n {\n \"solGraphNodeId\": \"customField/header/customHeaderField\",\n \"name\": \"customHeaderField\",\n \"dataType\": \"String\",\n \"required\": true\n }\n ]\n }\n\n","properties":{"payload":{"type":"array","default":"","description":"The list of custom nodes accessible through the message payload.","example":[{"solGraphNodeId":"customField/schema/customNameField","name":"customNameField","dataType":"String","required":true}],"items":{"$ref":"#/components/schemas/TransformationNode"}},"header":{"type":"array","default":"","description":"The list of custom nodes accessible through the message header fields.","example":[{"solGraphNodeId":"customField/header/customHeaderField","name":"customHeaderField","dataType":"String","required":true}],"items":{"$ref":"#/components/schemas/TransformationNode"}}}},"MicroIntegrationTransformationEdge":{"type":"object","default":null,"description":"The edge or connection between source and target nodes. Source nodes can be constants, headers, payload fields or\n transformation function outputs. Target nodes can be headers, payload fields, smart topics or transformation function inputs.
\n\n{\n \"source\": {\n \"solGraphNodeId\": \"/function/joinString\",\n \"propertyName\": \"result\"\n },\n \"target\": {\n \"solGraphNodeId\": \"/schema/notes\"\n }\n}\n\n","example":{"source":{"solGraphNodeId":"/function/joinString","propertyName":"result"},"target":{"solGraphNodeId":"/schema/notes"}},"properties":{"source":{"$ref":"#/components/schemas/MicroIntegrationTransformationEdgeNode","default":"","description":"The details of an edge's source node, including its unique identifier, property name, and property index. The property name and property index are optional and are used to identify sub-properties and array indices for array fields and transformation functions with multiple outputs."},"target":{"$ref":"#/components/schemas/MicroIntegrationTransformationEdgeNode","default":"","description":"The details of an edge's target node, including its unique identifier, property name, and property index. The property name and property index are optional and are used to identify sub-properties and array indices for array fields and transformation functions with multiple inputs."}},"required":["source","target"]},"MicroIntegrationTransformationEdgeNode":{"type":"object","default":null,"description":"The details of an edge node, including its unique identifier, property name, and property index.\nThe property name and property index are optional and are used to identify sub-properties and array indices for array fields\n and transformation functions with multiple inputs and outputs.
\n\n {\n \"solGraphNodeId\": \"/function/joinString\",\n \"propertyName\": \"inputs\",\n \"propertyIndex\": 0\n }\n \n","example":{"solGraphNodeId":"/function/joinString","propertyName":"inputs","propertyIndex":0},"properties":{"solGraphNodeId":{"type":"string","default":"","description":"The unique identifier of the node.","example":"/schema/parent","minLength":1},"propertyName":{"type":"string","default":"","description":"The property name of the node, used to identify sub-properties belonging to an array node or a specific input or output of a transformation function.","example":"child"},"propertyIndex":{"type":"integer","format":"int32","default":"","description":"The index of the node to access, used to identify array indices or transformation function input or output indices.","example":1},"resultFieldPath":{"type":"array","items":{"type":"string"},"writeOnly":true}},"required":["solGraphNodeId"]},"MicroIntegrationTransformationFunction":{"type":"object","default":null,"description":"The function used to transform source data into a different value or format.
\n\n {\n \"solGraphNodeId\": \"/function/joinString\",\n \"methodId\": \"joinString\",\n \"returnVariables\": [\n {\n \"name\": \"result\",\n \"dataType\": \"String\"\n }\n ]\n }\n\n","example":{"solGraphNodeId":"/function/joinString","methodId":"joinString","returnVariables":[{"name":"result","dataType":"String"}]},"properties":{"solGraphNodeId":{"type":"string","default":"","description":"The unique identifier of a function.","example":"joinNames","minLength":1},"methodId":{"type":"string","default":"","description":"The unique identifier of the transformation function.","example":"joinString","minLength":1},"returnVariables":{"type":"array","items":{"$ref":"#/components/schemas/MicroIntegrationTransformationFunctionOutput"}}},"required":["methodId","returnVariables","solGraphNodeId"]},"MicroIntegrationTransformationFunctionOutput":{"type":"object","default":null,"description":"The return variable produced by the transformation function.
\n\n{\n \"name\": \"result\",\n \"dataType\": \"String\"\n}\n\n","example":{"name":"result","dataType":"String"},"properties":{"name":{"type":"string","default":"","description":"The name assigned to the return variable.","example":"result","minLength":1}},"required":["name"]},"MicroIntegrationTransformationUpdatedFields":{"type":"object","default":null,"description":"The updated types and optionality of existing payload nodes.
\n\n{\n \"updatedSourceNodes\": [\n {\n \"solGraphNodeId\": \"/source/name\",\n \"name\": \"name\",\n \"dataType\": \"string\",\n \"required\": true\n }\n ],\n \"updatedTargetNodes\": [\n {\n \"solGraphNodeId\": \"/source/name\",\n \"name\": \"name\",\n \"dataType\": \"string\",\n \"required\": true\n }\n ]\n}\n\n","example":{"updatedSourceNodes":[{"solGraphNodeId":"/source/name","name":"name","dataType":"string","required":true}],"updatedTargetNodes":[{"solGraphNodeId":"/source/name","name":"name","dataType":"string","required":true}]},"properties":{"updatedSourceNodes":{"type":"array","default":"","description":"Source nodes for which we update the optionality or data types.","items":{"$ref":"#/components/schemas/MicroIntegrationTransformationUpdatedPayloadFields"}},"updatedTargetNodes":{"type":"array","default":"","description":"Target nodes for which we update the optionality or data types.","items":{"$ref":"#/components/schemas/MicroIntegrationTransformationUpdatedPayloadFields"}}}},"MicroIntegrationTransformationUpdatedPayloadFields":{"type":"object","default":null,"description":"The updated types and optionality of existing payload nodes.
\n\n{\n \"solGraphNodeId\": \"/source/name\",\n \"dataType\": \"string\",\n \"required\": true\n}\n\n","example":{"solGraphNodeId":"/source/name","dataType":"string","required":true},"properties":{"solGraphNodeId":{"type":"string","default":"","description":"The unique identifier of the node.","example":"/schema/address","minLength":1},"required":{"type":"boolean","default":false,"description":"The optionality of the node.","example":false},"dataType":{"type":"string","default":"","description":"The data type of the node.","example":"object"}},"required":["dataType","solGraphNodeId"]},"MicroIntegrationV2":{"type":"object","default":null,"properties":{"createdBy":{"type":"string","default":"","description":"The unique identifier representing the user who created the Micro-Integration.","example":"4f0awkmmtna","readOnly":true},"createdTime":{"type":"string","format":"date-time","default":"","description":"The time that the Micro-Integration was created, in ISO 8601 date/time format.","example":"2023-06-24T15:30:00","readOnly":true},"updatedBy":{"type":"string","default":"","description":"The unique identifier representing the user who last updated the Micro-Integration.","example":"4f0awkmmtna","readOnly":true},"updatedTime":{"type":"string","format":"date-time","default":"","description":"The time of the last update that was performed on the Micro-Integration, in ISO 8601 date/time format.","example":"2023-06-24T15:30:00","readOnly":true},"id":{"type":"string","default":"","description":"The unique identifier of the Micro-Integration.","example":"123abc789","readOnly":true},"environmentId":{"type":"string","default":"","description":"The unique identifier of the environment associated with the Micro-Integration.","example":"456abc789","readOnly":true},"name":{"type":"string","default":"","description":"The name of the Micro-Integration.","example":"My-First-Micro-Integration"},"description":{"type":"string","default":"","description":"The description of the Micro-Integration.","example":"My first Micro-Integration that consumes events from my external system."},"microIntegrationType":{"type":"string","default":"","description":"The type of Micro-Integration. You can determine the types using Get a list of Micro-Integration types.","example":"awssns"},"direction":{"type":"string","default":"","description":"The direction that data flows through the Micro-Integration. The directions are:
source-A source Micro-Integration is where data flows from the event broker service through the Micro-Integration to the external system.target-A target Micro-Integration is where data flows from the external system through the Micro-Integration to the event broker service.The version that of the Micro-Integration type being used.
","example":"1.0.0"},"state":{"type":"string","default":"","description":"The state of the Micro-Integration, each of which are described below:
notdeployed-A Micro-Integration starts in the Not Deployed state when it's first created. In the Not Deployed state, data does not flow between your external system and the event broker service.deploying-A transient state that indicates that the Micro-Integration is in the process of being deployed.running-In the Running state, data flows between your external system and the event broker service.undeploying-A transient state that indicates that the Micro-Integration is in the process of being undeployed.error-An error condition occurred with the Micro-Integration and recovery is not possible. The reasons for the errors are displayed in the error text.down-If an error condition occurs with a Micro-Integration and recovery is not possible, the Micro-Integration moves to the Down state. When you view the Micro-Integration, the reasons for the errors are displayed in the error text.Whether or not the state is currently being asynchronously retrieved. A subsequent API call should reflect the updated state.
","example":true},"brokerId":{"type":"string","default":"","description":"The unique identifier of the event broker service associated to the Micro-Integration.","example":"broker456"},"lastDeploymentId":{"type":"string","default":"","description":"The most recent deployment id for the Micro-Integration."},"configurationValues":{"type":"object","additionalProperties":{},"default":"","description":"The configuration details for the Micro-Integration. For example, the configuration values specified for Amazon SNS is a follows:
\n\n{\n \"awssns-vendor\": {\n \"region\": \"YOUR_AWS_REGION\",\n \"authentication\": {\n \"accessKey\": \"YOUR_AWS_ACCESS_KEY\",\n \"secretKey\": \"YOUR_AWS_SECRET_KEY\"\n }\n },\n \"awssns-solace\": {\n \"authentication\": {\n \"host\": \"YOUR_SOLACE_BROKER_HOST_URL\",\n \"messageVpn\": \"YOUR_SOLACE_BROKER_MESSAGE_VPN\",\n \"clientPassword\": \"YOUR_SOLACE_BROKER_CLIENT_PASSWORD\",\n \"clientUsername\": \"YOUR_SOLACE_BROKER_CLIENT_USERNAME\"\n }\n }\n}\n\n","example":{"awssns-vendor":{"region":"YOUR_AWS_REGION","authentication":{"accessKey":"YOUR_AWS_ACCESS_KEY","secretKey":"YOUR_AWS_SECRET_KEY"}},"awssns-solace":{"authentication":{"host":"YOUR_SOLACE_BROKER_HOST_URL","messageVpn":"YOUR_SOLACE_BROKER_MESSAGE_VPN","clientPassword":"YOUR_SOLACE_BROKER_CLIENT_PASSWORD","clientUsername":"YOUR_SOLACE_BROKER_CLIENT_USERNAME"}}}},"deploymentDetails":{"$ref":"#/components/schemas/MicroIntegrationDeployment","default":"","description":"The details of the most recent deployment for the Micro-Integration. This portion of the response that is only included if the 'include=deployment' query parameter is set to true."},"flows":{"type":"array","default":"","description":"The list of flows associated with this Micro-Integration. This portion of the response that is only included if the 'include=flows' query parameter is present.","items":{"$ref":"#/components/schemas/MicroIntegrationFlow"}},"aiDiagnosis":{"$ref":"#/components/schemas/MiFailureDiagnosisResponse","default":"","description":"The most recent AI failure diagnosis for the Micro-Integration. Only populated when the request includes aiDiagnosis."},"type":{"type":"string","default":"","description":"The type of object for informational purposes.","example":"microIntegration","readOnly":true}}},"MicroIntegrationV2Response":{"type":"object","properties":{"data":{"$ref":"#/components/schemas/MicroIntegrationV2"}}},"MicroIntegrationV2CloningConfiguration":{"type":"object","default":null,"description":"The fields to specify to clone a Micro-Integration.","properties":{"name":{"type":"string","default":"","description":"The name of the cloned Micro-Integration.","example":"My-First-Micro-Integration cloned","minLength":1},"description":{"type":"string","default":"","description":"The description of the Micro-Integration.","example":"My First Micro-Integration that consumes events from my external system."},"brokerId":{"type":"string","default":"","description":"The unique identifier of the event broker service associated to the Micro-Integration.","example":"broker456"},"configurationValues":{"type":"object","additionalProperties":{},"default":"","description":"The configuration details for the Micro-Integration. For example, the configuration values specified for Amazon SNS is a follows:
\n\n{\n \"awssns-vendor\": {\n \"region\": \"YOUR_AWS_REGION\",\n \"authentication\": {\n \"accessKey\": \"YOUR_AWS_ACCESS_KEY\",\n \"secretKey\": \"YOUR_AWS_SECRET_KEY\"\n }\n },\n \"awssns-solace\": {\n \"authentication\": {\n \"host\": \"YOUR_SOLACE_BROKER_HOST_URL\",\n \"messageVpn\": \"YOUR_SOLACE_BROKER_MESSAGE_VPN\",\n \"clientPassword\": \"YOUR_SOLACE_BROKER_CLIENT_PASSWORD\",\n \"clientUsername\": \"YOUR_SOLACE_BROKER_CLIENT_USERNAME\"\n }\n }\n}\n\n","example":{"awssns-vendor":{"region":"YOUR_AWS_REGION","authentication":{"accessKey":"YOUR_AWS_ACCESS_KEY","secretKey":"YOUR_AWS_SECRET_KEY"}},"awssns-solace":{"authentication":{"host":"YOUR_SOLACE_BROKER_HOST_URL","messageVpn":"YOUR_SOLACE_BROKER_MESSAGE_VPN","clientPassword":"YOUR_SOLACE_BROKER_CLIENT_PASSWORD","clientUsername":"YOUR_SOLACE_BROKER_CLIENT_USERNAME"}}}},"triggerDeployment":{"type":"boolean","default":false,"description":"Triggers the deployment of the micro-integration"},"removedFields":{"type":"array","default":"","description":"The list of fields to be removed from the Micro-Integration.","example":["brokerId"],"items":{"type":"string"}}},"required":["name"]},"MiFailureDiagnosisRequest":{"type":"object","default":null,"properties":{"miId":{"type":"string","default":"","description":"The unique identifier of the Micro-Integration to diagnose.","minLength":1}},"required":["miId"]},"MicroIntegrationV2CreationConfiguration":{"type":"object","default":null,"description":"The details of the Micro-Integration.","properties":{"name":{"type":"string","default":"","description":"The name of the Micro-Integration.","example":"My-First-Micro-Integration","minLength":1},"environmentId":{"type":"string","default":"","description":"The unique identifier of the environment associated with the Micro-Integration.","example":"ml81qeq69zs"},"description":{"type":"string","default":"","description":"The description of the Micro-Integration.","example":"My First Micro-integration that consumes events from my external system."},"brokerId":{"type":"string","default":"","description":"The unique identifier of the event broker service associated to the Micro-Integration.","example":"abc-broker123"},"microIntegrationType":{"type":"string","default":"","description":"The type of Micro-Integration that can be found by using Get a list of Micro-Integration types.","example":"awssns","minLength":1},"direction":{"type":"string","default":"","description":"The direction data flows through the Micro-Integration. The directions are:
source-A source Micro-Integration is where data flows from the event broker service through the Micro-Integration to the external system.target-A target Micro-Integration is where data flows from the external system through the Micro-Integration to the event broker service.The configuration details for the Micro-Integration. For example, the configuration values specified for Amazon SNS is a follows:
\n\n{\n \"awssns-vendor\": {\n \"region\": \"YOUR_AWS_REGION\",\n \"authentication\": {\n \"accessKey\": \"YOUR_AWS_ACCESS_KEY\",\n \"secretKey\": \"YOUR_AWS_SECRET_KEY\"\n }\n },\n \"awssns-solace\": {\n \"authentication\": {\n \"host\": \"YOUR_SOLACE_BROKER_HOST_URL\",\n \"messageVpn\": \"YOUR_SOLACE_BROKER_MESSAGE_VPN\",\n \"clientPassword\": \"YOUR_SOLACE_BROKER_CLIENT_PASSWORD\",\n \"clientUsername\": \"YOUR_SOLACE_BROKER_CLIENT_USERNAME\"\n }\n }\n}\n\n","example":{"awssns-vendor":{"region":"YOUR_AWS_REGION","authentication":{"accessKey":"YOUR_AWS_ACCESS_KEY","secretKey":"YOUR_AWS_SECRET_KEY"}},"awssns-solace":{"authentication":{"host":"YOUR_SOLACE_BROKER_HOST_URL","messageVpn":"YOUR_SOLACE_BROKER_MESSAGE_VPN","clientPassword":"YOUR_SOLACE_BROKER_CLIENT_PASSWORD","clientUsername":"YOUR_SOLACE_BROKER_CLIENT_USERNAME"}}}},"triggerDeployment":{"type":"boolean","default":false,"description":"Triggers the deployment of the micro-integration"}},"required":["configurationValues","direction","microIntegrationType","name"]},"AiAssistantResponseDTO":{"type":"object","properties":{"id":{"type":"string","default":"","description":"The id of the response."},"orgId":{"type":"string","default":"","description":"The organization id."},"microIntegrationType":{"type":"string","default":"","description":"The type of Micro-Integration."},"functionDefinitions":{"type":"array","default":"","description":"The function definitions available for this Micro-Integration type.","items":{"$ref":"#/components/schemas/MicroIntegrationFunction"}},"sourceNodes":{"type":"array","default":"","description":"The source nodes.","items":{"$ref":"#/components/schemas/NodeDTO"}},"targetNodes":{"type":"array","default":"","description":"The target nodes.","items":{"$ref":"#/components/schemas/NodeDTO"}},"edges":{"type":"array","default":"","description":"The edges that were created by the AI.","items":{"$ref":"#/components/schemas/MicroIntegrationTransformationEdge"}},"constants":{"type":"array","default":"","description":"The constants that were used by the AI.","items":{"$ref":"#/components/schemas/NodeDTO"}},"functions":{"type":"array","default":"","description":"The functions that were used by the AI.","items":{"$ref":"#/components/schemas/MicroIntegrationTransformationFunction"}},"state":{"type":"string","default":"","description":"The state of the request.","enum":["QUEUED","IN_PROGRESS","COMPLETED","ERROR"]},"errorMsg":{"type":"string","default":"","description":"The error message for a failed request."},"userPrompt":{"type":"string","default":"","description":"The user prompt."}}},"MicroIntegrationFunction":{"type":"object","default":null,"properties":{"id":{"type":"string","default":"","description":"The unique identifier representing the Micro-Integration function.","example":"joinString","readOnly":true},"name":{"type":"string","default":"","description":"The name of the Micro-Integration function.","example":"Join","readOnly":true},"shortDescription":{"type":"string","default":"","description":"The short description of the Micro-Integration function.","example":"Joins an array of strings with the specified delimiter.","readOnly":true},"longDescription":{"type":"string","default":"","description":"The detailed description of the Micro-Integration function.","example":"Joins an array of strings with the specified delimiter. The delimiter can be multiple characters. If an element of the array is null, then the string \"null\" is added to the result.","readOnly":true},"category":{"type":"string","default":"","description":"The category of the function","example":"Conversion","readOnly":true},"parameters":{"type":"array","default":"","description":"The details of input parameters supported by the Micro-Integration function.","example":[{"name":"delimiter","dataType":"String"},{"name":"inputs","dataType":"String[]"}],"items":{"$ref":"#/components/schemas/Parameter"},"readOnly":true},"returnValue":{"$ref":"#/components/schemas/ReturnValue","default":"","description":"The return type of the output produced by the Micro-Integration function.","example":{"dataType":"String"},"readOnly":true},"inputlessFunction":{"type":"boolean"},"arrayFunction":{"type":"boolean"},"isArrayFunction":{"type":"boolean","default":false,"description":"Whether this function operates on array data (derived from the function's category).","readOnly":true}}},"NodeDTO":{"type":"object","properties":{"solGraphNodeId":{"type":"string","default":"","description":"The unique identifier of the node.","example":"/schema/address","minLength":1},"propertyName":{"type":"string"},"constantValue":{},"required":{"type":"boolean"},"items":{"type":"array","items":{"$ref":"#/components/schemas/NodeDTO"}},"dataType":{"type":"string","default":"","description":"The data type of the node.","example":"object"}},"required":["dataType","solGraphNodeId"]},"Parameter":{"type":"object","default":null,"description":"The details of input parameters supported by the Micro-Integration function.","properties":{"name":{"type":"string","default":"","description":"The name of the parameter.","example":"inputs","readOnly":true},"description":{"type":"string","default":"","description":"The description of the parameter.","example":"The delimiter used for the function.","readOnly":true},"dataType":{"type":"string","default":"","description":"The data type of the parameter.","example":"String[]","readOnly":true},"parameterType":{"type":"string","default":"","description":"The type of parameter that includes: dataField-A field representing data present in the message payload.constant-Values that do not change.The configuration details for the Micro-Integration Flow. For example, the configuration values specified for Amazon SNS is a follows:
\n\n{\n \"awssns-solace-consumer\": {\n \"binder\": \"solace\",\n \"destination\": \"YOUR_SOLACE_SOURCE_QUEUE\"\n },\n \"awssns-vendor-producer\": {\n \"binder\": \"sns\",\n \"destination\": \"YOUR_SNS_DESTINATION\"\n }\n}\n\n","example":{"awssns-solace-consumer":{"binder":"solace","destination":"YOUR_SOLACE_SOURCE_QUEUE"},"awssns-vendor-producer":{"binder":"sns","destination":"YOUR_SNS_DESTINATION"}}},"transformation":{"$ref":"#/components/schemas/MicroIntegrationTransformation"}},"required":["microIntegrationId","name"]},"MicroIntegrationFlowCloneConfiguration":{"type":"object","default":null,"description":"The fields to specify to clone a Micro-Integration Flow.","properties":{"name":{"type":"string","default":"","description":"The name of the cloned Micro-Integration Flow.","example":"My First Micro-Integration Flow Cloned","minLength":1},"description":{"type":"string","default":"","description":"The description of the Micro-Integration Flow.","example":"Main data processing flow"},"configurationValues":{"type":"object","additionalProperties":{},"default":"","description":"The configuration details for the Micro-Integration Flow. For example, the configuration values specified for Amazon SNS is a follows:
\n\n{\n \"awssns-solace-consumer\": {\n \"binder\": \"solace\",\n \"destination\": \"YOUR_SOLACE_SOURCE_QUEUE\"\n },\n \"awssns-vendor-producer\": {\n \"binder\": \"sns\",\n \"destination\": \"YOUR_SNS_DESTINATION\"\n }\n}\n\n","example":{"awssns-solace-consumer":{"binder":"solace","destination":"YOUR_SOLACE_SOURCE_QUEUE"},"awssns-vendor-producer":{"binder":"sns","destination":"YOUR_SNS_DESTINATION"}}},"transformation":{"$ref":"#/components/schemas/MicroIntegrationTransformation","default":"","description":"The transformation being updated."},"removedFields":{"type":"array","default":"","description":"The list of fields to be removed from the Micro-Integration flow.","example":["brokerId"],"items":{"type":"string"}}},"required":["name"]},"MicroIntegrationV2StateUpdate":{"type":"object","default":null,"properties":{"state":{"type":"string","default":"","description":"The state of an existing Micro-Integration. You can specify the following states:
\ndeploying-Start the deployment of the Micro-Integration. A valid state to set when \n the Micro-Integration is in undeployed or error state.undeploying-Start the undeployment of the Micro-Integration. A valid state to set when \n the Micro-Integration is in the running state.The configuration details for the Micro-Integration. For example, the configuration values specified for Amazon SNS is a follows:
\n\n{\n \"awssns-vendor\": {\n \"region\": \"YOUR_AWS_REGION\",\n \"authentication\": {\n \"accessKey\": \"YOUR_AWS_ACCESS_KEY\",\n \"secretKey\": \"YOUR_AWS_SECRET_KEY\"\n }\n },\n \"awssns-solace\": {\n \"authentication\": {\n \"host\": \"YOUR_SOLACE_BROKER_HOST_URL\",\n \"messageVpn\": \"YOUR_SOLACE_BROKER_MESSAGE_VPN\",\n \"clientPassword\": \"YOUR_SOLACE_BROKER_CLIENT_PASSWORD\",\n \"clientUsername\": \"YOUR_SOLACE_BROKER_CLIENT_USERNAME\"\n }\n }\n}\n\n","example":{"awssns-vendor":{"region":"YOUR_AWS_REGION","authentication":{"accessKey":"YOUR_AWS_ACCESS_KEY","secretKey":"YOUR_AWS_SECRET_KEY"}},"awssns-solace":{"authentication":{"host":"YOUR_SOLACE_BROKER_HOST_URL","messageVpn":"YOUR_SOLACE_BROKER_MESSAGE_VPN","clientPassword":"YOUR_SOLACE_BROKER_CLIENT_PASSWORD","clientUsername":"YOUR_SOLACE_BROKER_CLIENT_USERNAME"}}}},"triggerDeployment":{"type":"boolean","default":false,"description":"Triggers the deployment of the micro-integration"},"removedFields":{"type":"array","default":"","description":"The list of fields to be removed from the Micro-Integration.","example":["brokerId"],"items":{"type":"string"}}}},"MicroIntegrationFlowUpdateConfiguration":{"type":"object","default":null,"description":"The fields to specify to update a Micro-Integration Flow.","properties":{"name":{"type":"string","default":"","description":"The name of the Micro-Integration Flow.","example":"My First Micro-Integration Flow"},"description":{"type":"string","default":"","description":"The description of the Micro-Integration Flow.","example":"Main data processing flow"},"configurationValues":{"type":"object","additionalProperties":{},"default":"","description":"The configuration details for the Micro-Integration Flow. For example, the configuration values specified for Amazon SNS is a follows:
\n\n{\n \"awssns-solace-consumer\": {\n \"binder\": \"solace\",\n \"destination\": \"YOUR_SOLACE_SOURCE_QUEUE\"\n },\n \"awssns-vendor-producer\": {\n \"binder\": \"sns\",\n \"destination\": \"YOUR_SNS_DESTINATION\"\n }\n}\n\n","example":{"awssns-solace-consumer":{"binder":"solace","destination":"YOUR_SOLACE_SOURCE_QUEUE"},"awssns-vendor-producer":{"binder":"sns","destination":"YOUR_SNS_DESTINATION"}}},"transformation":{"$ref":"#/components/schemas/MicroIntegrationTransformation","default":"","description":"The transformation being updated."},"removedFields":{"type":"array","default":"","description":"The list of fields to be removed from the Micro-Integration flow.","example":["brokerId"],"items":{"type":"string"}}}},"Pagination":{"type":"object","default":null,"properties":{"pageNumber":{"type":"string","default":"1","description":"The page number to retrieve.","minimum":1},"pageSize":{"type":"string","default":"100","description":"The number of entities to return per page.","maximum":100,"minimum":1},"count":{"type":"string","default":"","description":"The total number of entities that exist, ignoring paging."},"nextPage":{"type":"string","default":"","description":"The next page number that can be queried."},"totalPages":{"type":"string","default":"","description":"The total number of pages that can be queried."}}},"TransformationPayloadsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TransformationPayload"}},"meta":{"$ref":"#/components/schemas/meta"}}},"meta":{"type":"object","default":null,"description":"The metadata about the response, which can include:
\nconfigurationValues property at which the key field's value can be found for the given template type.","example":"region","readOnly":true},"defaultDescription":{"type":"string","default":"","description":"The description or value of the field when no value is provided in the Micro-Integration's configurationValues property.","example":"us/east1","readOnly":true}},"readOnly":true},"MicroIntegrationType":{"type":"object","default":null,"properties":{"id":{"type":"string","default":"","description":"The unique identifier of the Micro-Integration type.","example":"awssns-target","readOnly":true},"name":{"type":"string","default":"","description":"The name of the Micro-Integration type.","example":"Amazon SNS","readOnly":true},"version":{"type":"string","default":"","description":"The version of the Micro-Integration type.","example":"6.0.1","readOnly":true},"description":{"type":"string","default":"","description":"The description of the Micro-Integration type.","example":"The Amazon SNS-Target publishes events from an event broker service to an SNS Topic with message acknowledgement.","readOnly":true},"microIntegrationType":{"type":"string","default":"","description":"The unique identifier of the vendor or system associated with the Micro-Integration type.","example":"awssns","readOnly":true},"integrationHubUrl":{"type":"string","default":"","description":"The Integration Hub URL associated with the Micro-Integration Type. Configuration details, examples, download links, and more information can be found in the Integration Hub.","example":"https://solace.com/integration-hub/aws-sns/","readOnly":true},"category":{"type":"string","default":"","description":"The category that the Micro-Integration type belongs to, such as \"Messaging/Eventing\".","example":"Messaging/Eventing","readOnly":true},"direction":{"type":"string","default":"","description":"The direction specifies the flow of data for the Micro-Integration. The directions are:
source-A source Micro-Integration is where data flows from the event broker service through the Micro-Integration to the external system.target-A target Micro-Integration is where data flows from the external system through the Micro-Integration to the event broker service.A time series of metrics for a deployed Micro-Integration.
\n\n{\n \"end\": 1748973629000,\n \"attributes\": {},\n \"metric\": \"solace.connector.health\",\n \"interval\": 10,\n \"start\": 1748973620000,\n \"length\": 1,\n \"lastUpdated\": 1748973901000,\n \"orgId\": \"your_org_id\",\n \"advancedMonitoringEnabled\": true,\n \"queryIndex\": 2,\n \"aggr\": \"max\",\n \"scope\": \"deployment_id:your_deployment_id,org_id:your_org_id\",\n \"pointlist\": [[1748973620000, 503]],\n \"expression\": \"max:solace.connector.health{deployment_id:your_deployment_id,org_id:your_org_id}.rollup(max, 10)\",\n \"displayName\": \"solace.connector.health\",\n \"averageValue\": 503.0,\n \"eventBrokerServiceStatus\": null,\n \"timeSinceLastSuccess\": null,\n \"healthStatus\": \"HEALTHY\",\n \"latestValue\": 503,\n \"maxValue\": 503,\n \"sumValue\": 503\n}\n\n","properties":{"end":{"type":"integer","format":"int64","default":"","description":"The timestamp (in milliseconds since epoch) representing the end of the time series data.","example":1748973629000},"attributes":{"$ref":"#/components/schemas/MicroIntegrationMetricSeriesAttributes","default":"","description":"Additional attributes associated with the time series data.","example":{}},"metric":{"type":"string","default":"","description":"The name of the metric being measured.","example":"solace.connector.health"},"interval":{"type":"integer","format":"int32","default":"","description":"The time interval (in seconds) between data points in the time series.","example":10},"start":{"type":"integer","format":"int64","default":"","description":"The timestamp (in milliseconds since epoch) representing the start of the time series data.","example":1748973620000},"length":{"type":"integer","format":"int32","default":"","description":"The number of data points in the time series.","example":1},"lastUpdated":{"type":"integer","format":"int64","default":"","description":"The timestamp (in milliseconds since epoch) when the time series data was last updated.","example":1748973901000},"queryIndex":{"type":"integer","format":"int32","default":"","description":"The index of the query that generated this time series data.","example":2},"aggr":{"type":"string","default":"","description":"The aggregation method used for the time series data (e.g., max, min, avg).","example":"max"},"scope":{"type":"string","default":"","description":"The scope or context of the metric, typically containing tags or identifiers.","example":"deployment_id:your_deployment_id,org_id:your_org_id"},"pointlist":{"type":"array","default":"","description":"A list of data points, where each data point is a list containing a timestamp and a value.","example":[[1748973620000,503]],"items":{"type":"array","items":{"type":"integer","format":"int64"}}},"expression":{"type":"string","default":"","description":"The expression used to query the metric data.","example":"max:solace.connector.health{deployment_id:your_deployment_id,org_id:your_org_id}.rollup(max, 10)"},"displayName":{"type":"string","default":"","description":"The human-readable name of the metric for display purposes.","example":"solace.connector.health"},"averageValue":{"type":["number","null"],"format":"double","default":"","description":"The average value of all data points in the time series.","example":503},"eventBrokerServiceStatus":{"type":["string","null"],"default":"","description":"The status of the event broker service associated with this metric, if applicable."},"timeSinceLastSuccess":{"type":["integer","null"],"format":"int64","default":"","description":"The time (in milliseconds) since the last successful operation related to this metric, if applicable."},"healthStatus":{"type":"string","default":"","description":"The health status derived from the metric data.","example":"HEALTHY"},"latestValue":{"type":"integer","format":"int64","default":"","description":"The most recent value in the time series data.","example":503},"maxValue":{"type":"integer","format":"int32","default":"","description":"The maximum value in the time series data.","example":503},"sumValue":{"type":"integer","format":"int64","default":"","description":"The sum of all values in the time series data.","example":503}}},"MicroIntegrationMetricSeriesAttributes":{"type":"null","default":null,"description":"Container for additional attributes associated with a metric series. This object may contain custom properties depending on the metric type."},"MicroIntegrationLog":{"type":"object","default":null,"description":"A log created by a deployed Micro-Integration.","properties":{"message":{"type":"string","default":"","description":"The error message text.","example":"Failed to deploy Micro-Integration due to missing configuration."},"timestamp":{"type":"string","default":"","description":"The timestamp when the error occurred in ISO-8601 format.","example":"2025-05-15T20:48:58.096Z"},"attributes":{"$ref":"#/components/schemas/MicroIntegrationLogDetail","default":"","description":"Attributes which provide detailed information about the log, such as the component, logger name, and stack trace."}}},"MicroIntegrationLogContainerMicroIntegrationLog":{"type":"object","default":null,"properties":{"attributes":{"$ref":"#/components/schemas/MicroIntegrationLog","default":"","description":"The attributes of the log entry, such as the log message, timestamp, and additional metadata."}}},"MicroIntegrationLogDetail":{"type":"object","default":null,"description":"Detailed attributes of a Micro-Integration log message.
\n\n{\n \"component\": \"maas-micro-integration\",\n \"loggerName\": \"com.MicroIntegrationLogger\",\n \"stackTrace\": \"org.springframework.beans.factory.BeanCreationNotAllowedException: Error creating bean\"\n}\n\n","example":{"component":"maas-micro-integration","loggerName":"com.MicroIntegrationLogger","stackTrace":"org.springframework.beans.factory.BeanCreationNotAllowedException: Error creating bean"},"properties":{"component":{"type":"string","default":"","description":"The component that generated the log.","example":"maas-micro-integration"},"loggerName":{"type":"string","default":"","description":"The name of the logger that recorded the log.","example":"com.MicroIntegrationLogger"},"stackTrace":{"type":"string","default":"","description":"The stack trace of the log, if available.","example":"org.springframework.beans.factory.BeanCreationNotAllowedException: Error creating bean"}}},"MicroIntegrationLogResponse":{"type":"object","default":null,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MicroIntegrationLogContainerMicroIntegrationLog"}}}},"MicroIntegrationV2ListResult":{"type":"object","default":null,"properties":{"createdBy":{"type":"string","default":"","description":"The unique identifier representing the user who created the Micro-Integration.","example":"4f0awkmmtna","readOnly":true},"createdTime":{"type":"string","format":"date-time","default":"","description":"The time that the Micro-Integration was created, in ISO 8601 date/time format.","example":"2023-06-24T15:30:00","readOnly":true},"updatedBy":{"type":"string","default":"","description":"The unique identifier representing the user who last updated the Micro-Integration.","example":"4f0awkmmtna","readOnly":true},"updatedTime":{"type":"string","format":"date-time","default":"","description":"The time of the last update that was performed on the Micro-Integration, in ISO 8601 date/time format.","example":"2023-06-24T15:30:00","readOnly":true},"id":{"type":"string","default":"","description":"The unique identifier of the Micro-Integration.","example":"123abc789","readOnly":true},"environmentId":{"type":"string","default":"","description":"The unique identifier of the environment associated with the Micro-Integration.","example":"456abc789","readOnly":true},"name":{"type":"string","default":"","description":"The name of the Micro-Integration.","example":"My-First-Micro-Integration"},"description":{"type":"string","default":"","description":"The description of the Micro-Integration.","example":"My first Micro-Integration that consumes events from my external system."},"microIntegrationType":{"type":"string","default":"","description":"The type of Micro-Integration. You can determine the types using Get a list of Micro-Integration types.","example":"awssns"},"direction":{"type":"string","default":"","description":"The direction that data flows through the Micro-Integration. The directions are:
source-A source Micro-Integration is where data flows from the event broker service through the Micro-Integration to the external system.target-A target Micro-Integration is where data flows from the external system through the Micro-Integration to the event broker service.The version that of the Micro-Integration type being used.
","example":"1.0.0"},"state":{"type":"string","default":"","description":"The state of the Micro-Integration, each of which are described below:
notdeployed-A Micro-Integration starts in the Not Deployed state when it's first created. In the Not Deployed state, data does not flow between your external system and the event broker service.deploying-A transient state that indicates that the Micro-Integration is in the process of being deployed.running-In the Running state, data flows between your external system and the event broker service.undeploying-A transient state that indicates that the Micro-Integration is in the process of being undeployed.error-An error condition occurred with the Micro-Integration and recovery is not possible. The reasons for the errors are displayed in the error text.down-If an error condition occurs with a Micro-Integration and recovery is not possible, the Micro-Integration moves to the Down state. When you view the Micro-Integration, the reasons for the errors are displayed in the error text.Whether or not the state is currently being asynchronously retrieved. A subsequent API call should reflect the updated state.
","example":true},"brokerId":{"type":"string","default":"","description":"The unique identifier of the event broker service associated to the Micro-Integration.","example":"broker456"},"lastDeploymentId":{"type":"string","default":"","description":"The most recent deployment id for the Micro-Integration."},"configurationValues":{"type":"object","additionalProperties":{},"default":"","description":"The configuration details for the Micro-Integration. For example, the configuration values specified for Amazon SNS is a follows:
\n\n{\n \"awssns-vendor\": {\n \"region\": \"YOUR_AWS_REGION\",\n \"authentication\": {\n \"accessKey\": \"YOUR_AWS_ACCESS_KEY\",\n \"secretKey\": \"YOUR_AWS_SECRET_KEY\"\n }\n },\n \"awssns-solace\": {\n \"authentication\": {\n \"host\": \"YOUR_SOLACE_BROKER_HOST_URL\",\n \"messageVpn\": \"YOUR_SOLACE_BROKER_MESSAGE_VPN\",\n \"clientPassword\": \"YOUR_SOLACE_BROKER_CLIENT_PASSWORD\",\n \"clientUsername\": \"YOUR_SOLACE_BROKER_CLIENT_USERNAME\"\n }\n }\n}\n\n","example":{"awssns-vendor":{"region":"YOUR_AWS_REGION","authentication":{"accessKey":"YOUR_AWS_ACCESS_KEY","secretKey":"YOUR_AWS_SECRET_KEY"}},"awssns-solace":{"authentication":{"host":"YOUR_SOLACE_BROKER_HOST_URL","messageVpn":"YOUR_SOLACE_BROKER_MESSAGE_VPN","clientPassword":"YOUR_SOLACE_BROKER_CLIENT_PASSWORD","clientUsername":"YOUR_SOLACE_BROKER_CLIENT_USERNAME"}}}},"deploymentDetails":{"$ref":"#/components/schemas/MicroIntegrationDeployment","default":"","description":"The details of the most recent deployment for the Micro-Integration. This portion of the response that is only included if the 'include=deployment' query parameter is set to true."},"flows":{"type":"array","default":"","description":"The list of flows associated with this Micro-Integration. This portion of the response that is only included if the 'include=flows' query parameter is present.","items":{"$ref":"#/components/schemas/MicroIntegrationFlow"}},"aiDiagnosis":{"$ref":"#/components/schemas/MiFailureDiagnosisResponse","default":"","description":"The most recent AI failure diagnosis for the Micro-Integration. Only populated when the request includes aiDiagnosis."},"matchedFlowIds":{"type":"array","default":"","description":"List of flow IDs that matched the search criteria when using the 'nameContains' filter. This field is only present when the micro-integration was returned because a flow name matched the search string, but the micro-integration name itself did not match. If the micro-integration name matched the search, this field will be null. This field is independent of the 'include' query parameter.","example":["flow-id-1","flow-id-2"],"items":{"type":"string"},"readOnly":true},"type":{"type":"string","default":"","description":"The type of object for informational purposes.","example":"microIntegration","readOnly":true}}},"MicroIntegrationsV2Response":{"type":"object","default":null,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MicroIntegrationV2ListResult"}},"meta":{"$ref":"#/components/schemas/meta"}}},"MicroIntegrationTypesResponse":{"type":"object","default":null,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MicroIntegrationType"}},"meta":{"$ref":"#/components/schemas/meta"}}},"MicroIntegrationFunctionsResponse":{"type":"object","default":null,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MicroIntegrationFunction"}}}},"MicroIntegrationTemplate":{"type":"object","properties":{"id":{"type":"string","default":"","description":"The unique identifier representing the Micro-Integration template.","example":"awssns-solace","readOnly":true},"templateType":{"type":"string","default":"","description":"The type of the Micro-Integration template. Some common examples are as follows:\n workflow-A template that describes the streams of data that flow between an event broker service and\n the vendor-specific external system. The data can include header and payload transformations.solace-A template that contains the configuration for how to connect to the event broker service.\n This includes authentication details and destination detailssolaceSource-A template containing the configuration needed to produce events in an event mesh for\n use in a source Micro-Integration.solaceTarget-A template containing the configuration needed to consume events from an event mesh\n as an output of a target Micro-Integration.vendor-A template containing configuration outlining how to connect to the vendor-specific external system.\n This information often includes sensitive account information and connection details.vendorSource-A template containing the configuration needed to consume events from the vendor-specific system for use\n in a source Micro-Integration.vendorTarget-A template containing the configuration needed to produce events in the vendor-specific system as an output of\n a target Micro-Integration.\n[\n {\n \"id\": \"awssns-solace\",\n \"template\": {\n \"type\": \"object\",\n \"properties\": {\n \"authentication\": {\n \"title\": \"Authentication\",\n \"unevaluatedProperties\": false,\n \"oneOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"host\": {\n \"type\": \"string\",\n \"title\": \"Host\",\n \"description\": \"The host URI of the event broker, such as tcps://myhost:55555.\",\n \"x-configurationProperty\": {\n \"key\": \"solace.java.host\"\n }\n },\n \"messageVpn\": {\n \"type\": \"string\",\n \"title\": \"Message VPN\",\n \"description\": \"The name of the Message VPN to connect to on the event broker service.\",\n \"maxLength\": 32,\n \"x-configurationProperty\": {\n \"key\": \"solace.java.msg-vpn\"\n }\n },\n \"clientUsername\": {\n \"type\": \"string\",\n \"title\": \"Client Username\",\n \"description\": \"The username to authenticate with the event broker service to establish a\n messaging connection.\",\n \"maxLength\": 189,\n \"x-configurationProperty\": {\n \"key\": \"solace.java.client-username\"\n }\n },\n \"clientPassword\": {\n \"type\": \"string\",\n \"title\": \"Client Password\",\n \"description\": \"The password to authenticate with the event broker service to establish a\n messaging connection.\",\n \"maxLength\": 128,\n \"x-sensitivity\": \"SECRET\",\n \"x-configurationProperty\": {\n \"key\": \"solace.java.client-password\"\n }\n }\n },\n \"required\": [\n \"host\",\n \"messageVpn\",\n \"clientUsername\",\n \"clientPassword\"\n ],\n \"title\": \"PubSub+ Basic Authentication\"\n }\n ]\n }\n },\n \"required\": [\n \"authentication\"\n ],\n \"unevaluatedProperties\": false,\n \"title\": \"PubSub+ Binder\"\n }\n }\n]\n\n","example":"[\n {\n \"id\": \"awssns-solace\",\n \"template\": {\n \"type\": \"object\",\n \"properties\": {\n \"authentication\": {\n \"title\": \"Authentication\",\n \"unevaluatedProperties\": false,\n \"oneOf\": [\n {\n \"type\": \"object\",\n \"properties\": {\n \"host\": {\n \"type\": \"string\",\n \"title\": \"Host\",\n \"description\": \"The host URI of the event broker, such as tcps://myhost:55555.\",\n \"x-configurationProperty\": {\n \"key\": \"solace.java.host\"\n }\n },\n \"messageVpn\": {\n \"type\": \"string\",\n \"title\": \"Message VPN\",\n \"description\": \"The name of the Message VPN to connect to on the event broker service.\",\n \"maxLength\": 32,\n \"x-configurationProperty\": {\n \"key\": \"solace.java.msg-vpn\"\n }\n },\n \"clientUsername\": {\n \"type\": \"string\",\n \"title\": \"Client Username\",\n \"description\": \"The username to authenticate with the event broker service\n to establish a messaging connection.\",\n \"maxLength\": 189,\n \"x-configurationProperty\": {\n \"key\": \"solace.java.client-username\"\n }\n },\n \"clientPassword\": {\n \"type\": \"string\",\n \"title\": \"Client Password\",\n \"description\": \"The password to authenticate with the event broker service to establish a\n messaging connection.\",\n \"maxLength\": 128,\n \"x-sensitivity\": \"SECRET\",\n \"x-configurationProperty\": {\n \"key\": \"solace.java.client-password\"\n }\n }\n },\n \"required\": [\n \"host\",\n \"messageVpn\",\n \"clientUsername\",\n \"clientPassword\"\n ],\n \"title\": \"PubSub+ Basic Authentication\"\n }\n ]\n }\n },\n \"required\": [\n \"authentication\"\n ],\n \"unevaluatedProperties\": false,\n \"title\": \"PubSub+ Binder\"\n }\n }\n]","items":{},"readOnly":true,"uniqueItems":true},"optional":{"type":"boolean","default":false,"description":"Whether this template is optional","example":true,"readOnly":true},"type":{"type":"string","default":"","description":"The type of object for informational purposes.","example":"microIntegrationTemplate","readOnly":true}}},"MicroIntegrationTemplatesResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MicroIntegrationTemplate"}},"meta":{"$ref":"#/components/schemas/meta"}}},"MicroIntegrationFlowsResponse":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/MicroIntegrationFlow"}},"meta":{"$ref":"#/components/schemas/meta"}}},"ResponseListString":{"type":"object","properties":{"data":{"type":"array","items":{"type":"string"}},"meta":{"type":"object","additionalProperties":{}}}},"OrganizationIntegrationLimit":{"type":"object","default":null,"properties":{"createdBy":{"type":"string","default":"","description":"The unique identifier representing the user who created the Micro-Integration.","example":"4f0awkmmtna","readOnly":true},"createdTime":{"type":"string","format":"date-time","default":"","description":"The time that the Micro-Integration was created, in ISO 8601 date/time format.","example":"2023-06-24T15:30:00","readOnly":true},"updatedBy":{"type":"string","default":"","description":"The unique identifier representing the user who last updated the Micro-Integration.","example":"4f0awkmmtna","readOnly":true},"updatedTime":{"type":"string","format":"date-time","default":"","description":"The time of the last update that was performed on the Micro-Integration, in ISO 8601 date/time format.","example":"2023-06-24T15:30:00","readOnly":true},"limitClassId":{"type":"string","default":"","description":"The ID of the organization limit."},"purchasedQuantity":{"type":"integer","format":"int32","default":"","description":"The limit of SKUs."},"permittedFlowQuantity":{"type":"integer","format":"int32","default":"","description":"The number of permitted connector flows."},"usedFlowQuantity":{"type":"integer","format":"int32","default":"","description":"The number of used connector flows."},"description":{"type":"string","default":"","description":"The description of the limit."},"type":{"type":"string"},"id":{"type":"string"}}},"OrganizationIntegrationLimitResponse":{"type":"object","default":null,"properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/OrganizationIntegrationLimit"}},"meta":{"$ref":"#/components/schemas/meta"}}}},"securitySchemes":{"APIToken":{"type":"http","scheme":"bearer","bearerFormat":"JWT"}}}}