Files
KArtSell.Aegis/docs/Design/kbx-foundation-v36/governance/baselines/v15/api-manifest.json
T

519 lines
12 KiB
JSON

{
"schemaVersion": "1.0",
"apiVersion": "1.0.0",
"sourceSha256": "755cce76d76e9077014434dea59a8dc02cf2017a654befa79c119543d425ff2e",
"operationCount": 46,
"operations": [
{
"method": "POST",
"path": "/api/common/ai/ask",
"permission": "common.ai.use",
"id": "common.ai.ask",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/imports/sessions/{sessionId:guid}/commit",
"permission": "imports.execute",
"id": "common.imports.commit",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/imports/sessions",
"permission": "imports.execute",
"id": "common.imports.createSession",
"kind": "upload",
"idempotency": "supported",
"successStatuses": [
200
],
"contentType": "multipart/form-data"
},
{
"method": "GET",
"path": "/api/imports/sessions/{sessionId:guid}/errors.xlsx",
"permission": "imports.execute",
"id": "common.imports.errorWorkbook",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
],
"responseType": "blob"
},
{
"method": "GET",
"path": "/api/imports/sessions/{sessionId:guid}",
"permission": "imports.execute",
"id": "common.imports.getSession",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "PUT",
"path": "/api/imports/sessions/{sessionId:guid}/mapping",
"permission": "imports.execute",
"id": "common.imports.saveMapping",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/imports/sessions/{sessionId:guid}/saved-mappings",
"permission": "imports.execute",
"id": "common.imports.saveNamedMapping",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
204
]
},
{
"method": "GET",
"path": "/api/imports/{importType}/template",
"permission": "imports.execute",
"id": "common.imports.template",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
],
"responseType": "blob"
},
{
"method": "POST",
"path": "/api/imports/sessions/{sessionId:guid}/validate",
"permission": "imports.execute",
"id": "common.imports.validate",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/operations/work-items/claim",
"permission": "common.operations.claim",
"id": "common.operations.claim",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/operations/work-items/resolve",
"permission": "common.operations.resolve",
"id": "common.operations.resolve",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/operations/work-items/{id:guid}/retry",
"permission": "common.operations.retry",
"id": "common.operations.retry",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/operations/work-items",
"permission": "common.operations.read",
"id": "common.operations.search",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/reconcile/items/create-exceptions",
"permission": "common.operations.create",
"id": "common.reconcile.createExceptions",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/reconcile/items",
"permission": "common.reconcile.read",
"id": "common.reconcile.search",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/kbx/runtime/notice",
"permission": "common.runtime.read",
"id": "common.runtime.notice",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/kbx/runtime/notifications/{Id}/read",
"permission": "common.runtime.read",
"id": "common.runtime.notificationRead",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
204
]
},
{
"method": "GET",
"path": "/api/kbx/runtime/notifications",
"permission": "common.runtime.read",
"id": "common.runtime.notifications",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/kbx/runtime/operations",
"permission": "common.runtime.read",
"id": "common.runtime.operations",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/common/suggestions",
"permission": "common.suggestion.create",
"id": "common.suggestions.submit",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/erp/inventory/{itemId}/locations",
"permission": "erp.inventory.read",
"id": "erp.inventory.locations",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/erp/inventory",
"permission": "erp.inventory.read",
"id": "erp.inventory.search",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/erp/items/{id}",
"permission": "erp.item.read",
"id": "erp.items.get",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/erp/items",
"permission": "erp.item.read",
"id": "erp.items.search",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/lookups/customers/by-code/{code}",
"permission": "oms.order.read",
"id": "lookup.customers.resolveByCode",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/lookups/customers/{id}",
"permission": "oms.order.read",
"id": "lookup.customers.resolveById",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/lookups/customers",
"permission": "oms.order.read",
"id": "lookup.customers.search",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/lookups/items/by-code/{code}",
"permission": "oms.order.read",
"id": "lookup.items.resolveByCode",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/lookups/items/{id}",
"permission": "oms.order.read",
"id": "lookup.items.resolveById",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/lookups/items",
"permission": "oms.order.read",
"id": "lookup.items.search",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/lookups/warehouses/by-code/{code}",
"permission": "oms.order.read",
"id": "lookup.warehouses.resolveByCode",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/lookups/warehouses/{id}",
"permission": "oms.order.read",
"id": "lookup.warehouses.resolveById",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/lookups/warehouses",
"permission": "oms.order.read",
"id": "lookup.warehouses.search",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/oms/claims/{id:guid}/approve",
"permission": "oms.claim.approve",
"id": "oms.claims.approve",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/oms/claims/{id:guid}/complete",
"permission": "oms.claim.process",
"id": "oms.claims.complete",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/oms/claims/{id:guid}/hold",
"permission": "oms.claim.hold",
"id": "oms.claims.hold",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/oms/claims",
"permission": "oms.claim.read",
"id": "oms.claims.search",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/oms/claims/{id:guid}/start",
"permission": "oms.claim.process",
"id": "oms.claims.start",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/oms/orders/register",
"permission": "oms.order.create",
"id": "oms.orders.register",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/oms/orders",
"permission": "oms.order.read",
"id": "oms.orders.search",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/oms/orders/ship",
"permission": "oms.order.ship",
"id": "oms.orders.ship",
"kind": "command",
"idempotency": "required",
"successStatuses": [
200
]
},
{
"method": "GET",
"path": "/api/wms/picking/tasks/{taskId:guid}",
"permission": "wms.picking.execute",
"id": "wms.picking.getTask",
"kind": "query",
"idempotency": "none",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/wms/picking/tasks/{taskId:guid}/exceptions",
"permission": "wms.picking.execute",
"id": "wms.picking.reportException",
"kind": "command",
"idempotency": "required",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/wms/picking/tasks/{taskId:guid}/scan",
"permission": "wms.picking.execute",
"id": "wms.picking.scan",
"kind": "command",
"idempotency": "required",
"successStatuses": [
200,
422
]
},
{
"method": "POST",
"path": "/api/wms/picking/tasks/{taskId:guid}/quantity",
"permission": "wms.picking.execute",
"id": "wms.picking.setQuantity",
"kind": "command",
"idempotency": "required",
"successStatuses": [
200
]
},
{
"method": "POST",
"path": "/api/wms/picking/tasks/{taskId:guid}/start",
"permission": "wms.picking.execute",
"id": "wms.picking.start",
"kind": "command",
"idempotency": "supported",
"successStatuses": [
200
]
}
]
}