5737 lines
148 KiB
JSON
5737 lines
148 KiB
JSON
{
|
|
"openapi": "3.1.0",
|
|
"info": {
|
|
"title": "KBX API Contract",
|
|
"version": "2.1.0"
|
|
},
|
|
"paths": {
|
|
"/api/common/ai/ask": {
|
|
"post": {
|
|
"operationId": "common.ai.ask",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.ai.use",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/kbx/experiments/assignments": {
|
|
"get": {
|
|
"operationId": "common.experiments.assignments",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.experiment.evaluate",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/kbx/experiments": {
|
|
"get": {
|
|
"operationId": "common.experiments.overview",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.experiment.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/kbx/experiments/{experimentId}/rollback": {
|
|
"post": {
|
|
"operationId": "common.experiments.rollback",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "experimentId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.experiment.manage",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/kbx/experiments/{experimentId}/rollout": {
|
|
"post": {
|
|
"operationId": "common.experiments.rollout",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "experimentId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.experiment.manage",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/kbx/external-data/{datasetId}/refresh": {
|
|
"post": {
|
|
"operationId": "common.externalData.refresh",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "datasetId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"202": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.external-data.refresh",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/kbx/external-data/status": {
|
|
"get": {
|
|
"operationId": "common.externalData.status",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.external-data.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/imports/sessions/{sessionId}/commit": {
|
|
"post": {
|
|
"operationId": "common.imports.commit",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sessionId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "imports.execute",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/imports/sessions": {
|
|
"post": {
|
|
"operationId": "common.imports.createSession",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "imports.execute",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "upload"
|
|
}
|
|
},
|
|
"/api/imports/sessions/{sessionId}/errors.xlsx": {
|
|
"get": {
|
|
"operationId": "common.imports.errorWorkbook",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sessionId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "imports.execute",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/imports/sessions/{sessionId}": {
|
|
"get": {
|
|
"operationId": "common.imports.getSession",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sessionId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "imports.execute",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/imports/sessions/{sessionId}/mapping": {
|
|
"put": {
|
|
"operationId": "common.imports.saveMapping",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sessionId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "imports.execute",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/imports/sessions/{sessionId}/saved-mappings": {
|
|
"post": {
|
|
"operationId": "common.imports.saveNamedMapping",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sessionId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "imports.execute",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/imports/{importType}/template": {
|
|
"get": {
|
|
"operationId": "common.imports.template",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "importType",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "imports.execute",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/imports/sessions/{sessionId}/validate": {
|
|
"post": {
|
|
"operationId": "common.imports.validate",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "sessionId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "imports.execute",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/integrations/attempts/{attemptId}": {
|
|
"get": {
|
|
"operationId": "common.integrations.getAttempt",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "attemptId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.integration.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/integrations/attempts/{attemptId}/retry": {
|
|
"post": {
|
|
"operationId": "common.integrations.retryAttempt",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "attemptId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.integration.retry",
|
|
"x-kbx-idempotency": "required",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/operations/work-items/claim": {
|
|
"post": {
|
|
"operationId": "common.operations.claim",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.operations.claim",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/operations/work-items/resolve": {
|
|
"post": {
|
|
"operationId": "common.operations.resolve",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.operations.resolve",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/operations/work-items/{id}/retry": {
|
|
"post": {
|
|
"operationId": "common.operations.retry",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.operations.retry",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/operations/work-items": {
|
|
"get": {
|
|
"operationId": "common.operations.search",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.operations.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/reconcile/items/create-exceptions": {
|
|
"post": {
|
|
"operationId": "common.reconcile.createExceptions",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.operations.create",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/reconcile/items": {
|
|
"get": {
|
|
"operationId": "common.reconcile.search",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.reconcile.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/kbx/runtime/notice": {
|
|
"get": {
|
|
"operationId": "common.runtime.notice",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.runtime.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/kbx/runtime/notifications/{Id}/read": {
|
|
"post": {
|
|
"operationId": "common.runtime.notificationRead",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "Id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.runtime.read",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/kbx/runtime/notifications": {
|
|
"get": {
|
|
"operationId": "common.runtime.notifications",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.runtime.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/kbx/runtime/operations": {
|
|
"get": {
|
|
"operationId": "common.runtime.operations",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.runtime.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/common/suggestions": {
|
|
"post": {
|
|
"operationId": "common.suggestions.submit",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.suggestion.create",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/kbx/ux/events": {
|
|
"post": {
|
|
"operationId": "common.uxTelemetry.ingest",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"204": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.telemetry.write",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/kbx/ux/metrics": {
|
|
"get": {
|
|
"operationId": "common.uxTelemetry.metrics",
|
|
"tags": [
|
|
"COMMON"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "common.ux.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/erp/inventory/{itemId}/history": {
|
|
"get": {
|
|
"operationId": "erp.inventory.history",
|
|
"tags": [
|
|
"ERP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "itemId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.inventory.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/erp/inventory/{itemId}/locations": {
|
|
"get": {
|
|
"operationId": "erp.inventory.locations",
|
|
"tags": [
|
|
"ERP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "itemId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.inventory.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/erp/inventory": {
|
|
"get": {
|
|
"operationId": "erp.inventory.search",
|
|
"tags": [
|
|
"ERP"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.inventory.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/erp/item-prices/bulk": {
|
|
"post": {
|
|
"operationId": "erp.itemPrices.bulkSave",
|
|
"tags": [
|
|
"ERP"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.item.price.write",
|
|
"x-kbx-idempotency": "required",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/erp/items/{id}": {
|
|
"get": {
|
|
"operationId": "erp.items.get",
|
|
"tags": [
|
|
"ERP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.item.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
},
|
|
"put": {
|
|
"operationId": "erp.items.update",
|
|
"tags": [
|
|
"ERP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.item.write",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/erp/items": {
|
|
"get": {
|
|
"operationId": "erp.items.search",
|
|
"tags": [
|
|
"ERP"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.item.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
},
|
|
"post": {
|
|
"operationId": "erp.items.create",
|
|
"tags": [
|
|
"ERP"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.item.create",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/lookups/customers/by-code/{code}": {
|
|
"get": {
|
|
"operationId": "lookup.customers.resolveByCode",
|
|
"tags": [
|
|
"LOOKUP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "code",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/lookups/customers/{id}": {
|
|
"get": {
|
|
"operationId": "lookup.customers.resolveById",
|
|
"tags": [
|
|
"LOOKUP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/lookups/customers": {
|
|
"get": {
|
|
"operationId": "lookup.customers.search",
|
|
"tags": [
|
|
"LOOKUP"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/lookups/items/by-code/{code}": {
|
|
"get": {
|
|
"operationId": "lookup.items.resolveByCode",
|
|
"tags": [
|
|
"LOOKUP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "code",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.item.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/lookups/items/{id}": {
|
|
"get": {
|
|
"operationId": "lookup.items.resolveById",
|
|
"tags": [
|
|
"LOOKUP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.item.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/lookups/items": {
|
|
"get": {
|
|
"operationId": "lookup.items.search",
|
|
"tags": [
|
|
"LOOKUP"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.item.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/lookups/warehouses/by-code/{code}": {
|
|
"get": {
|
|
"operationId": "lookup.warehouses.resolveByCode",
|
|
"tags": [
|
|
"LOOKUP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "code",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/lookups/warehouses/{id}": {
|
|
"get": {
|
|
"operationId": "lookup.warehouses.resolveById",
|
|
"tags": [
|
|
"LOOKUP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/lookups/warehouses": {
|
|
"get": {
|
|
"operationId": "lookup.warehouses.search",
|
|
"tags": [
|
|
"LOOKUP"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/oms/claims/{id}/approve": {
|
|
"post": {
|
|
"operationId": "oms.claims.approve",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.claim.approve",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/oms/claims/{id}/complete": {
|
|
"post": {
|
|
"operationId": "oms.claims.complete",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.claim.process",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/oms/claims/{id}/hold": {
|
|
"post": {
|
|
"operationId": "oms.claims.hold",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.claim.hold",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/oms/claims": {
|
|
"get": {
|
|
"operationId": "oms.claims.search",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.claim.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/oms/claims/{id}/start": {
|
|
"post": {
|
|
"operationId": "oms.claims.start",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.claim.process",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/oms/orders/register": {
|
|
"post": {
|
|
"operationId": "oms.orders.register",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.create",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/oms/orders": {
|
|
"get": {
|
|
"operationId": "oms.orders.search",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/oms/orders/ship": {
|
|
"post": {
|
|
"operationId": "oms.orders.ship",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.ship",
|
|
"x-kbx-idempotency": "required",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/wms/picking/tasks/{taskId}": {
|
|
"get": {
|
|
"operationId": "wms.picking.getTask",
|
|
"tags": [
|
|
"WMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "taskId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "wms.picking.execute",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/wms/picking/tasks/{taskId}/exceptions": {
|
|
"post": {
|
|
"operationId": "wms.picking.reportException",
|
|
"tags": [
|
|
"WMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "taskId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "wms.picking.execute",
|
|
"x-kbx-idempotency": "required",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/wms/picking/tasks/{taskId}/scan": {
|
|
"post": {
|
|
"operationId": "wms.picking.scan",
|
|
"tags": [
|
|
"WMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "taskId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "wms.picking.execute",
|
|
"x-kbx-idempotency": "required",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/wms/picking/tasks/{taskId}/quantity": {
|
|
"post": {
|
|
"operationId": "wms.picking.setQuantity",
|
|
"tags": [
|
|
"WMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "taskId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "wms.picking.execute",
|
|
"x-kbx-idempotency": "required",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/wms/picking/tasks/{taskId}/start": {
|
|
"post": {
|
|
"operationId": "wms.picking.start",
|
|
"tags": [
|
|
"WMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "taskId",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "wms.picking.execute",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/erp/items/{id}/deactivate": {
|
|
"post": {
|
|
"operationId": "erp.items.deactivate",
|
|
"tags": [
|
|
"ERP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.item.write",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/erp/items/{id}/audit": {
|
|
"get": {
|
|
"operationId": "erp.items.audit",
|
|
"tags": [
|
|
"ERP"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "erp.item.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
},
|
|
"/api/oms/orders/{id}": {
|
|
"get": {
|
|
"operationId": "oms.orders.get",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
},
|
|
"put": {
|
|
"operationId": "oms.orders.update",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.write",
|
|
"x-kbx-idempotency": "supported",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/oms/orders/{id}/confirm": {
|
|
"post": {
|
|
"operationId": "oms.orders.confirm",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.confirm",
|
|
"x-kbx-idempotency": "required",
|
|
"x-kbx-kind": "command"
|
|
}
|
|
},
|
|
"/api/oms/orders/{id}/audit": {
|
|
"get": {
|
|
"operationId": "oms.orders.audit",
|
|
"tags": [
|
|
"OMS"
|
|
],
|
|
"parameters": [
|
|
{
|
|
"name": "id",
|
|
"in": "path",
|
|
"required": true,
|
|
"schema": {
|
|
"type": "string"
|
|
}
|
|
}
|
|
],
|
|
"responses": {
|
|
"200": {
|
|
"description": "Success"
|
|
},
|
|
"400": {
|
|
"description": "Validation problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"403": {
|
|
"description": "Permission problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"404": {
|
|
"description": "Not found problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"409": {
|
|
"description": "Conflict problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"422": {
|
|
"description": "Business problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"500": {
|
|
"description": "System problem",
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"$ref": "#/components/schemas/KbxProblem"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-permission": "oms.order.read",
|
|
"x-kbx-idempotency": "none",
|
|
"x-kbx-kind": "query"
|
|
}
|
|
}
|
|
},
|
|
"components": {
|
|
"schemas": {
|
|
"KbxProblem": {
|
|
"$schema": "https://json-schema.org/draft/2020-12/schema",
|
|
"$id": "https://kbx.local/contracts/problems/kbx.problem.schema.json",
|
|
"title": "KBX Problem",
|
|
"oneOf": [
|
|
{
|
|
"$ref": "#/$defs/validation"
|
|
},
|
|
{
|
|
"$ref": "#/$defs/businessRule"
|
|
},
|
|
{
|
|
"$ref": "#/$defs/conflict"
|
|
},
|
|
{
|
|
"$ref": "#/$defs/permission"
|
|
},
|
|
{
|
|
"$ref": "#/$defs/notFound"
|
|
},
|
|
{
|
|
"$ref": "#/$defs/integration"
|
|
},
|
|
{
|
|
"$ref": "#/$defs/system"
|
|
}
|
|
],
|
|
"$defs": {
|
|
"base": {
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"title"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"type": "string"
|
|
},
|
|
"title": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"detail": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"correlationId": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
}
|
|
}
|
|
},
|
|
"action": {
|
|
"type": "object",
|
|
"required": [
|
|
"id",
|
|
"label"
|
|
],
|
|
"properties": {
|
|
"id": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"label": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"validationError": {
|
|
"type": "object",
|
|
"required": [
|
|
"code",
|
|
"message"
|
|
],
|
|
"properties": {
|
|
"field": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"rowKey": {
|
|
"type": [
|
|
"string",
|
|
"null"
|
|
]
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"message": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
}
|
|
},
|
|
"additionalProperties": false
|
|
},
|
|
"validation": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/$defs/base"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"errors"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"const": "validation"
|
|
},
|
|
"errors": {
|
|
"type": "array",
|
|
"minItems": 1,
|
|
"items": {
|
|
"$ref": "#/$defs/validationError"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"businessRule": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/$defs/base"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"code"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"const": "business-rule"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"actions": {
|
|
"type": "array",
|
|
"items": {
|
|
"$ref": "#/$defs/action"
|
|
}
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"conflict": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/$defs/base"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"code"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"const": "conflict"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"currentVersion": {
|
|
"type": [
|
|
"integer",
|
|
"null"
|
|
],
|
|
"minimum": 1
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"permission": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/$defs/base"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"code"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"const": "permission"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"notFound": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/$defs/base"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"code"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"const": "not-found"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"integration": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/$defs/base"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"code",
|
|
"retryable"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"const": "integration"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"retryable": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
},
|
|
"system": {
|
|
"allOf": [
|
|
{
|
|
"$ref": "#/$defs/base"
|
|
},
|
|
{
|
|
"type": "object",
|
|
"required": [
|
|
"type",
|
|
"code",
|
|
"correlationId"
|
|
],
|
|
"properties": {
|
|
"type": {
|
|
"const": "system"
|
|
},
|
|
"code": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"correlationId": {
|
|
"type": "string",
|
|
"minLength": 1
|
|
},
|
|
"retryable": {
|
|
"type": "boolean"
|
|
}
|
|
}
|
|
}
|
|
]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"x-kbx-source-sha256": "8a8008b0eca039ef22b703b142dd7fa2efeaf5b14784ba9f3a954f656a1a0c8f"
|
|
}
|