{"data":{"siteConfig":{"withRbac":false},"site":{"pathPrefix":""},"apis":[{"id":"d73347a9-bba7-5160-9381-4bdb5ed1411aoverview/__redocly content redirect/process-intelligence-apis/agents-api/api-reference/openapi/reference/overview/","definitionId":"agents-api","link":"/process-intelligence-apis/agents-api/api-reference/openapi/reference/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/process-intelligence-apis/agents-api/api-reference/openapi/reference.page.yaml","info":{"title":"OpenAPI Specification","description":"AI API to chat with Celonis Agents and run their tools.","x-audience":"EX","version":"1.1.0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"agents-api","settings":{"corsProxyUrl":"https://cors.redoc.ly","generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"},{"lang":"PHP"}]}},"apiVersions":[{"definitionId":"agents-api","isDefault":true,"title":"agents-api","id":"agents-api"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"OpenAPI Specification\",\"description\":\"AI API to chat with Celonis Agents and run their tools.\",\"x-audience\":\"EX\",\"version\":\"1.1.0\"},\"security\":[{\"BearerAuth\":[]},{\"ApiKeyAuth\":[]}],\"servers\":[{\"url\":\"https://30f873b4-88d4-49ba-b327-6f651d7b99e6.remockly.com\"}],\"paths\":{\"/intelligence/api/ai/agents/{agent_id}/conversations\":{\"post\":{\"tags\":[\"Agents - Conversation\"],\"operationId\":\"pushConversations\",\"summary\":\"Post Conversation Message\",\"description\":\"Posts a conversation message to an asset, optionally with a conversation id.\\nAlways returns a text response for external use cases.\",\"parameters\":[{\"name\":\"agent_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"agent\"}}],\"requestBody\":{\"description\":\"Message details\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/Message\"}}}},\"responses\":{\"200\":{\"description\":\"Return agent id\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ChatResponse\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"},\"default\":{\"$ref\":\"#/components/responses/DefaultResponse\"}}}},\"/intelligence/api/ai/agents/{agent_id}/tools/spec\":{\"get\":{\"operationId\":\"get-tool-api\",\"tags\":[\"Agents - Tools\"],\"summary\":\"Get the agent tools OpenAPI specification\",\"description\":\"Get the agent tools OpenAPI specification which contains all the endpoints to execute the agent's tool\",\"parameters\":[{\"name\":\"agent_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"1234a123-12a1-12a1-1a1a-1a1abc12abc1\"}}],\"responses\":{\"200\":{\"description\":\"OpenAPI specification in JSON format\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"},\"default\":{\"$ref\":\"#/components/responses/DefaultResponse\"}}}},\"/intelligence/api/ai/agents/{agent_id}/tools/{tool_id}\":{\"post\":{\"operationId\":\"post-tool-response\",\"tags\":[\"Agents - Tools\"],\"summary\":\"Execute Tool\",\"description\":\"Execute a given agent tool.\",\"parameters\":[{\"name\":\"agent_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"1234a123-12a1-12a1-1a1a-1a1abc12abc1\"}},{\"name\":\"tool_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"tool_defined_name\"}}],\"requestBody\":{\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"example\":{\"kpi\":\"KIP_DEFINED_NAME\",\"field_ids\":[\"record.field_name\"]}}}}},\"responses\":{\"200\":{\"description\":\"Return results in Dynamic JSON format\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"example\":{\"kpis_and_attributes\":[{\"search_term\":\"invoice\",\"results\":[{\"id\":\"INVOICES.INVOICE_VALUE\",\"display_name\":\"Invoice Value\",\"column_type\":\"FLOAT\",\"type\":\"record\",\"score\":0.75}]}]}}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"},\"default\":{\"$ref\":\"#/components/responses/DefaultResponse\"}}}}},\"components\":{\"securitySchemes\":{\"BearerAuth\":{\"type\":\"http\",\"scheme\":\"bearer\",\"bearerFormat\":\"JWT\"},\"ApiKeyAuth\":{\"type\":\"apiKey\",\"in\":\"header\",\"name\":\"AppKey\"}},\"schemas\":{\"Problem\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"format\":\"uri-reference\",\"description\":\"A URI reference that uniquely identifies the problem type only in the context of the provided API. Opposed to the specification in RFC-7807, it is not recommended that it be dereferenceable and point to a human-readable documentation or be globally unique for the problem type.\\n\",\"default\":\"about:blank\",\"example\":\"/some/uri-reference\"},\"title\":{\"type\":\"string\",\"description\":\"A short summary of the problem type. Written in English and readable for engineers. Usually not suited for non technical stakeholders and not localized.\\n\",\"example\":\"some title for the error situation\"},\"status\":{\"type\":\"integer\",\"format\":\"int32\",\"description\":\"The HTTP status code generated by the origin server for this occurrence of the problem.\\n\",\"minimum\":100,\"maximum\":600,\"exclusiveMaximum\":true},\"detail\":{\"type\":\"string\",\"description\":\"A human readable explanation specific to this occurrence of the problem that is helpful to locate the problem and give advice on how to proceed. Written in English and readable for engineers. Usually not suited for non technical stakeholders and not localized.\\n\",\"example\":\"some description for the error situation\"},\"instance\":{\"type\":\"string\",\"format\":\"uri-reference\",\"description\":\"A URI reference that identifies the specific occurrence of the problem, e.g. by adding a fragment identifier or sub-path to the problem type. May be used to locate the root of this problem in the source code.\\n\",\"example\":\"/some/uri-reference#specific-occurrence-context\"}}},\"ChatResponse\":{\"title\":\"ChatResponse\",\"description\":\"Hits conversations of an specific agent\",\"type\":\"object\",\"properties\":{\"conversationId\":{\"type\":\"string\",\"description\":\"Conversation identifier\",\"example\":\"abc-def-ghi-etc\"},\"text\":{\"type\":\"string\",\"description\":\"Text from Chat\",\"example\":\"this is an example\"}}},\"Message\":{\"title\":\"Message chat\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"message\":{\"type\":\"string\"},\"conversationId\":{\"type\":\"string\"}},\"required\":[\"message\"]}},\"responses\":{\"BadRequest\":{\"description\":\"Bad Request.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"Unauthorized\":{\"description\":\"Unauthorized access.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"Forbidden\":{\"description\":\"Forbidden.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"NotFound\":{\"description\":\"The specified resource was not found\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"TooManyRequests\":{\"description\":\"Too Many Requests.\",\"headers\":{\"X-RateLimit-Limit\":{\"description\":\"Request limit per hour.\",\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},\"X-RateLimit-Remaining\":{\"description\":\"The number of requests left for the time window.\",\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},\"X-RateLimit-Reset\":{\"description\":\"The UTC date/time at which the current rate limit window resets.\",\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}},\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"InternalError\":{\"description\":\"Internal Server Error.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"ServiceUnavailable\":{\"description\":\"Service Unavailable.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}},\"DefaultResponse\":{\"description\":\"Default error\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/Problem\"}}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"corsProxyUrl\":\"https://cors.redoc.ly\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"PHP\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","permission":"guest","lastModified":"2025-10-07T16:52:38.000Z","label":"OpenAPI Specification","redocInfoPageId":"process-intelligence-apis/agents-api/api-reference/openapi/reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/celonis/celonis-public-developer-docs/process-intelligence-apis/agents-api/api-reference/openapi/reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"agents-api","isDefault":true,"id":"agents-api","title":"agents-api","link":null}]},{"id":"b7583657-4ac7-5276-975b-8bc40e5c2599overview/__redocly content redirect/celonis-apis/audit-log-api/openapi/openapi-external/overview/","definitionId":"autogenerated_celonis-apis/audit-log-api/openapi/openapi-external.yaml","link":"/celonis-apis/audit-log-api/openapi/openapi-external/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/celonis-apis/audit-log-api/openapi/openapi-external.yaml","info":{"description":"This is the documentation for the Audit Log API, that allows querying on audit logs in an EMS team. The API supports multiple methods of authentication:<br/> - (preferred method) Via OAuth 2.0 token with scope <tt>audit.log:read</tt>, passed in an HTTP header like this: <tt>Authorization: Bearer TOKEN</tt><br/> - Via Application keys, passed in an HTTP header like this: <tt>Authorization: AppKey APPLICATION_KEY</tt><br/> - Via API keys, passed in an HTTP header like this: <tt>Authorization: Bearer API_KEY</tt><br/><br/>Please see [this help page](https://docs.celonis.com/en/using-oauth-2-0.html) for more information about OAuth 2.0.<br/><br/>**ALL AUDIT LOG OPERATIONS ARE SCOPED TO A TEAM.**","title":"Celonis Audit Log API","version":"1.0.0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"autogenerated_celonis-apis/audit-log-api/openapi/openapi-external.yaml","isDefault":true,"label":"Overview","excludeFromSearch":false,"permission":"guest","settings":{},"apiVersions":[{"type":"reference-docs","definitionId":"autogenerated_celonis-apis/audit-log-api/openapi/openapi-external.yaml","isDefault":true,"label":"Overview"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.1\",\"info\":{\"description\":\"This is the documentation for the Audit Log API, that allows querying on audit logs in an EMS team. The API supports multiple methods of authentication:<br/> - (preferred method) Via OAuth 2.0 token with scope <tt>audit.log:read</tt>, passed in an HTTP header like this: <tt>Authorization: Bearer TOKEN</tt><br/> - Via Application keys, passed in an HTTP header like this: <tt>Authorization: AppKey APPLICATION_KEY</tt><br/> - Via API keys, passed in an HTTP header like this: <tt>Authorization: Bearer API_KEY</tt><br/><br/>Please see [this help page](https://docs.celonis.com/en/using-oauth-2-0.html) for more information about OAuth 2.0.<br/><br/>**ALL AUDIT LOG OPERATIONS ARE SCOPED TO A TEAM.**\",\"title\":\"Celonis Audit Log API\",\"version\":\"1.0.0\"},\"servers\":[{\"description\":\"Generated server url\",\"url\":\"http://localhost:8888/log\"}],\"security\":[{\"Authorization\":[]}],\"tags\":[{\"description\":\"For Querying Audit Logs in a team\",\"name\":\"Audit Log API\"}],\"paths\":{\"/api/external/audit\":{\"get\":{\"description\":\"Audit Logs can be filtered specifying a date interval.<br> Maximum number of Audit Logs that will be received by page is 200. <br> If there would be more Audit Logs on the specified date interval total number of pages will be returned for further querying.<br> 'USE AUDIT LOGS API' permission should be enabled\",\"operationId\":\"findAllAuditLogs\",\"parameters\":[{\"description\":\"Page number to be retrieved, starts with 0\",\"example\":0,\"in\":\"query\",\"name\":\"pageNumber\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":0,\"minimum\":0}},{\"description\":\"Limit of results per page\",\"example\":200,\"in\":\"query\",\"name\":\"pageSize\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":200,\"maximum\":200,\"minimum\":1}},{\"description\":\"Date Time ISO 8601 yyyy-MM-ddTHH:mm:ss\",\"example\":\"2021-01-01T09:00:00\",\"in\":\"query\",\"name\":\"from\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}},{\"description\":\"Date Time ISO 8601 yyyy-MM-ddTHH:mm:ss\",\"example\":\"2021-01-31T09:00:00\",\"in\":\"query\",\"name\":\"to\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PageTransportAuditLogExternalTransport\"}}},\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}},\"description\":\"Bad Request\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}},\"description\":\"Internal Server Error\"}},\"security\":[{\"Authorization\":[]}],\"summary\":\"List Audit Logs\",\"tags\":[\"Audit Log API\"]}}},\"components\":{\"schemas\":{\"AuditLogExternalTransport\":{\"type\":\"object\",\"properties\":{\"diffPayload\":{\"$ref\":\"#/components/schemas/DiffPayloadExternalTransport\"},\"event\":{\"type\":\"string\"},\"ipAddress\":{\"type\":\"string\"},\"message\":{\"type\":\"object\"},\"port\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\"},\"userId\":{\"type\":\"string\"},\"userRole\":{\"type\":\"string\"}}},\"DiffPayloadExternalTransport\":{\"type\":\"object\",\"properties\":{\"newValue\":{\"type\":\"string\"},\"oldValue\":{\"type\":\"string\"}}},\"ExceptionReference\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"reference\":{\"type\":\"string\"},\"shortMessage\":{\"type\":\"string\"}}},\"FrontendHandledBackendError\":{\"type\":\"object\",\"properties\":{\"errorInformation\":{\"type\":\"object\"},\"frontendErrorKey\":{\"type\":\"string\"}}},\"PageTransportAuditLogExternalTransport\":{\"type\":\"object\",\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AuditLogExternalTransport\"}},\"pageNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalCount\":{\"type\":\"integer\",\"format\":\"int64\"}}}},\"securitySchemes\":{\"Authorization\":{\"description\":\"Please, prefix the Token with \\\"AppKey \\\" or \\\"Bearer \\\" (word and space) to indicate the Authorization type\",\"in\":\"header\",\"name\":\"Authorization\",\"type\":\"apiKey\"}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","lastModified":"2026-01-05T21:57:24.000Z","redocInfoPageId":"celonis-apis/audit-log-api/openapi/openapi-external.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","sourcePath":"/data/celonis/celonis-public-developer-docs/celonis-apis/audit-log-api/openapi/openapi-external.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"autogenerated_celonis-apis/audit-log-api/openapi/openapi-external.yaml","isDefault":true,"id":null,"title":null,"link":"/celonis-apis/audit-log-api/openapi/openapi-external/overview/"}]},{"id":"de687edf-092e-5abb-a6df-60a4cef8928coverview/__redocly content redirect/celonis-apis/permissions-api/openapi/openapi/overview/","definitionId":"autogenerated_celonis-apis/permissions-api/openapi/openapi.yaml","link":"/celonis-apis/permissions-api/openapi/openapi/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/celonis-apis/permissions-api/openapi/openapi.yaml","info":{"description":"This is the documentation for the Permissions Export API that allows querying  of access permissions for a Celonis team. This API supports authentication via OAuth 2.0 token with scope <tt>authorization.permissions:read</tt>, passed in an HTTP header like this: <tt>Authorization: Bearer TOKEN</tt><br/><br/>Please see [this help page](https://docs.celonis.com/en/using-oauth-2-0.html) for more information about OAuth 2.0.<br/><br/>","title":"Permissions API","version":"1.0.0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"autogenerated_celonis-apis/permissions-api/openapi/openapi.yaml","isDefault":true,"label":"Overview","excludeFromSearch":false,"permission":"guest","settings":{},"apiVersions":[{"type":"reference-docs","definitionId":"autogenerated_celonis-apis/permissions-api/openapi/openapi.yaml","isDefault":true,"label":"Overview"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.1.0\",\"info\":{\"description\":\"This is the documentation for the Permissions Export API that allows querying  of access permissions for a Celonis team. This API supports authentication via OAuth 2.0 token with scope <tt>authorization.permissions:read</tt>, passed in an HTTP header like this: <tt>Authorization: Bearer TOKEN</tt><br/><br/>Please see [this help page](https://docs.celonis.com/en/using-oauth-2-0.html) for more information about OAuth 2.0.<br/><br/>\",\"title\":\"Permissions API\",\"version\":\"1.0.0\"},\"servers\":[{\"description\":\"Generated server url\",\"url\":\"https://adex-permissions.develop.celonis.cloud\"}],\"security\":[{\"Authorization\":[]}],\"tags\":[{\"description\":\"Export all permissions for the team as a JSON file.\",\"name\":\"Permissions Export API\"}],\"paths\":{\"/api/authorization/external/permissions\":{\"get\":{\"description\":\"Exports all permissions for the team as a JSON file.\",\"operationId\":\"findAllPermissions\",\"parameters\":[],\"responses\":{\"200\":{\"description\":\"A JSON file containing all permissions.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PermissionExportResponse\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient\\\\ \\\\permissions. In case you are unsure, please refer the documentation on [application keys]\\\\ \\\\(https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions]\\\\ \\\\(https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened.\\\\ \\\\Please forward the associated error ID along with any helpful information to [our support]\\\\ \\\\(https://help.celonis.cloud/help/display/CIBC/Support)\"}},\"security\":[{\"Authorization\":[]}],\"summary\":\"Export permissions\",\"tags\":[\"Permissions Export API\"]}}},\"components\":{\"schemas\":{\"FrontendHandledBackendError\":{\"type\":\"object\",\"properties\":{\"frontendErrorKey\":{\"type\":\"string\"},\"errorInformation\":{\"type\":\"string\"}}},\"PermissionExportItem\":{\"type\":\"object\",\"properties\":{\"subjectName\":{\"type\":\"string\"},\"subjectType\":{\"type\":\"string\"},\"subjectId\":{\"type\":\"string\"},\"groups\":{\"type\":\"string\"},\"role\":{\"type\":\"string\"},\"service\":{\"type\":\"string\"},\"objectName\":{\"type\":\"string\"},\"objectType\":{\"type\":\"string\"},\"objectId\":{\"type\":\"string\"},\"actions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}}},\"PermissionExportResponse\":{\"type\":\"object\",\"properties\":{\"permissions\":{\"type\":\"array\",\"description\":\"List of permissions\",\"items\":{\"$ref\":\"#/components/schemas/PermissionExportItem\"}}}}},\"securitySchemes\":{\"Authorization\":{\"description\":\"Please, prefix the Token with \\\"AppKey \\\" or \\\"Bearer \\\" (word and space) to indicate   the Authorization type\",\"in\":\"header\",\"name\":\"Authorization\",\"type\":\"apiKey\"}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","lastModified":"2026-02-02T22:46:17.000Z","redocInfoPageId":"celonis-apis/permissions-api/openapi/openapi.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","sourcePath":"/data/celonis/celonis-public-developer-docs/celonis-apis/permissions-api/openapi/openapi.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"autogenerated_celonis-apis/permissions-api/openapi/openapi.yaml","isDefault":true,"id":null,"title":null,"link":"/celonis-apis/permissions-api/openapi/openapi/overview/"}]},{"id":"366312b5-b0a5-584d-84cd-45c3e685173boverview/__redocly content redirect/celonis-apis/platform-api/openapi/openapi-external/overview/","definitionId":"autogenerated_celonis-apis/platform-api/openapi/openapi-external.yaml","link":"/celonis-apis/platform-api/openapi/openapi-external/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/celonis-apis/platform-api/openapi/openapi-external.yaml","info":{"contact":{"email":"support@celonis.com","name":"Celonis Support","url":"https://celonis.com"},"description":"This is the documentation for the Platform Adoption API, that allows querying on platform adoption event in an EMS team. The API supports multiple methods of authentication:<br/> - (preferred method) Via OAuth 2.0 token with scope <tt>platform-adoption.tracking-events:read</tt>, passed in an HTTP header like this: <tt>Authorization: Bearer TOKEN</tt><br/> - Via Application keys, passed in an HTTP header like this: <tt>Authorization: AppKey APPLICATION_KEY</tt><br/> - Via API keys, passed in an HTTP header like this: <tt>Authorization: Bearer API_KEY</tt><br/><br/>Please see [this help page](https://docs.celonis.com/en/using-oauth-2-0.html) for more information about OAuth 2.0.<br/><br/>","title":"Celonis Platform Adoption API","version":"1.0.0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"autogenerated_celonis-apis/platform-api/openapi/openapi-external.yaml","isDefault":true,"label":"Overview","excludeFromSearch":false,"permission":"guest","settings":{},"apiVersions":[{"type":"reference-docs","definitionId":"autogenerated_celonis-apis/platform-api/openapi/openapi-external.yaml","isDefault":true,"label":"Overview"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.1\",\"info\":{\"contact\":{\"email\":\"support@celonis.com\",\"name\":\"Celonis Support\",\"url\":\"https://celonis.com\"},\"description\":\"This is the documentation for the Platform Adoption API, that allows querying on platform adoption event in an EMS team. The API supports multiple methods of authentication:<br/> - (preferred method) Via OAuth 2.0 token with scope <tt>platform-adoption.tracking-events:read</tt>, passed in an HTTP header like this: <tt>Authorization: Bearer TOKEN</tt><br/> - Via Application keys, passed in an HTTP header like this: <tt>Authorization: AppKey APPLICATION_KEY</tt><br/> - Via API keys, passed in an HTTP header like this: <tt>Authorization: Bearer API_KEY</tt><br/><br/>Please see [this help page](https://docs.celonis.com/en/using-oauth-2-0.html) for more information about OAuth 2.0.<br/><br/>\",\"title\":\"Celonis Platform Adoption API\",\"version\":\"1.0.0\"},\"servers\":[{\"description\":\"Default Server URL\",\"url\":\"/\"}],\"security\":[{\"Authorization\":[]}],\"tags\":[{\"description\":\"For Querying Platform Adoption in a team\",\"name\":\"Platform Adoption API\"}],\"paths\":{\"/platform-adoption/api/external/adoption-tracking-events/STUDIO_ASSET\":{\"get\":{\"operationId\":\"findAllStudioAssetAdoptionTrackingEvents\",\"parameters\":[{\"description\":\"Type of adoption tracking event\",\"example\":\"APPS\",\"in\":\"query\",\"name\":\"appName\",\"required\":false,\"schema\":{\"$ref\":\"#/components/schemas/StudioAppName\"}},{\"description\":\"Page number to be retrieved, starts with 0\",\"example\":0,\"in\":\"query\",\"name\":\"pageNumber\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":0,\"minimum\":0}},{\"description\":\"Limit of results per page\",\"example\":200,\"in\":\"query\",\"name\":\"pageSize\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":200,\"maximum\":200,\"minimum\":1}},{\"description\":\"Date Time ISO 8601 yyyy-MM-dd\",\"example\":\"2022-01-01\",\"in\":\"query\",\"name\":\"from\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date\"}},{\"description\":\"Date Time ISO 8601 yyyy-MM-dd\",\"example\":\"2022-01-31\",\"in\":\"query\",\"name\":\"to\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date\"}}],\"responses\":{\"200\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SwaggerStudioAssetAdoptionTrackingEventExternal\"}}},\"description\":\"A JSON object representing the paginated results.\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{},\"description\":\"Bad Request. Please check the response contents for an explanation of the cause.\"},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"content\":{},\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\"}},\"security\":[{\"Authorization\":[]}],\"tags\":[\"Platform Adoption API\"]}}},\"components\":{\"schemas\":{\"StudioAppName\":{\"type\":\"string\",\"enum\":[\"APPS\",\"STUDIO\"]},\"StudioAssetAdoptionTrackingEventExternalTransport\":{\"type\":\"object\",\"properties\":{\"appName\":{\"$ref\":\"#/components/schemas/StudioAppName\"},\"asset\":{\"$ref\":\"#/components/schemas/StudioNodeSummaryExternalTransport\"},\"assetPackage\":{\"$ref\":\"#/components/schemas/StudioNodeSummaryExternalTransport\"},\"folders\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/StudioNodeSummaryExternalTransport\"}},\"space\":{\"$ref\":\"#/components/schemas/StudioNodeSummaryExternalTransport\"},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\"},\"user\":{\"$ref\":\"#/components/schemas/UserSummaryExternalTransport\"}}},\"StudioNodeSummaryExternalTransport\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"}}},\"SwaggerStudioAssetAdoptionTrackingEventExternal\":{\"type\":\"object\",\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/StudioAssetAdoptionTrackingEventExternalTransport\"}},\"pageNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalCount\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"UserSummaryExternalTransport\":{\"type\":\"object\",\"properties\":{\"email\":{\"type\":\"string\"},\"id\":{\"type\":\"string\"}}}},\"securitySchemes\":{\"Authorization\":{\"description\":\"Please, prefix the Token with \\\"AppKey \\\" or \\\"Bearer \\\" (word and space) to indicate the Authorization type\",\"in\":\"header\",\"name\":\"Authorization\",\"type\":\"apiKey\"}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","lastModified":"2025-10-02T15:08:26.000Z","redocInfoPageId":"celonis-apis/platform-api/openapi/openapi-external.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","sourcePath":"/data/celonis/celonis-public-developer-docs/celonis-apis/platform-api/openapi/openapi-external.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"autogenerated_celonis-apis/platform-api/openapi/openapi-external.yaml","isDefault":true,"id":null,"title":null,"link":"/celonis-apis/platform-api/openapi/openapi-external/overview/"}]},{"id":"6a0f24bd-1ef4-53b1-b7c8-ce4b43ce6c7boverview/__redocly content redirect/celonis-apis/scim-api/openapi/scim_openapi_spec/overview/","definitionId":"autogenerated_celonis-apis/scim-api/openapi/scim_openapi_spec.yaml","link":"/celonis-apis/scim-api/openapi/scim_openapi_spec/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/celonis-apis/scim-api/openapi/scim_openapi_spec.yaml","info":{"title":"Celonis SCIM API","description":"The SCIM API allows for the managing groups and users within the Celonis Platform.","contact":{"name":"Celonis Support"},"version":"1.0.0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"autogenerated_celonis-apis/scim-api/openapi/scim_openapi_spec.yaml","isDefault":true,"label":"Overview","excludeFromSearch":false,"permission":"guest","settings":{},"apiVersions":[{"type":"reference-docs","definitionId":"autogenerated_celonis-apis/scim-api/openapi/scim_openapi_spec.yaml","isDefault":true,"label":"Overview"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.1\",\"info\":{\"title\":\"Celonis SCIM API\",\"description\":\"The SCIM API allows for the managing groups and users within the Celonis Platform.\",\"contact\":{\"name\":\"Celonis Support\"},\"version\":\"1.0.0\"},\"servers\":[{\"url\":\"/user-provisioning\",\"description\":\"Default Server URL\"}],\"tags\":[{\"name\":\"Discovery\",\"description\":\"Retrieve the most recent configuration and schemata via the following endpoints.\"},{\"name\":\"Bulk API\",\"description\":\"Used to process bulk executions of resource operations.\"},{\"name\":\"Group API\",\"description\":\"For CRUD manipulation of groups and group memberships. Group memberships can only be managed via the Group resource.\"},{\"name\":\"User API\",\"description\":\"For CRUD manipulation of users in a team.\"}],\"paths\":{\"/scim/v2/Users/{id}\":{\"get\":{\"tags\":[\"User API\"],\"summary\":\"Retrieve a user by its ID\",\"operationId\":\"getUser\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"User ID\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"description\":\"User was not found.\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"put\":{\"tags\":[\"User API\"],\"summary\":\"Update a user by its ID\",\"description\":\"Updates to a user can also fail, e.g. because of license restrictions. Email updates are forbidden.\",\"operationId\":\"updateUserWithPUT\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"A JSON object describing the user after the update.\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\",\"urn:celonis:params:scim:schemas:extension:2.0:User\"],\"userName\":\"user@celonis.com\",\"displayName\":\"SCIM User #1\",\"externalId\":\"DEADBEEF\",\"role\":\"ANALYST\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"delete\":{\"tags\":[\"User API\"],\"summary\":\"Delete a user by its ID\",\"description\":\"Deleting a user from a team does not impact any other team memberships that this user might have.\",\"operationId\":\"deleteUser\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"User ID\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"204\":{\"description\":\"OK, but no content to return.\",\"content\":{}},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Groups/{id}\":{\"get\":{\"tags\":[\"Group API\"],\"summary\":\"Retrieve a group by its ID\",\"operationId\":\"getGroup\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"Group ID\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"description\":\"Group was not found\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"put\":{\"tags\":[\"Group API\"],\"summary\":\"Update a group by its ID\",\"description\":\"A groups members or its role can be changed via an update to it. Group operations can fail due to license constraints. User cannot be a member of more than 50 groups.\",\"operationId\":\"updateGroupWithPUT\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"Group ID\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"A JSON object describing the group after the update.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"13371337\",\"displayName\":\"SCIM Group#1\",\"members\":[],\"role\":\"ANALYST\"}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"13371337\",\"displayName\":\"SCIM Group#1\",\"members\":[],\"role\":\"ANALYST\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"delete\":{\"tags\":[\"Group API\"],\"summary\":\"Delete a group by its ID\",\"description\":\"Remove a group from a team with this endpoint. Removing a group does not remove its members from the Celonis Platform team.\",\"operationId\":\"deleteGroup\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"description\":\"Group ID\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"204\":{\"description\":\"OK, but no content to return.\",\"content\":{}},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Users\":{\"get\":{\"tags\":[\"User API\"],\"summary\":\"Search for users via GET\",\"description\":\"Filtering and searching are not supported.\",\"operationId\":\"search_1\",\"parameters\":[{\"name\":\"startIndex\",\"in\":\"query\",\"description\":\"Index of total result set to start list from\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":1}},{\"name\":\"count\",\"in\":\"query\",\"description\":\"Number of items to retrieve, starting at the given index\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":200}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Limit result to items that contain these attributes at the minimum. See the [specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.9)\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Exclude these attributes from the result set. See [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.9)\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"A list of resources, formatted as per [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2)\"},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"post\":{\"tags\":[\"User API\"],\"summary\":\"Add a user\",\"description\":\"This adds users to a team. It can fail if the license is exceeded. A user gets the <tt>MEMBER</tt> role by default.\",\"operationId\":\"createUser\",\"parameters\":[{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"A JSON object describing the user to be created.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\",\"urn:celonis:params:scim:schemas:extension:2.0:User\"],\"userName\":\"user@celonis.com\",\"displayName\":\"SCIM User #1\",\"externalId\":\"DEADBEEF\",\"role\":\"ANALYST\",\"sendEmailOnInvitation\":\"true\"}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\",\"urn:celonis:params:scim:schemas:extension:2.0:User\"],\"userName\":\"user@celonis.com\",\"displayName\":\"SCIM User #1\",\"externalId\":\"DEADBEEF\",\"role\":\"ANALYST\",\"sendEmailOnInvitation\":\"true\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Users/.search\":{\"post\":{\"tags\":[\"User API\"],\"summary\":\"Search for users via POST\",\"description\":\"Filtering and searching are not supported.\",\"operationId\":\"search\",\"requestBody\":{\"description\":\"A JSON object with fields as in the GET search request.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"],\"attributes\":[\"id\"],\"startIndex\":1,\"count\":10}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"],\"attributes\":[\"id\"],\"startIndex\":1,\"count\":10}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"A list of resources, formatted as per [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2)\"},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Groups\":{\"get\":{\"tags\":[\"Group API\"],\"summary\":\"Search for groups via GET\",\"description\":\"Filtering and sorting are not supported.\",\"operationId\":\"searchOverGet\",\"parameters\":[{\"name\":\"startIndex\",\"in\":\"query\",\"description\":\"Index of total result set to start list from\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":1}},{\"name\":\"count\",\"in\":\"query\",\"description\":\"Number of items to retrieve, starting at the given index\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":200}},{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Limit result to items that contain these attributes at the minimum. See the [specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.9)\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Exclude these attributes from the result set. See [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.9)\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"A list of resources, formatted as per [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2)\"},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]},\"post\":{\"tags\":[\"Group API\"],\"summary\":\"Create a group\",\"description\":\"This creates a group inside the team, if it does not exist already. User memberships can already be specified upon creation. Group creation may fail due to license constraints. User cannot be a member of more than 50 groups.\",\"operationId\":\"createGroup\",\"parameters\":[{\"name\":\"attributes\",\"in\":\"query\",\"description\":\"Attributes to include\",\"required\":false,\"schema\":{\"type\":\"string\"}},{\"name\":\"excludedAttributes\",\"in\":\"query\",\"description\":\"Attributes to exclude\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"A JSON object describing the group to be created. The group name must be unique.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"13371337\",\"displayName\":\"SCIM Group#1\",\"members\":[],\"role\":\"ANALYST\"}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"13371337\",\"displayName\":\"SCIM Group#1\",\"members\":[],\"role\":\"ANALYST\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"links\":{\"See schema endpoint\":{\"operationRef\":\"#/scim-discovery-controller/get_schemas\"}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Groups/.search\":{\"post\":{\"tags\":[\"Group API\"],\"summary\":\"Search for groups via POST\",\"description\":\"Filtering and sorting are not supported.\",\"operationId\":\"searchOverPost\",\"requestBody\":{\"description\":\"A JSON object with fields as in the GET search request.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"],\"attributes\":[\"id\"],\"startIndex\":1,\"count\":10}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:SearchRequest\"],\"attributes\":[\"id\"],\"startIndex\":1,\"count\":10}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"A list of resources, formatted as per [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.4.2)\"},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, non-existing group members or exceeding the maximum of 50 groups per User.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Bulk\":{\"post\":{\"tags\":[\"Bulk API\"],\"operationId\":\"processBulkData\",\"requestBody\":{\"description\":\"A JSON object that describes a series of operations that would otherwise have been sent via single requests. The Bulk API will execute these in sequence and stop after the first operation fails.\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"failOnErrors\":1,\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:BulkRequest\"],\"Operations\":[{\"method\":\"POST\",\"path\":\"/Users\",\"bulkId\":\"bulk1\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"userName\":\"user1+bulk@celonis.com\",\"displayName\":\"Bulk User #1\",\"externalId\":\"{{externalUserId1}}\",\"role\":\"MEMBER\",\"sendEmailOnInvitation\":\"true\"}},{\"method\":\"POST\",\"path\":\"/Users\",\"bulkId\":\"bulk2\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"userName\":\"user2+bulk@celonis.com\",\"displayName\":\"Bulk User #2\",\"externalId\":\"{{externalUserId2}}\",\"role\":\"MEMBER\",\"sendEmailOnInvitation\":\"true\"}},{\"method\":\"POST\",\"path\":\"/Groups\",\"bulkId\":\"bulk3\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"{{externalGroupId1}}\",\"displayName\":\"SCIM Bulk Group #1 {{externalGroupId1}}\",\"members\":[]}},{\"method\":\"POST\",\"path\":\"/Groups\",\"bulkId\":\"bulk4\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"{{externalGroupId2}}\",\"displayName\":\"SCIM Bulk Group #2 {{externalGroupId2}}\",\"members\":[]}}]}},\"application/json\":{\"schema\":{\"type\":\"object\"},\"example\":{\"failOnErrors\":1,\"schemas\":[\"urn:ietf:params:scim:api:messages:2.0:BulkRequest\"],\"Operations\":[{\"method\":\"POST\",\"path\":\"/Users\",\"bulkId\":\"bulk1\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"userName\":\"user1+bulk@celonis.com\",\"displayName\":\"Bulk User #1\",\"externalId\":\"{{externalUserId1}}\",\"role\":\"MEMBER\",\"sendEmailOnInvitation\":\"true\"}},{\"method\":\"POST\",\"path\":\"/Users\",\"bulkId\":\"bulk2\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:User\"],\"userName\":\"user2+bulk@celonis.com\",\"displayName\":\"Bulk User #2\",\"externalId\":\"{{externalUserId2}}\",\"role\":\"MEMBER\",\"sendEmailOnInvitation\":\"true\"}},{\"method\":\"POST\",\"path\":\"/Groups\",\"bulkId\":\"bulk3\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"{{externalGroupId1}}\",\"displayName\":\"SCIM Bulk Group #1 {{externalGroupId1}}\",\"members\":[]}},{\"method\":\"POST\",\"path\":\"/Groups\",\"bulkId\":\"bulk4\",\"data\":{\"schemas\":[\"urn:ietf:params:scim:schemas:core:2.0:Group\"],\"externalId\":\"{{externalGroupId2}}\",\"displayName\":\"SCIM Bulk Group #2 {{externalGroupId2}}\",\"members\":[]}}]}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK, formatted as per [the specification](https://datatracker.ietf.org/doc/html/rfc7644#section-3.7.3)\",\"content\":{\"application/scim+json\":{\"schema\":{\"type\":\"string\"}},\"application/json\":{\"schema\":{\"type\":\"string\"}}}},\"204\":{\"description\":\"OK, but no content to return.\"},\"400\":{\"description\":\"Bad Request. Please check the response contents for an explanation of the cause. Causes include exceeding the team license, duplicate or empty user names or names that exceed 100 characters.\",\"content\":{}},\"401\":{\"description\":\"Unauthorized. Please check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://help.celonis.cloud/help/display/CIBC/Application+Keys) and [permissions](https://help.celonis.cloud/help/display/CIBC/Permissions).\"},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://help.celonis.cloud/help/display/CIBC/Support)\",\"content\":{}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/ServiceProviderConfig\":{\"get\":{\"tags\":[\"Discovery\"],\"summary\":\"Retrieve data on the configuration and capabilities of our SCIM implementation\",\"operationId\":\"getServiceProviderConfiguration\",\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Schemas\":{\"get\":{\"tags\":[\"Discovery\"],\"summary\":\"Retrieve all schemas currently in use by the Celonis Platform.\",\"operationId\":\"get_schemas\",\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/Schemas/{schemaUrn}\":{\"get\":{\"tags\":[\"Discovery\"],\"summary\":\"Retrieve specific schema currently in use by the Celonis Platform.\",\"operationId\":\"get_schema\",\"parameters\":[{\"name\":\"schemaUrn\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/ResourceTypes\":{\"get\":{\"tags\":[\"Discovery\"],\"summary\":\"Retrieve all user types available via the SCIM API\",\"operationId\":\"getResourceTypes\",\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}},\"security\":[{\"Authorization\":[]}]}},\"/scim/v2/ResourceTypes/{resourceType}\":{\"get\":{\"tags\":[\"Discovery\"],\"summary\":\"Retrieve specified resource type types available via the SCIM API\",\"operationId\":\"getResourceType\",\"parameters\":[{\"name\":\"resourceType\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}},\"security\":[{\"Authorization\":[]}]}}},\"components\":{\"schemas\":{\"ExceptionReference\":{\"type\":\"object\",\"properties\":{\"reference\":{\"type\":\"string\"},\"message\":{\"type\":\"string\"},\"shortMessage\":{\"type\":\"string\"}}},\"FrontendHandledBackendError\":{\"type\":\"object\",\"properties\":{\"frontendErrorKey\":{\"type\":\"string\"},\"errorInformation\":{\"type\":\"object\"}}}},\"securitySchemes\":{\"Authorization\":{\"type\":\"apiKey\",\"description\":\"Please, prefix the Token with \\\"AppKey \\\" or \\\"Bearer \\\" (word and space) to indicate the Authorization type\",\"name\":\"Authorization\",\"in\":\"header\"}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","lastModified":"2025-08-13T17:40:51.000Z","redocInfoPageId":"celonis-apis/scim-api/openapi/scim_openapi_spec.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","sourcePath":"/data/celonis/celonis-public-developer-docs/celonis-apis/scim-api/openapi/scim_openapi_spec.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"autogenerated_celonis-apis/scim-api/openapi/scim_openapi_spec.yaml","isDefault":true,"id":null,"title":null,"link":"/celonis-apis/scim-api/openapi/scim_openapi_spec/overview/"}]},{"id":"2165ce70-0b44-52bc-b8e6-4550bca389b8overview/__redocly content redirect/celonis-apis/team-api/openapi/openapi/overview/","definitionId":"autogenerated_celonis-apis/team-api/openapi/openapi.yaml","link":"/celonis-apis/team-api/openapi/openapi/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/celonis-apis/team-api/openapi/openapi.yaml","info":{"title":"OpenAPI Specification","version":"1.0.0","description":"This is the documentation for the Team API, that allows querying data for a Celonis Platform team."},"data":{"redirect":true,"type":"reference-docs","definitionId":"autogenerated_celonis-apis/team-api/openapi/openapi.yaml","isDefault":true,"label":"Overview","excludeFromSearch":false,"permission":"guest","settings":{},"apiVersions":[{"type":"reference-docs","definitionId":"autogenerated_celonis-apis/team-api/openapi/openapi.yaml","isDefault":true,"label":"Overview"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.1\",\"info\":{\"title\":\"OpenAPI Specification\",\"version\":\"1.0.0\",\"description\":\"This is the documentation for the Team API, that allows querying data for a Celonis Platform team.\"},\"servers\":[{\"description\":\"Default Server URL\",\"url\":\"/\"}],\"tags\":[{\"description\":\"Allows you to query and export a list of all members assigned to a Celonis Platform team.\",\"name\":\"Members API\"},{\"description\":\"Allows you to query the Login History for a team and export it for use with external monitoring tools to capture and monitor platform login events.\",\"name\":\"Login History API\"}],\"paths\":{\"/api/external/authentication-events\":{\"get\":{\"description\":\"Login History events can be filtered by specifying a date interval.<br> Maximum number of events that will be received by page is 200. <br> The OAuth 2.0 scope to use is <tt>team.login-history:read</tt>.<br> If there would be more events on the specified date interval total number of pages will be returned for further querying.\",\"operationId\":\"findAllAuthenticationEvents\",\"parameters\":[{\"description\":\"Page number to be retrieved, starts with 0\",\"example\":0,\"in\":\"query\",\"name\":\"pageNumber\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":0,\"minimum\":0}},{\"description\":\"Limit of results per page\",\"example\":200,\"in\":\"query\",\"name\":\"pageSize\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":200,\"maximum\":200,\"minimum\":1}},{\"description\":\"Date Time ISO 8601 yyyy-MM-ddTHH:mm:ss\",\"example\":\"2022-01-01T09:00:00\",\"in\":\"query\",\"name\":\"from\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}},{\"description\":\"Date Time ISO 8601 yyyy-MM-ddTHH:mm:ss\",\"example\":\"2022-01-31T09:00:00\",\"in\":\"query\",\"name\":\"to\",\"required\":false,\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}],\"responses\":{\"200\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PageTransportAuthenticationEventExternalTransport\"}}},\"description\":\"A list of Login History events\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{},\"description\":\"Bad Request. Please check the response contents for an explanation of the cause.\"},\"401\":{\"description\":\"Unauthorized. Check whether your API key or application key has sufficient permissions. In case you are unsure, please refer the documentation on [application keys](https://docs.celonis.com/en/creating-api-keys.html) and [permissions](https://docs.celonis.com/en/creating-and-granting-permissions-to-application-keys.html).\"},\"403\":{\"description\":\"Forbidden\"},\"405\":{\"description\":\"Method Not Allowed\"},\"500\":{\"content\":{},\"description\":\"An internal error happened. Please forward the associated error ID along with any helpful information to [our support](https://www.celopeers.com/s/support?language=en_US)\"}},\"security\":[{\"Authorization\":[]}],\"summary\":\"List Login History\",\"tags\":[\"Login History API\"]}},\"/api/external/members\":{\"get\":{\"description\":\"Maximum number of members that will be received by page is 200.<br> The OAuth 2.0 scope to use is <tt>team.user-group-info:read</tt>.<br>\",\"operationId\":\"getMemberProfileExternalTransport\",\"parameters\":[{\"description\":\"Page number to be retrieved. Starts with 0.\",\"example\":0,\"in\":\"query\",\"name\":\"pageNumber\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":0,\"minimum\":0}},{\"description\":\"Limit of results per page\",\"example\":200,\"in\":\"query\",\"name\":\"pageSize\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":200,\"maximum\":200,\"minimum\":1}},{\"description\":\"A boolean parameter to show internal or external members\",\"example\":true,\"in\":\"query\",\"name\":\"includeInternal\",\"required\":true,\"schema\":{\"type\":\"boolean\",\"default\":true}}],\"responses\":{\"200\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/PageTransportMemberProfileExternalTransport\"}}},\"description\":\"A list of Members\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{},\"description\":\"Bad Request. Check the response contents for an explanation of the cause.\"},\"401\":{\"description\":\"Unauthorized. Check whether your API key or application key has sufficient permissions. If you are unsure, refer the documentation on [application keys](https://docs.celonis.com/en/creating-api-keys.html) and [permissions](https://docs.celonis.com/en/creating-and-granting-permissions-to-application-keys.html).\"},\"403\":{\"description\":\"Forbidden\"},\"405\":{\"description\":\"Method Not Allowed\"},\"500\":{\"content\":{},\"description\":\"An internal error happened. Forward the associated error ID along with any helpful information to [our support](https://www.celopeers.com/s/support?language=en_US)\"}},\"security\":[{\"Authorization\":[]}],\"summary\":\"List of all members\",\"tags\":[\"Members API\"]}}},\"components\":{\"schemas\":{\"AuthenticationEventExternalTransport\":{\"type\":\"object\",\"properties\":{\"authenticationEventType\":{\"$ref\":\"#/components/schemas/AuthenticationEventType\"},\"email\":{\"type\":\"string\",\"description\":\"Email associated with Login History request\",\"example\":\"email@example.com\"},\"success\":{\"type\":\"boolean\",\"description\":\"Result of the Login History Event\",\"example\":true},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date and time when event occurred in ISO 8601 UTC format\",\"example\":\"2021-01-08T16:36:29.003Z\"}}},\"AuthenticationEventType\":{\"type\":\"string\",\"description\":\"Category of the Login History Event\",\"enum\":[\"LOGIN\",\"LOGIN_SSO\",\"LOGIN_CELONIS_ID\",\"LOGIN_OIDC\",\"LOGOUT\",\"ACCOUNT_TEMPORARILY_LOCKED\",\"ACCOUNT_NOT_CONFIRMED\",\"ACCOUNT_NOT_ACTIVE\",\"NOT_MEMBER_OF_TEAM\",\"TEAM_MEMBERSHIP_NOT_ACTIVE\",\"TEAM_MEMBERSHIP_NOT_CONFIRMED\",\"BAD_CREDENTIALS\",\"INVALID_2FA_TOKEN\",\"INVALID_PROVIDER\"],\"example\":\"LOGIN\"},\"ExternalGroupTransport\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Name of the group\",\"example\":\"Sample Group\"},\"teamRole\":{\"type\":\"string\",\"description\":\"Role assigned to group\",\"example\":\"ANALYST\"}}},\"MemberProfileExternalTransport\":{\"type\":\"object\",\"properties\":{\"group\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ExternalGroupTransport\"}},\"inactivityPeriod\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"Number of days in which the user has not logged in.\",\"example\":14},\"lastLogin\":{\"type\":\"string\",\"description\":\"Date and time when of member last login in UTC format\",\"example\":\"12/10/2023, 6:49:07 AM UTC\"},\"nameAndEmail\":{\"type\":\"string\",\"description\":\"Name and email address of member\",\"example\":\"Lorem Ipsum (email@example.com)\"},\"status\":{\"type\":\"string\",\"description\":\"Current status of member in his team\",\"example\":\"Active\"},\"userId\":{\"type\":\"string\",\"description\":\"Unique identifier of a member\",\"example\":\"8161c24e-2b32-44eb-bedb-ede2267be989\"},\"userRole\":{\"type\":\"string\",\"description\":\"Role of the member in the Celonis Platform\",\"example\":\"MEMBER\"}}},\"PageTransportAuthenticationEventExternalTransport\":{\"type\":\"object\",\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/AuthenticationEventExternalTransport\"}},\"pageNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalCount\":{\"type\":\"integer\",\"format\":\"int64\"}}},\"PageTransportMemberProfileExternalTransport\":{\"type\":\"object\",\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/MemberProfileExternalTransport\"}},\"pageNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalCount\":{\"type\":\"integer\",\"format\":\"int64\"}}}},\"securitySchemes\":{\"Authorization\":{\"description\":\"Prefix the Token with \\\"AppKey \\\" or \\\"Bearer \\\" (word and space) to indicate the Authorization type\",\"in\":\"header\",\"name\":\"Authorization\",\"type\":\"apiKey\"}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","lastModified":"2025-08-13T17:40:51.000Z","redocInfoPageId":"celonis-apis/team-api/openapi/openapi.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","sourcePath":"/data/celonis/celonis-public-developer-docs/celonis-apis/team-api/openapi/openapi.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"autogenerated_celonis-apis/team-api/openapi/openapi.yaml","isDefault":true,"id":null,"title":null,"link":"/celonis-apis/team-api/openapi/openapi/overview/"}]},{"id":"4b98e5d8-7cec-50c0-997b-276bdf52198boverview/__redocly content redirect/cpm/reporting/openapi/openapi/overview/","definitionId":"autogenerated_cpm/reporting/openAPI/openapi.json","link":"/cpm/reporting/openapi/openapi/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/cpm/reporting/openAPI/openapi.json","info":{"title":"Cpm.Service.Reporting.Api","version":"1.0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"autogenerated_cpm/reporting/openAPI/openapi.json","isDefault":true,"label":"Overview","excludeFromSearch":false,"permission":"guest","settings":{},"apiVersions":[{"type":"reference-docs","definitionId":"autogenerated_cpm/reporting/openAPI/openapi.json","isDefault":true,"label":"Overview"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.4\",\"info\":{\"title\":\"Cpm.Service.Reporting.Api\",\"version\":\"1.0\"},\"paths\":{\"/api/v1/elements\":{\"get\":{\"tags\":[\"Elements\"],\"parameters\":[{\"name\":\"FacetName\",\"in\":\"query\",\"schema\":{\"type\":\"string\"}},{\"name\":\"Skip\",\"in\":\"query\",\"schema\":{\"maximum\":2147483647,\"minimum\":0,\"type\":\"integer\",\"format\":\"int32\"}},{\"name\":\"Take\",\"in\":\"query\",\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},{\"name\":\"x-tenant-id\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ElementResponseListAggregatedResponse\"}}}},\"400\":{\"description\":\"Bad Request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ValidationProblemDetails\"}}}},\"401\":{\"description\":\"Unauthorized\"},\"500\":{\"description\":\"Internal Server Error\"}},\"security\":[{\"ApiKey\":[]}]}},\"/api/v1/facets/{facetName}/hierarchy\":{\"get\":{\"tags\":[\"Facets\"],\"parameters\":[{\"name\":\"facetName\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"x-tenant-id\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ElementHierarchyResponse\"}}}}},\"400\":{\"description\":\"Bad Request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ValidationProblemDetails\"}}}},\"401\":{\"description\":\"Unauthorized\"},\"500\":{\"description\":\"Internal Server Error\"}},\"security\":[{\"ApiKey\":[]}]}},\"/api/v1/facets\":{\"get\":{\"tags\":[\"Facets\"],\"parameters\":[{\"name\":\"x-tenant-id\",\"in\":\"header\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FacetResponseListAggregatedResponse\"}}}},\"400\":{\"description\":\"Bad Request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ValidationProblemDetails\"}}}},\"401\":{\"description\":\"Unauthorized\"},\"500\":{\"description\":\"Internal Server Error\"}},\"security\":[{\"ApiKey\":[]}]}}},\"components\":{\"schemas\":{\"Element\":{\"type\":\"object\",\"properties\":{\"containerPermaLink\":{\"type\":\"string\",\"nullable\":true},\"creationId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"facetName\":{\"type\":\"string\",\"nullable\":true},\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"ordering\":{\"type\":\"integer\",\"format\":\"int32\",\"nullable\":true},\"permaLink\":{\"type\":\"string\",\"nullable\":true},\"state\":{\"type\":\"string\",\"nullable\":true},\"stereotype\":{\"type\":\"string\",\"nullable\":true},\"type\":{\"type\":\"string\",\"nullable\":true},\"variantDefinitionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"variantId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"versionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"attributes\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":{},\"nullable\":true},\"nullable\":true},\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Element\"},\"nullable\":true},\"related\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ElementRef\"},\"nullable\":true},\"nullable\":true},\"isMasterVariant\":{\"type\":\"boolean\",\"nullable\":true},\"isRootNode\":{\"type\":\"boolean\",\"nullable\":true},\"supportsVariants\":{\"type\":\"boolean\"},\"supportsVersions\":{\"type\":\"boolean\"},\"variants\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ElementVariant\"},\"nullable\":true},\"versions\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ElementVersion\"},\"nullable\":true}},\"additionalProperties\":false},\"ElementHierarchyResponse\":{\"type\":\"object\",\"properties\":{\"children\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/HierarchyElement\"},\"nullable\":true},\"key\":{\"type\":\"string\",\"nullable\":true}},\"additionalProperties\":false},\"ElementRef\":{\"type\":\"object\",\"properties\":{\"containerPermaLink\":{\"type\":\"string\",\"nullable\":true},\"creationId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"facetName\":{\"type\":\"string\",\"nullable\":true},\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"ordering\":{\"type\":\"integer\",\"format\":\"int32\",\"nullable\":true},\"permaLink\":{\"type\":\"string\",\"nullable\":true},\"state\":{\"type\":\"string\",\"nullable\":true},\"stereotype\":{\"type\":\"string\",\"nullable\":true},\"type\":{\"type\":\"string\",\"nullable\":true},\"variantDefinitionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"variantId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"versionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"isReference\":{\"type\":\"boolean\"},\"isRootNode\":{\"type\":\"boolean\",\"nullable\":true}},\"additionalProperties\":false},\"ElementResponse\":{\"type\":\"object\",\"properties\":{\"containerPermaLink\":{\"type\":\"string\",\"nullable\":true},\"creationId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"facetName\":{\"type\":\"string\",\"nullable\":true},\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"ordering\":{\"type\":\"integer\",\"format\":\"int32\",\"nullable\":true},\"permaLink\":{\"type\":\"string\",\"nullable\":true},\"state\":{\"type\":\"string\",\"nullable\":true},\"stereotype\":{\"type\":\"string\",\"nullable\":true},\"type\":{\"type\":\"string\",\"nullable\":true},\"variantDefinitionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"variantId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"versionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"attributes\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":{},\"nullable\":true},\"nullable\":true},\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Element\"},\"nullable\":true},\"related\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ElementRef\"},\"nullable\":true},\"nullable\":true},\"isMasterVariant\":{\"type\":\"boolean\",\"nullable\":true},\"isRootNode\":{\"type\":\"boolean\",\"nullable\":true},\"supportsVariants\":{\"type\":\"boolean\"},\"supportsVersions\":{\"type\":\"boolean\"},\"variants\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ElementVariant\"},\"nullable\":true},\"versions\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ElementVersion\"},\"nullable\":true}},\"additionalProperties\":false},\"ElementResponseListAggregatedResponse\":{\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ElementResponse\"}},\"nullable\":true},\"skip\":{\"type\":\"integer\",\"format\":\"int32\",\"nullable\":true},\"take\":{\"type\":\"integer\",\"format\":\"int32\",\"nullable\":true},\"totalCount\":{\"type\":\"integer\",\"format\":\"int32\"}},\"additionalProperties\":false},\"ElementVariant\":{\"type\":\"object\",\"properties\":{\"containerPermaLink\":{\"type\":\"string\",\"nullable\":true},\"creationId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"facetName\":{\"type\":\"string\",\"nullable\":true},\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"ordering\":{\"type\":\"integer\",\"format\":\"int32\",\"nullable\":true},\"permaLink\":{\"type\":\"string\",\"nullable\":true},\"state\":{\"type\":\"string\",\"nullable\":true},\"stereotype\":{\"type\":\"string\",\"nullable\":true},\"type\":{\"type\":\"string\",\"nullable\":true},\"variantDefinitionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"variantId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"versionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"attributes\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":{},\"nullable\":true},\"nullable\":true},\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Element\"},\"nullable\":true},\"related\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ElementRef\"},\"nullable\":true},\"nullable\":true},\"isMasterVariant\":{\"type\":\"boolean\"},\"supportsVersions\":{\"type\":\"boolean\"},\"versions\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ElementVersion\"},\"nullable\":true}},\"additionalProperties\":false},\"ElementVersion\":{\"type\":\"object\",\"properties\":{\"containerPermaLink\":{\"type\":\"string\",\"nullable\":true},\"creationId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"facetName\":{\"type\":\"string\",\"nullable\":true},\"id\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"ordering\":{\"type\":\"integer\",\"format\":\"int32\",\"nullable\":true},\"permaLink\":{\"type\":\"string\",\"nullable\":true},\"state\":{\"type\":\"string\",\"nullable\":true},\"stereotype\":{\"type\":\"string\",\"nullable\":true},\"type\":{\"type\":\"string\",\"nullable\":true},\"variantDefinitionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"variantId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"versionId\":{\"type\":\"string\",\"format\":\"uuid\",\"nullable\":true},\"attributes\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"additionalProperties\":{},\"nullable\":true},\"nullable\":true},\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/Element\"},\"nullable\":true},\"related\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ElementRef\"},\"nullable\":true},\"nullable\":true},\"isMasterVariant\":{\"type\":\"boolean\",\"nullable\":true}},\"additionalProperties\":false},\"FacetResponse\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"nullable\":true}},\"additionalProperties\":false},\"FacetResponseListAggregatedResponse\":{\"type\":\"object\",\"properties\":{\"items\":{\"type\":\"array\",\"items\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/FacetResponse\"}},\"nullable\":true},\"skip\":{\"type\":\"integer\",\"format\":\"int32\",\"nullable\":true},\"take\":{\"type\":\"integer\",\"format\":\"int32\",\"nullable\":true},\"totalCount\":{\"type\":\"integer\",\"format\":\"int32\"}},\"additionalProperties\":false},\"HierarchyElement\":{\"type\":\"object\",\"properties\":{\"children\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/HierarchyElement\"},\"nullable\":true},\"key\":{\"type\":\"string\",\"nullable\":true}},\"additionalProperties\":false},\"NotFoundResult\":{\"type\":\"object\",\"properties\":{\"statusCode\":{\"type\":\"integer\",\"format\":\"int32\"}},\"additionalProperties\":false},\"ValidationProblemDetails\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"nullable\":true},\"title\":{\"type\":\"string\",\"nullable\":true},\"status\":{\"type\":\"integer\",\"format\":\"int32\",\"nullable\":true},\"detail\":{\"type\":\"string\",\"nullable\":true},\"instance\":{\"type\":\"string\",\"nullable\":true},\"errors\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"nullable\":true}},\"additionalProperties\":{}}},\"securitySchemes\":{\"ApiKey\":{\"type\":\"apiKey\",\"description\":\"Input the Reporting ApiKey to access this API\",\"name\":\"x-api-key\",\"in\":\"header\"}}},\"security\":[{\"ApiKey\":[]}]}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","lastModified":"2025-08-27T20:15:59.000Z","redocInfoPageId":"cpm/reporting/openAPI/openapi.json#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","sourcePath":"/data/celonis/celonis-public-developer-docs/cpm/reporting/openAPI/openapi.json"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"autogenerated_cpm/reporting/openAPI/openapi.json","isDefault":true,"id":null,"title":null,"link":"/cpm/reporting/openapi/openapi/overview/"}]},{"id":"8a33ea39-a7a5-52c5-8a0f-c5cad537c52eoverview/__redocly content redirect/data-ingestion-api/standard/openapi/openapi/overview/","definitionId":"autogenerated_data-ingestion-api/standard/openapi/openApi.yaml","link":"/data-ingestion-api/standard/openapi/openapi/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/data-ingestion-api/standard/openapi/openApi.yaml","info":{"title":"Celonis Standard Data Ingestion API","version":"v0","description":"**Read this section carefully!**\n\n### Purpose of this API\n\nThe Standard Data Ingestion API implements a subset of the AWS S3 API providing a mechanism for users to load arbitrary structured data into Celonis with minimal development effort. \n\n### Obtaining credentials\n\nIn order to obtain an access key / secret, you will first have to [configure a data connection](https://developer.celonis.com/data-ingestion-api/standard/using_standard_data_ingestion/).\n\n### Canonical vs. auxiliary endpoints\n\nThis API consists of only one _canonical_ endpoint triggering the asynchronous ingestion of Parquet files into a Celonis datapool / table. \nHowever, in order to provide compatibility with established data systems and ETL tools (e.g. Spark/Databricks), we also support a set of _auxiliary_ \nendpoints implementing operations that many S3 integration rely upon for internal book-keeping purposes (e.g. headObject, listObjects, etc).\n\n### Supported functionality \n\nOnly the endpoints, headers, query and path parameters explicitly listed in this specification are supported. Please refrain \nfrom building functionality on top of S3 features that you may observe to be working but are not explicitly mentioned in this document \nas they may suddenly stop working without any notice.\n\n### Error codes\n\nThe error status codes documented in the spec are specific to the Celonis Platform. Surfacing of AWS-specific error codes \nto end users is done on a best effort bases.\n\n### Note on code generation\n\nNote that this spec is only intended for documentation purposes. Please always use the official SDKs from AWS in order to interact\nwith this API as we do not support generating an API client from this spec.\n","x-audience":"EX"},"data":{"redirect":true,"type":"reference-docs","definitionId":"autogenerated_data-ingestion-api/standard/openapi/openApi.yaml","isDefault":true,"label":"Overview","excludeFromSearch":false,"permission":"guest","settings":{},"apiVersions":[{"type":"reference-docs","definitionId":"autogenerated_data-ingestion-api/standard/openapi/openApi.yaml","isDefault":true,"label":"Overview"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.4\",\"info\":{\"title\":\"Celonis Standard Data Ingestion API\",\"version\":\"v0\",\"description\":\"**Read this section carefully!**\\n\\n### Purpose of this API\\n\\nThe Standard Data Ingestion API implements a subset of the AWS S3 API providing a mechanism for users to load arbitrary structured data into Celonis with minimal development effort. \\n\\n### Obtaining credentials\\n\\nIn order to obtain an access key / secret, you will first have to [configure a data connection](https://developer.celonis.com/data-ingestion-api/standard/using_standard_data_ingestion/).\\n\\n### Canonical vs. auxiliary endpoints\\n\\nThis API consists of only one _canonical_ endpoint triggering the asynchronous ingestion of Parquet files into a Celonis datapool / table. \\nHowever, in order to provide compatibility with established data systems and ETL tools (e.g. Spark/Databricks), we also support a set of _auxiliary_ \\nendpoints implementing operations that many S3 integration rely upon for internal book-keeping purposes (e.g. headObject, listObjects, etc).\\n\\n### Supported functionality \\n\\nOnly the endpoints, headers, query and path parameters explicitly listed in this specification are supported. Please refrain \\nfrom building functionality on top of S3 features that you may observe to be working but are not explicitly mentioned in this document \\nas they may suddenly stop working without any notice.\\n\\n### Error codes\\n\\nThe error status codes documented in the spec are specific to the Celonis Platform. Surfacing of AWS-specific error codes \\nto end users is done on a best effort bases.\\n\\n### Note on code generation\\n\\nNote that this spec is only intended for documentation purposes. Please always use the official SDKs from AWS in order to interact\\nwith this API as we do not support generating an API client from this spec.\\n\",\"x-audience\":\"EX\"},\"servers\":[{\"url\":\"https://{team}.{realm}.celonis.cloud\",\"variables\":{\"team\":{\"description\":\"the team-domain associated to access key / secret used to issue API requests.\",\"default\":\"dev\"},\"realm\":{\"description\":\"the Celonis realm\",\"default\":\"develop\"}}}],\"security\":[{\"awsSignatureV4\":[]}],\"paths\":{\"/api/data-ingestion/continuous/connection/{connectionId}/{tableName}/{fileName}.parquet\":{\"put\":{\"summary\":\"Ingest a Parquet file\",\"description\":\"Canonical endpoint to upload Parquet files for ingestion into the specified Celonis connection / source-table.\",\"operationId\":\"putDataFile\",\"parameters\":[{\"$ref\":\"#/components/parameters/ConnectionId\"},{\"$ref\":\"#/components/parameters/TableName\"},{\"$ref\":\"#/components/parameters/FileName\"},{\"$ref\":\"#/components/parameters/DecodedContentLength\"},{\"$ref\":\"#/components/parameters/Trailer\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/Empty\"}}}},\"401\":{\"$ref\":\"#/components/responses/401\"},\"403\":{\"$ref\":\"#/components/responses/403\"},\"404\":{\"$ref\":\"#/components/responses/404\"},\"default\":{\"$ref\":\"#/components/responses/default\"}}}},\"/api/data-ingestion/continuous/connection/{connectionId}/{tableName}/{objectKey}\":{\"put\":{\"summary\":\"Upload a file\",\"description\":\"Auxiliary endpoint allowing the upload of a file to the tenant object store. Uploads of Parquet files through this endpoint will not result in the data being ingested in any data pool. Also, note that files uploaded through this endpoint will only be retained for a few hours.\\n\",\"operationId\":\"putObject\",\"parameters\":[{\"$ref\":\"#/components/parameters/ConnectionId\"},{\"$ref\":\"#/components/parameters/TableName\"},{\"$ref\":\"#/components/parameters/FileName\"},{\"$ref\":\"#/components/parameters/ObjectKey\"},{\"$ref\":\"#/components/parameters/DecodedContentLength\"},{\"$ref\":\"#/components/parameters/Trailer\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/Empty\"}}}},\"401\":{\"$ref\":\"#/components/responses/401\"},\"403\":{\"$ref\":\"#/components/responses/403\"},\"404\":{\"$ref\":\"#/components/responses/404\"},\"default\":{\"$ref\":\"#/components/responses/default\"}}},\"head\":{\"summary\":\"Get object metadata\",\"description\":\"Auxiliary endpoint allowing for the verification that an object with a given key exists.\",\"operationId\":\"headObject\",\"parameters\":[{\"$ref\":\"#/components/parameters/ConnectionId\"},{\"$ref\":\"#/components/parameters/TableName\"},{\"$ref\":\"#/components/parameters/ObjectKey\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/Empty\"}}}},\"401\":{\"$ref\":\"#/components/responses/401\"},\"403\":{\"$ref\":\"#/components/responses/403\"},\"404\":{\"$ref\":\"#/components/responses/404\"},\"default\":{\"$ref\":\"#/components/responses/default\"}}}},\"/api/data-ingestion/continuous\":{\"get\":{\"summary\":\"List tenant's objects\",\"description\":\"Auxiliary endpoint allowing integrations to list objects in the tenant virtual bucket. Note that this endpoint is currently only partially implemented as it does not support pagination and markers.\",\"operationId\":\"listObjects\",\"parameters\":[{\"$ref\":\"#/components/parameters/Prefix\"},{\"$ref\":\"#/components/parameters/MaxKeys\"}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"text/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/ListBucketResult\"}}}},\"401\":{\"$ref\":\"#/components/responses/401\"},\"403\":{\"$ref\":\"#/components/responses/403\"},\"default\":{\"$ref\":\"#/components/responses/default\"}}},\"head\":{\"summary\":\"Get virtual bucket information\",\"description\":\"Auxiliary mock endpoint for the headBucket operation.\",\"operationId\":\"headBucket\",\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"text/xml\\\"\":{\"schema\":{\"$ref\":\"#/components/schemas/Empty\"}}}},\"401\":{\"$ref\":\"#/components/responses/401\"},\"403\":{\"$ref\":\"#/components/responses/403\"}}}}},\"components\":{\"securitySchemes\":{\"awsSignatureV4\":{\"type\":\"http\",\"scheme\":\"bearer\",\"description\":\"AWS Signature Version 4 authentication.\\n\\n**Required Headers:**\\n- `Authorization`: Contains the signature and credential information\\n- `x-amz-date`: Request timestamp\\n- `x-amz-content-sha256`: Payload hash\\n\\nFor detailed implementation, see [AWS Signature Version 4 Signing Process](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html).\\n\"}},\"parameters\":{\"ConnectionId\":{\"name\":\"connectionId\",\"required\":true,\"in\":\"path\",\"schema\":{\"type\":\"string\"},\"description\":\"The datapool connection id obtained when configuring the ingestion through the Celonis UI.\"},\"TableName\":{\"name\":\"tableName\",\"required\":true,\"in\":\"path\",\"description\":\"The configured source table name for this ingestion\",\"schema\":{\"type\":\"string\"}},\"FileName\":{\"name\":\"fileName\",\"required\":true,\"in\":\"path\",\"schema\":{\"type\":\"string\"},\"description\":\"A unique file name for the uploaded Parquet file.\"},\"CopySource\":{\"name\":\"X-Amz-Copy-Source\\\"\",\"in\":\"header\",\"schema\":{\"type\":\"string\"},\"description\":\"The (tenant-scoped) path of the source object to be copied. Set by S3 clients when issuing CopyObject requests\"},\"DecodedContentLength\":{\"name\":\"x-amz-decoded-content-length\",\"in\":\"header\",\"schema\":{\"type\":\"string\"},\"description\":\"Automatically set by S3 clients when using chunked uploads\"},\"Trailer\":{\"name\":\"x-amz-trailer\",\"in\":\"header\",\"schema\":{\"type\":\"string\"},\"description\":\"Automatically set by S3 clients when using chunked uploads\"},\"ObjectKey\":{\"name\":\"objectKey\",\"in\":\"path\",\"schema\":{\"type\":\"string\"},\"required\":true,\"description\":\"A tenant-scoped object key. Please refer to AWS documentation for the allowed characters and length limitations\"},\"Prefix\":{\"name\":\"prefix\",\"in\":\"query\",\"schema\":{\"type\":\"string\"},\"description\":\"A tenant-scoped object key prefix. It must start with the canonical prefix '/api/data-ingestion/continuous/connection/{connectionId}/{tableName}'\"},\"MaxKeys\":{\"name\":\"max-keys\",\"in\":\"query\",\"schema\":{\"type\":\"integer\"},\"description\":\"The maximum number of object keys to list in the response\"}},\"responses\":{\"401\":{\"description\":\"Unauthorized access.\",\"content\":{\"text/xml\":{\"schema\":{\"type\":\"string\"}}}},\"403\":{\"description\":\"Forbidden access.\",\"content\":{\"text/xml\":{\"schema\":{\"type\":\"string\"}}}},\"404\":{\"description\":\"The specified resource does not exist.\",\"content\":{\"text/xml\":{\"schema\":{\"type\":\"string\"}}}},\"default\":{\"description\":\"Default error\",\"content\":{\"text/xml\":{\"schema\":{\"type\":\"string\"}}}}},\"schemas\":{\"Empty\":{},\"ListBucketResult\":{\"type\":\"object\",\"xml\":{\"name\":\"ListBucketResult\",\"namespace\":\"http://s3.amazonaws.com/doc/2006-03-01/\"},\"properties\":{\"Prefix\":{\"type\":\"string\",\"description\":\"The supplied key prefix for the listObject operation\"},\"Name\":{\"type\":\"string\",\"description\":\"The bucket name. This will be set to the current team on virtual hosted style requests, whilst it will be set to `continuous` for default, path-style requests.\"},\"IsTruncated\":{\"type\":\"boolean\"},\"KeyCount\":{\"type\":\"integer\"},\"EncodingType\":{\"type\":\"string\"},\"Contents\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"Key\":{\"type\":\"string\"},\"LastModified\":{\"type\":\"string\",\"format\":\"date-time\"},\"ETag\":{\"type\":\"string\"},\"Size\":{\"type\":\"integer\",\"format\":\"int64\"},\"StorageClass\":{\"type\":\"string\"}},\"required\":[\"Key\",\"ETag\",\"Size\",\"StorageClass\"]}}},\"required\":[\"Prefix\",\"Name\",\"IsTruncated\",\"KeyCount\",\"EncodingType\"]}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","lastModified":"2025-08-22T14:20:42.000Z","redocInfoPageId":"data-ingestion-api/standard/openapi/openApi.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","sourcePath":"/data/celonis/celonis-public-developer-docs/data-ingestion-api/standard/openapi/openApi.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"autogenerated_data-ingestion-api/standard/openapi/openApi.yaml","isDefault":true,"id":null,"title":null,"link":"/data-ingestion-api/standard/openapi/openapi/overview/"}]},{"id":"2afeda47-3875-5810-8895-49621100bbd5overview/__redocly content redirect/mlwb/openapi/openapi/overview/","definitionId":"autogenerated_mlwb/openapi/openapi.yaml","link":"/mlwb/openapi/openapi/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/mlwb/openapi/openapi.yaml","info":{"title":"Celonis Machine Learning Workbench APIs","description":"Documentation for the external Machine Learning APIs. These APIs allow you to trigger executions, manage resources, and more. To access the APIs, a Bearer API Key and a team-specific AppKey must be passed in the header.","version":"1.0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"autogenerated_mlwb/openapi/openapi.yaml","isDefault":true,"label":"Overview","excludeFromSearch":false,"permission":"guest","settings":{},"apiVersions":[{"type":"reference-docs","definitionId":"autogenerated_mlwb/openapi/openapi.yaml","isDefault":true,"label":"Overview"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.1.0\",\"info\":{\"title\":\"Celonis Machine Learning Workbench APIs\",\"description\":\"Documentation for the external Machine Learning APIs. These APIs allow you to trigger executions, manage resources, and more. To access the APIs, a Bearer API Key and a team-specific AppKey must be passed in the header.\",\"version\":\"1.0\"},\"servers\":[{\"url\":\"https://dev.us-1.celonis.cloud/machine-learning\",\"description\":\"Generated server url\"}],\"tags\":[{\"name\":\"Notebook\",\"description\":\"The Notebook API is used to create, read, update, and delete notebooks.\"},{\"name\":\"Schedule\",\"description\":\"The Schedule API is used to create, read, update, and delete schedules.\"},{\"name\":\"Notebook Resources\",\"description\":\"The Notebook Resources API configures notebook resource such as CPU, memory, storage, and gpu.\"},{\"name\":\"Notebook Execution\",\"description\":\"The Notebook Executions API is used to trigger, stop, and track notebook executions.\"},{\"name\":\"Job Execution\",\"description\":\"The Job Execution API is used to trigger, stop, and track job executions.\"},{\"name\":\"Job Execution Group\",\"description\":\"The Job Execution Group API retrieves job execution groups.\"}],\"paths\":{\"/api/scheduling/{id}\":{\"get\":{\"tags\":[\"Schedule\"],\"summary\":\"Get a schedule\",\"operationId\":\"findOne\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/SchedulingTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}},\"put\":{\"tags\":[\"Schedule\"],\"summary\":\"Update a schedule\",\"operationId\":\"update\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SchedulingTransport\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/SchedulingTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}},\"delete\":{\"tags\":[\"Schedule\"],\"summary\":\"Delete a schedule\",\"operationId\":\"delete\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/scheduling/{id}/change-status\":{\"put\":{\"tags\":[\"Schedule\"],\"summary\":\"Enable or Disable a schedule\",\"operationId\":\"changeStatus\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"status\",\"in\":\"query\",\"required\":true,\"schema\":{\"type\":\"boolean\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/SchedulingTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}\":{\"get\":{\"tags\":[\"Notebook\"],\"summary\":\"Get an app\",\"operationId\":\"findOne_1\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}},\"put\":{\"tags\":[\"Notebook\"],\"summary\":\"Update an app\",\"operationId\":\"update_1\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookTransport\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}},\"delete\":{\"tags\":[\"Notebook\"],\"summary\":\"Delete an app\",\"operationId\":\"delete_1\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/upgrade\":{\"put\":{\"tags\":[\"Notebook\"],\"summary\":\"Upgrade app to the latest version\",\"operationId\":\"upgrade\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/resources\":{\"get\":{\"tags\":[\"Notebook Resources\"],\"summary\":\"Get Notebook Resources\",\"operationId\":\"getResources\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookResourcesTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}},\"put\":{\"tags\":[\"Notebook Resources\"],\"summary\":\"Update Notebook Resources\",\"operationId\":\"updateResources\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookResourcesTransport\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookResourcesTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/probe\":{\"put\":{\"tags\":[\"Notebook\"],\"summary\":\"Check if an app is running\",\"operationId\":\"activeProbe\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/move\":{\"put\":{\"tags\":[\"Notebook\"],\"summary\":\"Move an app from one workspace to another\",\"operationId\":\"moveToWorkspace\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"workspaceId\",\"in\":\"query\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/app-key\":{\"get\":{\"tags\":[\"Notebook\"],\"summary\":\"Get the application key of the app\",\"operationId\":\"getApplicationKey\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ApplicationKeyTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}},\"put\":{\"tags\":[\"Notebook\"],\"summary\":\"Set an application key to the app\",\"operationId\":\"setApplicationKey\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"appKey\",\"in\":\"query\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/executions/{id}/stop\":{\"put\":{\"tags\":[\"Notebook Execution\"],\"summary\":\"Stop a running execution\",\"operationId\":\"stop\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/scheduling\":{\"get\":{\"tags\":[\"Schedule\"],\"summary\":\"List all schedules\",\"operationId\":\"findAll\",\"parameters\":[{\"name\":\"notebookId\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SchedulingTransport\"}}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}},\"post\":{\"tags\":[\"Schedule\"],\"summary\":\"Create a schedule\",\"operationId\":\"create\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SchedulingTransport\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"Created\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/SchedulingTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/scheduling/{id}/run\":{\"post\":{\"tags\":[\"Schedule\"],\"summary\":\"Run a schedule\",\"operationId\":\"runSchedule\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks\":{\"get\":{\"tags\":[\"Notebook\"],\"summary\":\"List all notebooks\",\"operationId\":\"findAll_1\",\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NotebookTransport\"}}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}},\"post\":{\"tags\":[\"Notebook\"],\"summary\":\"Create an app\",\"operationId\":\"create_1\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookTransport\"}}},\"required\":true},\"responses\":{\"201\":{\"description\":\"Created\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/stop\":{\"post\":{\"tags\":[\"Notebook\"],\"summary\":\"Stop an app\",\"operationId\":\"stop_1\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/start\":{\"post\":{\"tags\":[\"Notebook\"],\"summary\":\"Start an app\",\"operationId\":\"start\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/open\":{\"post\":{\"tags\":[\"Notebook\"],\"summary\":\"Open an app\",\"operationId\":\"open\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/jobs/{jobId}/executions\":{\"get\":{\"tags\":[\"Job Execution\"],\"summary\":\"Get all executions\",\"operationId\":\"getExecutions\",\"parameters\":[{\"name\":\"jobId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageIndex\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":0,\"minimum\":0}},{\"name\":\"limit\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":1,\"minimum\":1}},{\"name\":\"startedOrder\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"default\":\"DESC\"}},{\"name\":\"executionSources\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"array\",\"default\":[\"DATA_MODEL_RELOAD\",\"KNOWLEDGE_MODEL\",\"API\",\"SKILL_UPDATE\"],\"items\":{\"type\":\"string\",\"enum\":[\"API\",\"KNOWLEDGE_MODEL\",\"DATA_MODEL_RELOAD\",\"SKILL_UPDATE\"]}}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/PageJobExecutionTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}},\"post\":{\"tags\":[\"Job Execution\"],\"summary\":\"Trigger an execution\",\"operationId\":\"execute\",\"parameters\":[{\"name\":\"jobId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"description\":\"input\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/JsonNode\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/JobExecution\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/jobs/{jobId}/application-key\":{\"post\":{\"tags\":[\"Job Execution\"],\"summary\":\"Update job application key\",\"operationId\":\"updateApplicationKey\",\"parameters\":[{\"name\":\"jobId\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ApplicationKeyTransport\"}}},\"required\":true},\"responses\":{\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/jobs/executions/{id}/stop\":{\"post\":{\"tags\":[\"Job Execution\"],\"summary\":\"Stop a running execution\",\"operationId\":\"stop_2\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/jobs/executions/{id}/logs\":{\"get\":{\"tags\":[\"Job Execution\"],\"summary\":\"Get job execution logs\",\"operationId\":\"getLogs\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"logLevels\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"array\",\"default\":[\"INFO\",\"DEBUG\",\"WARNING\",\"ERROR\"],\"items\":{\"type\":\"string\",\"enum\":[\"DEBUG\",\"INFO\",\"WARNING\",\"ERROR\"]}}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/JobExecutionLogTransport\"}}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/executions\":{\"post\":{\"tags\":[\"Notebook Execution\"],\"summary\":\"Trigger an execution\",\"operationId\":\"execute_1\",\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookExecutionTransport\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookExecutionTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/scheduling/{id}/executions\":{\"get\":{\"tags\":[\"Schedule\"],\"summary\":\"List all executions of a schedule\",\"operationId\":\"findAllExecutions\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageIndex\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":0,\"minimum\":0}},{\"name\":\"limit\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":1,\"minimum\":1}},{\"name\":\"startedOrder\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"default\":\"DESC\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/PageNotebookExecutionTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/versions/latest\":{\"get\":{\"tags\":[\"Notebook\"],\"summary\":\"Get a list of all versions newer than the Notebook id version provided in the parameter\",\"operationId\":\"getAllNewVersions\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NotebookVersionTransport\"}}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/llm/access-info\":{\"get\":{\"tags\":[\"Notebook\"],\"summary\":\"Get app's access information for LLM use case\",\"operationId\":\"getAccessInformationLLM\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookAccessInformationTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/content\":{\"get\":{\"tags\":[\"Notebook\"],\"summary\":\"Get a list of all the files inside the app\",\"operationId\":\"getContents\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"path\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"default\":\"\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookTreeItem\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/{id}/access-info\":{\"get\":{\"tags\":[\"Notebook\"],\"summary\":\"Get access information for the app\",\"operationId\":\"getAccessInformation\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookAccessInformationTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/versions\":{\"get\":{\"tags\":[\"Notebook\"],\"summary\":\"Get a list of all the versions of the app\",\"operationId\":\"getAllVersions\",\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NotebookVersionTransport\"}}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/node\":{\"get\":{\"tags\":[\"Notebook\"],\"summary\":\"Check if team has dedicated service\",\"operationId\":\"hasDedicatedService\",\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"type\":\"boolean\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/machine-learning-images\":{\"get\":{\"tags\":[\"Notebook\"],\"summary\":\"List all Machine Learning images\",\"operationId\":\"getMachineLearningImages\",\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ImageTransport\"}}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/notebooks/limit/reached\":{\"get\":{\"tags\":[\"Notebook\"],\"summary\":\"Check if the team has reached the maximum number of notebooks\",\"operationId\":\"limitReached\",\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"type\":\"boolean\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/jobs/executions/{id}\":{\"get\":{\"tags\":[\"Job Execution\"],\"summary\":\"Get an execution\",\"operationId\":\"getExecution\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/JobExecution\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/jobs/executions/groups\":{\"get\":{\"tags\":[\"Job Execution Group\"],\"summary\":\"Get execution groups\",\"operationId\":\"getExecutionGroups\",\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/JobExecutionGroup\"}}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/executions/{id}\":{\"get\":{\"tags\":[\"Notebook Execution\"],\"summary\":\"Get an execution\",\"operationId\":\"find\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/NotebookExecutionTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/executions/{id}/logs\":{\"get\":{\"tags\":[\"Notebook Execution\"],\"summary\":\"Get execution logs\",\"operationId\":\"getLogs_1\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"logLevels\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"array\",\"default\":[\"INFO\",\"DEBUG\",\"WARNING\",\"ERROR\"],\"items\":{\"type\":\"string\",\"enum\":[\"DEBUG\",\"INFO\",\"WARNING\",\"ERROR\"]}}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NotebookExecutionLogTransport\"}}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/executions/triggered/{id}\":{\"get\":{\"tags\":[\"Notebook Execution\"],\"operationId\":\"getTriggeredExecutions\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"name\":\"pageIndex\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":0,\"minimum\":0}},{\"name\":\"limit\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\",\"format\":\"int32\",\"default\":1,\"minimum\":1}},{\"name\":\"startedOrder\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\",\"default\":\"DESC\"}},{\"name\":\"executionSources\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"array\",\"default\":[\"DATA_MODEL_RELOAD\",\"KNOWLEDGE_MODEL\",\"API\"],\"items\":{\"type\":\"string\",\"enum\":[\"SCHEDULING\",\"API\",\"KNOWLEDGE_MODEL\",\"DATA_MODEL_RELOAD\",\"SKILL_UPDATE\"]}}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/PageNotebookExecutionTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/executions/triggered-groups\":{\"get\":{\"tags\":[\"Notebook Execution\"],\"operationId\":\"getTriggeredExecutionGroups\",\"parameters\":[{\"name\":\"notebookId\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/TriggeredExecutionGroupTransport\"}}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}},\"/api/executions/triggered-groups/{id}\":{\"get\":{\"tags\":[\"Notebook Execution\"],\"operationId\":\"getTriggeredExecutionGroup\",\"parameters\":[{\"name\":\"id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/TriggeredExecutionGroupTransport\"}}}},\"204\":{\"description\":\"No Content\"},\"400\":{\"description\":\"Bad Request\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}}},\"403\":{\"description\":\"Forbidden\"},\"500\":{\"description\":\"Internal Server Error\",\"content\":{\"*/*\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}}}}}}},\"components\":{\"schemas\":{\"ExceptionReference\":{\"type\":\"object\",\"properties\":{\"reference\":{\"type\":\"string\"},\"message\":{\"type\":\"string\"},\"shortMessage\":{\"type\":\"string\"}}},\"FrontendHandledBackendError\":{\"type\":\"object\",\"properties\":{\"frontendErrorKey\":{\"type\":\"string\"},\"errorInformation\":{}}},\"SchedulingConfig\":{\"type\":\"object\",\"properties\":{\"executionPattern\":{\"type\":\"string\",\"enum\":[\"HOURLY\",\"X_HOURLY\",\"DAILY\",\"WEEKLY\",\"MONTHLY\",\"CUSTOM\"]},\"minute\":{\"type\":\"integer\",\"format\":\"int32\"},\"everyXHours\":{\"type\":\"integer\",\"format\":\"int32\"},\"time\":{\"type\":\"string\"},\"day\":{\"type\":\"integer\",\"format\":\"int32\"},\"weekDays\":{\"type\":\"array\",\"items\":{\"type\":\"integer\",\"format\":\"int32\"}},\"monthPattern\":{\"type\":\"string\",\"enum\":[\"SPECIFIC_DAY\",\"LAST_DAY\"]},\"customCron\":{\"type\":\"string\"},\"timezoneId\":{\"type\":\"string\"},\"lastExecutionDate\":{\"type\":\"string\",\"format\":\"date-time\"},\"nextExecutionDate\":{\"type\":\"string\",\"format\":\"date-time\"},\"enabled\":{\"type\":\"boolean\"}}},\"SchedulingTransport\":{\"type\":\"object\",\"properties\":{\"permissions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"resourcePath\":{\"type\":\"string\"},\"actions\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"COPY_ALL\",\"COPY\",\"CREATE\",\"DELETE_ALL\",\"DELETE\",\"EDIT_ALL\",\"EDIT\",\"EXECUTE_ALL\",\"EXECUTE\",\"EXPORT_ALL\",\"EXPORT\",\"MANAGE_ALL\",\"MANAGE\",\"READ_ALL\",\"READ\",\"SHARE_ALL\",\"SHARE\",\"USE_ALL\",\"USE\",\"ANY_ACTION_ON_CHILDREN\",\"ENABLED\",\"MOVE\",\"MOVE_ALL\",\"IMPORT_ALL\",\"IMPORT\",\"UNRECOGNIZED\"]}},\"groupedResourceTypeToActions\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"COPY_ALL\",\"COPY\",\"CREATE\",\"DELETE_ALL\",\"DELETE\",\"EDIT_ALL\",\"EDIT\",\"EXECUTE_ALL\",\"EXECUTE\",\"EXPORT_ALL\",\"EXPORT\",\"MANAGE_ALL\",\"MANAGE\",\"READ_ALL\",\"READ\",\"SHARE_ALL\",\"SHARE\",\"USE_ALL\",\"USE\",\"ANY_ACTION_ON_CHILDREN\",\"ENABLED\",\"MOVE\",\"MOVE_ALL\",\"IMPORT_ALL\",\"IMPORT\",\"UNRECOGNIZED\"]}}},\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"notebookId\":{\"type\":\"string\"},\"executeFile\":{\"type\":\"string\"},\"notebookName\":{\"type\":\"string\"},\"lastNotebookExecutionId\":{\"type\":\"string\"},\"schedulingConfig\":{\"$ref\":\"#/components/schemas/SchedulingConfig\"},\"timeout\":{\"type\":\"integer\",\"format\":\"int32\"},\"timeUnit\":{\"type\":\"string\",\"enum\":[\"MINUTES\",\"HOURS\"]},\"maxRetries\":{\"type\":\"integer\",\"format\":\"int32\"},\"lastNotebookExecutionStatus\":{\"type\":\"string\",\"enum\":[\"CREATED\",\"QUEUED\",\"STARTING\",\"STARTED\",\"COMPLETED\",\"NOTEBOOK_ERROR\",\"FAILED\",\"TIMEOUT\",\"CANCELED\",\"RESOURCES_ERROR\",\"CONFIGURATION_ERROR\"]},\"notebookStopped\":{\"type\":\"boolean\"},\"objectId\":{\"type\":\"string\"}},\"required\":[\"executeFile\",\"name\",\"notebookId\",\"schedulingConfig\",\"timeUnit\",\"timeout\"]},\"NotebookResourcesTransport\":{\"type\":\"object\",\"properties\":{\"cpu\":{\"type\":\"number\",\"format\":\"double\"},\"memory\":{\"type\":\"integer\",\"format\":\"int32\"},\"storage\":{\"type\":\"integer\",\"format\":\"int32\"},\"gpu\":{\"type\":\"integer\",\"format\":\"int32\"}},\"required\":[\"cpu\",\"memory\",\"storage\"]},\"NotebookTransport\":{\"type\":\"object\",\"properties\":{\"permissions\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"uniqueItems\":true},\"resourcePath\":{\"type\":\"string\"},\"actions\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"COPY_ALL\",\"COPY\",\"CREATE\",\"DELETE_ALL\",\"DELETE\",\"EDIT_ALL\",\"EDIT\",\"EXECUTE_ALL\",\"EXECUTE\",\"EXPORT_ALL\",\"EXPORT\",\"MANAGE_ALL\",\"MANAGE\",\"READ_ALL\",\"READ\",\"SHARE_ALL\",\"SHARE\",\"USE_ALL\",\"USE\",\"ANY_ACTION_ON_CHILDREN\",\"ENABLED\",\"MOVE\",\"MOVE_ALL\",\"IMPORT_ALL\",\"IMPORT\",\"UNRECOGNIZED\"]}},\"groupedResourceTypeToActions\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"enum\":[\"COPY_ALL\",\"COPY\",\"CREATE\",\"DELETE_ALL\",\"DELETE\",\"EDIT_ALL\",\"EDIT\",\"EXECUTE_ALL\",\"EXECUTE\",\"EXPORT_ALL\",\"EXPORT\",\"MANAGE_ALL\",\"MANAGE\",\"READ_ALL\",\"READ\",\"SHARE_ALL\",\"SHARE\",\"USE_ALL\",\"USE\",\"ANY_ACTION_ON_CHILDREN\",\"ENABLED\",\"MOVE\",\"MOVE_ALL\",\"IMPORT_ALL\",\"IMPORT\",\"UNRECOGNIZED\"]}}},\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"url\":{\"type\":\"string\"},\"versionId\":{\"type\":\"string\"},\"lastAccessDate\":{\"type\":\"string\",\"format\":\"date-time\"},\"agreement\":{\"type\":\"boolean\"},\"appKey\":{\"type\":\"string\"},\"imageType\":{\"type\":\"string\",\"enum\":[\"JUPYTER\",\"VSCODE\",\"STREAMLIT\"]},\"imageId\":{\"type\":\"string\"},\"imageKey\":{\"type\":\"string\"},\"homePath\":{\"type\":\"string\"},\"machineId\":{\"type\":\"string\"},\"workspaceId\":{\"type\":\"string\"},\"stopped\":{\"type\":\"boolean\"},\"notebookResources\":{\"$ref\":\"#/components/schemas/NotebookResourcesTransport\"},\"productive\":{\"type\":\"boolean\"},\"logRetentionDays\":{\"type\":\"integer\",\"format\":\"int32\"},\"availableStorageInMb\":{\"type\":\"integer\",\"format\":\"int32\"},\"modelId\":{\"type\":\"string\"},\"llmEnabled\":{\"type\":\"boolean\"},\"objectId\":{\"type\":\"string\"},\"status\":{\"type\":\"string\"}},\"required\":[\"agreement\",\"imageId\",\"name\"]},\"JsonNode\":{},\"JobExecution\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"tenantId\":{\"type\":\"string\",\"writeOnly\":true},\"jobId\":{\"type\":\"string\"},\"image\":{\"type\":\"string\"},\"input\":{\"type\":\"string\"},\"status\":{\"type\":\"string\",\"enum\":[\"CREATED\",\"STARTED\",\"RUNNING\",\"COMPLETED\",\"FAILED\",\"CANCELED\"]},\"started\":{\"type\":\"string\",\"format\":\"date-time\"},\"completed\":{\"type\":\"string\",\"format\":\"date-time\"},\"jobExecutionSource\":{\"type\":\"string\",\"enum\":[\"API\",\"KNOWLEDGE_MODEL\",\"DATA_MODEL_RELOAD\",\"SKILL_UPDATE\"]},\"jobExecutionSourceId\":{\"type\":\"string\"},\"timeout\":{\"type\":\"integer\",\"format\":\"int64\"},\"errorMessage\":{\"type\":\"string\"},\"logsCleanup\":{\"type\":\"boolean\"},\"optionalTenantId\":{\"type\":\"string\"}}},\"ApplicationKeyTransport\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"key\":{\"type\":\"string\"},\"createdAt\":{\"type\":\"string\",\"format\":\"date-time\"},\"lastUsedAt\":{\"type\":\"string\",\"format\":\"date-time\"},\"originalId\":{\"type\":\"string\"},\"teamRole\":{\"type\":\"integer\",\"format\":\"int32\"},\"internal\":{\"type\":\"boolean\"}}},\"JobExecutionLogTransport\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\"},\"logLevel\":{\"type\":\"string\"}}},\"NotebookExecutionTransport\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"notebookId\":{\"type\":\"string\"},\"notebookExecutionSourceId\":{\"type\":\"string\"},\"notebookExecutionSource\":{\"type\":\"string\"},\"executionFileName\":{\"type\":\"string\"},\"notebookExecutionStatus\":{\"type\":\"string\",\"enum\":[\"CREATED\",\"QUEUED\",\"STARTING\",\"STARTED\",\"COMPLETED\",\"NOTEBOOK_ERROR\",\"FAILED\",\"TIMEOUT\",\"CANCELED\",\"RESOURCES_ERROR\",\"CONFIGURATION_ERROR\"]},\"started\":{\"type\":\"string\",\"format\":\"date-time\"},\"completed\":{\"type\":\"string\",\"format\":\"date-time\"},\"params\":{\"$ref\":\"#/components/schemas/JsonNode\"},\"result\":{\"type\":\"string\"},\"logsOutputPath\":{\"type\":\"string\"},\"executionTimeout\":{\"type\":\"integer\",\"format\":\"int32\"},\"maxRetries\":{\"type\":\"integer\",\"format\":\"int32\"},\"timeUnit\":{\"type\":\"string\",\"enum\":[\"NANOSECONDS\",\"MICROSECONDS\",\"MILLISECONDS\",\"SECONDS\",\"MINUTES\",\"HOURS\",\"DAYS\"]}},\"required\":[\"executionFileName\",\"notebookId\"]},\"PageNotebookExecutionTransport\":{\"type\":\"object\",\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NotebookExecutionTransport\"}},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalCount\":{\"type\":\"integer\",\"format\":\"int64\"},\"first\":{\"type\":\"boolean\"},\"last\":{\"type\":\"boolean\"},\"empty\":{\"type\":\"boolean\"},\"totalPages\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"NotebookVersionTransport\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"versionCode\":{\"type\":\"string\"},\"createdDate\":{\"type\":\"string\",\"format\":\"date-time\"},\"imageId\":{\"type\":\"string\"},\"imageKey\":{\"type\":\"string\"},\"latest\":{\"type\":\"boolean\"},\"warning\":{\"type\":\"string\"},\"warningCode\":{\"type\":\"string\"},\"releaseNotes\":{\"type\":\"string\"}}},\"NotebookAccessInformationTransport\":{\"type\":\"object\",\"properties\":{\"token\":{\"type\":\"string\"},\"machineId\":{\"type\":\"string\"},\"puppetId\":{\"type\":\"string\"},\"publicAddress\":{\"type\":\"string\"},\"instanceType\":{\"type\":\"string\"},\"volumeDriver\":{\"type\":\"string\"},\"memoryLimit\":{\"type\":\"string\"},\"cpuCoresLimit\":{\"type\":\"string\"},\"diskUsageLimit\":{\"type\":\"string\"},\"gpuCoresLimit\":{\"type\":\"string\"},\"appKey\":{\"type\":\"string\"},\"imageUrl\":{\"type\":\"string\"},\"imageType\":{\"type\":\"string\"},\"execCommands\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"notebookMode\":{\"type\":\"boolean\"},\"routeToBedrock\":{\"type\":\"boolean\"},\"kubernetes\":{\"type\":\"boolean\"},\"withPlan\":{\"type\":\"boolean\"},\"migration\":{\"type\":\"boolean\"}}},\"NotebookTreeItem\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"path\":{\"type\":\"string\"},\"type\":{\"type\":\"string\"},\"content\":{},\"directory\":{\"type\":\"boolean\"},\"children\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/NotebookTreeItem\"}},\"notebook\":{\"type\":\"boolean\"}}},\"ImageTransport\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"name\":{\"type\":\"string\"},\"imageKey\":{\"type\":\"string\"},\"imageType\":{\"type\":\"string\",\"enum\":[\"JUPYTER\",\"VSCODE\",\"STREAMLIT\"]},\"imageUrl\":{\"type\":\"string\"},\"homePath\":{\"type\":\"string\"},\"visibleInDropdown\":{\"type\":\"boolean\"}}},\"JobExecutionTransport\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"jobId\":{\"type\":\"string\"},\"params\":{\"$ref\":\"#/components/schemas/JsonNode\"},\"status\":{\"type\":\"string\",\"enum\":[\"CREATED\",\"STARTED\",\"RUNNING\",\"COMPLETED\",\"FAILED\",\"CANCELED\"]},\"started\":{\"type\":\"string\",\"format\":\"date-time\"},\"completed\":{\"type\":\"string\",\"format\":\"date-time\"},\"jobExecutionSource\":{\"type\":\"string\"},\"errorMessage\":{\"type\":\"string\"}}},\"PageJobExecutionTransport\":{\"type\":\"object\",\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/JobExecutionTransport\"}},\"pageSize\":{\"type\":\"integer\",\"format\":\"int32\"},\"pageNumber\":{\"type\":\"integer\",\"format\":\"int32\"},\"totalCount\":{\"type\":\"integer\",\"format\":\"int64\"},\"first\":{\"type\":\"boolean\"},\"last\":{\"type\":\"boolean\"},\"empty\":{\"type\":\"boolean\"},\"totalPages\":{\"type\":\"integer\",\"format\":\"int32\"}}},\"JobExecutionGroup\":{\"type\":\"object\",\"properties\":{\"jobName\":{\"type\":\"string\"},\"lastJobExecutionId\":{\"type\":\"string\"},\"lastJobExecutionStatus\":{\"type\":\"string\",\"enum\":[\"CREATED\",\"STARTED\",\"RUNNING\",\"COMPLETED\",\"FAILED\",\"CANCELED\"]},\"lastJobExecutionStartedDate\":{\"type\":\"string\",\"format\":\"date-time\"}}},\"NotebookExecutionLogTransport\":{\"type\":\"object\",\"properties\":{\"notebookExecutionId\":{\"type\":\"string\"},\"message\":{\"type\":\"string\"},\"timestamp\":{\"type\":\"string\",\"format\":\"date-time\"},\"logLevel\":{\"type\":\"string\"}}},\"TriggeredExecutionGroupTransport\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\"},\"notebookId\":{\"type\":\"string\"},\"notebookName\":{\"type\":\"string\"},\"executionFileName\":{\"type\":\"string\"},\"lastExecutionId\":{\"type\":\"string\"},\"lastExecutionStatus\":{\"type\":\"string\",\"enum\":[\"CREATED\",\"QUEUED\",\"STARTING\",\"STARTED\",\"COMPLETED\",\"NOTEBOOK_ERROR\",\"FAILED\",\"TIMEOUT\",\"CANCELED\",\"RESOURCES_ERROR\",\"CONFIGURATION_ERROR\"]},\"lastExecutionStartedDate\":{\"type\":\"string\",\"format\":\"date-time\"}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","lastModified":"2025-09-09T19:47:14.000Z","redocInfoPageId":"mlwb/openapi/openapi.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","sourcePath":"/data/celonis/celonis-public-developer-docs/mlwb/openapi/openapi.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"autogenerated_mlwb/openapi/openapi.yaml","isDefault":true,"id":null,"title":null,"link":"/mlwb/openapi/openapi/overview/"}]},{"id":"bd29ea08-640a-5ae1-b9b4-be57aa9d6fd3overview/__redocly content redirect/data-ingestion-api/openapi/reference/overview/","definitionId":"celonis-data-ingestion","link":"/data-ingestion-api/openapi/reference/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/data-ingestion-api/openapi/reference.page.yaml","info":{"title":"OpenAPI definition","version":"v0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"celonis-data-ingestion","settings":{"corsProxyUrl":"https://cors.redoc.ly","generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"},{"lang":"PHP"}]}},"apiVersions":[{"definitionId":"celonis-data-ingestion","isDefault":true,"title":"celonis-data-ingestion","id":"celonis-data-ingestion"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.1\",\"info\":{\"title\":\"OpenAPI definition\",\"version\":\"v0\"},\"servers\":[{\"url\":\"http://localhost:8888/app\",\"description\":\"Generated server url\"}],\"paths\":{\"/api/v1/data-push/{poolId}/jobs/\":{\"post\":{\"operationId\":\"createJob\",\"parameters\":[{\"in\":\"path\",\"name\":\"poolId\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"in\":\"query\",\"name\":\"validate\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"default\":false}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/DataPushJob\"}}},\"required\":true},\"responses\":{\"200\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/DataPushJob\"}}},\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}},\"description\":\"Bad Request\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Not Found\"},\"429\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Too Many Requests\"},\"500\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}},\"description\":\"Internal Server Error\"}},\"summary\":\"Create a new Data Push Job in a Data Pool\",\"tags\":[\"Data Push API\"]},\"get\":{\"operationId\":\"listJobs\",\"parameters\":[{\"in\":\"path\",\"name\":\"poolId\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/DataPushJob\"}}}},\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}},\"description\":\"Bad Request\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Not Found\"},\"429\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Too Many Requests\"},\"500\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}},\"description\":\"Internal Server Error\"}},\"summary\":\"List running Data Push Jobs for a Data Pool\",\"tags\":[\"Data Push API\"]}},\"/api/v1/data-push/{poolId}/jobs/{id}/chunks/upserted\":{\"post\":{\"operationId\":\"addUpsertedChunk\",\"parameters\":[{\"in\":\"path\",\"name\":\"poolId\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"description\":\"Job Id\",\"in\":\"path\",\"name\":\"id\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"file\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"Chunk file\"}},\"required\":[\"file\"]}}}},\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}},\"description\":\"Bad request\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Job not found\"},\"429\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Too Many Requests\"},\"500\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}},\"description\":\"Internal Server Error\"}},\"summary\":\"Add chunk to a Data Push Job\",\"tags\":[\"Data Push API\"]}},\"/api/v1/data-push/{poolId}/jobs/{id}/chunks\":{\"get\":{\"operationId\":\"listChunks\",\"parameters\":[{\"in\":\"path\",\"name\":\"poolId\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"description\":\"Job Id\",\"in\":\"path\",\"name\":\"id\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/DataPushChunk\"}}}},\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}},\"description\":\"Bad Request\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Job not found\"},\"429\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Too Many Requests\"},\"500\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}},\"description\":\"Internal Server Error\"}},\"summary\":\"List the chunks of a Data Push Job\",\"tags\":[\"Data Push API\"]}},\"/api/v1/data-push/{poolId}/jobs/{id}/chunks/deleted\":{\"post\":{\"operationId\":\"addDeletedChunk\",\"parameters\":[{\"in\":\"path\",\"name\":\"poolId\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"description\":\"Job Id\",\"in\":\"path\",\"name\":\"id\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"object\",\"properties\":{\"file\":{\"type\":\"string\",\"format\":\"binary\",\"description\":\"Chunk file\"}},\"required\":[\"file\"]}}}},\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}},\"description\":\"Bad request\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Job not found\"},\"429\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Too Many Requests\"},\"500\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}},\"description\":\"Internal Server Error\"}},\"summary\":\"Delete rows from a table via a Data Push Job\",\"tags\":[\"Data Push API\"]}},\"/api/v1/data-push/{poolId}/jobs/{id}\":{\"get\":{\"operationId\":\"getJob\",\"parameters\":[{\"in\":\"path\",\"name\":\"poolId\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"in\":\"path\",\"name\":\"id\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/DataPushJob\"}}},\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}},\"description\":\"Bad Request\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Job not found\"},\"429\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Too Many Requests\"},\"500\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}},\"description\":\"Internal Server Error\"}},\"summary\":\"Get the status of a Data Push Job\",\"tags\":[\"Data Push API\"]},\"post\":{\"operationId\":\"executeJob\",\"parameters\":[{\"in\":\"path\",\"name\":\"poolId\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"description\":\"The ID of the Job you want to execute.\",\"in\":\"path\",\"name\":\"id\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"description\":\"The order column to be used for duplicate removal\",\"in\":\"query\",\"name\":\"duplicateRemovalColumn\",\"required\":false,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}},\"description\":\"Job already closed\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Job not found\"},\"409\":{\"description\":\"A job on the same target is already running. Parallel job executions are not allowed\"},\"429\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Too Many Requests\"},\"500\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}},\"description\":\"Internal Server Error\"}},\"summary\":\"Execute a Data Push Job\",\"tags\":[\"Data Push API\"]},\"delete\":{\"operationId\":\"deleteJob\",\"parameters\":[{\"in\":\"path\",\"name\":\"poolId\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"description\":\"The ID of the Job you want to delete.\",\"in\":\"path\",\"name\":\"id\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}},\"description\":\"Bad Request\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Not Found\"},\"429\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Too Many Requests\"},\"500\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}},\"description\":\"Internal Server Error\"}},\"summary\":\"Delete a Data Push Job\",\"tags\":[\"Data Push API\"]}},\"/api/v1/data-push/{poolId}/jobs/{id}/cancel\":{\"post\":{\"operationId\":\"cancelJob\",\"parameters\":[{\"in\":\"path\",\"name\":\"poolId\",\"required\":true,\"schema\":{\"type\":\"string\"}},{\"description\":\"The ID of the Job you want to cancel.\",\"in\":\"path\",\"name\":\"id\",\"required\":true,\"schema\":{\"type\":\"string\"}}],\"responses\":{\"200\":{\"description\":\"OK\"},\"204\":{\"description\":\"No Content\"},\"400\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/FrontendHandledBackendError\"}}},\"description\":\"Bad Request\"},\"403\":{\"description\":\"Forbidden\"},\"404\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Not Found\"},\"429\":{\"content\":{\"application/json\":{\"schema\":{\"type\":\"string\"}}},\"description\":\"Too Many Requests\"},\"500\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ExceptionReference\"}}},\"description\":\"Internal Server Error\"}},\"summary\":\"Cancel a Data Push Job\",\"tags\":[\"Data Push API\"]}}},\"components\":{\"schemas\":{\"CSVColumnParsingOptions\":{\"type\":\"object\",\"properties\":{\"columnName\":{\"type\":\"string\"},\"dateFormat\":{\"type\":\"string\"},\"decimalSeparator\":{\"type\":\"string\"},\"thousandsSeparator\":{\"type\":\"string\"}}},\"CSVParsingOptions\":{\"type\":\"object\",\"properties\":{\"additionalColumnOptions\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/CSVColumnParsingOptions\"}},\"charSet\":{\"type\":\"string\"},\"dateFormat\":{\"type\":\"string\"},\"decimalSeparator\":{\"type\":\"string\"},\"escapeSequence\":{\"type\":\"string\"},\"lineEnding\":{\"type\":\"string\"},\"quoteSequence\":{\"type\":\"string\"},\"separatorSequence\":{\"type\":\"string\"},\"thousandSeparator\":{\"type\":\"string\"}}},\"ChunkType\":{\"type\":\"string\",\"enum\":[\"UPSERT\",\"DELETE\"]},\"ColumnTransport\":{\"type\":\"object\",\"properties\":{\"columnName\":{\"type\":\"string\"},\"columnType\":{\"$ref\":\"#/components/schemas/ColumnType\"},\"decimals\":{\"type\":\"integer\",\"format\":\"int32\"},\"fieldLength\":{\"type\":\"integer\",\"format\":\"int32\"},\"pkField\":{\"type\":\"boolean\"}}},\"ColumnType\":{\"type\":\"string\",\"enum\":[\"INTEGER\",\"DATE\",\"TIME\",\"DATETIME\",\"FLOAT\",\"BOOLEAN\",\"STRING\"]},\"DataPushChunk\":{\"type\":\"object\",\"properties\":{\"checksum\":{\"type\":\"string\"},\"creationDate\":{\"type\":\"string\",\"format\":\"date-time\"},\"fileLength\":{\"type\":\"integer\",\"format\":\"int64\"},\"id\":{\"type\":\"string\"},\"optionalTenantId\":{\"type\":\"string\"},\"pushJobId\":{\"type\":\"string\"},\"tenantId\":{\"type\":\"string\",\"writeOnly\":true},\"type\":{\"$ref\":\"#/components/schemas/ChunkType\"}}},\"DataPushJob\":{\"type\":\"object\",\"properties\":{\"allowDuplicate\":{\"type\":\"boolean\"},\"changeDate\":{\"type\":\"string\",\"format\":\"date-time\"},\"connectionId\":{\"type\":\"string\"},\"creationDate\":{\"type\":\"string\",\"format\":\"date-time\"},\"csvParsingOptions\":{\"$ref\":\"#/components/schemas/CSVParsingOptions\"},\"dataPoolId\":{\"type\":\"string\"},\"fallbackVarcharLength\":{\"type\":\"integer\",\"format\":\"int32\"},\"fileType\":{\"$ref\":\"#/components/schemas/UploadFileType\"},\"foreignKeys\":{\"type\":\"string\"},\"id\":{\"type\":\"string\"},\"keys\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"lastModified\":{\"type\":\"string\",\"format\":\"date-time\"},\"lastPing\":{\"type\":\"string\",\"format\":\"date-time\"},\"logs\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"mirrorTargetNames\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}},\"optionalTenantId\":{\"type\":\"string\"},\"postExecutionQuery\":{\"type\":\"string\"},\"sanitizedPostExecutionQuery\":{\"type\":\"string\"},\"status\":{\"$ref\":\"#/components/schemas/JobStatus\"},\"tableSchema\":{\"$ref\":\"#/components/schemas/TableTransport\"},\"targetName\":{\"type\":\"string\"},\"targetSchema\":{\"type\":\"string\"},\"tenantId\":{\"type\":\"string\",\"writeOnly\":true},\"type\":{\"$ref\":\"#/components/schemas/JobType\"},\"upsertStrategy\":{\"$ref\":\"#/components/schemas/DataPushUpsertStrategy\"}},\"description\":\"The descriptor of the Job which you want to create.\"},\"DataPushUpsertStrategy\":{\"type\":\"string\",\"enum\":[\"UPSERT_WITH_UNCHANGED_METADATA\",\"UPSERT_WITH_NULLIFICATION\"]},\"DuplicateRemovalOptions\":{\"type\":\"object\",\"properties\":{\"duplicateRemovalOrderColumn\":{\"type\":\"string\"},\"filterDeletionsOnOrderColumn\":{\"type\":\"boolean\"},\"prefilterDeletionsAgainstTempTable\":{\"type\":\"boolean\"},\"removeDuplicates\":{\"type\":\"boolean\"}}},\"ExceptionReference\":{\"type\":\"object\",\"properties\":{\"message\":{\"type\":\"string\"},\"reference\":{\"type\":\"string\"},\"shortMessage\":{\"type\":\"string\"}}},\"Feature\":{\"type\":\"object\",\"properties\":{\"enabled\":{\"type\":\"boolean\"},\"key\":{\"type\":\"string\"}}},\"FrontendHandledBackendError\":{\"type\":\"object\",\"properties\":{\"errorInformation\":{\"type\":\"object\"},\"frontendErrorKey\":{\"type\":\"string\"}}},\"JobStatus\":{\"type\":\"string\",\"enum\":[\"NEW\",\"QUEUED\",\"RUNNING\",\"DONE\",\"ERROR\",\"CANCELED\"]},\"JobType\":{\"type\":\"string\",\"enum\":[\"REPLACE\",\"DELTA\"]},\"TableTransport\":{\"type\":\"object\",\"properties\":{\"columns\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/ColumnTransport\"}},\"tableName\":{\"type\":\"string\"}}},\"UploadFileType\":{\"type\":\"string\",\"enum\":[\"PARQUET\",\"CSV\"]}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"corsProxyUrl\":\"https://cors.redoc.ly\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"PHP\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","permission":"guest","lastModified":"2025-08-22T16:02:15.000Z","label":"OpenAPI definition","redocInfoPageId":"data-ingestion-api/openapi/reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/celonis/celonis-public-developer-docs/data-ingestion-api/openapi/reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"celonis-data-ingestion","isDefault":true,"id":"celonis-data-ingestion","title":"celonis-data-ingestion","link":null}]},{"id":"007f68da-7220-5b97-b9af-318e730e89e1overview/__redocly content redirect/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference/overview/","definitionId":"knowledge-model-api","link":"/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference.page.yaml","info":{"title":"OpenAPI Specification","description":"EMS API to work with Knowledge Model elements, like records, kpis, filters and their related data.","x-audience":"EX","version":"1.32.0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"knowledge-model-api","settings":{"corsProxyUrl":"https://cors.redoc.ly","generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"},{"lang":"PHP"}]}},"apiVersions":[{"definitionId":"knowledge-model-api","isDefault":true,"title":"knowledge-model-api","id":"knowledge-model-api"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"OpenAPI Specification\",\"description\":\"EMS API to work with Knowledge Model elements, like records, kpis, filters and their related data.\",\"x-audience\":\"EX\",\"version\":\"1.32.0\"},\"security\":[{\"BearerAuth\":[]},{\"ApiKeyAuth\":[]}],\"servers\":[{\"url\":\"https://b0eca2bc-fbc3-400f-b855-9fe468151d15.remockly.com\"}],\"paths\":{\"/intelligence/api/knowledge-models\":{\"get\":{\"operationId\":\"getKnowledgeModel\",\"summary\":\"Get a list of KMs\",\"tags\":[\"Schema\"],\"description\":\"List of Knowledge Models defined in an EMS team\",\"parameters\":[{\"$ref\":\"#/components/parameters/pageParam\"},{\"$ref\":\"#/components/parameters/pageSizeParam\"},{\"$ref\":\"#/components/parameters/singleSortParam\"}],\"responses\":{\"200\":{\"description\":\"List of Knowledge Model ids and names\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/knowledgeModelResultPage\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}\":{\"get\":{\"operationId\":\"getKnowledgeModelDetails\",\"summary\":\"Get the top-level KM details\",\"description\":\"Knowledge Model defined in an EMS team\",\"tags\":[\"Schema\"],\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}}],\"responses\":{\"200\":{\"description\":\"Top-level Knowledge Model details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/knowledgeModelDetailedDTO\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}/filters\":{\"get\":{\"operationId\":\"getFilters\",\"tags\":[\"Schema\"],\"summary\":\"Get a list of KM Filters\",\"description\":\"List of Filters for the Knowledge Model\",\"parameters\":[{\"$ref\":\"#/components/parameters/pageParam\"},{\"$ref\":\"#/components/parameters/pageSizeParam\"},{\"$ref\":\"#/components/parameters/singleSortParam\"},{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-kms\"}}],\"responses\":{\"200\":{\"description\":\"List of Filter ids and names\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/filterResultPage\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}/records\":{\"get\":{\"operationId\":\"getRecords\",\"tags\":[\"Schema\"],\"summary\":\"Get a list of KM Records schema\",\"description\":\"List of Records schema\",\"parameters\":[{\"$ref\":\"#/components/parameters/pageParam\"},{\"$ref\":\"#/components/parameters/pageSizeParam\"},{\"$ref\":\"#/components/parameters/singleSortParam\"},{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}}],\"responses\":{\"200\":{\"description\":\"List of Record ids and names\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/recordSchemaResultPage\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}/records/{record_id}\":{\"get\":{\"operationId\":\"getRecordDetails\",\"tags\":[\"Schema\"],\"summary\":\"Get the top-level KM Record Schema details\",\"description\":\"Top-level Record Schema details\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"name\":\"record_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"MATERIALS\"}},{\"$ref\":\"#/components/parameters/singleSortParam\"}],\"responses\":{\"200\":{\"description\":\"Top-level Record Schema details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/recordDTO\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}/data\":{\"get\":{\"operationId\":\"getKnowledgeModelDataResult\",\"tags\":[\"Data\"],\"summary\":\"Get a list of KM data\",\"description\":\"Data for a Knowledge Model\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"$ref\":\"#/components/parameters/filtersParam\"},{\"$ref\":\"#/components/parameters/fieldsOptionalParam\"},{\"$ref\":\"#/components/parameters/pageParam\"},{\"$ref\":\"#/components/parameters/pageSizeParam\"},{\"$ref\":\"#/components/parameters/sortParam\"},{\"$ref\":\"#/components/parameters/filterExprParam\"},{\"$ref\":\"#/components/parameters/options\"},{\"$ref\":\"#/components/parameters/kpisParam\"},{\"$ref\":\"#/components/parameters/searchTerm\"},{\"$ref\":\"#/components/parameters/searchPrecision\"},{\"$ref\":\"#/components/parameters/searchField\"}],\"responses\":{\"200\":{\"description\":\"List of Knowledge Model data\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/recordResultPageDTO\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}},\"post\":{\"tags\":[\"Data\"],\"summary\":\"Get a list of KM data with advanced filtering\",\"description\":\"Query Data for a Knowledge Model that is combining different Records, this endpoint allows clients to easily include more complicated queries.\",\"operationId\":\"getKnowledgeModelQueryResultByUsingQueryInBody\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/KmQueryDataRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"List of Knowledge Model data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/recordResultPageDTO\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}/records/{record_id}/data\":{\"get\":{\"operationId\":\"getRecordDataResult\",\"tags\":[\"Data\"],\"summary\":\"Get a list of KM Record data\",\"description\":\"Data for a Record in the Knowledge Model.\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"name\":\"record_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"MATERIALS\"}},{\"$ref\":\"#/components/parameters/filtersParam\"},{\"$ref\":\"#/components/parameters/fieldsParam\"},{\"$ref\":\"#/components/parameters/pageParam\"},{\"$ref\":\"#/components/parameters/pageSizeParam\"},{\"$ref\":\"#/components/parameters/sortParam\"},{\"$ref\":\"#/components/parameters/filterExprParam\"},{\"$ref\":\"#/components/parameters/options\"},{\"$ref\":\"#/components/parameters/searchTerm\"},{\"$ref\":\"#/components/parameters/searchPrecision\"},{\"$ref\":\"#/components/parameters/searchField\"}],\"responses\":{\"200\":{\"description\":\"List of Record data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/recordResultPageDTO\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}},\"post\":{\"tags\":[\"Data\"],\"summary\":\"Get a list of KM Record data with advanced filtering\",\"description\":\"Query Data for a Record in the Knowledge Model. This endpoint allows clients to easily include more complicated queries.\",\"operationId\":\"getRecordDataResultByUsingQueryInBody\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"name\":\"record_id\",\"in\":\"path\",\"required\":true,\"style\":\"simple\",\"explode\":false,\"schema\":{\"type\":\"string\",\"example\":\"MATERIALS\"}}],\"requestBody\":{\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/KmQueryRecordDataRequest\"}}},\"required\":true},\"responses\":{\"200\":{\"description\":\"List of Record data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/recordResultPageDTO\"}}}},\"400\":{\"description\":\"Bad Request.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"401\":{\"description\":\"Unauthorized access.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/authErrorDTO\"}}}},\"403\":{\"description\":\"Forbidden.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"404\":{\"description\":\"The specified resource was not found.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"429\":{\"description\":\"Too Many Requests.\",\"headers\":{\"X-RateLimit-Limit\":{\"description\":\"Request limit per hour.\",\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},\"X-RateLimit-Remaining\":{\"description\":\"The number of requests left for the time window.\",\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},\"X-RateLimit-Reset\":{\"description\":\"The UTC date/time at which the current rate limit window. resets.\",\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}},\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"500\":{\"description\":\"Internal Server Error.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"503\":{\"description\":\"Service Unavailable.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}}}}},\"/intelligence/api/knowledge-models/{km_id}/records/{record_id}/query\":{\"get\":{\"operationId\":\"getRecordQueryResult\",\"tags\":[\"Beta: Semantics for 3P AI Agents\"],\"summary\":\"Get a list of KM Record data\",\"description\":\"Query Data for a Record in the Knowledge Model.\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"name\":\"record_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"MATERIALS\"}},{\"$ref\":\"#/components/parameters/filtersParam\"},{\"$ref\":\"#/components/parameters/fieldsOptionalParam\"},{\"$ref\":\"#/components/parameters/pageParam\"},{\"$ref\":\"#/components/parameters/pageSizeParam\"},{\"$ref\":\"#/components/parameters/sortParam\"},{\"$ref\":\"#/components/parameters/filterExprParam\"},{\"$ref\":\"#/components/parameters/options\"},{\"$ref\":\"#/components/parameters/searchTerm\"},{\"$ref\":\"#/components/parameters/searchPrecision\"},{\"$ref\":\"#/components/parameters/searchField\"}],\"responses\":{\"200\":{\"description\":\"List of Record data.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/queryResultPageDTO\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}/kpis\":{\"get\":{\"operationId\":\"getKpis\",\"tags\":[\"Schema\"],\"summary\":\"Get a list of KM KPI's schema\",\"description\":\"List of KPI's schema.\",\"parameters\":[{\"$ref\":\"#/components/parameters/pageParam\"},{\"$ref\":\"#/components/parameters/pageSizeParam\"},{\"$ref\":\"#/components/parameters/singleSortParam\"},{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}}],\"responses\":{\"200\":{\"description\":\"List of KPI's.\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/kpiSchemaResultPage\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}/query\":{\"get\":{\"operationId\":\"getKnowledgeModelQueryResult\",\"tags\":[\"Beta: Semantics for 3P AI Agents\"],\"summary\":\"Get a list of KM data from different records\",\"description\":\"Query Data for a Knowledge Model that is combining different Records\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"$ref\":\"#/components/parameters/filtersParam\"},{\"$ref\":\"#/components/parameters/fieldsOptionalParam\"},{\"$ref\":\"#/components/parameters/pageParam\"},{\"$ref\":\"#/components/parameters/pageSizeParam\"},{\"$ref\":\"#/components/parameters/sortParam\"},{\"$ref\":\"#/components/parameters/filterExprParam\"},{\"$ref\":\"#/components/parameters/options\"},{\"$ref\":\"#/components/parameters/kpisParam\"},{\"$ref\":\"#/components/parameters/searchTerm\"},{\"$ref\":\"#/components/parameters/searchPrecision\"},{\"$ref\":\"#/components/parameters/searchField\"}],\"responses\":{\"200\":{\"description\":\"List of Record data\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/queryResultPageDTO\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}/spec\":{\"get\":{\"operationId\":\"getKnowledgeModelSpec\",\"tags\":[\"Beta: Semantics for 3P AI Agents\"],\"summary\":\"Generate an OpenAPI spec from a Knowledge Model\",\"description\":\"OpenaAPI spec of Knowledge Model\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"name\":\"curated\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"example\":false}}],\"responses\":{\"200\":{\"description\":\"OpenAPI Spec\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/openApiSpecDTO\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}/records/{record_id}/summary\":{\"get\":{\"operationId\":\"summaryResult\",\"tags\":[\"Beta: Semantics for 3P AI Agents\"],\"summary\":\"Get KM record statistics - Only for Attributes\",\"description\":\"Knowledge Model record content statistics, only calculed for attributes. KPI and Flags will return empty results\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"name\":\"record_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"MATERIALS\"}},{\"$ref\":\"#/components/parameters/filtersParam\"},{\"$ref\":\"#/components/parameters/fieldsOptionalParam\"},{\"$ref\":\"#/components/parameters/excludFieldsOptionalParam\"},{\"$ref\":\"#/components/parameters/sampleSizeParam\"}],\"responses\":{\"200\":{\"description\":\"List of Record data\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/recordSummaryResultPageDTO\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/odata/{km_id}.svc/$metadata\":{\"get\":{\"operationId\":\"odataMetadataResult\",\"tags\":[\"Beta: OData Protocol\"],\"summary\":\"OData metadata endpoint\",\"description\":\"OData Knowledge Model $metadata\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"$ref\":\"#/components/parameters/odataFormatParam\"}],\"responses\":{\"200\":{\"description\":\"List of Record data\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ODataServiceResultPage\"}},\"application/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/ODataServiceResultPage\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"415\":{\"$ref\":\"#/components/responses/NotSupportedFormat\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/odata/{km_id}.svc\":{\"get\":{\"operationId\":\"odataServiceDefinitionResult\",\"tags\":[\"Beta: OData Protocol\"],\"summary\":\"OData service definition endpoint\",\"description\":\"OData Knowledge Model service definition endpoint\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"$ref\":\"#/components/parameters/odataFormatParam\"}],\"responses\":{\"200\":{\"description\":\"List of Record data\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ODataServiceDefinitionResultPage\"}},\"application/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/ODataServiceDefinitionXMLResultPage\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"415\":{\"$ref\":\"#/components/responses/NotSupportedFormat\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/odata/{km_id}.svc/{record_id}_entries\":{\"get\":{\"operationId\":\"odataServiceDataResult\",\"tags\":[\"Beta: OData Protocol\"],\"summary\":\"OData service data endpoint\",\"description\":\"OData Knowledge Model service data endpoint\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"name\":\"record_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"MATERIALS\"}},{\"$ref\":\"#/components/parameters/odataFormatParam\"},{\"$ref\":\"#/components/parameters/odataSelectParam\"},{\"$ref\":\"#/components/parameters/odataTopParam\"},{\"$ref\":\"#/components/parameters/odataSkipParam\"},{\"$ref\":\"#/components/parameters/odataFilterParam\"},{\"$ref\":\"#/components/parameters/odataFilterIdParam\"},{\"$ref\":\"#/components/parameters/odataOrderByParam\"},{\"$ref\":\"#/components/parameters/odataCountParam\"}],\"responses\":{\"200\":{\"description\":\"List of Record data\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ODataServiceDataResultPage\"}},\"application/xml\":{\"schema\":{\"$ref\":\"#/components/schemas/ODataServiceDataXMLResultPage\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"415\":{\"$ref\":\"#/components/responses/NotSupportedFormat\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}}},\"components\":{\"securitySchemes\":{\"BearerAuth\":{\"type\":\"http\",\"scheme\":\"bearer\",\"bearerFormat\":\"JWT\"},\"ApiKeyAuth\":{\"type\":\"apiKey\",\"in\":\"header\",\"name\":\"AppKey\"}},\"schemas\":{\"resultPage\":{\"title\":\"Result page\",\"type\":\"object\",\"properties\":{\"page\":{\"type\":\"integer\",\"description\":\"Page\",\"example\":0},\"pageSize\":{\"type\":\"integer\",\"description\":\"Page size, defined by pageSize parameter\",\"example\":50},\"total\":{\"type\":\"integer\",\"description\":\"Total elements returned in the page\",\"example\":1},\"sort\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":\"material_number\"}}}},\"schemaResultPage\":{\"title\":\"Result page\",\"type\":\"object\",\"properties\":{\"page\":{\"type\":\"integer\",\"description\":\"Page\",\"example\":0},\"pageSize\":{\"type\":\"integer\",\"description\":\"Page size, defined by pageSize parameter\",\"example\":50},\"total\":{\"type\":\"integer\",\"description\":\"Total elements returned in the page\",\"example\":1},\"sort\":{\"type\":\"string\",\"description\":\"Field used to apply sorting to the requested data, + or no symbol means ASC, - means DESC\",\"example\":\"+id\"}}},\"recordResultPageDTO\":{\"title\":\"Record data result page\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"content\":{\"$ref\":\"#/components/schemas/recordItemDTO\"}},\"allOf\":[{\"$ref\":\"#/components/schemas/resultPage\"}]},\"recordSchemaResultPage\":{\"title\":\"Record schema result page\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/recordIdDTO\"}}},\"allOf\":[{\"$ref\":\"#/components/schemas/schemaResultPage\"}]},\"kpiSchemaResultPage\":{\"title\":\"KPI schema result page\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/kpiDTO\"}}},\"allOf\":[{\"$ref\":\"#/components/schemas/schemaResultPage\"}]},\"filterResultPage\":{\"title\":\"Filter schema result page\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/filterDTO\"}}},\"allOf\":[{\"$ref\":\"#/components/schemas/schemaResultPage\"}]},\"knowledgeModelResultPage\":{\"title\":\"KnowledgeModel result page\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/knowledgeModelSimplifiedDTO\"}}},\"allOf\":[{\"$ref\":\"#/components/schemas/schemaResultPage\"}]},\"errorDTO\":{\"title\":\"Error\",\"type\":\"object\",\"description\":\"This [RFC7807] specification is to define common error formats for those applications that need one, so that they aren't required to define their own, or worse, tempted to redefine the semantics of existing HTTP status codes. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\",\"properties\":{\"title\":{\"type\":\"string\",\"description\":\"A short, human-readable summary of the problem type.  It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\"},\"status\":{\"type\":\"integer\",\"description\":\"The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\"},\"detail\":{\"type\":\"string\",\"description\":\"The details of the Error\"},\"errorCode\":{\"type\":\"string\",\"description\":\"Unique Identifier of the Error\"},\"type\":{\"type\":\"string\",\"description\":\"A URI reference [RFC3986] that identifies the problem type. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\"}}},\"recordSummaryResultPageDTO\":{\"title\":\"Record data result page\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"content\":{\"$ref\":\"#/components/schemas/recordItemDTO\"},\"shape\":{\"type\":\"array\",\"items\":{\"type\":\"integer\",\"example\":[10,200000]}},\"summary\":{\"type\":\"object\",\"properties\":{\"count\":{\"type\":\"integer\",\"example\":300000,\"description\":\"Number of non-null values (applicable to all field types)\"},\"unique\":{\"type\":\"integer\",\"description\":\"Number of unique non-null values (applicable only to strings & timestamps)\"},\"top\":{\"type\":\"string\",\"description\":\"Most frequent value (applicable only to strings & timestamps)\"},\"freq\":{\"type\":\"string\",\"description\":\"Frequency of the most frequent value (applicable only to strings & timestamps)\"},\"mean\":{\"type\":\"number\",\"description\":\"Mean of the values (applicable only to numeric fields)\"},\"std\":{\"type\":\"number\",\"description\":\"Standard deviation of the values (applicable only to numeric fields)\"},\"min\":{\"type\":\"number\",\"description\":\"Minimum value (applicable only to numeric fields)\"},\"max\":{\"type\":\"number\",\"description\":\"Maximum value (applicable only to numeric fields)\"},\"25_percentile\":{\"type\":\"number\",\"description\":\"percentile (applicable only to numeric fields)\"},\"50_percentile\":{\"type\":\"number\",\"description\":\"percentile (applicable only to numeric fields)\"},\"75_percentile\":{\"type\":\"number\",\"description\":\"percentile (applicable only to numeric fields)\"}}}}},\"authErrorDTO\":{\"title\":\"Authentication Error\",\"type\":\"object\",\"properties\":{\"error\":{\"type\":\"string\"}}},\"filterDTO\":{\"title\":\"Filter\",\"description\":\"Filter to apply in a KM\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Filter's Unique identifier\",\"example\":\"24M_FILTER\"},\"name\":{\"type\":\"string\",\"description\":\"Human understandable Filter display name\",\"example\":\"24 Months\"},\"description\":{\"type\":\"string\",\"description\":\"Human understandable Filter description\",\"example\":\"Materials we purchased over the past 24 months.\"}}},\"knowledgeModelIdDTO\":{\"title\":\"Knowledge Model Identifier\",\"description\":\"Knowledge Model id and name\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Unique Identifier of Knowledge Model\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"},\"name\":{\"type\":\"string\",\"description\":\"Human understandable text\",\"example\":\"Purchase Requisition KM\"}}},\"knowledgeModelDetailedDTO\":{\"title\":\"Knowledge Model\",\"description\":\"Knowledge Model data's structure\",\"type\":\"object\",\"properties\":{\"extendedKMId\":{\"type\":\"string\",\"description\":\"Knowledge model used as reference, KM base.\",\"example\":\"open-purchase-requisition.purchase-requisition-km-base\"}},\"allOf\":[{\"$ref\":\"#/components/schemas/knowledgeModelIdDTO\"}]},\"knowledgeModelSimplifiedDTO\":{\"title\":\"Knowledge Model\",\"description\":\"Knowledge Model data's structure\",\"type\":\"object\",\"properties\":{\"published\":{\"type\":\"string\",\"description\":\"Latest published date\",\"example\":\"2023-04-19 11:29:45\"}},\"allOf\":[{\"$ref\":\"#/components/schemas/knowledgeModelIdDTO\"}]},\"recordItemHeaderDTO\":{\"title\":\"Record Item Header\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Field identity to use in field list param and filterExpression param\"},\"name\":{\"type\":\"string\",\"description\":\"Human understandable text\"},\"type\":{\"type\":\"string\",\"enum\":[\"integer\",\"date\",\"time\",\"datetime\",\"timestamp\",\"float\",\"boolean\",\"string\"],\"description\":\"Possible data types.\"},\"format\":{\"type\":\"string\",\"description\":\"Format expression\"},\"unit\":{\"type\":\"string\",\"description\":\"A complementary sign for format value view\"},\"aggregation\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Indicate if a field is a aggregation/calculated information(KPI).\"},\"filterable\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Indicate if the field could be filtered.\"},\"sortable\":{\"type\":\"boolean\",\"default\":false,\"description\":\"Indicate if the field could be sorted.\"}}},\"recordItemDTO\":{\"title\":\"Record Item\",\"type\":\"object\",\"properties\":{\"headers\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/recordItemHeaderDTO\"},\"example\":[{\"id\":\"material_name\",\"name\":\"Material name\",\"type\":\"string\",\"format\":\"\",\"unit\":\"\",\"aggregation\":\"false\",\"filterable\":\"true\",\"sortable\":\"true\"},{\"id\":\"material_number\",\"name\":\"Material number\",\"type\":\"string\",\"format\":\"\",\"unit\":\"\",\"aggregation\":\"false\",\"filterable\":\"true\",\"sortable\":\"true\"},{\"id\":\"material_group\",\"name\":\"Material group\",\"type\":\"string\",\"format\":\"\",\"unit\":\"\",\"aggregation\":\"false\",\"filterable\":\"true\",\"sortable\":\"true\"}]},\"data\":{\"type\":\"array\",\"description\":\"List of record item, compound with name and value\",\"items\":{\"additionalProperties\":{},\"example\":[{\"material_name\":\"PC Installation / Configuration\",\"material_number\":\"I-1000\",\"material_group\":\"Services\"}]}}}},\"recordIdDTO\":{\"title\":\"Record Type Identifier\",\"description\":\"Record Type's id and name\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Record's Unique identifier\",\"example\":\"MATERIALS\"},\"name\":{\"type\":\"string\",\"description\":\"Record display name, a human understandable name\",\"example\":\"Materials\"},\"description\":{\"type\":\"string\",\"description\":\"Record description\",\"example\":\"Materials that have been purchased.\"},\"shortDisplayName\":{\"type\":\"string\",\"description\":\"Record short display name\",\"example\":\"Materials\"},\"internalNote\":{\"type\":\"string\",\"description\":\"Record internal note\",\"example\":\"Materials\"}}},\"kpiDTO\":{\"title\":\"KPI asset definition\",\"description\":\"KPI structure within the knowledge model\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"KPI's Unique identifier\",\"example\":\"AVG_EVENTS_PER_CASE\"},\"name\":{\"type\":\"string\",\"description\":\"KPI's display name, a human understandable name\",\"example\":\"Average events per case\"},\"description\":{\"type\":\"string\",\"description\":\"KPI's description\",\"example\":\"An average events per case\"},\"format\":{\"type\":\"string\",\"example\":\"#.###\",\"description\":\"Format to be applied\"},\"unit\":{\"type\":\"string\",\"example\":\"euros\",\"description\":\"Unit added to field value\"},\"direction\":{\"type\":\"string\",\"example\":\"Up, Down, None\",\"description\":\"Desired trend direction for the KPI progress\"},\"target\":{\"type\":\"string\",\"example\":\"any value\",\"description\":\"Default KPI target (Optional)\"},\"parameters\":{\"type\":\"array\",\"description\":\"KPI's List of parameters\",\"items\":{\"$ref\":\"#/components/schemas/kpiParameterItemDTO\",\"example\":[{\"id\":\"parameter_1\",\"name\":\"My First Parameter\",\"value\":\"1\"},{\"id\":\"parameter_2\",\"name\":\"My Second Parameter\",\"value\":\"a\"},{\"id\":\"parameter_3\",\"name\":\"My Third Parameter\",\"value\":\"5\"}]}}}},\"kpiParameterItemDTO\":{\"title\":\"Parameter defined for a Knowledge Model KPI\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Field identity to use in field list param and filterExpression param\"},\"name\":{\"type\":\"string\",\"description\":\"Human understandable text\"},\"value\":{\"type\":\"string\",\"description\":\"Initial value for the parameter.\"}}},\"recordFieldDTO\":{\"title\":\"Record Type Field\",\"description\":\"Fields for a Record\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"example\":\"payment_amount\",\"description\":\"Amount pending to pay\"},\"name\":{\"type\":\"string\",\"example\":\"Amount in euros pending to pay\",\"description\":\"human understandable name\"},\"description\":{\"type\":\"string\",\"description\":\"Record field description\",\"example\":\"Amount pending to pay\"},\"shortDisplayName\":{\"type\":\"string\",\"description\":\"Record short display name\",\"example\":\"Amount\"},\"internalNote\":{\"type\":\"string\",\"description\":\"Record internal note\",\"example\":\"Amount of the record\"},\"type\":{\"type\":\"string\",\"enum\":[\"string\",\"date\",\"integer\",\"boolean\",\"number\",\"datetime\",\"timestamp\",\"float\"]},\"format\":{\"type\":\"string\",\"example\":\"#.###\",\"description\":\"Format to be applied\"},\"unit\":{\"type\":\"string\",\"example\":\"euros\",\"description\":\"Unit added to field value\"}}},\"recordDTO\":{\"title\":\"Record Type\",\"description\":\"Record represents a concept inside a Knowledge Model\",\"type\":\"object\",\"properties\":{\"fields\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/recordFieldDTO\"},\"example\":[{\"id\":\"material_name\",\"name\":\"Material Name\",\"description\":\"Materials name that have been purchased.\",\"shortDisplayName\":\"Materials\",\"internalNote\":\"Materials\",\"type\":\"string\",\"format\":\"\",\"unit\":\"\"},{\"id\":\"material_number\",\"name\":\"Material Number\",\"description\":\"Materials number that have been purchased.\",\"shortDisplayName\":\"Materials\",\"internalNote\":\"Materials\",\"type\":\"string\",\"format\":\"\",\"unit\":\"\"},{\"id\":\"material_group\",\"name\":\"Material Group\",\"description\":\"Materials group that have been purchased.\",\"shortDisplayName\":\"Materials\",\"internalNote\":\"Materials\",\"type\":\"string\",\"format\":\"\",\"unit\":\"\"}]}},\"allOf\":[{\"$ref\":\"#/components/schemas/recordIdDTO\"}]},\"queryResultPageDTO\":{\"title\":\"Query data result page\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"additionalProperties\":{},\"example\":[{\"material_name\":\"PC Installation / Configuration\",\"material_number\":\"I-1000\",\"material_group\":\"Services\"}]}}},\"allOf\":[{\"$ref\":\"#/components/schemas/resultPage\"}]},\"ODataServiceResultPage\":{\"title\":\"OData Service result page\",\"type\":\"object\",\"properties\":{\"$Version\":{\"type\":\"string\",\"example\":4.01}},\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"$Kind\":{\"type\":\"string\",\"example\":\"EntityType\"}},\"additionalProperties\":{\"type\":\"object\",\"properties\":{\"$Type\":{\"type\":\"string\",\"example\":null}}}}},\"ODataServiceDefinitionResultPage\":{\"title\":\"OData Service Definition result page\",\"type\":\"object\",\"properties\":{\"@odata.context\":{\"type\":\"string\",\"description\":\"OData $metadata URI\",\"example\":\"https://team.domain.celonis.cloud/intelligence/api/odata/kmid.svc/$metadata\"},\"value\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"example\":\"km_record_entries\"},\"url\":{\"type\":\"string\",\"example\":\"km_record_entries\"}}}}}},\"ODataServiceDefinitionXMLResultPage\":{\"title\":\"OData Service Definition result page\",\"type\":\"object\",\"properties\":{\"@odata.context\":{\"type\":\"string\",\"description\":\"OData $metadata URI\",\"example\":\"https://team.domain.celonis.cloud/intelligence/api/odata/kmid.svc/$metadata\"},\"workspace\":{\"type\":\"object\",\"properties\":{\"title\":{\"type\":\"string\",\"example\":\"ODataKnowledgeModel.Container\"},\"collection\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"example\":\"km_record_entries\",\"xml\":{\"attribute\":true}},\"href\":{\"type\":\"string\",\"example\":\"km_record_entries\",\"xml\":{\"attribute\":true}},\"title\":{\"type\":\"string\",\"example\":\"km_record_entries\"}}}}}}}},\"ODataServiceDataResultPage\":{\"title\":\"OData Service Data result page\",\"type\":\"object\",\"properties\":{\"@odata.context\":{\"type\":\"string\",\"description\":\"OData $metadata URI\",\"example\":\"https://team.domain.celonis.cloud/intelligence/api/odata/kmid.svc/$metadata#km_record_entries\"},\"value\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"example\":{\"field_id1\":\"value1\",\"field_id2\":\"value2\"}}}}}},\"ODataServiceDataXMLResultPage\":{\"title\":\"OData Service Data XML result page\",\"type\":\"object\",\"properties\":{\"feed\":{\"type\":\"object\",\"properties\":{\"context\":{\"type\":\"string\",\"description\":\"OData $metadata URI\",\"example\":\"https://team.domain.celonis.cloud/intelligence/api/odata/kmid.svc/$metadata#km_record_entries\",\"xml\":{\"attribute\":true}},\"entry\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"properties\":{\"updated\":{\"type\":\"string\",\"format\":\"datatime\"},\"category\":{\"type\":\"object\",\"properties\":{\"term\":{\"type\":\"string\",\"xml\":{\"attribute\":true},\"example\":\"#ODataKnowledgeModel.DELIVERY_ITEM\"}}},\"content\":{\"type\":\"object\",\"properties\":{\"type\":{\"type\":\"string\",\"example\":\"application/xml\",\"xml\":{\"attribute\":true}},\"properties\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"object\",\"example\":{\"field_id1\":\"value1\",\"field_id2\":\"value2\"}}}}}}}}}}}},\"openApiSpecDTO\":{\"properties\":{\"openapi\":{\"type\":\"string\",\"pattern\":\"^3\\\\.0\\\\.\\\\d(-.+)?$\"},\"info\":{\"type\":\"object\",\"required\":[\"title\",\"version\"],\"properties\":{\"title\":{\"type\":\"string\"},\"description\":{\"type\":\"string\"},\"termsOfService\":{\"type\":\"string\",\"format\":\"uri-reference\"},\"contact\":{\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\"},\"url\":{\"type\":\"string\",\"format\":\"uri-reference\"}}},\"version\":{\"type\":\"string\"},\"x-audience\":{\"type\":\"string\",\"example\":\"EX\"}}},\"servers\":{\"type\":\"array\",\"items\":{\"type\":\"object\",\"required\":[\"url\"],\"properties\":{\"url\":{\"type\":\"string\"}}}},\"security\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/SecurityRequirement\"}},\"paths\":{\"$ref\":\"#/components/schemas/Paths\"},\"components\":{\"$ref\":\"#/components/schemas/Components\"}}},\"Reference\":{\"type\":\"object\",\"properties\":{\"$ref\":{\"type\":\"string\",\"format\":\"uri-reference\"}}},\"Components\":{\"type\":\"object\",\"properties\":{\"schemas\":{\"type\":\"object\",\"oneOf\":[{\"$ref\":\"#/components/schemas/Schema\"},{\"$ref\":\"#/components/schemas/Reference\"}]}}},\"Schema\":{\"type\":\"object\",\"properties\":{\"title\":{\"type\":\"string\"},\"multipleOf\":{\"type\":\"number\",\"minimum\":0,\"exclusiveMinimum\":true},\"maximum\":{\"type\":\"number\"},\"exclusiveMaximum\":{\"type\":\"boolean\",\"default\":false},\"minimum\":{\"type\":\"number\"},\"exclusiveMinimum\":{\"type\":\"boolean\",\"default\":false},\"maxLength\":{\"type\":\"integer\",\"minimum\":0},\"minLength\":{\"type\":\"integer\",\"minimum\":0,\"default\":0},\"pattern\":{\"type\":\"string\",\"format\":\"regex\"},\"maxItems\":{\"type\":\"integer\",\"minimum\":0},\"minItems\":{\"type\":\"integer\",\"minimum\":0,\"default\":0},\"uniqueItems\":{\"type\":\"boolean\",\"default\":false},\"maxProperties\":{\"type\":\"integer\",\"minimum\":0},\"minProperties\":{\"type\":\"integer\",\"minimum\":0,\"default\":0},\"required\":{\"type\":\"array\",\"items\":{\"type\":\"string\"},\"minItems\":1,\"uniqueItems\":true},\"enum\":{\"type\":\"array\",\"items\":{},\"minItems\":1,\"uniqueItems\":false},\"type\":{\"type\":\"string\",\"enum\":[\"array\",\"boolean\",\"integer\",\"number\",\"object\",\"string\"]},\"not\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/Schema\"},{\"$ref\":\"#/components/schemas/Reference\"}]},\"allOf\":{\"type\":\"array\",\"items\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/Schema\"},{\"$ref\":\"#/components/schemas/Reference\"}]}},\"oneOf\":{\"type\":\"array\",\"items\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/Schema\"},{\"$ref\":\"#/components/schemas/Reference\"}]}},\"anyOf\":{\"type\":\"array\",\"items\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/Schema\"},{\"$ref\":\"#/components/schemas/Reference\"}]}},\"items\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/Schema\"},{\"$ref\":\"#/components/schemas/Reference\"}]},\"properties\":{\"type\":\"object\",\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/Schema\"},{\"$ref\":\"#/components/schemas/Reference\"}]}},\"additionalProperties\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/Schema\"},{\"$ref\":\"#/components/schemas/Reference\"},{\"type\":\"boolean\"}],\"default\":true},\"description\":{\"type\":\"string\"},\"format\":{\"type\":\"string\"},\"default\":{},\"nullable\":{\"type\":\"boolean\",\"default\":false},\"example\":{}},\"additionalProperties\":false},\"Paths\":{\"type\":\"object\",\"additionalProperties\":false},\"SecurityRequirement\":{\"type\":\"object\",\"additionalProperties\":{\"type\":\"array\",\"items\":{\"type\":\"string\"}}},\"KmQueryDataRequest\":{\"required\":[\"projection\"],\"type\":\"object\",\"properties\":{\"projection\":{\"$ref\":\"#/components/schemas/Projection\"}},\"description\":\"The top-level request object for querying the Knowledge Model.\"},\"KmQueryRecordDataRequest\":{\"required\":[\"projection\"],\"type\":\"object\",\"properties\":{\"projection\":{\"$ref\":\"#/components/schemas/KmRecordDataRequestProjection\"}},\"description\":\"The top-level request records for querying the Knowledge Model.\"},\"KmRecordDataRequestProjection\":{\"required\":[\"fields\"],\"type\":\"object\",\"properties\":{\"fields\":{\"$ref\":\"#/components/schemas/KmRecordFieldsProjection\"},\"filters\":{\"$ref\":\"#/components/schemas/FiltersProjection\"},\"pagination\":{\"$ref\":\"#/components/schemas/KmPaginationProjection\"},\"sort\":{\"$ref\":\"#/components/schemas/SortProjection\"},\"options\":{\"$ref\":\"#/components/schemas/KmOptionsProjection\"},\"search\":{\"$ref\":\"#/components/schemas/SearchProjection\"}},\"description\":\"Defines the parameters related to the query to be executed against the Knowledge Model Record.\"},\"Projection\":{\"type\":\"object\",\"properties\":{\"fields\":{\"$ref\":\"#/components/schemas/KmRecordFieldsProjection\"},\"filters\":{\"$ref\":\"#/components/schemas/FiltersProjection\"},\"pagination\":{\"$ref\":\"#/components/schemas/KmPaginationProjection\"},\"sort\":{\"$ref\":\"#/components/schemas/SortProjection\"},\"options\":{\"$ref\":\"#/components/schemas/KmOptionsProjection\"},\"kpis\":{\"$ref\":\"#/components/schemas/KpisProjection\"},\"search\":{\"$ref\":\"#/components/schemas/SearchProjection\"}},\"description\":\"Defines the projection criteria for the Knowledge Model query.\"},\"KmRecordFieldsProjection\":{\"maxLength\":2048,\"minLength\":1,\"type\":\"string\",\"description\":\"Projection of KM Record fields expressed as a comma separated list of Record Fields names to be used.\",\"nullable\":false,\"example\":\"material_name,material_number,material_group\"},\"FiltersProjection\":{\"type\":\"object\",\"properties\":{\"kmFilterNames\":{\"type\":\"array\",\"description\":\"List of predefined Knowledge Model filter names to apply.\",\"example\":[\"filter1\",\"filter2\",\"filter3\"],\"items\":{\"type\":\"string\"}},\"filterExpr\":{\"type\":\"array\",\"description\":\"List of raw filter expressions (e.g., OData syntax).\",\"example\":[\"active eq true and name ne 'John Doe'\"],\"items\":{\"type\":\"string\"}}},\"description\":\"Defines filtering criteria for the Knowledge Model query.\"},\"KmPaginationProjection\":{\"type\":\"object\",\"properties\":{\"pageNumber\":{\"minimum\":0,\"type\":\"integer\",\"description\":\"Page number of the result, starting by 0 (first page).\",\"format\":\"int32\",\"default\":0},\"pageSize\":{\"minimum\":1,\"type\":\"integer\",\"description\":\"Page size of the result, the number of items returned in a page.\",\"format\":\"int32\",\"default\":50}},\"description\":\"Projection of pagination parameters to be used, expressed as a page number and a page size.\"},\"SortProjection\":{\"maxLength\":2048,\"minLength\":2,\"type\":\"string\",\"description\":\"Projection of sort parameters to be used, expressed as comma separated values where each is composed of one char for the direction (+ for ASC, - for DESC), and a field name.\",\"nullable\":true,\"example\":\"+field1,-field2,+field3\"},\"KmOptionsProjection\":{\"maxItems\":1,\"minItems\":0,\"type\":\"array\",\"description\":\"Set different options to customize the data results for a projection.\",\"nullable\":true,\"items\":{\"$ref\":\"#/components/schemas/KmOptionsValues\"}},\"KmOptionsValues\":{\"type\":\"string\",\"description\":\"Set different **options to customize the data results** for a query. Supported options \\n* **Distinct**: Enable the unique data results for a query\\n\",\"enum\":[\"distinct\"]},\"KpisProjection\":{\"type\":\"array\",\"description\":\"List of KPIs.\",\"items\":{\"type\":\"string\"}},\"SearchProjection\":{\"type\":\"object\",\"properties\":{\"term\":{\"type\":\"string\",\"description\":\"The search term or keyword.\",\"example\":\"tot_revenue\"},\"field\":{\"type\":\"string\",\"description\":\"Optional specific field to search within. If omitted, searches across all relevant fields.\",\"example\":\"revenue\"},\"precision\":{\"maximum\":100,\"minimum\":0,\"type\":\"integer\",\"description\":\"The precision level for the search (e.g., fuzzy matching tolerance).\",\"format\":\"int32\",\"example\":10}},\"description\":\"Defines search criteria for full-text search or specific field search.\"}},\"parameters\":{\"filtersParam\":{\"style\":\"form\",\"explode\":false,\"in\":\"query\",\"name\":\"filters\",\"required\":false,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"A predefined filter id\",\"example\":\"active_incidents,cel_and_kpi\"}}},\"fieldsParam\":{\"style\":\"form\",\"explode\":false,\"in\":\"query\",\"name\":\"fields\",\"required\":true,\"allowEmptyValue\":false,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"A predefined filter id\",\"example\":\"active,approval\"}}},\"fieldsOptionalParam\":{\"style\":\"form\",\"explode\":false,\"in\":\"query\",\"name\":\"fields\",\"required\":false,\"allowEmptyValue\":false,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"A predefined filter id\",\"example\":\"active,approval\"}}},\"recordFieldsParam\":{\"style\":\"form\",\"explode\":false,\"in\":\"query\",\"name\":\"fields\",\"required\":true,\"allowEmptyValue\":false,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Record Field Id, separated by \\\".\\\"\",\"example\":\"record1_id.field1_id,record1_id.field2_id,record2_id.fieldN_id\"}}},\"filterExprParam\":{\"style\":\"form\",\"explode\":true,\"in\":\"query\",\"name\":\"filterExpr\",\"required\":false,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Dynamic filter expressions\",\"example\":\"active eq true and name not eq 'John Doe'\"}}},\"pageParam\":{\"in\":\"query\",\"name\":\"page\",\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":0,\"default\":0,\"description\":\"The page number of the result, starting by 0 (first page)\"}},\"pageSizeParam\":{\"in\":\"query\",\"name\":\"pageSize\",\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"default\":50,\"description\":\"The number of items returned in a page.\"}},\"sortParam\":{\"style\":\"form\",\"explode\":false,\"in\":\"query\",\"name\":\"sort\",\"required\":false,\"description\":\"Defines the strategy to proceed for sorting. It must be a comma separated list of fields, and they should start with \\\"+\\\" to apply ASC order or \\\"-\\\" to apply DESC order. Fields with no prefix will be sorted as ASC. Non existing fields at the header will throw an error\",\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":\"+field1,-field2,field3\"}}},\"singleSortParam\":{\"style\":\"form\",\"explode\":false,\"in\":\"query\",\"name\":\"sort\",\"required\":false,\"description\":\"Defines the strategy to proceed for case insensitive sorting. It must be just one field, and it should start with \\\"+\\\" to apply ASC order or \\\"-\\\" to apply DESC order. Non prefix will sort as ASC. Non existing field at the header will throw an error\",\"schema\":{\"type\":\"string\",\"example\":[\"-field1\"]}},\"options\":{\"style\":\"form\",\"explode\":false,\"in\":\"query\",\"name\":\"options\",\"required\":false,\"description\":\"Set different **options to customize the data results** for a query. Supported options \\n* **Distinct**: Enable the unique data results for a query\\n\",\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":\"distinct\"}}},\"kpisParam\":{\"style\":\"form\",\"explode\":false,\"in\":\"query\",\"name\":\"kpis\",\"required\":false,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"As many kpi ids if they exists in the knowledge model\",\"example\":\"AVG_EVENTS_PER_CASE,FILTERED_COUNT\"}}},\"excludFieldsOptionalParam\":{\"style\":\"form\",\"explode\":false,\"in\":\"query\",\"name\":\"excludeFields\",\"required\":false,\"allowEmptyValue\":false,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"Field id from a record\",\"example\":\"active,approval\"}}},\"searchTerm\":{\"in\":\"query\",\"name\":\"searchTerm\",\"required\":false,\"schema\":{\"type\":\"string\",\"description\":\"The term to search for. The search will attempt to find matches that are similar to this term.\"}},\"searchPrecision\":{\"in\":\"query\",\"name\":\"searchPrecision\",\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"maximum\":100,\"description\":\"The strictness of the fuzzy matching algorithm. A lower value will return less accurate matches (more 'fuzzy').\"}},\"searchField\":{\"in\":\"query\",\"name\":\"searchField\",\"required\":false,\"schema\":{\"type\":\"string\",\"description\":\"The specific field within the data structure that is targeted by the search.\"}},\"sampleSizeParam\":{\"in\":\"query\",\"name\":\"sampleSize\",\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"default\":10,\"description\":\"The number of items returned in a sample.\"}},\"odataSelectParam\":{\"in\":\"query\",\"name\":\"$select\",\"required\":false,\"schema\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"description\":\"The $select system query option allows clients to request a specific set of properties for each entity or complex type.\",\"example\":\"active,approval\"}}},\"odataFormatParam\":{\"in\":\"query\",\"name\":\"$format\",\"required\":false,\"schema\":{\"type\":\"string\",\"description\":\"The $format system query option allows clients to request a response in a particular format and is useful for clients without access to request headers for standard content-type negotiation.\",\"example\":\"json\"}},\"odataTopParam\":{\"in\":\"query\",\"name\":\"$top\",\"required\":false,\"schema\":{\"type\":\"integer\",\"description\":\"The $top system query option requests the number of items in the queried collection to be included in the result.\",\"example\":10}},\"odataSkipParam\":{\"in\":\"query\",\"name\":\"$skip\",\"required\":false,\"schema\":{\"type\":\"integer\",\"description\":\"The $skip query option requests the number of items in the queried collection that are to be skipped and not included in the result.\",\"example\":100}},\"odataCountParam\":{\"in\":\"query\",\"name\":\"$count\",\"required\":false,\"schema\":{\"type\":\"boolean\",\"description\":\"The $count system query option allows clients to request a count of the matching resources included with the resources in the response. The $count query option has a Boolean value of true or false.\",\"example\":true}},\"odataOrderByParam\":{\"in\":\"query\",\"name\":\"$orderby\",\"required\":false,\"schema\":{\"type\":\"string\",\"description\":\"The $orderby system query option allows clients to request resources in a particular order.\",\"example\":\"field1\"}},\"odataFilterParam\":{\"in\":\"query\",\"name\":\"$filter\",\"required\":false,\"schema\":{\"type\":\"string\",\"description\":\"The $filter system query option allows clients to filter a collection of resources that are addressed by a request URL.\",\"example\":\"field1 eq 'value1'\"}},\"odataFilterIdParam\":{\"in\":\"query\",\"name\":\"filterid\",\"required\":false,\"schema\":{\"type\":\"string\",\"description\":\"The filterid is a custom query option allows clients to filter a collection of resources using pre-defined knowledge model filter.\",\"example\":\"filterid\"}}},\"responses\":{\"Ok\":{\"description\":\"The resource has been fetched and transmitted in the message body\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/resultPage\"}}}},\"BadRequest\":{\"description\":\"Bad Request.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"Unauthorized\":{\"description\":\"Unauthorized access.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/authErrorDTO\"}}}},\"Forbidden\":{\"description\":\"Forbidden.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"NotFound\":{\"description\":\"The specified resource was not found\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"NotSupportedFormat\":{\"description\":\"Unsupported media type requested.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"TooManyRequests\":{\"description\":\"Too Many Requests.\",\"headers\":{\"X-RateLimit-Limit\":{\"description\":\"Request limit per hour.\",\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},\"X-RateLimit-Remaining\":{\"description\":\"The number of requests left for the time window.\",\"schema\":{\"type\":\"integer\",\"format\":\"int32\"}},\"X-RateLimit-Reset\":{\"description\":\"The UTC date/time at which the current rate limit window resets.\",\"schema\":{\"type\":\"string\",\"format\":\"date-time\"}}},\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"InternalError\":{\"description\":\"Internal Server Error.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"ServiceUnavailable\":{\"description\":\"Service Unavailable.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"corsProxyUrl\":\"https://cors.redoc.ly\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"PHP\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","permission":"guest","lastModified":"2025-12-11T15:32:26.000Z","label":"OpenAPI Specification","redocInfoPageId":"process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/celonis/celonis-public-developer-docs/process-intelligence-apis/knowledge-model-api/api-reference/openapi/reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"knowledge-model-api","isDefault":true,"id":"knowledge-model-api","title":"knowledge-model-api","link":null}]},{"id":"e388eb03-88f9-5549-92bd-87fe61d32f92overview/__redocly content redirect/mcp-server-asset/api-reference/openapi/reference/overview/","definitionId":"mcp-server-asset","link":"/mcp-server-asset/api-reference/openapi/reference/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/mcp-server-asset/api-reference/openapi/reference.page.yaml","info":{"title":"MCP Server Asset OpenAPI specification","description":"Model Context Protocol (MCP) Server Asset API provides access to Celonis data and insights through \nstandardized JSON-RPC 2.0 protocol endpoints. This API enables AI agents to interact with various \nCelonis platform tools including data loading, insights generation, knowledge models, etc.\n\nThe API implements the MCP specification with support for:\n- Tool discovery via `tools/list` method\n- Tool execution via `tools/call` method\n- Rate limiting per asset (500 calls/minute by default)\n","x-audience":"EX","version":"1.0.0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"mcp-server-asset","settings":{"corsProxyUrl":"https://cors.redoc.ly","generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"},{"lang":"PHP"}]}},"apiVersions":[{"definitionId":"mcp-server-asset","isDefault":true,"title":"mcp-server-asset","id":"mcp-server-asset"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"MCP Server Asset OpenAPI specification\",\"description\":\"Model Context Protocol (MCP) Server Asset API provides access to Celonis data and insights through \\nstandardized JSON-RPC 2.0 protocol endpoints. This API enables AI agents to interact with various \\nCelonis platform tools including data loading, insights generation, knowledge models, etc.\\n\\nThe API implements the MCP specification with support for:\\n- Tool discovery via `tools/list` method\\n- Tool execution via `tools/call` method\\n- Rate limiting per asset (500 calls/minute by default)\\n\",\"x-audience\":\"EX\",\"version\":\"1.0.0\"},\"security\":[{\"BearerAuth\":[]}],\"servers\":[{\"url\":\"https://{team_domain}.{realm}\",\"description\":\"MCP Server Wrapper\",\"variables\":{\"team_domain\":{\"default\":\"my_team\",\"description\":\"Team domain name in Celonis\"},\"realm\":{\"default\":\"eu-1.celonis.cloud\",\"description\":\"Celonis realm (e.g., eu-1.celonis.cloud)\"}}}],\"paths\":{\"/studio-copilot/api/v1/mcp-servers/mcp/{asset_id}\":{\"get\":{\"operationId\":\"getMcpServerSseStream\",\"summary\":\"Establish SSE connection for MCP Server\",\"description\":\"Establishes a Server-Sent Events (SSE) connection for real-time bidirectional communication \\nwith the MCP Server. The connection will automatically timeout after 60 seconds.\\n\",\"tags\":[\"MCP Server\"],\"parameters\":[{\"$ref\":\"#/components/parameters/AssetIdPath\"},{\"$ref\":\"#/components/parameters/DraftQuery\"}],\"responses\":{\"200\":{\"description\":\"SSE connection established successfully\",\"content\":{\"text/event-stream\":{\"schema\":{\"type\":\"string\",\"description\":\"Server-Sent Events stream\"}}}},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"}}},\"post\":{\"operationId\":\"postMcpServerRequest\",\"summary\":\"Execute MCP protocol requests\",\"description\":\"Routes MCP protocol requests (JSON-RPC 2.0) to the specified MCP Server asset.\\n\\nSupported methods:\\n- `tools/list`: Retrieve available tools for the asset\\n- `tools/call`: Execute a specific tool with arguments\\n\\nRate Limiting: 500 calls per minute per asset. When exceeded, \\nthe response will contain an error with isError=true and retry guidance.\\n\",\"tags\":[\"MCP Server\"],\"parameters\":[{\"$ref\":\"#/components/parameters/AssetIdPath\"},{\"$ref\":\"#/components/parameters/DraftQuery\"}],\"requestBody\":{\"required\":true,\"description\":\"JSON-RPC 2.0 formatted MCP request\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/McpRequest\"},\"examples\":{\"toolsListRequest\":{\"summary\":\"List available tools\",\"value\":{\"jsonrpc\":\"2.0\",\"id\":1,\"method\":\"tools/list\",\"params\":{}}},\"toolsCallRequest\":{\"summary\":\"Call a tool (e.g. search_data)\",\"value\":{\"jsonrpc\":\"2.0\",\"id\":4,\"method\":\"tools/call\",\"params\":{\"name\":\"search_data\",\"arguments\":{\"search_terms\":[\"Document Type\"],\"user_query\":\"Document Type\"}}}}}}}},\"responses\":{\"200\":{\"description\":\"Successful MCP response\",\"content\":{\"application/json\":{\"schema\":{\"oneOf\":[{\"$ref\":\"#/components/schemas/McpSuccessResponse\"},{\"$ref\":\"#/components/schemas/McpErrorResponse\"}]}}}},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"}}}}},\"components\":{\"securitySchemes\":{\"BearerAuth\":{\"type\":\"http\",\"scheme\":\"bearer\",\"bearerFormat\":\"JWT\",\"description\":\"JWT authentication token obtained from Celonis authentication service.\\nThe token must have permissions to USE_OR_EDIT the specified asset.\\n\"}},\"parameters\":{\"AssetIdPath\":{\"name\":\"asset_id\",\"in\":\"path\",\"required\":true,\"description\":\"The unique identifier (UUID) of the MCP Server asset\",\"schema\":{\"type\":\"string\",\"format\":\"uuid\",\"example\":\"56b10c32-97c5-4060-8e3d-12e040f889f2\"}},\"DraftQuery\":{\"name\":\"draft\",\"in\":\"query\",\"required\":false,\"description\":\"Optional flag to indicate draft mode access\",\"schema\":{\"type\":\"boolean\",\"default\":false}}},\"schemas\":{\"McpRequest\":{\"type\":\"object\",\"description\":\"JSON-RPC 2.0 formatted MCP protocol request\",\"required\":[\"jsonrpc\",\"id\",\"method\"],\"properties\":{\"jsonrpc\":{\"type\":\"string\",\"enum\":[\"2.0\"],\"description\":\"JSON-RPC protocol version\",\"example\":\"2.0\"},\"id\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"integer\"}],\"description\":\"Unique identifier for the request (will be echoed in response)\",\"example\":1},\"method\":{\"type\":\"string\",\"description\":\"MCP method name\",\"enum\":[\"tools/list\",\"tools/call\"],\"example\":\"tools/list\"},\"params\":{\"type\":\"object\",\"description\":\"Method-specific parameters\",\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Tool name (required for tools/call)\",\"example\":\"search_data\"},\"arguments\":{\"type\":\"object\",\"description\":\"Tool-specific arguments (required for tools/call)\",\"additionalProperties\":true,\"example\":{\"search_terms\":[\"John Doe\",\"Jane Smith\"],\"user_query\":\"John Doe\"}}}}}},\"McpSuccessResponse\":{\"type\":\"object\",\"description\":\"Successful MCP response (JSON-RPC 2.0 result)\",\"required\":[\"jsonrpc\",\"id\",\"result\"],\"properties\":{\"jsonrpc\":{\"type\":\"string\",\"enum\":[\"2.0\"],\"description\":\"JSON-RPC protocol version\"},\"id\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"integer\"}],\"description\":\"Request identifier (matches the request id)\"},\"result\":{\"type\":\"object\",\"description\":\"Method result containing response data\",\"oneOf\":[{\"$ref\":\"#/components/schemas/ToolsListResult\"},{\"$ref\":\"#/components/schemas/ToolsCallResult\"}]}}},\"McpErrorResponse\":{\"type\":\"object\",\"description\":\"Error MCP response (JSON-RPC 2.0 error)\",\"required\":[\"jsonrpc\",\"id\",\"error\"],\"properties\":{\"jsonrpc\":{\"type\":\"string\",\"enum\":[\"2.0\"],\"description\":\"JSON-RPC protocol version\"},\"id\":{\"oneOf\":[{\"type\":\"string\"},{\"type\":\"integer\"}],\"description\":\"Request identifier (matches the request id)\"},\"error\":{\"type\":\"object\",\"required\":[\"code\",\"message\"],\"properties\":{\"code\":{\"type\":\"integer\",\"description\":\"JSON-RPC error code\",\"example\":-32603,\"enum\":[-32700,-32600,-32601,-32602,-32603]},\"message\":{\"type\":\"string\",\"description\":\"Human-readable error message\"},\"data\":{\"type\":\"object\",\"description\":\"Additional error information\",\"additionalProperties\":true}}}}},\"ToolsListResult\":{\"type\":\"object\",\"description\":\"Result for tools/list method\",\"required\":[\"tools\"],\"properties\":{\"tools\":{\"type\":\"array\",\"description\":\"List of available tools for this asset\",\"items\":{\"$ref\":\"#/components/schemas/ToolDefinition\"}}}},\"ToolDefinition\":{\"type\":\"object\",\"description\":\"Definition of an available tool\",\"required\":[\"name\",\"description\",\"inputSchema\"],\"properties\":{\"name\":{\"type\":\"string\",\"description\":\"Unique tool identifier\",\"example\":\"search_data\"},\"description\":{\"type\":\"string\",\"description\":\"Human-readable tool description\",\"example\":\"Retrieves data from the Celonis platform\"},\"inputSchema\":{\"type\":\"object\",\"description\":\"JSON Schema defining the tool's input parameters\",\"additionalProperties\":true},\"outputSchema\":{\"type\":\"object\",\"description\":\"JSON Schema defining the tool's output structure\",\"additionalProperties\":true},\"annotations\":{\"type\":\"object\",\"description\":\"Additional metadata about the tool\",\"additionalProperties\":true}}},\"ToolsCallResult\":{\"type\":\"object\",\"description\":\"Result for tools/call method\",\"required\":[\"content\",\"isError\"],\"properties\":{\"content\":{\"type\":\"array\",\"description\":\"Array of content items (typically text responses)\",\"items\":{\"type\":\"object\",\"required\":[\"type\",\"text\"],\"properties\":{\"type\":{\"type\":\"string\",\"enum\":[\"text\"],\"description\":\"Content type\"},\"text\":{\"type\":\"string\",\"description\":\"Text content (may be JSON string or error message)\"}}}},\"structuredContent\":{\"type\":\"object\",\"description\":\"Optional structured response data (tool-specific format)\",\"additionalProperties\":true,\"example\":{\"page\":0,\"page_size\":50,\"total\":100,\"data_frame_content\":{\"data\":[],\"schema_\":[]}}},\"isError\":{\"type\":\"boolean\",\"description\":\"Indicates if the tool call resulted in an error\",\"example\":false}}},\"ErrorDetail\":{\"type\":\"object\",\"description\":\"Simple error response with detail message\",\"required\":[\"detail\"],\"properties\":{\"detail\":{\"type\":\"string\",\"description\":\"Human-readable error message describing what went wrong\",\"example\":\"Asset not found or not accessible.\"}}}},\"responses\":{\"NotFound\":{\"description\":\"Not Found - The specified resource was not found.\\nThis may occur when:\\n- The asset_id doesn't exist\\n- The asset is not accessible to the authenticated user\\n- The MCP Server feature is not active for this team\\n\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/ErrorDetail\"},\"examples\":{\"assetNotFound\":{\"summary\":\"Asset not found or not accessible\",\"value\":{\"detail\":\"Asset not found or not accessible.\"}},\"featureNotActive\":{\"summary\":\"MCP Server feature not active\",\"value\":{\"detail\":\"MCP Server Asset feature is not active\"}}}}}},\"InternalError\":{\"description\":\"Internal Server Error - An unexpected error occurred on the server.\\n\",\"content\":{\"text/plain\":{\"schema\":{\"type\":\"string\"},\"example\":\"Internal Server Error\"}}}}},\"tags\":[{\"name\":\"MCP Server\",\"description\":\"Model Context Protocol (MCP) Server endpoints for interacting with Celonis data and insights.\\n\\nAll operations are rate-limited to 500 calls per minute per asset (configurable).\\nRequests follow the JSON-RPC 2.0 protocol specification.\\n\"}]}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"corsProxyUrl\":\"https://cors.redoc.ly\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"PHP\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","permission":"guest","lastModified":"2025-11-03T21:37:26.000Z","label":"MCP Server Asset OpenAPI specification","redocInfoPageId":"mcp-server-asset/api-reference/openapi/reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/celonis/celonis-public-developer-docs/mcp-server-asset/api-reference/openapi/reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"mcp-server-asset","isDefault":true,"id":"mcp-server-asset","title":"mcp-server-asset","link":null}]},{"id":"e7d41f04-149c-5040-97ce-91e73979b907overview/__redocly content redirect/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/reference/overview/","definitionId":"outbound","link":"/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/reference/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/reference.page.yaml","info":{"title":"Event OpenAPI Specification","description":"Subscription API to send events to a webhook configured when creating a subscription. Our API can send automatically events to a deffined webhook.","x-audience":"EX","version":"1.0.0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"outbound","settings":{"corsProxyUrl":"https://cors.redoc.ly","generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"},{"lang":"PHP"}]}},"apiVersions":[{"definitionId":"outbound","isDefault":true,"title":"outbound","id":"outbound"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"Event OpenAPI Specification\",\"description\":\"Subscription API to send events to a webhook configured when creating a subscription. Our API can send automatically events to a deffined webhook.\",\"x-audience\":\"EX\",\"version\":\"1.0.0\"},\"security\":[{\"BearerAuth\":[]},{\"ApiKeyAuth\":[]}],\"servers\":[{\"url\":\"https://webhook/service\"}],\"tags\":[{\"name\":\"Webhook\",\"description\":\"Webhook used to receive asynchronous events from Subscription API\"}],\"paths\":{\"/api/events\":{\"post\":{\"operationId\":\"consumEvents\",\"summary\":\"Receive asynchronous events from Subscription API\",\"tags\":[\"Webhook\"],\"description\":\"Receive asynchronous events\",\"requestBody\":{\"description\":\"Event from a Record or Data Model\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/eventDTO\"}}}},\"responses\":{\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"429\":{\"$ref\":\"#/components/responses/TooManyRequests\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"},\"2XX\":{\"description\":\"Event received\"}}}}},\"components\":{\"securitySchemes\":{\"BearerAuth\":{\"type\":\"http\",\"scheme\":\"bearer\",\"bearerFormat\":\"JWT\"},\"ApiKeyAuth\":{\"type\":\"apiKey\",\"in\":\"header\",\"name\":\"AppKey\"}},\"schemas\":{\"errorDTO\":{\"title\":\"Error\",\"type\":\"object\",\"description\":\"This [RFC7807] specification is to define common error formats for those applications that need one, so that they aren't required to define their own, or worse, tempted to redefine the semantics of existing HTTP status codes. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\",\"properties\":{\"title\":{\"type\":\"string\",\"description\":\"A short, human-readable summary of the problem type.  It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\"},\"status\":{\"type\":\"integer\",\"description\":\"The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\"},\"detail\":{\"type\":\"string\",\"description\":\"The details of the Error\"},\"errorCode\":{\"type\":\"string\",\"description\":\"Unique Identifier of the Error\"},\"type\":{\"type\":\"string\",\"description\":\"A URI reference [RFC3986] that identifies the problem type. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\"}}},\"eventDTO\":{\"title\":\"Asynchronous event\",\"description\":\"Asynchronous event triggered by Subscription\",\"type\":\"object\",\"properties\":{\"subscriberId\":{\"type\":\"string\",\"description\":\"Subscriber's Unique identifier as a SUID\",\"example\":\"abc-123-bad-123\"},\"triggerId\":{\"type\":\"string\",\"description\":\"Trigger's Unique identifier as a SUID\",\"example\":\"abc-123-bad-123\"},\"offset\":{\"type\":\"number\",\"description\":\"Position of the event in the subscription Queue source\",\"example\":1234},\"creationDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date of the event creation\",\"example\":\"2023-07-21T17:32:28Z\"},\"event\":{\"$ref\":\"#/components/schemas/signalEventDTO\"}}},\"signalEventDTO\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Event's Unique identifier as a SUID\",\"example\":\"abc-123-bad-123\"},\"identifier\":{\"type\":\"string\",\"description\":\"Third party Identifier as a string\",\"example\":1},\"typedIdentifier\":{\"type\":\"object\",\"description\":\"Type of the Identifier for the event\",\"example\":2},\"fields\":{\"type\":\"array\",\"description\":\"Fields for the Event\",\"items\":{\"$ref\":\"#/components/schemas/eventFieldDTO\"}}}},\"eventFieldDTO\":{\"title\":\"Fields Metadata for the event\",\"description\":\"Fields Metadata for the event\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Id for the field as a String\",\"example\":\"CASE_NUMBER\"},\"value\":{\"type\":\"object\",\"description\":\"Value for the field, it could be any type of (date, string, float, int)\",\"example\":\"my_value\"},\"type\":{\"type\":\"string\",\"description\":\"The type that applies to the value (DATE, STRING, FLOAT, INT)\",\"example\":\"STRING\"},\"isIdentifier\":{\"type\":\"boolean\",\"description\":\"If the field is used as an identifier\",\"example\":true}}},\"authErrorDTO\":{\"title\":\"Authentication Error\",\"type\":\"object\",\"properties\":{\"error\":{\"type\":\"string\"}}}},\"responses\":{\"BadRequest\":{\"description\":\"Bad Request.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"Unauthorized\":{\"description\":\"Unauthorized access.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/authErrorDTO\"}}}},\"Forbidden\":{\"description\":\"Forbidden.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"NotFound\":{\"description\":\"The specified resource was not found\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"NotSupportedFormat\":{\"description\":\"Unsupported media type requested.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"TooManyRequests\":{\"description\":\"Too Many Requests.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"InternalError\":{\"description\":\"Internal Server Error.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"ServiceUnavailable\":{\"description\":\"Service Unavailable.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"corsProxyUrl\":\"https://cors.redoc.ly\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"PHP\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","permission":"guest","lastModified":"2025-01-24T15:24:54.000Z","label":"Event OpenAPI Specification","redocInfoPageId":"process-intelligence-apis/subscription-api/outbound-api-reference/openapi/reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/celonis/celonis-public-developer-docs/process-intelligence-apis/subscription-api/outbound-api-reference/openapi/reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"outbound","isDefault":true,"id":"outbound","title":"outbound","link":null}]},{"id":"99a28f73-b8da-5659-9f6e-1313053fd566overview/__redocly content redirect/process-intelligence-apis/subscription-api/api-reference/openapi/reference/overview/","definitionId":"subscription","link":"/process-intelligence-apis/subscription-api/api-reference/openapi/reference/overview/","sourcePath":"/data/celonis/celonis-public-developer-docs/process-intelligence-apis/subscription-api/api-reference/openapi/reference.page.yaml","info":{"title":"OpenAPI Specification","description":"Celonis API to create subscriptions to triggers and to manage their lifecycle.","x-audience":"EX","version":"1.8.0"},"data":{"redirect":true,"type":"reference-docs","definitionId":"subscription","settings":{"corsProxyUrl":"https://cors.redoc.ly","generateCodeSamples":{"languages":[{"lang":"curl"},{"lang":"JavaScript"},{"lang":"Java"},{"lang":"Python"},{"lang":"PHP"}]}},"apiVersions":[{"definitionId":"subscription","isDefault":true,"title":"subscription","id":"subscription"}],"isDefaultApiVersion":true,"redocStoreStr":"{\"menu\":{\"activeItemIdx\":-1},\"definition\":{\"data\":{\"openapi\":\"3.0.0\",\"info\":{\"title\":\"OpenAPI Specification\",\"description\":\"Celonis API to create subscriptions to triggers and to manage their lifecycle.\",\"x-audience\":\"EX\",\"version\":\"1.8.0\"},\"security\":[{\"BearerAuth\":[]},{\"ApiKeyAuth\":[]}],\"servers\":[{\"url\":\"https://6c823f95-99fb-4d3f-8e8e-749be34ece02.remockly.com\"}],\"paths\":{\"/intelligence/api/knowledge-models/{km_id}/triggers\":{\"get\":{\"operationId\":\"getTriggers\",\"tags\":[\"Triggers\"],\"summary\":\"List the Triggers of a Knowledge Model\",\"description\":\"List the Triggers of a Knowledge Model\",\"parameters\":[{\"$ref\":\"#/components/parameters/pageParam\"},{\"$ref\":\"#/components/parameters/pageSizeParam\"},{\"$ref\":\"#/components/parameters/singleSortParam\"},{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-kms\"}}],\"responses\":{\"200\":{\"description\":\"List of Trigger ids and names\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/triggerResultPage\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}/triggers/{trigger_id}\":{\"get\":{\"operationId\":\"getTriggerDetails\",\"tags\":[\"Triggers\"],\"summary\":\"Get Trigger Schema details\",\"description\":\"Get Trigger Schema details\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"}},{\"name\":\"trigger_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"MATERIALS\"}}],\"responses\":{\"200\":{\"description\":\"Trigger Schema details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/triggerDetailedDTO\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/knowledge-models/{km_id}/triggers/{trigger_id}/subscriptions\":{\"post\":{\"operationId\":\"createSubscription\",\"tags\":[\"Subscriptions\"],\"summary\":\"Creates a subscription to a Knowledge Model trigger\",\"description\":\"Creates a subscription to a Knowledge Model trigger\",\"parameters\":[{\"name\":\"km_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"open-purchase-requisition.purchase-requisition-kms\"}},{\"name\":\"trigger_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"abc-123-efg-456\"}}],\"requestBody\":{\"description\":\"Subscription's details\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/subscriptionRequest\"}}}},\"responses\":{\"201\":{\"description\":\"Id of the created subscription\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/subscriptionId\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/subscriptions\":{\"get\":{\"operationId\":\"getSubscriptions\",\"tags\":[\"Subscriptions\"],\"summary\":\"List all Subscriptions\",\"description\":\"List all Subscriptions\",\"parameters\":[{\"$ref\":\"#/components/parameters/pageParam\"},{\"$ref\":\"#/components/parameters/pageSizeParam\"},{\"$ref\":\"#/components/parameters/singleSortParam\"}],\"responses\":{\"200\":{\"description\":\"List of Subscription details\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/subscriptionResultPage\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/subscriptions/{subscription_id}\":{\"delete\":{\"operationId\":\"unsubscribe\",\"tags\":[\"Subscriptions\"],\"summary\":\"Unsubscribe from a trigger removing all the data of the subscription\",\"description\":\"Unsubscribe from a trigger removing all the data of the subscription\",\"parameters\":[{\"name\":\"subscription_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"abc-123-efg-456\"}}],\"responses\":{\"204\":{\"description\":\"Removed successfully.\"},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}},\"put\":{\"operationId\":\"updateSubscription\",\"tags\":[\"Subscriptions\"],\"summary\":\"Updates the subscription metadata\",\"description\":\"Updates the subscription metadata\",\"parameters\":[{\"name\":\"subscription_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"abc-123-efg-456\"}}],\"requestBody\":{\"description\":\"Details to update\",\"required\":true,\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/subscriptionRequest\"}}}},\"responses\":{\"200\":{\"description\":\"Updated\"},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/subscriptions/{subscription_id}/events\":{\"patch\":{\"operationId\":\"nextPageFromRemainingData\",\"tags\":[\"Subscriptions\"],\"summary\":\"Retrieves the next page of failed events\",\"description\":\"Retrieves the next page of failed events\",\"parameters\":[{\"name\":\"subscription_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"abc-123-efg-456\"}}],\"responses\":{\"200\":{\"description\":\"List of Signals data\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/SignalResultPage\"}}}},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/subscriptions/{subscription_id}/pause\":{\"patch\":{\"operationId\":\"pauseSubscription\",\"tags\":[\"Subscriptions\"],\"summary\":\"Pauses the subscription (stops emitting events)\",\"description\":\"Pauses the subscription (stops emitting events)\",\"parameters\":[{\"name\":\"subscription_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"abc-123-efg-456\"}}],\"responses\":{\"204\":{\"description\":\"Subscription was paused successfully.\"},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/subscriptions/{subscription_id}/resume\":{\"patch\":{\"operationId\":\"resumeSubscription\",\"tags\":[\"Subscriptions\"],\"summary\":\"Resumes a paused subscription (events queued are now emitted)\",\"description\":\"Resumes paused subscription (events queued are now emitted)\",\"parameters\":[{\"name\":\"subscription_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"abc-123-efg-456\"}}],\"responses\":{\"204\":{\"description\":\"Subscription was resumed successfully\"},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/subscriptions/{subscription_id}/resume-from-latest\":{\"patch\":{\"operationId\":\"resumeSubscriptionNoHistory\",\"tags\":[\"Subscriptions\"],\"summary\":\"Resumes paused subscription discarding historic events (new events only are emitted)\",\"description\":\"Resumes paused subscription discarding history events (new events only are emitted)\",\"parameters\":[{\"name\":\"subscription_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"abc-123-efg-456\"}}],\"responses\":{\"204\":{\"description\":\"Subscription was resumed successfully.\"},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}},\"/intelligence/api/subscriptions/{subscription_id}/replay\":{\"patch\":{\"operationId\":\"replaySubscriptionFromAnOffset\",\"tags\":[\"Subscriptions\"],\"summary\":\"Replay subscription (re-emit events from the specified position)\",\"description\":\"Replay subscription (re-emit events from the specified position)\",\"parameters\":[{\"name\":\"subscription_id\",\"in\":\"path\",\"required\":true,\"schema\":{\"type\":\"string\",\"example\":\"abc-123-efg-456\"}},{\"name\":\"fromOffset\",\"in\":\"query\",\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":0,\"default\":0,\"description\":\"The position where the offset of the event queue will be moved to replay events, if they exist\"}}],\"responses\":{\"204\":{\"description\":\"Subscription replay was successful.\"},\"400\":{\"$ref\":\"#/components/responses/BadRequest\"},\"401\":{\"$ref\":\"#/components/responses/Unauthorized\"},\"403\":{\"$ref\":\"#/components/responses/Forbidden\"},\"404\":{\"$ref\":\"#/components/responses/NotFound\"},\"500\":{\"$ref\":\"#/components/responses/InternalError\"},\"503\":{\"$ref\":\"#/components/responses/ServiceUnavailable\"}}}}},\"components\":{\"securitySchemes\":{\"BearerAuth\":{\"type\":\"http\",\"scheme\":\"bearer\",\"bearerFormat\":\"JWT\"},\"ApiKeyAuth\":{\"type\":\"apiKey\",\"in\":\"header\",\"name\":\"AppKey\"}},\"schemas\":{\"resultPage\":{\"title\":\"Result page\",\"type\":\"object\",\"properties\":{\"page\":{\"type\":\"integer\",\"description\":\"Page\",\"example\":0},\"pageSize\":{\"type\":\"integer\",\"description\":\"Page size, defined by pageSize parameter\",\"example\":50},\"total\":{\"type\":\"integer\",\"description\":\"Total elements returned in the page\",\"example\":1},\"sort\":{\"type\":\"array\",\"items\":{\"type\":\"string\",\"example\":\"material_number\"}}}},\"schemaResultPage\":{\"title\":\"Result page\",\"type\":\"object\",\"properties\":{\"page\":{\"type\":\"integer\",\"description\":\"Page\",\"example\":0},\"pageSize\":{\"type\":\"integer\",\"description\":\"Page size, defined by pageSize parameter\",\"example\":50},\"total\":{\"type\":\"integer\",\"description\":\"Total elements returned in the page\",\"example\":1},\"sort\":{\"type\":\"string\",\"description\":\"Field used to apply sorting to the requested data, + or no symbol means ASC, - means DESC\",\"example\":\"+id\"}}},\"triggerResultPage\":{\"title\":\"Trigger schema result page\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/triggerDTO\"}}},\"allOf\":[{\"$ref\":\"#/components/schemas/schemaResultPage\"}]},\"subscriptionResultPage\":{\"title\":\"Subscription schema result page\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/subscriptionDTO\"}}},\"allOf\":[{\"$ref\":\"#/components/schemas/schemaResultPage\"}]},\"SignalResultPage\":{\"title\":\"Signal result page\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"pageSize\":{\"type\":\"integer\",\"description\":\"Page size, defined by the system\",\"example\":50},\"content\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/eventDTO\"}}}},\"subscriptionId\":{\"title\":\"Id subscription created\",\"type\":\"object\",\"additionalProperties\":false,\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"subscription id\",\"example\":123}}},\"errorDTO\":{\"title\":\"Error\",\"type\":\"object\",\"description\":\"This [RFC7807] specification is to define common error formats for those applications that need one, so that they aren't required to define their own, or worse, tempted to redefine the semantics of existing HTTP status codes. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\",\"properties\":{\"title\":{\"type\":\"string\",\"description\":\"A short, human-readable summary of the problem type.  It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4). This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\"},\"status\":{\"type\":\"integer\",\"description\":\"The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\"},\"detail\":{\"type\":\"string\",\"description\":\"The details of the Error\"},\"errorCode\":{\"type\":\"string\",\"description\":\"Unique Identifier of the Error\"},\"type\":{\"type\":\"string\",\"description\":\"A URI reference [RFC3986] that identifies the problem type. This definition was copied from https://datatracker.ietf.org/doc/html/rfc7807\"}}},\"authErrorDTO\":{\"title\":\"Authentication Error\",\"type\":\"object\",\"properties\":{\"error\":{\"type\":\"string\"}}},\"callbackResumedInfoDTO\":{\"title\":\"Callback Information\",\"type\":\"object\",\"required\":[\"uri\",\"protocol\"],\"properties\":{\"uri\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":1024,\"description\":\"Uri to perform the callback from the Subscription API once the trigger is fired\",\"example\":\"https://fake.domain.es/triggers/hook\"},\"protocol\":{\"type\":\"string\",\"enum\":[\"HTTPS\"],\"description\":\"Only value possible actually is HTTPS which means the callback URI must be a valid https\",\"example\":\"HTTPS\"}}},\"callbackInfoDTO\":{\"allOf\":[{\"$ref\":\"#/components/schemas/callbackResumedInfoDTO\"}],\"properties\":{\"headers\":{\"type\":\"object\",\"description\":\"Callback headers may include authentication tokens, content types, and more. \\n<br><br>Allowed callback headers are: \\n<br>Authorization \\n<br>Content-Type \\n<br>User-Agent \\n<br>Host \\n<br>Accept \\n<br><br>Additionally, the total size limit for headers is <strong>8192</strong> bytes.\\n\",\"additionalProperties\":{\"type\":\"string\",\"example\":{\"Authorization\":\"eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI0Ii\",\"Content-Type\":\"application/json\"}}}}},\"triggerDTO\":{\"title\":\"Trigger\",\"description\":\"Trigger defined at KM\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Trigger's Unique identifier as a SUID\",\"example\":\"abc-123-bad-123\"},\"record\":{\"type\":\"string\",\"description\":\"Record's Unique identifier as a SUID\",\"example\":\"efg-456-efg-456\"},\"name\":{\"type\":\"string\",\"description\":\"Human understandable Trigger name\",\"example\":\"Blocked Orders\"}}},\"triggerDetailedDTO\":{\"title\":\"Trigger\",\"description\":\"Trigger detailed\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Trigger's Unique identifier as a SUID\",\"example\":\"abc-123-bad-123\"},\"name\":{\"type\":\"string\",\"description\":\"Human understandable Trigger name\",\"example\":\"Blocked Orders\"},\"fields\":{\"type\":\"array\",\"items\":{\"$ref\":\"#/components/schemas/triggerFieldDTO\"}}}},\"triggerFieldDTO\":{\"title\":\"Trigger Field\",\"description\":\"Fields for a Trigger\",\"type\":\"object\",\"properties\":{\"name\":{\"type\":\"string\",\"example\":\"Amount in euros pending to pay\",\"description\":\"human understandable name\"},\"type\":{\"type\":\"string\",\"enum\":[\"string\",\"date\",\"time\",\"integer\",\"boolean\",\"number\",\"datetime\",\"timestamp\",\"float\"]},\"format\":{\"type\":\"string\",\"example\":\"#.###\",\"description\":\"Format to be applied\"},\"unit\":{\"type\":\"string\",\"example\":\"euros\",\"description\":\"Unit added to field value\"}}},\"subscriptionDTO\":{\"title\":\"Subscription\",\"description\":\"Subscription schema\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Subscriber's Unique identifier as a SUID\",\"example\":\"abc-123-bad-123\"},\"name\":{\"type\":\"string\",\"description\":\"Human understandable Subscription name\",\"example\":\"Blocked Orders\"},\"status\":{\"type\":\"string\",\"enum\":[\"active\",\"failed\",\"suspended\",\"paused\",\"rejected\"]},\"configurations\":{\"allOf\":[{\"$ref\":\"#/components/schemas/configurations\"}]},\"knowledgeModelId\":{\"type\":\"string\",\"description\":\"Unique Identifier of Knowledge Model\",\"example\":\"open-purchase-requisition.purchase-requisition-km\"},\"triggerId\":{\"type\":\"string\",\"description\":\"Trigger's Unique identifier as a SUID\",\"example\":\"abc-123-bad-123\"},\"latestSucceedEvent\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date of the last successfully emitted event\",\"example\":\"2023-07-21T17:32:28Z\"},\"offset\":{\"type\":\"number\",\"format\":\"int64\",\"description\":\"Offset of the last successfully emitted event\",\"example\":123},\"creationDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Subscription creation date\"},\"ownerName\":{\"type\":\"string\",\"description\":\"Owner name\",\"example\":\"Owner name\"},\"callbackInfo\":{\"$ref\":\"#/components/schemas/callbackResumedInfoDTO\"},\"lastSuccessEventOffset\":{\"type\":\"integer\",\"format\":\"int64\",\"description\":\"Identifier of the last succeed event\",\"example\":123}}},\"configurations\":{\"type\":\"array\",\"uniqueItems\":true,\"description\":\"Configuration for the Subscription\",\"example\":[\"SKIP_ERRORS\"],\"items\":{\"type\":\"string\",\"enum\":[\"SKIP_ERRORS\"]}},\"eventDTO\":{\"title\":\"Event stored at subscription data source\",\"description\":\"Event stored at subscription data source\",\"type\":\"object\",\"properties\":{\"subscriberId\":{\"type\":\"string\",\"description\":\"Subscriber's Unique identifier as a SUID\",\"example\":\"abc-123-bad-123\"},\"triggerId\":{\"type\":\"string\",\"description\":\"Trigger's Unique identifier as a SUID\",\"example\":\"abc-123-bad-123\"},\"offset\":{\"type\":\"number\",\"description\":\"Position of the event in the subscription data source\",\"example\":1234},\"creationDate\":{\"type\":\"string\",\"format\":\"date-time\",\"description\":\"Date of the event creation\",\"example\":\"2023-07-21T17:32:28Z\"},\"event\":{\"$ref\":\"#/components/schemas/signalEventDTO\"}}},\"signalEventDTO\":{\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Event's Unique identifier as a SUID\",\"example\":\"abc-123-bad-123\"},\"identifier\":{\"type\":\"string\",\"description\":\"Third party Identifier as a string\",\"example\":1},\"typedIdentifier\":{\"type\":\"object\",\"description\":\"Type of the Identifier for the event\",\"example\":2},\"fields\":{\"type\":\"array\",\"description\":\"Fields for the Event\",\"items\":{\"$ref\":\"#/components/schemas/eventFieldDTO\"}}}},\"eventFieldDTO\":{\"title\":\"Fields Metadata for the event\",\"description\":\"Fields Metadata for the event\",\"type\":\"object\",\"properties\":{\"id\":{\"type\":\"string\",\"description\":\"Id for the field as a String\",\"example\":\"CASE_NUMBER\"},\"value\":{\"type\":\"object\",\"description\":\"Value for the field, it could be any type of (date, string, float, int)\",\"example\":\"my_value\"},\"type\":{\"type\":\"string\",\"description\":\"The type that applies to the value (DATE, STRING, FLOAT, INT)\",\"example\":\"STRING\"},\"isIdentifier\":{\"type\":\"boolean\",\"description\":\"If the field is used as an identifier\",\"example\":true}}},\"subscriptionRequest\":{\"title\":\"SubscriptionRequest\",\"description\":\"Request with details to create the subscription\",\"type\":\"object\",\"required\":[\"name\",\"callbackInfo\"],\"properties\":{\"name\":{\"type\":\"string\",\"minLength\":1,\"maxLength\":1024,\"description\":\"Name for the subscription\",\"example\":\"My Subscription to XYZ\"},\"callbackInfo\":{\"allOf\":[{\"$ref\":\"#/components/schemas/callbackInfoDTO\"}]},\"configurations\":{\"allOf\":[{\"$ref\":\"#/components/schemas/configurations\"}]}}}},\"parameters\":{\"pageParam\":{\"in\":\"query\",\"name\":\"page\",\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":0,\"default\":0,\"description\":\"The page number of the result, starting by 0 (first page)\"}},\"pageSizeParam\":{\"in\":\"query\",\"name\":\"pageSize\",\"required\":false,\"schema\":{\"type\":\"integer\",\"minimum\":1,\"default\":50,\"description\":\"The number of items returned in a page.\"}},\"singleSortParam\":{\"style\":\"form\",\"explode\":false,\"in\":\"query\",\"name\":\"sort\",\"required\":false,\"description\":\"Defines the strategy to proceed for case insensitive sorting. It must be just one field, and it should start with \\\"+\\\" to apply ASC order or \\\"-\\\" to apply DESC order. Non prefix will sort as ASC. Non existing field at the header will throw an error\",\"schema\":{\"type\":\"string\",\"example\":[\"-field1\"]}}},\"responses\":{\"Ok\":{\"description\":\"The resource has been fetched and transmitted in the message body\",\"content\":{\"application/json\":{\"schema\":{\"$ref\":\"#/components/schemas/resultPage\"}}}},\"BadRequest\":{\"description\":\"Bad Request.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"Unauthorized\":{\"description\":\"Unauthorized access.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/authErrorDTO\"}}}},\"Forbidden\":{\"description\":\"Forbidden.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"NotFound\":{\"description\":\"The specified resource was not found\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"InternalError\":{\"description\":\"Internal Server Error.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}},\"ServiceUnavailable\":{\"description\":\"Service Unavailable.\",\"content\":{\"application/problem+json\":{\"schema\":{\"$ref\":\"#/components/schemas/errorDTO\"}}}}}}}},\"options\":{\"hideTryItPanel\":false,\"pagination\":\"item\",\"corsProxyUrl\":\"https://cors.redoc.ly\",\"generateCodeSamples\":{\"languages\":[{\"lang\":\"curl\"},{\"lang\":\"JavaScript\"},{\"lang\":\"Java\"},{\"lang\":\"Python\"},{\"lang\":\"PHP\"}]},\"disableSearch\":true,\"ctrlFHijack\":false,\"disableSidebar\":true,\"theme\":{\"overrides\":{\"DownloadButton\":{\"custom\":\"\"},\"NextSectionButton\":{\"custom\":\"\"}},\"codeBlock\":{\"tokens\":{}},\"schema\":{\"constraints\":{},\"examples\":{}},\"rightPanel\":{\"textColor\":\"#eeeeee\"},\"typography\":{\"heading1\":{},\"heading2\":{},\"heading3\":{},\"rightPanelHeading\":{}}}}}","permission":"guest","lastModified":"2025-10-08T17:21:49.000Z","label":"OpenAPI Specification","redocInfoPageId":"process-intelligence-apis/subscription-api/api-reference/openapi/reference.page.yaml#overview","redocPagination":"item","redocInfoPageLink":"","redocHasInfoPage":false,"redocHasSecurityDefinitions":false,"httpVerb":null,"matchPath":"","excludeFromSearch":false,"sourcePath":"/data/celonis/celonis-public-developer-docs/process-intelligence-apis/subscription-api/api-reference/openapi/reference.page.yaml"},"definitionProperties":{},"permission":"guest","versions":[{"definitionId":"subscription","isDefault":true,"id":"subscription","title":"subscription","link":null}]}]}}