{ "openapi" : "3.0.1", "info" : { "title" : "Decision Runtime API", "version" : "6.0.2", "x-ibm-zen-api-key-auth" : "true" }, "servers" : [ { "url" : "/@context_root@/v1", "description" : "Decision Runtime" } ], "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ], "paths" : { "/about" : { "get" : { "tags" : [ "Decision runtime" ], "summary" : "About IBM Automation Decision Services runtime", "description" : "Retrieve the information about the decision runtime", "operationId" : "getAbout", "responses" : { "200" : { "description" : "The information about the decision runtime was successfully retrieved", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/AboutInformation" } } } }, "500" : { "description" : "The information about the decision runtime could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } } } } }, "/deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/archive" : { "get" : { "tags" : [ "Decision storage management" ], "summary" : "Retrieve a decision service archive", "description" : "Retrieve a decision service archive", "operationId" : "getDecisionArchive", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The decision service archive was successfully retrieved", "content" : { "application/octet-stream" : { "schema" : { "type" : "string", "format" : "binary" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve decision service archive", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service archive was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The decision service archive could not be retrieved due to an internal storage service error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] }, "post" : { "tags" : [ "Decision storage management" ], "summary" : "Stores a decision service archive", "description" : "Stores a decision service archive", "operationId" : "deployDecisionArchive", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } }, { "name" : "allowDuplicateDecisionService", "in" : "query", "description" : "Allow deployment with duplicate decisionServiceId and decisionServiceVersion", "schema" : { "type" : "boolean", "default" : false } } ], "requestBody" : { "content" : { "application/octet-stream" : { "schema" : { "type" : "object" } }, "multipart/form-data" : { "schema" : { "type" : "object" } } } }, "responses" : { "200" : { "description" : "The decision service archive was stored successfully" }, "400" : { "description" : "The decision service version is invalid", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "415" : { "description" : "The decision service archive is malformed or invalid", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to store decision service archive", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "409" : { "description" : "The decision service archive is already deployed in the deployment space", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The decision service archive could not be stored due to an internal storage service error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "503" : { "description" : "The decision runtime is in maintenance. The decision runtime is read-only during this period and write operations are not available", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] }, "delete" : { "tags" : [ "Decision storage management" ], "summary" : "Delete a decision service archive", "description" : "Delete a decision service archive", "operationId" : "deleteDecisionArchive", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The decision service archive was successfully deleted" }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to delete decision service archive successfully", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service archive was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The decision service archive could not be deleted due to an internal storage service error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "503" : { "description" : "The decision runtime is in maintenance. The decision runtime is read-only during this period and write operations are not available", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/deploymentSpaces/{deploymentSpaceId}/decisions" : { "get" : { "tags" : [ "Decision storage management" ], "summary" : "Retrieve decision IDs", "description" : "Retrieve decision IDs", "operationId" : "getDecisionIds", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "maxDeploymentTime", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "pageNumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "pageSize", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "exposed", "in" : "query", "schema" : { "type" : "boolean", "default" : false } } ], "responses" : { "200" : { "description" : "The decision IDs were successfully retrieved. Note that the returned list can be empty if there is no decision in the deployment space or if the deployment space does not exist", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "400" : { "description" : "The requested decision archive deployment time format is invalid", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve decision IDs", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The decision IDs could not be retrieved due to an internal storage service error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] }, "delete" : { "tags" : [ "Decision storage management" ], "summary" : "Delete decision IDs", "description" : "Delete decision IDs", "operationId" : "deleteArchivesDecisions", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "excludeLastDeployed", "in" : "query", "schema" : { "type" : "boolean", "default" : true } } ], "responses" : { "200" : { "description" : "The decision IDs were successfully deleted", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to delete decision IDs", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "404" : { "description" : "The deployment space was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The decision IDs could not be retrieved due to an internal storage service error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "503" : { "description" : "The decision runtime is in maintenance. The decision runtime is read-only during this period and write operations are not available", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/operations/{operation}/extendedExecute" : { "post" : { "tags" : [ "Decision runtime" ], "summary" : "Execute a decision service", "description" : "Execute a decision service", "operationId" : "extendedExecuteDecisionOperation", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionRequest" } } } }, "responses" : { "200" : { "description" : "The decision operation was successfully executed", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionResponse" } } } }, "400" : { "description" : "The decision operation could not be executed due to a problem in the input payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to execute the decision", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service or decision operation was not found. It can happen during the maintenance of the decision runtime if a decision was deployed to a new decision runtime instance and then fetched from an old decision runtime instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "429" : { "description" : "The limit for executions of the decision has been reached", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The decision operation could not be executed due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/operations/{operation}/execute" : { "post" : { "tags" : [ "Decision runtime" ], "summary" : "Execute decision service with simplified input and output payloads", "description" : "Execute a decision service with simplified input and output payloads", "operationId" : "executeDecisionOperation", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "required" : true }, "responses" : { "200" : { "description" : "The decision operation was successfully executed", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "400" : { "description" : "The decision operation could not be executed due to a problem in the input payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to execute the decision", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "404" : { "description" : "The decision service or decision operation was not found. It can happen during the maintenance of the decision runtime if a decision was deployed to a new decision runtime instance and then fetched from an old decision runtime instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "429" : { "description" : "The limit for execution of the decision has been reached", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The decision operation could not be executed due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/openapi" : { "get" : { "tags" : [ "Decision runtime" ], "summary" : "Retrieve the OpenAPI specification of a decision service", "description" : "Retrieve the OpenAPI specification of a decision service", "operationId" : "getDecisionOpenAPI", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "outputFormat", "in" : "query", "schema" : { "type" : "string", "description" : "The format of the generated swagger specification, either JSON or YAML", "default" : "JSON", "enum" : [ "JSON", "YAML" ] } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The OpenAPI specification was successfully retrieved", "content" : { "application/json" : { "schema" : { "type" : "object" } }, "application/x-yaml" : { "schema" : { "type" : "object" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the OpenAPI specification of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The OpenAPI specification could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/operations" : { "get" : { "tags" : [ "Decision runtime" ], "summary" : "Retrieve the list of decision operations of a decision service", "description" : "Retrieve the list of decision operations of a decision service", "operationId" : "getDecisionOperationIds", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The list of decision operations was successfully retrieved", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionOperationsList" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the list of decision operations", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The list of decision operations coud not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/operations/{operation}/exampleInput" : { "get" : { "tags" : [ "Decision runtime" ], "summary" : "Retrieve a sample input payload of a decision operation", "description" : "Retrieve a sample input payload of a decision operation", "operationId" : "getDecisionOperationExampleInput", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The sample input payload was successfully generated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionOperationExamplePayload" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the sample input payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service or decision operation could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "422" : { "description" : "The decision operation sample input payload could not be generated due to excessive type complexity", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The decision operation sample input payload could not be generated due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/operations/{operation}/schemas" : { "get" : { "tags" : [ "Decision runtime" ], "summary" : "Retrieve the input and output schemas or OpenAPI of a decision operation", "description" : "Retrieve the input and output schemas or OpenAPI of a decision operation", "operationId" : "getDecisionOperationSchemas", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "format", "in" : "query", "schema" : { "type" : "string", "description" : "The supported formats for the input and output schemas of a decision operation", "enum" : [ "JSON_SCHEMA", "OPEN_API" ] } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The schemas were successfully retrieved", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/DecisionOperationSchemas" }, { "type" : "object" } ] } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the decision operation schemas", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The schemas could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/deploymentSpaces/{deploymentSpaceId}/decisionServices/{decisionServiceId}" : { "delete" : { "tags" : [ "Decision storage management" ], "summary" : "Delete all decisions of a decision service", "description" : "Delete all decisions associated to a decision service", "operationId" : "deleteDecisionService", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The decisions were successfully deleted" }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to delete decisions via decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "404" : { "description" : "No decision service was found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The decisions could not be deleted due to an internal storage service error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "503" : { "description" : "The decision runtime is in maintenance. The decision runtime is read-only during this period and write operations are not available", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } } } }, "/deploymentSpaces" : { "get" : { "tags" : [ "Decision storage management" ], "summary" : "Get deployment space IDs", "description" : "Get deployment space IDs", "operationId" : "getDeploymentSpaceIds", "responses" : { "200" : { "description" : "The deployment space IDs were successfully retrieved", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "type" : "string" } } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve deployment space IDs", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "404" : { "description" : "No deployment space was found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The deployment space IDs could not be retrieved due to an internal storage service error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/health" : { "get" : { "tags" : [ "Decision runtime" ], "summary" : "Retrieve the status of the decision runtime", "description" : "Retrieve the status of the decision runtime.", "operationId" : "getHealth", "responses" : { "200" : { "description" : "The decision runtime service is available", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Health" } } } }, "503" : { "description" : "The decision runtime service is not available", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Health" }, "example" : { "status" : "FAIL", "archiveStorageStatus" : "NOT_READY", "metadataStorageStatus" : "NOT_READY", "eventEmitterStatus" : "NOT_READY" } } } }, "500" : { "description" : "The status of the decision runtime could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } } } } }, "/selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/extendedExecute" : { "post" : { "tags" : [ "Last deployed version execution" ], "summary" : "Execute the last deployed version of a decision service", "description" : "Execute the last deployed version of a decision service", "operationId" : "extendedExecuteLastDeployedDecisionServiceVersion", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionRequest" } } } }, "responses" : { "200" : { "description" : "The decision operation was successfully executed", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionResponse" } } } }, "400" : { "description" : "The decision operation could not be executed due to a problem in the input payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to execute the decision operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service or decision operation was not found. It can happen during the maintenance of the decision runtime if a decision was deployed to a new decision runtime instance and then fetched from an old decision runtime instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The decision operation could not be executed due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/execute" : { "post" : { "tags" : [ "Last deployed version execution" ], "summary" : "Execute the last deployed version of a decision service with simple input and output payloads", "description" : "Execute the last deployed version of a decision service with simplified input and output payloads", "operationId" : "executeLastDeployedDecisionServiceVersion", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "required" : true }, "responses" : { "200" : { "description" : "The decision operation was successfully executed", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "400" : { "description" : "The decision operation could not be executed due to a problem in the input payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to execute the decision operation", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "404" : { "description" : "The decision service or decision operation was not found. It can happen during the maintenance of the decision runtime if a decision was deployed to a new decision runtime instance and then fetched from an old decision runtime instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The decision operation could not be executed due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/openapi" : { "get" : { "tags" : [ "Last deployed version execution" ], "summary" : "Retrieve the OpenAPI specification of the last deployed version of a decision service", "description" : "Retrieve the OpenAPI specification of the last deployed version of a decision service", "operationId" : "getLastDeployedDecisionServiceVersionOpenApi", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "outputFormat", "in" : "query", "schema" : { "type" : "string", "description" : "the format of the generated swagger specification, either JSON or YAML", "default" : "JSON", "enum" : [ "JSON", "YAML" ] } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The OpenAPI specification was successfully retrieved", "content" : { "application/json" : { "schema" : { "type" : "object" } }, "application/x-yaml" : { "schema" : { "type" : "object" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the OpenAPI specification", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The OpenAPI specification could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/operations" : { "get" : { "tags" : [ "Last deployed version execution" ], "summary" : "Retrieve the list of decision operations of the last deployed version of a decision service", "description" : "Retrieve the list of decision operations of the last deployed version of a decision service", "operationId" : "getLastDeployedDecisionServiceVersionOperations", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The list of decision operations was successfully retrieved", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionOperationsList" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the list of decision operations", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service or decision operation was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The list of decision operations could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/exampleInput" : { "get" : { "tags" : [ "Last deployed version execution" ], "summary" : "Retrieve a sample input payload of the last deployed version of a decision operation", "description" : "Retrieve a sample input payload of the last deployed version of a decision operation", "operationId" : "getLastDeployedDecisionServiceVersionExampleInput", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "A sample payload was successfully generated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionOperationExamplePayload" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve a sample payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service or decision operation could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "A decision operation sample payload could not be generated due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastDeployedDecisionService/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/schemas" : { "get" : { "tags" : [ "Last deployed version execution" ], "summary" : "Retrieve the input and output schemas or OpenAPI of the last deployed version of a decision operation", "description" : "Retrieve the input and output schemas or OpenAPI of the last deployed version of a decision operation", "operationId" : "getLastDeployedDecisionServiceVersionSchemas", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "format", "in" : "query", "schema" : { "type" : "string", "description" : "The supported formats for the input and output schemas of a decision operation", "enum" : [ "JSON_SCHEMA", "OPEN_API" ] } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The schemas were successfully retrieved", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/DecisionOperationSchemas" }, { "type" : "object" } ] } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the decision operation schemas", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The schemas could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/extendedExecute" : { "post" : { "tags" : [ "Last semantic version execution" ], "summary" : "Executes the last semantic version of a decision service", "description" : "Executes the last semantic version of a decision service", "operationId" : "extendedExecuteLastSemanticDecisionServiceVersion", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "majorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "minorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionRequest" } } } }, "responses" : { "200" : { "description" : "The decision operation was successfully executed", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionResponse" } } } }, "400" : { "description" : "The decision operation could not be executed due to a problem in the input payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to execute the last semantic version of decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service or decision operation was not found. It can happen during the maintenance of the decision runtime if a decision was deployed to a new decision runtime instance and then fetched from an old decision runtime instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The decision operation could not be executed due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/execute" : { "post" : { "tags" : [ "Last semantic version execution" ], "summary" : "Executes the last semantic version of a decision service with simple input and output payloads", "description" : "Executes the last semantic version of a decision service with simplified input and output payloads", "operationId" : "executeLastSemanticDecisionServiceVersion", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "majorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "minorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "required" : true }, "responses" : { "200" : { "description" : "The decision operation was successfully executed", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "400" : { "description" : "The decision operation could not be executed due to a problem in the input payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to execute the last semantic version of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "404" : { "description" : "The decision service or decision operation was not found. It can happen during the maintenance of the decision runtime if a decision was deployed to a new decision runtime instance and then fetched from an old decision runtime instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The decision operation could not be executed due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/openapi" : { "get" : { "tags" : [ "Last semantic version execution" ], "summary" : "Retrieve the OpenAPI specification of the last semantic version of a decision service", "description" : "Retrieve the OpenAPI specification of the last semantic version of a decision service", "operationId" : "getLastSemanticDecisionServiceVersionOpenApi", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "majorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "minorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "outputFormat", "in" : "query", "schema" : { "type" : "string", "description" : "the format of the generated swagger specification, either JSON or YAML", "default" : "JSON", "enum" : [ "JSON", "YAML" ] } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The OpenAPI specification was successfully retrieved", "content" : { "application/json" : { "schema" : { "type" : "object" } }, "application/x-yaml" : { "schema" : { "type" : "object" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the OpenAPI specification of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The OpenAPI specification could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations" : { "get" : { "tags" : [ "Last semantic version execution" ], "summary" : "Retrieve the list of decision operations of the last semantic version of a decision service", "description" : "Retrieve the list of decision operations of the last semantic version of a decision service", "operationId" : "getLastSemanticDecisionServiceVersionOperations", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "majorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "minorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The list of decision operations was successfully retrieved", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionOperationsList" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the list of decision operations of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The list of decision operations could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/exampleInput" : { "get" : { "tags" : [ "Last semantic version execution" ], "summary" : "Retrieve a sample input payload of the last semantic version of a decision service", "description" : "Retrieve a sample input payload of the last semantic version of a decision service", "operationId" : "getLastSemanticDecisionServiceVersionExampleInput", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "majorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "minorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "A sample payload was successfully generated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionOperationExamplePayload" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the sample payload of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service or decision operation could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "A decision operation sample payload could not be generated due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSemanticDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/schemas" : { "get" : { "tags" : [ "Last semantic version execution" ], "summary" : "Retrieve the input and output schemas or OpenAPI of the last semantic version of a decision service", "description" : "Retrieve the input and output schemas or OpenAPI of the last semantic version of a decision service", "operationId" : "getLastSemanticDecisionServiceVersionSchemas", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "majorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "minorVersion", "in" : "query", "schema" : { "type" : "integer", "format" : "int32" } }, { "name" : "format", "in" : "query", "schema" : { "type" : "string", "description" : "The supported formats for the input and output schemas of a decision operation", "enum" : [ "JSON_SCHEMA", "OPEN_API" ] } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The schemas were successfully retrieved", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/DecisionOperationSchemas" }, { "type" : "object" } ] } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the schemas payload of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The schemas could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/extendedExecute" : { "post" : { "tags" : [ "Last sorted version execution" ], "summary" : "Execute the last sorted version of a decision service", "description" : "Execute the last sorted version of a decision service.", "operationId" : "extendedExecuteLastSortedDecisionServiceVersion", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionRequest" } } } }, "responses" : { "200" : { "description" : "The decision operation was successfully executed", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionResponse" } } } }, "400" : { "description" : "The decision operation could not be executed due to a problem in the input payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to execute the last sorted version of decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service or decision operation was not found. It can happen during the maintenance of the decision runtime if a decision was deployed to a new decision runtime instance and then fetched from an old decision runtime instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The decision operation could not be executed due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/execute" : { "post" : { "tags" : [ "Last sorted version execution" ], "summary" : "Execute the last sorted version of a decision service with simple input and output payloads", "description" : "Execute the last sorted version of a decision service with simplified input and output payloads.", "operationId" : "executeLastSortedDecisionServiceVersion", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "required" : true }, "responses" : { "200" : { "description" : "The decision operation was successfully executed", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "400" : { "description" : "The decision operation could not be executed due to a problem in the input payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to execute the last sorted version of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "404" : { "description" : "The decision service or decision operation was not found. It can happen during the maintenance of the decision runtime if a decision was deployed to a new decision runtime instance and then fetched from an old decision runtime instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The decision operation could not be executed due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/openapi" : { "get" : { "tags" : [ "Last sorted version execution" ], "summary" : "Retrieve the OpenAPI specification of the last sorted version of a decision service", "description" : "Retrieve the OpenAPI specification of the last sorted version of a decision service.", "operationId" : "getLastSortedDecisionServiceVersionOpenApi", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "outputFormat", "in" : "query", "schema" : { "type" : "string", "description" : "the format of the generated swagger specification, either JSON or YAML", "default" : "JSON", "enum" : [ "JSON", "YAML" ] } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The OpenAPI specification was successfully retrieved", "content" : { "application/json" : { "schema" : { "type" : "object" } }, "application/x-yaml" : { "schema" : { "type" : "object" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the OpenAPI specification of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The OpenAPI specification could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations" : { "get" : { "tags" : [ "Last sorted version execution" ], "summary" : "Retrieve the list of decision operations of the last sorted version of a decision service", "description" : "Retrieve the list of decision operations of the last sorted version of a decision service.", "operationId" : "getLastSortedDecisionServiceVersionOperations", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The list of decision operations was successfully retrieved", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionOperationsList" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the list of decision operations of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The list of decision operations could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/exampleInput" : { "get" : { "tags" : [ "Last sorted version execution" ], "summary" : "Retrieve a sample input payload of the last sorted version of a decision service", "description" : "Retrieve a sample input payload of the last sorted version of a decision service.", "operationId" : "getLastSortedDecisionServiceVersionExampleInput", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "A sample payload was successfully generated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionOperationExamplePayload" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the sample payload of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service or decision operation could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "A decision operation sample payload could not be generated due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/lastSortedDecisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/schemas" : { "get" : { "tags" : [ "Last sorted version execution" ], "summary" : "Retrieve the input and output schemas or OpenAPI of the last sorted version of a decision service", "description" : "Retrieve the input and output schemas or OpenAPI of the last sorted version of a decision service.", "operationId" : "getLastSortedDecisionServiceVersionSchemas", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "format", "in" : "query", "schema" : { "type" : "string", "description" : "The supported formats for the input and output schemas of a decision operation", "enum" : [ "JSON_SCHEMA", "OPEN_API" ] } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The schemas were successfully retrieved", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/DecisionOperationSchemas" }, { "type" : "object" } ] } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the schemas payload of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The schemas could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/deploymentSpaces/{deploymentSpaceId}/decisions/{decisionId}/metadata" : { "get" : { "tags" : [ "Decision storage management" ], "summary" : "Retrieve decision service metadata", "description" : "Retrieve decision service metadata", "operationId" : "getDecisionMetadata", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The decision service metadata was successfully retrieved", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Metadata" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to access to the decision service metadata", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service metadata was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The decision service metadata could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] }, "put" : { "tags" : [ "Decision storage management" ], "summary" : "Create or update decision service metadata", "description" : "Create or update decision service metadata", "operationId" : "setDecisionMetadata", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/Metadata" } } } }, "responses" : { "200" : { "description" : "The decision service metadata was successfully updated or created" }, "400" : { "description" : "The decision service input metadata is invalid, i.e either null, empty or not a valid JSON object", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to update some or all of decision service metadata", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The decision service metadata could not be updated or created due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "503" : { "description" : "The decision runtime is in maintenance. The decision runtime is read-only during this period and write operations are not available", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] }, "delete" : { "tags" : [ "Decision storage management" ], "summary" : "Delete decision service metadata", "description" : "Delete decision service metadata", "operationId" : "deleteDecisionMetadata", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The decision service metadata was successfully deleted" }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to delete the metadata", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service metadata was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The decision service metadata could not be deleted due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "503" : { "description" : "The decision runtime is in maintenance. The decision runtime is read-only during this period and write operations are not available", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/deploymentSpaces/{deploymentSpaceId}" : { "delete" : { "tags" : [ "Decision storage management" ], "summary" : "Delete a deployment space", "description" : "Delete a deployment space", "operationId" : "deleteDeploymentSpace", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The deployment space was successfully deleted" }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to delete the deployment space", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "404" : { "description" : "The deployment space was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The deployment space could not be deleted due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "503" : { "description" : "The decision runtime is in maintenance. The decision runtime is read-only during this period and write operations are not available", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/deploymentSpaces/{deploymentSpaceId}/metadata" : { "get" : { "tags" : [ "Decision storage management" ], "summary" : "Retrieve deployment space metadata", "description" : "Retrieve deployment space metadata", "operationId" : "getDeploymentSpaceDecisionsMetadata", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "maxDeploymentTime", "in" : "query", "schema" : { "type" : "string" } }, { "name" : "pageNumber", "in" : "query", "schema" : { "type" : "integer", "format" : "int32", "default" : -1 } }, { "name" : "pageSize", "in" : "query", "schema" : { "minimum" : 0, "type" : "integer", "format" : "int32" } }, { "name" : "exposed", "in" : "query", "schema" : { "type" : "boolean", "default" : false } }, { "name" : "names", "in" : "query", "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "The decision service metadata was successfully retrieved", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/MetadataMap" } } } } }, "400" : { "description" : "The specified maximum deployment time could not be parsed", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to access to the decision service metadata", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "404" : { "description" : "The decision service metadata was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The decision service metadata could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/execute" : { "post" : { "tags" : [ "Specific version execution" ], "summary" : "Execute a specific version of a decision service with simple input and output payloads", "description" : "Execute a specific version of a decision service with simplified input and output payloads", "operationId" : "executeDecisionServiceVersion", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceVersion", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "type" : "object" } } }, "required" : true }, "responses" : { "200" : { "description" : "The decision operation was successfully executed", "content" : { "application/json" : { "schema" : { "type" : "object" } } } }, "400" : { "description" : "The decision operation could not be executed due to a problem in the input payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to execute a specific version of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "404" : { "description" : "The decision service or decision operation was not found. It can happen during the maintenance of the decision runtime if a decision was deployed to a new decision runtime instance and then fetched from an old decision runtime instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The decision operation could not be executed due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/extendedExecute" : { "post" : { "tags" : [ "Specific version execution" ], "summary" : "Execute a specific version of a decision service", "description" : "Execute a specific version of a decision service", "operationId" : "extendedExecuteDecisionServiceVersion", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceVersion", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "requestBody" : { "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionRequest" } } } }, "responses" : { "200" : { "description" : "The decision operation was successfully executed", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionResponse" } } } }, "400" : { "description" : "The decision operation could not be executed due to a problem in the input payload", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to execute a specific version of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service or decision operation was not found. It can happen during the maintenance of the decision runtime if a decision was deployed to a new decision runtime instance and then fetched from an old decision runtime instance", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The decision operation could not be executed due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/openapi" : { "get" : { "tags" : [ "Specific version execution" ], "summary" : "Retrieve the OpenAPI specification of a specific version of a decision service", "description" : "Retrieve the OpenAPI specification of a specific version of a decision service", "operationId" : "getDecisionServiceVersionOpenApi", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceVersion", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "outputFormat", "in" : "query", "schema" : { "type" : "string", "description" : "the format of the generated swagger specification, either JSON or YAML", "default" : "JSON", "enum" : [ "JSON", "YAML" ] } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The OpenAPI specification was successfully retrieved", "content" : { "application/json" : { "schema" : { "type" : "object" } }, "application/x-yaml" : { "schema" : { "type" : "object" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the OpenAPI specification of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The OpenAPI specification could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } }, "application/x-yaml" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations" : { "get" : { "tags" : [ "Specific version execution" ], "summary" : "Retrieve the list of decision operations of a specific version of a decision service", "description" : "Retrieve the list of decision operations of a specific version of a decision service", "operationId" : "getDecisionServiceVersionOperations", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceVersion", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The list of decision operations was successfully retrieved", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionOperationsList" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the list of decision operations of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service was not found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The list of decision operations could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/exampleInput" : { "get" : { "tags" : [ "Specific version execution" ], "summary" : "Retrieve a sample input payload of a specifc version of a decision service", "description" : "Retrieve a sample input payload of a specific version of a decision service", "operationId" : "getDecisionServiceVersionExampleInput", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceVersion", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "A sample payload was successfully generated", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionOperationExamplePayload" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the sample payload of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service or decision operation could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "A decision operation sample payload could not be generated due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/selectors/decisionServiceVersion/deploymentSpaces/{deploymentSpaceId}/operations/{operation}/schemas" : { "get" : { "tags" : [ "Specific version execution" ], "summary" : "Retrieve the input and output schemas or OpenAPI of a specific version of a decision service", "description" : "Retrieve the input and output schemas or OpenAPI of a specific version of a decision service", "operationId" : "getDecisionServiceVersionSchemas", "parameters" : [ { "name" : "deploymentSpaceId", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "operation", "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceId", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "decisionServiceVersion", "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { "name" : "format", "in" : "query", "schema" : { "type" : "string", "description" : "The supported formats for the input and output schemas of a decision operation", "enum" : [ "JSON_SCHEMA", "OPEN_API" ] } }, { "name" : "retryCount", "in" : "query", "description" : "Maximum number of retries when the request failed", "deprecated" : true, "schema" : { "maximum" : 10, "type" : "integer", "format" : "int32", "default" : 0 } }, { "name" : "retryDelay", "in" : "query", "description" : "Duration in milliseconds between two retries", "deprecated" : true, "schema" : { "maximum" : 30000, "minimum" : 200, "type" : "integer", "format" : "int64", "default" : 500 } } ], "responses" : { "200" : { "description" : "The schemas were successfully retrieved", "content" : { "application/json" : { "schema" : { "anyOf" : [ { "$ref" : "#/components/schemas/DecisionOperationSchemas" }, { "type" : "object" } ] } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the schemas payload of the decision service", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "404" : { "description" : "The decision service could not be found", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } }, "500" : { "description" : "The schemas could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/DecisionError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } }, "/snapshot" : { "get" : { "tags" : [ "Decision runtime" ], "summary" : "Retrieve a snapshot of the state of the decision runtime", "description" : "Retrieve a snapshot of the state of the decision runtime.", "operationId" : "getSnapshot", "responses" : { "200" : { "description" : "The snapshot of the state of decision runtime was successfully retrieved.", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/ObjectNode" } } } }, "401" : { "description" : "The operation could not be performed due to an authentication problem", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "403" : { "description" : "No sufficient privileges to retrieve the snapshot of the state of decision runtime", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } }, "500" : { "description" : "The snapshot of the state of decision runtime could not be retrieved due to an internal error", "content" : { "application/json" : { "schema" : { "$ref" : "#/components/schemas/BaseError" } } } } }, "security" : [ { "BASIC-AUTH" : [ ] }, { "ZENJWT" : [ ] }, { "ZENAPIKEY" : [ ] } ] } } }, "components" : { "schemas" : { "AboutInformation" : { "type" : "object", "properties" : { "vendor" : { "type" : "string", "description" : "The product vendor." }, "product" : { "type" : "string", "description" : "The product name." }, "component" : { "type" : "string", "description" : "The product component name." }, "version" : { "type" : "string", "description" : "The decision runtime version." }, "commit" : { "type" : "string", "description" : "Git commit id" }, "date" : { "type" : "string", "description" : "Build date" }, "engine_api" : { "type" : "string", "description" : "The version of the decision engine API used by the decision runtime" }, "emitter_enabled" : { "type" : "boolean", "description" : "Whether the event emitter is enabled and active" }, "runtime" : { "type" : "string", "description" : "The decision runtime version" }, "swagger_ui" : { "type" : "string", "description" : "The SwaggerUI version used by the decision runtime" }, "jackson" : { "type" : "string", "description" : "The Jackson version used by the decision runtime" }, "annotation" : { "type" : "string", "description" : "The Engine annotation version used by the decision runtime" }, "license" : { "type" : "string", "description" : "The license version for IBM Automation Decision Services runtime" }, "ml_integration" : { "type" : "string", "description" : "The version of the ML integration runtime" }, "kafka_client" : { "type" : "string", "description" : "The Kafka client version used by the decision runtime" }, "execution_api" : { "type" : "string", "description" : "The Execution-api version used by the decision runtime" }, "mongodb" : { "type" : "string", "description" : "The MongoDB version used by the decision runtime" }, "liberty" : { "type" : "string", "description" : "The IBM Websphere Liberty version used by the decision runtime" } }, "description" : "Information about the IBM Automation Decision Services runtime." }, "BaseError" : { "type" : "object", "properties" : { "output" : { "type" : "object", "description" : "The output of the decision service archive.", "nullable" : true }, "incident" : { "$ref" : "#/components/schemas/Incident" } }, "description" : "The response when an error occurs" }, "Incident" : { "type" : "object", "properties" : { "incidentId" : { "type" : "string", "description" : "A unique identifier for the incident" }, "incidentCategory" : { "type" : "string", "description" : "The category of the incident, for instance \"Decision not found\"" }, "stackTrace" : { "type" : "string", "description" : "An associated stack trace, if the decision runtime is configured to provide it. By default, the stack trace is null" } }, "description" : "The description of the failure" }, "DecisionError" : { "type" : "object", "properties" : { "decisionId" : { "type" : "string", "description" : "A unique identifier for the decision service archive to execute." }, "decisionOperation" : { "type" : "string", "description" : "The identifier for the decision operation within the decision service archive." }, "executionId" : { "type" : "string", "description" : "The identifier for this execution of the decision service archive." }, "output" : { "type" : "object", "description" : "The output of the decision service archive.", "nullable" : true }, "executionTrace" : { "$ref" : "#/components/schemas/Trace" }, "warnings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DecisionWarning" } }, "incident" : { "$ref" : "#/components/schemas/Incident" } }, "description" : "The response when a decision execution fails or an error occurs" }, "DecisionWarning" : { "type" : "object", "properties" : { "messageId" : { "type" : "string" }, "message" : { "type" : "string" } }, "description" : "Warning messages associated with a decision execution" }, "ExceptionRecord" : { "type" : "object", "properties" : { "recordIndex" : { "type" : "string", "description" : "The index of the trace record from where the exception was raised." }, "type" : { "type" : "string", "description" : "The type of the exception raised." }, "message" : { "type" : "string", "description" : "The message of the exception raised." }, "internallyHandled" : { "type" : "boolean", "description" : "Null whether the exception cannot be handled by a custom handler otherwise indicates whether the exception was rethrown." } }, "description" : "ExceptionRecord is used in the trace to store information about an exception raised." }, "MessageRecord" : { "type" : "object", "properties" : { "recordIndex" : { "type" : "string", "description" : "The index of the TraceRecord from where the message was printed." }, "message" : { "type" : "string", "description" : "The message printed." } }, "description" : "MessageRecord is used in the trace to store information about a message printed." }, "Trace" : { "type" : "object", "properties" : { "configuration" : { "$ref" : "#/components/schemas/TraceConfiguration" }, "rootRecord" : { "$ref" : "#/components/schemas/TraceRecord" }, "printedMessages" : { "type" : "array", "description" : "List of MessageRecord containing information about messages printed during the execution.", "items" : { "$ref" : "#/components/schemas/MessageRecord" } }, "exceptionsRaised" : { "type" : "array", "description" : "List of ExceptionRecord containing information about exception raised during the execution.", "items" : { "$ref" : "#/components/schemas/ExceptionRecord" } } }, "description" : "A trace contains information about the execution of a decision. Its content depends on a TraceConfiguration." }, "TraceConfiguration" : { "type" : "object", "properties" : { "executionDuration" : { "type" : "boolean", "description" : "If true, add in the trace the execution duration (in msec) in every trace record. Default value is false." }, "printedMessages" : { "type" : "boolean", "description" : "If true, add in the trace all messages printed by the engines. Default value is true." }, "decisionModel" : { "$ref" : "#/components/schemas/TraceConfigurationForDecisionModel" }, "rules" : { "$ref" : "#/components/schemas/TraceConfigurationForRule" }, "ruleflow" : { "$ref" : "#/components/schemas/TraceConfigurationForRuleflow" } }, "description" : "TraceConfiguration allows user to configure which information should be recorded in the trace." }, "TraceConfigurationForDecisionModel" : { "type" : "object", "properties" : { "inputParameters" : { "type" : "string", "description" : "ObjectSerializationKind allows user to configure how objects are recorded in the trace.", "enum" : [ "ClassNameNHashcode", "ToString", "Object", "None" ] }, "outputParameters" : { "type" : "string", "description" : "ObjectSerializationKind allows user to configure how objects are recorded in the trace.", "enum" : [ "ClassNameNHashcode", "ToString", "Object", "None" ] }, "inputNode" : { "type" : "string", "description" : "ObjectSerializationKind allows user to configure how objects are recorded in the trace.", "enum" : [ "ClassNameNHashcode", "ToString", "Object", "None" ] }, "outputNode" : { "type" : "string", "description" : "ObjectSerializationKind allows user to configure how objects are recorded in the trace.", "enum" : [ "ClassNameNHashcode", "ToString", "Object", "None" ] } }, "description" : "TraceConfigurationForDecisionModel allows user to configure which information about decision models should be recorded in the trace." }, "TraceConfigurationForRule" : { "type" : "object", "properties" : { "boundObjectsAtStart" : { "type" : "string", "description" : "ObjectSerializationKind allows user to configure how objects are recorded in the trace.", "enum" : [ "ClassNameNHashcode", "ToString", "Object", "None" ] }, "boundObjectsAtEnd" : { "type" : "string", "description" : "ObjectSerializationKind allows user to configure how objects are recorded in the trace.", "enum" : [ "ClassNameNHashcode", "ToString", "Object", "None" ] }, "allRules" : { "type" : "boolean", "description" : "If true, add in the trace the name of all rules that can be executed by the rule engine. Default value is false." }, "executedRules" : { "type" : "boolean", "description" : "If true, add in the trace the details of the executed rules. Default value is false." }, "nonExecutedRules" : { "type" : "boolean", "description" : "If true, add in the trace the name of all rules that were not executed by the engine. Default value is false." }, "exceptions" : { "type" : "string", "description" : "ExceptionTraceKind allows user to configure which exceptions are recorded in the trace.", "enum" : [ "None", "NotHandled", "All" ] } }, "description" : "TraceConfigurationForRule allows user to configure which information about rules should be recorded in the trace." }, "TraceConfigurationForRuleflow" : { "type" : "object", "properties" : { "inputParameters" : { "type" : "string", "description" : "ObjectSerializationKind allows user to configure how objects are recorded in the trace.", "enum" : [ "ClassNameNHashcode", "ToString", "Object", "None" ] }, "outputParameters" : { "type" : "string", "description" : "ObjectSerializationKind allows user to configure how objects are recorded in the trace.", "enum" : [ "ClassNameNHashcode", "ToString", "Object", "None" ] }, "allTasks" : { "type" : "boolean", "description" : "If true, add in the trace the name of all tasks that can be executed by the engine. Default value is false." }, "executedTasks" : { "type" : "boolean", "description" : "According to the value set, add in the trace a record for each task executed. Default value is true." }, "notExecutedTasks" : { "type" : "boolean", "description" : "If true, add in the trace the name of all tasks that were not executed by the engine. Default value is false." }, "selectedRules" : { "type" : "boolean" } }, "description" : "TraceConfigurationForRuleflow allows user to configure which information about ruleflows should be recorded in the trace." }, "TraceRecord" : { "type" : "object", "properties" : { "recordType" : { "type" : "string", "description" : "The type of the unit executed. It can be 'DecisionModel', 'DecisionModelNode', 'Rule', 'ReteEngine', 'Task' or 'RuleFlow'." }, "recordIndex" : { "type" : "string", "description" : "The index of the trace record. This index is hierarchical and can be used to locate the trace record in the tree structure." }, "properties" : { "type" : "object", "additionalProperties" : { "type" : "object", "description" : " Map containing information about the unit executed. Available keys depend on the record type and the trace configuration used." }, "description" : " Map containing information about the unit executed. Available keys depend on the record type and the trace configuration used." } }, "description" : "A TraceRecord contains information about the execution of one unit. The TraceRecord are stored in the trace." }, "DecisionResponse" : { "type" : "object", "properties" : { "decisionId" : { "type" : "string", "description" : "A unique identifier for the decision service archive to execute." }, "decisionOperation" : { "type" : "string", "description" : "The identifier for the decision operation within the decision service archive." }, "executionId" : { "type" : "string", "description" : "The identifier for this execution of the decision service archive." }, "output" : { "type" : "object", "description" : "The output of the decision service archive.", "nullable" : true }, "executionTrace" : { "$ref" : "#/components/schemas/Trace" }, "warnings" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/DecisionWarning" } } }, "description" : "The response to the decision execution request." }, "DecisionRequest" : { "type" : "object", "properties" : { "executionId" : { "type" : "string", "description" : "The identifier for this execution of the decision service archive. If unspecified, the decision runtime creates it." }, "input" : { "type" : "object", "description" : "The input data for the decision service archive." }, "executionTraceFilters" : { "$ref" : "#/components/schemas/TraceConfiguration" }, "deploymentSpaceId" : { "type" : "string", "description" : "The decision running deployment space (can be dev, test... whatever)." } }, "description" : "The decision execution request." }, "DecisionOperationsList" : { "required" : [ "operations" ], "type" : "object", "properties" : { "decisionId" : { "type" : "string", "description" : "The identifier for the decision service archive." }, "operations" : { "type" : "array", "description" : "The list of decision operations for the given decision id.", "items" : { "type" : "string", "description" : "The list of decision operations for the given decision id." } } }, "description" : "The list of decision operations for a given decision id" }, "DecisionOperationExamplePayload" : { "type" : "object", "properties" : { "decisionId" : { "type" : "string", "description" : "The identifier for the decision service archive." }, "decisionOperation" : { "type" : "string", "description" : "The identifier for the decision operation within the decision service archive." }, "input" : { "type" : "object", "description" : "A sample input payload for the given decision operation" } }, "description" : "A sample input payload for a given decision operation" }, "DecisionOperationSchemas" : { "type" : "object", "properties" : { "decisionId" : { "type" : "string", "description" : "The identifier for the decision service archive." }, "decisionOperation" : { "type" : "string", "description" : "The identifier for the decision operation within the decision service archive." }, "schemaFormat" : { "type" : "string", "description" : "The supported formats for the input and output schemas of a decision operation", "enum" : [ "JSON_SCHEMA", "OPEN_API" ] }, "inputSchema" : { "type" : "object", "description" : "The input schema for the given decision operation." }, "outputSchema" : { "type" : "object", "description" : "The output schema for the given decision operation." } }, "description" : "The input and output schemas for a given decision operation" }, "Health" : { "type" : "object", "properties" : { "status" : { "type" : "string", "description" : "The decision runtime health.", "enum" : [ "PASS", "FAIL", "WARN" ] }, "archiveStorageStatus" : { "type" : "string", "description" : "The readiness status of the decision archive storage service.", "enum" : [ "READY", "NOT_READY" ] }, "metadataStorageStatus" : { "type" : "string", "description" : "The readiness status of the decision metadata storage service.", "enum" : [ "READY", "NOT_READY" ] }, "eventEmitterStatus" : { "type" : "string", "description" : "The readiness status of the event emitter.", "enum" : [ "READY", "NOT_READY" ] } }, "description" : "The health status of the decision runtime." }, "Metadata" : { "type" : "object", "properties" : { "map" : { "type" : "object", "additionalProperties" : { "$ref" : "#/components/schemas/MetadataProperty" }, "description" : "A mapping of property names to the corresponding metadata properties" } }, "description" : "The metadata associated with a decision in a given deployment space" }, "MetadataProperty" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of this property" }, "kind" : { "type" : "string", "description" : "The possible kinds of metedata properties", "enum" : [ "PLAIN", "ENCRYPTED" ] }, "readOnly" : { "type" : "boolean", "description" : "Whether the value of this property can be modified" }, "value" : { "type" : "object", "description" : "The value of this property" } }, "description" : "The representation of a single property in a set of metadata" }, "MetadataMap" : { "type" : "object", "properties" : { "empty" : { "type" : "boolean" } }, "additionalProperties" : { "$ref" : "#/components/schemas/MetadataProperty" }, "description" : "The metadata associated with a decision in a given deployment space." }, "ObjectNode" : { "type" : "object" } }, "securitySchemes" : { "BASIC-AUTH" : { "type" : "http", "scheme" : "basic" }, "ZENJWT" : { "type" : "http", "scheme" : "bearer" }, "ZENAPIKEY" : { "type" : "apiKey", "name" : "Authorization", "in" : "header" } } } }