# Open Mercato API Version: 0.10.1-develop.7783.1.e04ffd226c Auto-generated OpenAPI definition for all enabled modules. ## Servers - https://pokaz.mcc.commercy.pl/api – Default environment ## GET `/ai_assistant/ai/actions/{id}` Fetch the current state of an AI pending action by id. Returns the tenant-scoped {@link AiPendingAction} addressed by `:id`. Powers the chat UI reconnect/polling path: after a page reload or SSE reconnect the client carries the `pendingActionId` from an earlier `mutation-preview-card` UI part and calls this route to re-hydrate the card. Server-internal fields (`normalizedInput`, `createdByUserId`, `idempotencyKey`) are stripped by a whitelist serializer. Enforces tenant/org scoping via the repository. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Serialized pending action. Never includes normalizedInput, createdByUserId, or idempotencyKey. Content-Type: `application/json` **400** – The `:id` path parameter is not a UUID. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks the `ai_assistant.view` feature. Content-Type: `application/json` **404** – No pending action with the given id is accessible to the caller. Content-Type: `application/json` **500** – Internal runtime failure. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/actions/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/actions/{id}/cancel` Cancel an AI pending action without executing the wrapped tool. Flips a pending AI action from `pending` to `cancelled` and emits the `ai.action.cancelled` event. The tool handler is never invoked. Idempotent: a second call on a row already in `cancelled` status returns 200 with the current row without re-emitting the event. Rows whose `expiresAt` is in the past are flipped to `expired` and returned as 409 `expired` so the client can surface the TTL loss instead of silently masking it as a cancellation. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Cancellation complete (or idempotent replay); body includes the serialized pending action with status `cancelled`. Content-Type: `application/json` **400** – The `:id` path parameter is not a UUID, or the cancel request body is invalid (unknown field, reason exceeds 500 chars, wrong type). Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.view`. Content-Type: `application/json` **404** – Pending action not found in the caller scope. Content-Type: `application/json` **409** – Pending action is not in `pending` status (already confirmed/failed/executing) or has expired. Content-Type: `application/json` **500** – Unexpected server failure during cancel. Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/actions/:id/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/actions/{id}/confirm` Confirm an AI pending action, re-running every server-side check before execution. Re-verifies the full contract from spec §9.4 (status, expiry, agent registration, required features, mutation policy, tool whitelist, attachment tenant scope, record version, and schema drift), flips the pending-action state machine to `executing`, invokes the wrapped tool handler, and persists `executionResult`. Idempotent: a second call on a row already in `confirmed` state returns the prior result without re-executing the handler. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Confirmation complete; body includes the serialized pending action and the mutation result. Content-Type: `application/json` **400** – The `:id` path parameter is not a UUID. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.view`, a required agent feature, tool whitelist, or accesses attachments outside their tenant. Content-Type: `application/json` **404** – Pending action or agent not found in the caller scope. Content-Type: `application/json` **409** – Pending action is not in `pending` status or has expired. Content-Type: `application/json` **412** – Record version changed between propose and confirm, or the input schema no longer accepts the stored payload. Content-Type: `application/json` **500** – Unexpected server failure during confirm. Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/actions/:id/confirm" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/agents` List registered AI agents, filtered by the caller's features. Returns `{ agents: [...] }` — the subset of agents from `ai-agents.generated.ts` that the authenticated caller can invoke based on each agent's `requiredFeatures`. Mirrors the `meta.list_agents` tool handler so backoffice pages (e.g. the playground) can render an agent picker without going through the MCP tool transport. **Tags:** AI Assistant **Requires authentication.** ### Responses **200** – Accessible agent summaries. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **500** – Internal failure while loading the agent registry. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/agents" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/ai_assistant/ai/agents/{agentId}/loop-override` Remove the loop-policy columns from the agent-scoped runtime override row. Nulls out all seven loop columns on the agent-scoped `ai_agent_runtime_overrides` row. Idempotent — returns 200 even when no override exists. Requires `ai_assistant.settings.manage`. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **200** – Loop override cleared (or already absent). Content-Type: `application/json` **400** – Invalid agent id. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.settings.manage`. Content-Type: `application/json` **404** – Unknown agent id. Content-Type: `application/json` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/agents/:agentId/loop-override" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/agents/{agentId}/loop-override` Read the current loop-policy override for this agent, if any. Returns `{ agentId, override }` where `override` is the agent-scoped loop-policy row from `ai_agent_runtime_overrides` (or `null`). Requires `ai_assistant.view`. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **200** – Loop override payload. Content-Type: `application/json` **400** – Invalid agent id. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.view`. Content-Type: `application/json` **404** – Unknown agent id. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/agents/:agentId/loop-override" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/ai_assistant/ai/agents/{agentId}/loop-override` Set (or replace) the tenant-scoped loop-policy override for this agent. Body: loop columns. All fields are nullable/optional; `null` explicitly clears that axis. Validates `loopStopWhenJson` items and `loopActiveToolsJson` membership. Requires `ai_assistant.settings.manage`. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "loopDisabled": null, "loopMaxSteps": null, "loopMaxToolCalls": null, "loopMaxWallClockMs": null, "loopMaxTokens": null, "loopStopWhenJson": null, "loopActiveToolsJson": null } ``` ### Responses **200** – Override persisted. Content-Type: `application/json` **400** – Invalid agent id or validation error. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.settings.manage`. Content-Type: `application/json` **404** – Unknown agent id. Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/agents/:agentId/loop-override" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"loopDisabled\": null, \"loopMaxSteps\": null, \"loopMaxToolCalls\": null, \"loopMaxWallClockMs\": null, \"loopMaxTokens\": null, \"loopStopWhenJson\": null, \"loopActiveToolsJson\": null }" ``` ## GET `/ai_assistant/ai/agents/{agentId}/models` Get the providers and curated models available for the chat-UI picker for this agent Returns all configured providers with their curated model catalogs, filtered to providers that have an API key configured in the current environment. When the agent declares `allowRuntimeOverride: false`, the response reflects that constraint so the UI picker can hide itself. Includes the agent's resolved default provider/model so the picker can render a "(default)" badge next to the right entry. When a tenant-scoped lookup (the allowlist snapshot or the per-agent runtime override) cannot be loaded, the route still answers 200 with a partially resolved provider list and sets `degraded: true` plus a `degradedReason` code, so callers can tell a full entitlement list from a partial one. RBAC: requires the same features as the agent itself (typically `ai_assistant.view`). **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **200** – Providers and curated models available for the agent picker. Empty `providers` array when `allowRuntimeOverride` is false. `degraded` is `false` and `degradedReason` is `null` on a fully resolved response; `degraded: true` with `degradedReason: "tenant_allowlist_unavailable"` means a tenant-scoped lookup failed, so `providers` may be missing the tenant allowlist and/or the per-agent override narrowing — one code covers the whole tenant-scoped block because no client can act differently per source. Clients SHOULD render the list but MUST NOT treat it as the tenant's authoritative entitlement (for example, do not prune a stored model selection against it). Content-Type: `application/json` **401** – Unauthenticated. Content-Type: `application/json` **403** – Caller lacks the agent's required features. Content-Type: `application/json` **404** – Unknown agent id. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/agents/:agentId/models" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/ai_assistant/ai/agents/{agentId}/mutation-policy` Remove the tenant-scoped mutationPolicy override for this agent. Deletes the override row if it exists; subsequent calls fall back to the agent's code-declared policy. Idempotent — returns 200 even when no override exists. Requires `ai_assistant.settings.manage`. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **200** – Override cleared (or already absent). Content-Type: `application/json` **400** – Invalid agent id. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.settings.manage`. Content-Type: `application/json` **404** – Unknown agent id. Content-Type: `application/json` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/agents/:agentId/mutation-policy" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/agents/{agentId}/mutation-policy` Read the effective mutationPolicy for an agent — code-declared value plus any tenant override. Returns `{ agentId, codeDeclared, override }` where `codeDeclared` is the agent's compiled-in `mutationPolicy` and `override` is the persisted tenant-scoped override (or `null`). Requires `ai_assistant.view`. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **200** – Effective mutationPolicy payload. Content-Type: `application/json` **400** – Invalid agent id. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.view`. Content-Type: `application/json` **404** – Unknown agent id. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/agents/:agentId/mutation-policy" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/agents/{agentId}/mutation-policy` Set (or replace) the tenant-scoped mutationPolicy override for this agent. Body: `{ mutationPolicy: "read-only" | "confirm-required" | "destructive-confirm-required", notes? }`. The override MUST NOT escalate beyond the agent's code-declared policy. Escalation attempts are rejected with 400 + `code: "escalation_not_allowed"`. Requires `ai_assistant.settings.manage`. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "mutationPolicy": "read-only" } ``` ### Responses **200** – Override persisted. Content-Type: `application/json` **400** – Invalid agent id, malformed body, or escalation attempt. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.settings.manage`. Content-Type: `application/json` **404** – Unknown agent id. Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/agents/:agentId/mutation-policy" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"mutationPolicy\": \"read-only\" }" ``` ## GET `/ai_assistant/ai/agents/{agentId}/prompt-override` Read the latest prompt-section override for an agent plus recent version history. Returns `{ agentId, override, versions }` where `override` is the latest persisted row (or `null`) and `versions` is the newest-first history capped at 10 rows. Tenant-scoped; requires `ai_assistant.settings.manage`. **Tags:** AI Assistant ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Responses **200** – Latest override + recent version history. Content-Type: `application/json` **400** – Invalid agent id. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.settings.manage`. Content-Type: `application/json` **404** – Unknown agent id. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/agents/:agentId/prompt-override" \ -H "Accept: application/json" ``` ## POST `/ai_assistant/ai/agents/{agentId}/prompt-override` Save a new prompt-section override version for the agent. Persists an additive `{ sections: Record, notes? }` override, allocating the next monotonic version for `(tenant, org, agent)`. Reserved policy keys (`mutationPolicy`, `readOnly`, `allowedTools`, `acceptedMediaTypes`) are rejected with 400 / `reserved_key`. Requires `ai_assistant.settings.manage`. **Tags:** AI Assistant ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agentId | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Override persisted. Returns `{ ok: true, version, updatedAt }`. Content-Type: `application/json` **400** – Invalid agent id, malformed body, or reserved policy key. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.settings.manage`. Content-Type: `application/json` **404** – Unknown agent id. Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/agents/:agentId/prompt-override" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{}" ``` ## POST `/ai_assistant/ai/chat` Stream a chat turn for a registered AI agent Dispatches a chat turn to the focused AI agent identified by `?agent=.`. Enforces agent-level `requiredFeatures`, tool whitelisting, read-only / mutationPolicy, execution-mode compatibility, and attachment media-type policy. The streaming response body uses an AI SDK-compatible `text/event-stream` transport. Optional `?provider=`, `?model=`, and `?baseUrl=` query params let callers override the resolved provider/model/base-URL for this turn (Phase 4a). Provider must be registered and configured; baseUrl must match `AI_RUNTIME_BASEURL_ALLOWLIST` when set. Both are suppressed when the agent declares `allowRuntimeOverride: false`. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | agent | query | any | Required | | provider | query | any | Optional | | model | query | any | Optional | | baseUrl | query | any | Optional | | loopBudget | query | any | Optional | ### Request Body Content-Type: `application/json` ```json { "messages": [ { "role": "user", "content": "string" } ] } ``` ### Responses **200** – Streaming text/event-stream response compatible with AI SDK chat transports. Content-Type: `text/event-stream` **400** – Invalid query param, malformed payload, or message count above the cap. Typed codes: `runtime_override_disabled` (agent has allowRuntimeOverride:false), `provider_unknown` (provider id not registered), `provider_not_configured` (provider registered but no API key in env), `baseurl_not_allowlisted` (baseUrl not in AI_RUNTIME_BASEURL_ALLOWLIST). Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks agent-level or tool-level required features. Content-Type: `application/json` **404** – Unknown agent id. Content-Type: `application/json` **409** – Agent/tool/execution-mode policy violation. Content-Type: `application/json` **500** – Internal runtime failure. Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/chat?agent=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"messages\": [ { \"role\": \"user\", \"content\": \"string\" } ] }" ``` ## GET `/ai_assistant/ai/conversations` List AI chat conversations visible to the caller. Returns `{ items, nextCursor }` for the authenticated caller, ordered by `lastMessageAt` descending. View-only callers receive only their own conversations. Callers with `ai_assistant.conversations.manage` may list conversations across users in the same tenant/organization. The `agent` and `status` filters are optional; `cursor` is the ISO timestamp returned by a previous response. **Tags:** AI Assistant **Requires authentication.** ### Responses **200** – Caller-owned conversation summaries. Content-Type: `application/json` **400** – Invalid query parameters. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks the `ai_assistant.view` feature. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/conversations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/conversations` Idempotently create a new AI chat conversation. If a non-deleted conversation already exists with the supplied `conversationId` for the authenticated caller in this tenant/org, returns the existing summary. Otherwise creates a fresh row and writes the owner-participant row in the same transaction. **Tags:** AI Assistant **Requires authentication.** ### Responses **200** – Existing conversation (idempotent path). Content-Type: `application/json` **201** – Newly created conversation. Content-Type: `application/json` **400** – Invalid request body. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks the `ai_assistant.view` feature. Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/conversations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/ai_assistant/ai/conversations/{conversationId}` Soft-delete a conversation and its messages. View-only callers can delete only their own conversations. Callers with `ai_assistant.conversations.manage` can delete conversations in the same tenant/organization. Marks the conversation row and every undeleted message row with a `deleted_at` timestamp in one transaction. The transcript remains in the database for audit/restore until a future retention worker hard-deletes it. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | ### Responses **200** – Soft-delete acknowledgment. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks the `ai_assistant.view` feature. Content-Type: `application/json` **404** – No conversation accessible to the caller. Content-Type: `application/json` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/conversations/:conversationId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/conversations/{conversationId}` Fetch a conversation summary and recent transcript. Returns `{ conversation, messages, nextCursor }` for the supplied `conversationId`. View-only callers can load only their own conversations. Callers with `ai_assistant.conversations.manage` can load conversations across users in the same tenant/organization. Messages are ordered ascending by `createdAt`. The `before` cursor returns the next older page when paging back through long transcripts. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | ### Responses **200** – Conversation transcript page for the authenticated owner. Content-Type: `application/json` **400** – Invalid path or query parameters. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks the `ai_assistant.view` feature. Content-Type: `application/json` **404** – No conversation accessible to the caller. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/conversations/:conversationId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/ai_assistant/ai/conversations/{conversationId}` Update an existing conversation. Accepts a partial body containing any of `title`, `status`, `pageContext`. Setting `status` to `closed` archives the conversation while keeping its transcript intact. View-only callers can update only their own conversations; conversation managers can update conversations in the same tenant/organization. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | ### Responses **200** – Updated conversation summary. Content-Type: `application/json` **400** – Invalid request body. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks the `ai_assistant.view` feature. Content-Type: `application/json` **404** – No conversation accessible to the caller. Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/conversations/:conversationId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/ai/conversations/{conversationId}/participants` List active participants of a conversation. Returns the list of active (non-revoked) participants for the conversation. Only the conversation owner or a caller with `ai_assistant.conversations.manage` can call this endpoint. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | ### Responses **200** – List of active participants. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks required features. Content-Type: `application/json` **404** – Conversation not found or not accessible. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/conversations/:conversationId/participants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/conversations/{conversationId}/participants` Add a participant to a conversation. Grants a named user read access to the conversation. Requires `ai_assistant.conversations.share`. Only the conversation owner may add participants. If the user was previously revoked, the soft-deleted row is restored. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | ### Responses **201** – Participant added; conversation visibility updated to "shared". Content-Type: `application/json` **400** – Invalid request body. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks required feature or is not the owner. Content-Type: `application/json` **404** – Conversation not found. Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/conversations/:conversationId/participants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/ai_assistant/ai/conversations/{conversationId}/participants/{userId}` Revoke a participant from a conversation (soft-delete). Soft-deletes the participant row. If no active non-owner participants remain, the conversation visibility is reset to "private". Only the conversation owner or a manager may revoke participants. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | conversationId | path | any | Required | | userId | path | any | Required | ### Responses **204** – Participant revoked. **400** – Invalid path parameters. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks required features or is not the owner. Content-Type: `application/json` **404** – Conversation not found. Content-Type: `application/json` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/conversations/:conversationId/participants/:userId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/conversations/import` Import a conversation that previously lived only in browser localStorage. Idempotent: messages with `clientMessageId` already present in the server transcript are skipped and counted in `skippedMessageCount`. New messages are appended with the original `clientMessageId` so subsequent retries continue to dedupe. Up to 100 messages per request. Attachment previews stored as `data:` URLs in the source localStorage record MUST NOT be forwarded to this endpoint; the UI strips them before upload. **Tags:** AI Assistant **Requires authentication.** ### Responses **200** – Import result including imported/skipped counters. Content-Type: `application/json` **400** – Invalid request body. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks the `ai_assistant.view` feature. Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/conversations/import" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/ai/run-object` Run an object-mode AI agent and return the generated object Invokes `runAiAgentObject` server-side for the registered AI agent identified by `agent` (matching "."). Enforces the same `requiredFeatures`, tool whitelisting, mutationPolicy, and attachment media-type policy as the chat dispatcher, but additionally requires the agent to declare `executionMode: "object"`. Returns the generated object in a single JSON response (no streaming). **Tags:** AI Assistant **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "agent": "string", "messages": [ { "role": "user", "content": "string" } ] } ``` ### Responses **200** – Object-mode run completed; response body contains `{ object, usage?, finishReason? }`. Content-Type: `application/json` **400** – Malformed payload or message cap exceeded. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks agent-level or tool-level required features. Content-Type: `application/json` **404** – Unknown agent id. Content-Type: `application/json` **409** – Agent/tool/execution-mode policy violation. Content-Type: `application/json` **422** – Agent does not support object-mode execution. Content-Type: `application/json` **500** – Internal runtime failure. Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/ai/run-object" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"agent\": \"string\", \"messages\": [ { \"role\": \"user\", \"content\": \"string\" } ] }" ``` ## POST `/ai_assistant/chat` Send message to AI agent via SSE stream **Tags:** AI Assistant **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/chat" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/health` Check OpenCode and MCP connection status **Tags:** AI Assistant **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/health" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/mcp-key` Generate MCP API key Generates a persistent `omk_` API key scoped to the calling user's tenant/organization and carrying the caller's own roles, so the key has the same ACL as the user. **Tags:** AI Assistant **Requires authentication.** ### Responses **200** – API key created Content-Type: `application/json` ```json { "id": "string", "name": "string", "keyPrefix": "string", "secret": "string", "tenantId": null, "organizationId": null, "roles": [ "string" ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to create MCP API key Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/mcp-key" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/moderation-flags` List input-moderation audit flags for the current tenant. Returns the append-only `ai_moderation_flags` audit rows (category flags + scores only — never prompt content) for the caller's tenant. Always tenant-scoped; cross-tenant access is impossible. Optionally filtered by `agentId`, `userId`, and a `from`/`to` date window. Paginated (`pageSize` ≤ 100). Requires `ai_assistant.settings.manage`. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | agentId | query | any | Optional | | userId | query | any | Optional | | from | query | any | Optional | | to | query | any | Optional | ### Responses **200** – Paginated moderation-flag rows: `{ items, total, page, pageSize }`. Content-Type: `application/json` **400** – Invalid query parameters. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.settings.manage`. Content-Type: `application/json` **500** – Internal failure. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/moderation-flags?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/route` Route user query to appropriate AI handler **Tags:** AI Assistant **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/route" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/session-key` Generate session key Generates a new session token that can be included in MCP tool calls via the _sessionToken parameter. The token inherits the calling user's roles and organization context. **Tags:** AI Assistant **Requires authentication.** ### Responses **200** – Session key created successfully Content-Type: `application/json` ```json { "sessionToken": "string", "expiresAt": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to create session key Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/session-key" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/ai_assistant/settings` Clear per-tenant AI runtime override Soft-deletes the active per-tenant runtime override. Pass `agentId` to clear only the agent-specific row; omit to clear the tenant-wide default. Gated by `ai_assistant.settings.manage`. Idempotent — returns 200 with `cleared: false` when no active row existed. **Tags:** AI Assistant **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "agentId": null } ``` ### Responses **200** – Returns `{ cleared: boolean }` indicating whether a row was found and removed. Content-Type: `application/json` **401** – Unauthenticated. Content-Type: `application/json` **403** – Caller lacks ai_assistant.settings.manage. Content-Type: `application/json` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/ai_assistant/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"agentId\": null }" ``` ## GET `/ai_assistant/settings` Get AI provider configuration **Tags:** AI Assistant **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/ai_assistant/settings` Upsert per-tenant AI runtime override Creates or updates the per-tenant AI runtime override (provider, model, baseURL). Optionally scoped to a specific agent via `agentId`. Gated by `ai_assistant.settings.manage`. baseURL must match AI_RUNTIME_BASEURL_ALLOWLIST when set. **Tags:** AI Assistant **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "providerId": null, "modelId": null, "baseURL": null, "agentId": null, "allowedOverrideProviders": null, "inputModeration": null } ``` ### Responses **200** – Override saved. Returns the saved row. Content-Type: `application/json` **400** – Validation error: unknown provider, invalid URL, or baseURL not allowlisted. Content-Type: `application/json` **401** – Unauthenticated. Content-Type: `application/json` **403** – Caller lacks ai_assistant.settings.manage. Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/ai_assistant/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"providerId\": null, \"modelId\": null, \"baseURL\": null, \"agentId\": null, \"allowedOverrideProviders\": null, \"inputModeration\": null }" ``` ## DELETE `/ai_assistant/settings/allowlist` Clear per-tenant AI provider/model allowlist Soft-deletes the tenant allowlist row. Tenant overrides revert to env-only enforcement. Idempotent — returns `{ cleared: false }` when no active row existed. **Tags:** AI Assistant **Requires authentication.** ### Responses **200** – Returns `{ cleared: boolean }`. Content-Type: `application/json` **401** – Unauthenticated. Content-Type: `application/json` **403** – Caller lacks ai_assistant.settings.manage. Content-Type: `application/json` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/ai_assistant/settings/allowlist" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/ai_assistant/settings/allowlist` Upsert per-tenant AI provider/model allowlist Persists the per-tenant allowlist of providers and models. The runtime intersects this with the env allowlist (`OM_AI_AVAILABLE_*`) at resolution time. Tenant values that fall outside the env allowlist are rejected with `provider_not_in_env_allowlist` / `model_not_in_env_allowlist` 400 codes. Gated by `ai_assistant.settings.manage`. **Tags:** AI Assistant **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "allowedProviders": null } ``` ### Responses **200** – Allowlist saved. Returns the saved snapshot. Content-Type: `application/json` **400** – Validation error or values outside env allowlist. Content-Type: `application/json` **401** – Unauthenticated. Content-Type: `application/json` **403** – Caller lacks ai_assistant.settings.manage. Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/ai_assistant/settings/allowlist" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"allowedProviders\": null }" ``` ## GET `/ai_assistant/tools` List available MCP tools filtered by user permissions **Tags:** AI Assistant **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/tools" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/ai_assistant/tools/execute` Execute a specific read-only MCP tool by name Mutation tools must use the agent chat or run-object dispatcher and its mutation approval policy. **Tags:** AI Assistant **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` **403** – Mutation tools cannot execute directly, or caller lacks tool permissions. Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/ai_assistant/tools/execute" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/usage/daily` Fetch daily token-usage rollup rows for a date window. Returns aggregated token-usage data from `ai_token_usage_daily` for the given date window. Tenant-scoped. Optionally filtered by `agentId` and/or `modelId`. Requires `ai_assistant.settings.manage`. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | from | query | any | Required | | to | query | any | Required | | agentId | query | any | Optional | | modelId | query | any | Optional | ### Responses **200** – Array of daily rollup rows. Content-Type: `application/json` **400** – Invalid query parameters. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.settings.manage`. Content-Type: `application/json` **500** – Internal failure. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/usage/daily?from=string&to=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/usage/sessions` List per-session token usage totals for a date window. Returns aggregated token-usage data grouped by `session_id` from `ai_token_usage_events` for the given date window. Tenant-scoped. Optionally filtered by `agentId`. Paginated via `limit` / `offset`. Requires `ai_assistant.settings.manage`. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | from | query | any | Required | | to | query | any | Required | | agentId | query | any | Optional | | limit | query | any | Required | | offset | query | any | Required | ### Responses **200** – Array of session-level usage summaries plus pagination metadata. Content-Type: `application/json` **400** – Invalid query parameters. Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.settings.manage`. Content-Type: `application/json` **500** – Internal failure. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/usage/sessions?from=string&to=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/ai_assistant/usage/sessions/{sessionId}` Fetch per-step token usage event rows for a single session. Returns up to 200 raw `ai_token_usage_events` rows for the given `sessionId`, ordered by `created_at ASC, step_index ASC`. Tenant-scoped. Requires `ai_assistant.settings.manage`. **Tags:** AI Assistant **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | sessionId | path | any | Required | ### Responses **200** – Array of per-step event rows for the session. Content-Type: `application/json` **400** – Invalid session id (must be a UUID). Content-Type: `application/json` **401** – Unauthenticated caller. Content-Type: `application/json` **403** – Caller lacks `ai_assistant.settings.manage`. Content-Type: `application/json` **404** – No events found for the given session id in the caller's tenant. Content-Type: `application/json` **500** – Internal failure. Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/ai_assistant/usage/sessions/:sessionId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/api_keys/keys` Delete API key Removes an API key by identifier. The key must belong to the current tenant and fall within the requester organization scope. **Tags:** API Keys **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required. API key identifier to delete | ### Responses **200** – Key deleted successfully Content-Type: `application/json` ```json { "success": true } ``` **400** – Missing or invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Organization outside allowed scope Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Key not found within scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/api_keys/keys?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/api_keys/keys` List API keys Returns paginated API keys visible to the current user, including per-key role assignments and organization context. **Tags:** API Keys **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | ### Responses **200** – Collection of API keys Content-Type: `application/json` ```json { "items": [ { "id": "string", "name": "string", "description": null, "keyPrefix": "string", "organizationId": null, "organizationName": null, "createdAt": "string", "lastUsedAt": null, "expiresAt": null, "roles": [ { "id": "string", "name": null } ] } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **400** – Tenant context missing Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden by organization scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/api_keys/keys" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/api_keys/keys` Create API key Creates a new API key, returning the one-time secret value together with the generated key prefix and scope details. **Tags:** API Keys **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "name": "string", "description": null, "tenantId": null, "organizationId": null, "roles": [], "expiresAt": null } ``` ### Responses **201** – API key created successfully Content-Type: `application/json` ```json { "id": "string", "name": "string", "keyPrefix": "string", "tenantId": null, "organizationId": null, "roles": [ { "id": "string", "name": null } ] } ``` **400** – Invalid payload or missing tenant context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Organization outside allowed scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/api_keys/keys" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"name\": \"string\", \"description\": null, \"tenantId\": null, \"organizationId\": null, \"roles\": [], \"expiresAt\": null }" ``` ## DELETE `/attachments` Delete attachment Removes an uploaded attachment and deletes the stored asset. **Tags:** Attachments **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required | ### Responses **200** – Attachment deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing attachment identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Owner policy denies access Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Attachment or owner is unavailable Content-Type: `application/json` ```json { "error": "string" } ``` **504** – Owner authorization timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/attachments?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/attachments` List attachments for a record Returns uploaded attachments for the given entity record, ordered by newest first. Without both page and pageSize, only the newest 100 attachments are returned; pass page and pageSize to page through the rest. **Tags:** Attachments **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Required. Entity identifier that owns the attachments | | recordId | query | any | Required. Record identifier within the entity | | page | query | any | Optional | | pageSize | query | any | Optional | ### Responses **200** – Attachments found for the record Content-Type: `application/json` ```json { "items": [ { "id": "string", "url": "string", "fileName": "string", "fileSize": 1, "createdAt": "string", "mimeType": null, "content": null } ] } ``` **400** – Missing entity or record identifiers Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Owner policy denies access Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Attachment or owner is unavailable Content-Type: `application/json` ```json { "error": "string" } ``` **504** – Owner authorization timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/attachments?entityId=string&recordId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/attachments` Upload attachment Uploads a new attachment using multipart form-data and stores metadata for later retrieval. **Tags:** Attachments **Requires authentication.** ### Request Body Content-Type: `multipart/form-data` ```text entityId=string recordId=string file=string ``` ### Responses **200** – Attachment stored successfully Content-Type: `application/json` ```json { "ok": true, "item": { "id": "string", "url": "string", "fileName": "string", "fileSize": 1, "content": null } } ``` **400** – Payload validation error Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Attachment violates field constraints Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: multipart/form-data" \ -d "{ \"entityId\": \"string\", \"recordId\": \"string\", \"file\": \"string\" }" ``` ## GET `/attachments/file/{id}` Download or serve attachment file Returns the raw file content for an attachment. Path parameter: {id} - Attachment UUID. Query parameter: ?download=1 - Force file download with Content-Disposition header. Access control is enforced based on partition settings. **Tags:** Attachments ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – File content with appropriate MIME type Content-Type: `application/json` **400** – Missing attachment ID Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized - authentication required for private partitions Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden - insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Attachment or file not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Partition misconfigured Content-Type: `application/json` ```json { "error": "string" } ``` **504** – Owner authorization timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/attachments/file/:id" \ -H "Accept: application/json" ``` ## GET `/attachments/image/{id}` Serve image with optional resizing Returns an image attachment with optional on-the-fly resizing and cropping. Resized images are cached for performance. Only works with image MIME types. Path parameter: {id} - Attachment UUID. Query parameters: ?width=N (1-4000 pixels), ?height=N (1-4000 pixels), ?cropType=cover|contain (resize behavior). **Tags:** Attachments ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Binary image content (Content-Type: image/jpeg, image/png, etc.) Content-Type: `application/json` **400** – Invalid parameters, missing ID, or non-image attachment Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized - authentication required for private partitions Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden - insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Image not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Partition misconfigured or image rendering failed Content-Type: `application/json` ```json { "error": "string" } ``` **504** – Owner authorization timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/attachments/image/:id" \ -H "Accept: application/json" ``` ## GET `/attachments/image/{id}/{slug}` Serve image with optional resizing Returns an image attachment with optional on-the-fly resizing and cropping. Resized images are cached for performance. Only works with image MIME types. Path parameter: {id} - Attachment UUID. Query parameters: ?width=N (1-4000 pixels), ?height=N (1-4000 pixels), ?cropType=cover|contain (resize behavior). **Tags:** Attachments ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | slug | path | any | Required | ### Responses **200** – Binary image content (Content-Type: image/jpeg, image/png, etc.) Content-Type: `application/json` **400** – Invalid parameters, missing ID, or non-image attachment Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized - authentication required for private partitions Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden - insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Image not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Partition misconfigured or image rendering failed Content-Type: `application/json` ```json { "error": "string" } ``` **504** – Owner authorization timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/attachments/image/:id/:slug" \ -H "Accept: application/json" ``` ## GET `/attachments/library` List attachments Returns paginated list of attachments with optional filtering by search term, partition, and tags. Includes available tags and partitions. **Tags:** Attachments **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional. Page number for pagination | | pageSize | query | any | Optional. Number of items per page (max 100) | | search | query | any | Optional. Search by file name (case-insensitive) | | partition | query | any | Optional. Filter by partition code | | tags | query | any | Optional. Filter by tags (comma-separated) | | sortField | query | any | Optional. Field to sort by | | sortDir | query | any | Optional. Sort direction | ### Responses **200** – Attachments list with pagination and metadata Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "fileName": "string", "fileSize": 1, "mimeType": "string", "partitionCode": "string", "partitionTitle": null, "url": null, "createdAt": "string", "tags": [ "string" ], "assignments": [], "content": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1, "availableTags": [ "string" ], "partitions": [ { "code": "string", "title": "string", "description": null, "isPublic": true } ] } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Owner policy denies access Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Attachment or owner is unavailable Content-Type: `application/json` ```json { "error": "string" } ``` **504** – Owner authorization timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/attachments/library?page=1&pageSize=25" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/attachments/library/{id}` Delete attachment Permanently deletes an attachment file from storage and database. Emits CRUD side effects. **Tags:** Attachments **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Attachment deleted successfully Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid attachment ID Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Owner policy denies access Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Attachment not found Content-Type: `application/json` ```json { "error": "string" } ``` **504** – Owner authorization timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/attachments/library/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/attachments/library/{id}` Get attachment details Returns complete details of an attachment including metadata, tags, assignments, and custom fields. **Tags:** Attachments **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Attachment details Content-Type: `application/json` ```json { "item": { "id": "00000000-0000-4000-8000-000000000000", "fileName": "string", "fileSize": 1, "mimeType": "string", "partitionCode": "string", "partitionTitle": null, "tags": [ "string" ], "assignments": [], "content": null, "customFields": null } } ``` **400** – Invalid attachment ID Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Owner policy denies access Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Attachment not found Content-Type: `application/json` ```json { "error": "string" } ``` **504** – Owner authorization timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/attachments/library/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/attachments/library/{id}` Update attachment metadata Updates attachment tags, assignments, and custom fields. Emits CRUD side effects for indexing and events. **Tags:** Attachments **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Attachment updated successfully Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload or attachment ID Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Owner policy denies access Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Attachment not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to save attributes Content-Type: `application/json` ```json { "error": "string" } ``` **504** – Owner authorization timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/attachments/library/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## DELETE `/attachments/partitions` Delete partition Deletes a partition. Default partitions cannot be deleted. Partitions with existing attachments cannot be deleted. **Tags:** Attachments **Requires authentication.** ### Responses **200** – Partition deleted successfully Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid ID or default partition deletion attempt Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Partitions locked in demo mode Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Partition not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Partition in use Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/attachments/partitions` List all attachment partitions Returns all configured attachment partitions with storage settings, OCR configuration, and access control settings. **Tags:** Attachments **Requires authentication.** ### Responses **200** – List of partitions Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "code": "string", "title": "string", "description": null, "isPublic": true, "requiresOcr": true, "ocrModel": null, "configJson": null, "createdAt": null, "updatedAt": null, "envKey": "string" } ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/attachments/partitions` Create new partition Creates a new attachment partition with specified storage and OCR settings. Requires unique partition code. **Tags:** Attachments **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "code": "string", "title": "string", "description": null, "ocrModel": null, "storageDriver": "local", "configJson": null } ``` ### Responses **201** – Partition created successfully Content-Type: `application/json` ```json { "item": { "id": "00000000-0000-4000-8000-000000000000", "code": "string", "title": "string", "description": null, "isPublic": true, "requiresOcr": true, "ocrModel": null, "configJson": null, "createdAt": null, "updatedAt": null, "envKey": "string" } } ``` **400** – Invalid payload or partition code Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Partitions locked in demo mode Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Partition code already exists Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"code\": \"string\", \"title\": \"string\", \"description\": null, \"ocrModel\": null, \"storageDriver\": \"local\", \"configJson\": null }" ``` ## PUT `/attachments/partitions` Update partition Updates an existing partition. Partition code cannot be changed. Title, description, OCR settings, and access control can be modified. **Tags:** Attachments **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "code": "string", "title": "string", "description": null, "ocrModel": null, "storageDriver": "local", "configJson": null, "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Partition updated successfully Content-Type: `application/json` ```json { "item": { "id": "00000000-0000-4000-8000-000000000000", "code": "string", "title": "string", "description": null, "isPublic": true, "requiresOcr": true, "ocrModel": null, "configJson": null, "createdAt": null, "updatedAt": null, "envKey": "string" } } ``` **400** – Invalid payload or code change attempt Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Partitions locked in demo mode Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Partition not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/attachments/partitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"code\": \"string\", \"title\": \"string\", \"description\": null, \"ocrModel\": null, \"storageDriver\": \"local\", \"configJson\": null, \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## POST `/attachments/transfer` Transfer attachments to different record Transfers one or more attachments from one record to another within the same entity type. Updates attachment assignments and metadata to reflect the new record. **Tags:** Attachments **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "attachmentIds": [ "00000000-0000-4000-8000-000000000000" ], "toRecordId": "string" } ``` ### Responses **200** – Attachments transferred successfully Content-Type: `application/json` ```json { "ok": true, "updated": 1 } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Owner policy denies access Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Attachments not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Attachment model missing Content-Type: `application/json` ```json { "error": "string" } ``` **504** – Owner authorization timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/attachments/transfer" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"string\", \"attachmentIds\": [ \"00000000-0000-4000-8000-000000000000\" ], \"toRecordId\": \"string\" }" ``` ## GET `/audit_logs/audit-logs/access` Retrieve access logs Fetches paginated access audit logs scoped to the authenticated user. Tenant administrators can optionally expand the search to other actors or organizations. **Tags:** Audit & Action Logs **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | organizationId | query | any | Optional. Limit results to a specific organization | | actorUserId | query | any | Optional. Filter by actor user id (tenant administrators only) | | resourceKind | query | any | Optional. Restrict to a resource kind such as `order` or `product` | | accessType | query | any | Optional. Access type filter, e.g. `read` or `export` | | page | query | any | Optional. Page number (default 1) | | pageSize | query | any | Optional. Page size (default 50) | | limit | query | any | Optional. Explicit maximum number of records when paginating manually | | before | query | any | Optional. Return logs created before this ISO-8601 timestamp | | after | query | any | Optional. Return logs created after this ISO-8601 timestamp | ### Responses **200** – Access logs returned successfully Content-Type: `application/json` ```json { "items": [ { "id": "string", "resourceKind": "string", "resourceId": "string", "accessType": "string", "actorUserId": null, "actorUserName": null, "tenantId": null, "tenantName": null, "organizationId": null, "organizationName": null, "fields": [ "string" ], "context": null, "createdAt": "string" } ], "canViewTenant": true, "page": 1, "pageSize": 1, "total": 1, "totalPages": 1 } ``` **400** – Invalid filters supplied Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Caller has no resolved tenant scope and is not a superadmin Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/audit_logs/audit-logs/access" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/audit_logs/audit-logs/actions` Fetch action logs Returns recent action audit log entries. Tenant administrators can widen the scope to other actors or organizations, and callers can optionally restrict results to undoable actions. **Tags:** Audit & Action Logs **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | organizationId | query | any | Optional. Limit results to a specific organization | | actorUserId | query | any | Optional. Filter logs created by specific actor IDs (tenant administrators only). Accepts a single UUID or a comma-separated UUID list. | | resourceKind | query | any | Optional. Filter by resource kind (e.g., "order", "product") | | resourceId | query | any | Optional. Filter by resource ID (UUID of the specific record) | | actionType | query | any | Optional. Filter by action type (`create`, `edit`, `delete`, `assign`). Accepts a single value or a comma-separated list. | | fieldName | query | any | Optional. Filter to entries where the given field changed. Accepts a single field name or a comma-separated list. | | includeRelated | query | any | Optional. When `true`, also returns changes to child entities linked via parentResourceKind/parentResourceId | | includeTotal | query | any | Optional. When `true`, the response includes the filtered total count. | | undoableOnly | query | any | Optional. When `true`, only undoable actions are returned | | limit | query | any | Optional. Maximum number of records to return (default 50, max 1000) | | offset | query | any | Optional. Zero-based record offset for pagination (legacy — prefer page/pageSize) | | page | query | any | Optional. Page number (default 1) | | pageSize | query | any | Optional. Page size (default 50, max 200) | | sortField | query | any | Optional. Sort field: `createdAt`, `user`, `action`, `field`, or `source`. | | sortDir | query | any | Optional. Sort direction: `asc` or `desc`. | | before | query | any | Optional. Return actions created before this ISO-8601 timestamp | | after | query | any | Optional. Return actions created after this ISO-8601 timestamp | ### Responses **200** – Action logs retrieved successfully Content-Type: `application/json` ```json { "items": [ { "id": "string", "commandId": "string", "actionLabel": null, "executionState": "done", "actorUserId": null, "actorUserName": null, "tenantId": null, "tenantName": null, "organizationId": null, "organizationName": null, "resourceKind": null, "resourceId": null, "parentResourceKind": null, "parentResourceId": null, "undoToken": null, "createdAt": "string", "updatedAt": "string", "snapshotBefore": null, "snapshotAfter": null, "changes": null, "context": null } ], "canViewTenant": true, "page": 1, "pageSize": 1, "total": 1, "totalPages": 1 } ``` **400** – Invalid filter values Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Caller has no resolved tenant scope and is not a superadmin Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/audit_logs/audit-logs/actions?includeRelated=false&includeTotal=false&undoableOnly=false" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/audit_logs/audit-logs/actions/export` Export action logs as CSV Returns a CSV attachment containing filtered action audit log entries. Tenant administrators can widen the scope to other actors or organizations. **Tags:** Audit & Action Logs **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | organizationId | query | any | Optional. Limit results to a specific organization | | actorUserId | query | any | Optional. Filter logs created by specific actor IDs (tenant administrators only). Accepts a single UUID or a comma-separated UUID list. | | resourceKind | query | any | Optional. Filter by resource kind (e.g., "order", "product") | | resourceId | query | any | Optional. Filter by resource ID (UUID of the specific record) | | actionType | query | any | Optional. Filter by action type (`create`, `edit`, `delete`, `assign`). Accepts a single value or a comma-separated list. | | fieldName | query | any | Optional. Filter to entries where the given field changed. Accepts a single field name or a comma-separated list. | | includeRelated | query | any | Optional. When `true`, also returns changes to child entities linked via parentResourceKind/parentResourceId | | undoableOnly | query | any | Optional. When `true`, only undoable actions are returned | | limit | query | any | Optional. Maximum number of records to export (default 1000, capped at 1000) | | sortField | query | any | Optional. Sort field: `createdAt`, `user`, `action`, `field`, or `source`. | | sortDir | query | any | Optional. Sort direction: `asc` or `desc`. | | before | query | any | Optional. Return actions created before this ISO-8601 timestamp | | after | query | any | Optional. Return actions created after this ISO-8601 timestamp | ### Responses **200** – CSV export generated successfully Content-Type: `application/json` ```json { "file": "csv" } ``` **400** – Invalid filter values Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Caller has no resolved tenant scope and is not a superadmin Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/audit_logs/audit-logs/actions/export?includeRelated=false&undoableOnly=false" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/audit_logs/audit-logs/actions/redo` Redo by action log id Redoes the latest undone command owned by the caller. Requires the action to still be eligible for redo within tenant and organization scope. **Tags:** Audit & Action Logs **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "logId": "string" } ``` ### Responses **200** – Redo executed successfully Content-Type: `application/json` ```json { "ok": true, "logId": null, "undoToken": null } ``` **400** – Log not eligible for redo Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Redo blocked by scope checks Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/audit_logs/audit-logs/actions/redo" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"logId\": \"string\" }" ``` ## POST `/audit_logs/audit-logs/actions/undo` Undo action by token Replays the undo handler registered for a command. The provided undo token must match the latest undoable log entry accessible to the caller. **Tags:** Audit & Action Logs **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "undoToken": "string" } ``` ### Responses **200** – Undo applied successfully Content-Type: `application/json` ```json { "ok": true, "logId": "string" } ``` **400** – Invalid or unavailable undo token Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Undo blocked by organization or tenant scope Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Undo deliberately blocked by a beforeUndo command interceptor. The interceptor chooses the status (any 4xx/5xx) and may replace the body. Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/audit_logs/audit-logs/actions/undo" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"undoToken\": \"string\" }" ``` ## GET `/auth/admin/nav` Resolve backend chrome bootstrap payload Returns the backend chrome payload available to the authenticated administrator after applying scope, RBAC, role defaults, and personal sidebar preferences. **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Backend chrome payload Content-Type: `application/json` ```json { "brand": null, "groups": [ { "name": "string", "items": [ { "href": "string", "title": "string" } ] } ], "settingsSections": [ { "id": "string", "label": "string", "items": [ { "id": "string", "label": "string", "href": "string" } ] } ], "settingsPathPrefixes": [ "string" ], "profileSections": [ { "id": "string", "label": "string", "items": [ { "id": "string", "label": "string", "href": "string" } ] } ], "profilePathPrefixes": [ "string" ], "grantedFeatures": [ "string" ], "roles": [ "string" ], "currentOrganization": null } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/admin/nav" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/autologin` Auto sign-in using env-configured demo credentials When OM_AUTOLOGIN_EMAIL / OM_AUTOLOGIN_PASSWORD are configured, signs the visitor in with those credentials and redirects into the app. Intended for single-tenant demo instances only. Falls back to the login page when disabled or misconfigured. **Tags:** Authentication & Accounts ### Responses **200** – Success response Content-Type: `application/json` **307** – Redirect into the app (or to /login on failure) Content-Type: `text/html` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/autologin" \ -H "Accept: application/json" ``` ## POST `/auth/feature-check` Check feature grants for the current user Evaluates which of the requested features are available to the signed-in user within the active tenant / organization context. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "features": [ "string" ] } ``` ### Responses **200** – Evaluation result Content-Type: `application/json` ```json { "ok": true, "granted": [ "string" ], "userId": "string" } ``` **400** – Invalid request — features array missing, too large, or contains invalid entries Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/feature-check" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"features\": [ \"string\" ] }" ``` ## GET `/auth/features` List declared feature flags Returns all static features contributed by the enabled modules along with their module source. **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Aggregated feature catalog Content-Type: `application/json` ```json { "items": [ { "id": "string", "title": "string", "module": "string" } ], "modules": [ { "id": "string", "title": "string" } ] } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/features" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/locale` Set locale and redirect Stores the selected locale in a cookie and redirects to a safe local path. **Tags:** Authentication & Accounts ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | locale | query | any | Required. A locale code this tenant serves — one of the `servable` entries returned by `GET /api/translations/locales`. Codes are canonicalized (`de-AT` → `de`). | | redirect | query | any | Optional | ### Responses **200** – Success response Content-Type: `application/json` **302** – Locale cookie set and request redirected Content-Type: `application/json` **400** – Invalid locale Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/locale?locale=string" \ -H "Accept: application/json" ``` ## POST `/auth/locale` Set locale Stores the selected locale in a cookie and returns a JSON success response. **Tags:** Authentication & Accounts ### Request Body Content-Type: `application/json` ```json { "locale": "string" } ``` ### Responses **200** – Locale cookie set Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid locale or malformed request body Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/locale" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"locale\": \"string\" }" ``` ## POST `/auth/login` Authenticate user credentials Validates the submitted credentials and issues a bearer token cookie for subsequent API calls. **Tags:** Authentication & Accounts ### Request Body Content-Type: `application/x-www-form-urlencoded` ```text email=user%40example.com&password=string ``` ### Responses **200** – Authentication succeeded Content-Type: `application/json` ```json { "ok": true, "token": "string", "redirect": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Invalid credentials Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – User lacks required role, or the request was submitted cross-site Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **429** – Too many login attempts Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/login" \ -H "Accept: application/json" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "email=user%40example.com&password=string" ``` ## POST `/auth/logout` Invalidate session and redirect Revokes the session identified by the `auth_token` sid claim and the `session_token` cookie, clears both cookies together with the organization-scope cookies (`om_selected_org`, `om_selected_tenant`), and redirects the browser to the login page. A valid access token is not required, so a logout submitted after the access token expired still revokes the remember-me refresh session. A request that carries neither session cookie is only redirected. **Tags:** Authentication & Accounts ### Responses **201** – Success response Content-Type: `application/json` **307** – Redirect to login after successful logout Content-Type: `text/html` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/logout" \ -H "Accept: application/json" ``` ## GET `/auth/profile` Get current profile Returns the email address, display name, and roles for the signed-in user. The display name is null when unset. **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Profile payload Content-Type: `application/json` ```json { "email": "user@example.com", "name": null, "roles": [ "string" ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – No user binding in the authenticated scope Content-Type: `application/json` ```json { "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/profile" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/profile` Update current profile Updates the email address or password for the signed-in user. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Profile updated Content-Type: `application/json` ```json { "ok": true, "email": "user@example.com" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Interactive session required Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/auth/profile" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## POST `/auth/reset` Send reset email Requests a password reset email for the given account. The endpoint always returns `ok: true` to avoid leaking account existence. **Tags:** Authentication & Accounts ### Request Body Content-Type: `application/x-www-form-urlencoded` ```text email=user%40example.com ``` ### Responses **200** – Reset email dispatched (or ignored for unknown accounts) Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid request origin Content-Type: `application/json` ```json { "error": "string" } ``` **429** – Too many password reset requests Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Password reset email origin is not configured Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/reset" \ -H "Accept: application/json" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "email=user%40example.com" ``` ## POST `/auth/reset/confirm` Complete password reset Validates the reset token and updates the user password. The returned `redirect` carries the resolved user's tenant as a navigation hint (`/login?tenant=...`) so a tenant-bound user lands on the tenant login entry; tenantless users get `/login`. **Tags:** Authentication & Accounts ### Request Body Content-Type: `application/x-www-form-urlencoded` ```text token=string&password=string ``` ### Responses **200** – Password reset succeeded Content-Type: `application/json` ```json { "ok": true, "redirect": "string" } ``` **400** – Invalid token or payload Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **429** – Too many reset confirmation attempts Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/reset/confirm" \ -H "Accept: application/json" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "token=string&password=string" ``` ## POST `/auth/reset/validate` Check whether a password reset token is still usable Reports whether a reset token exists, is unused, and has not expired, so the reset page can render a terminal state instead of a form the token can never submit. The token is never consumed and the response never distinguishes unknown, used, and expired tokens. **Tags:** Authentication & Accounts ### Request Body Content-Type: `application/x-www-form-urlencoded` ```text token=string ``` ### Responses **200** – Token state resolved Content-Type: `application/json` ```json { "ok": true, "valid": true } ``` **429** – Too many token validation attempts Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/reset/validate" \ -H "Accept: application/json" \ -H "Content-Type: application/x-www-form-urlencoded" \ -d "token=string" ``` ## DELETE `/auth/roles` Delete role Deletes a role by identifier. Fails when users remain assigned. **Tags:** Authentication & Accounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required. Role identifier | ### Responses **200** – Role deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Role cannot be deleted Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/auth/roles?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/roles` List roles Returns available roles within the current tenant. Super administrators receive visibility across tenants. **Tags:** Authentication & Accounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | tenantId | query | any | Optional | ### Responses **200** – Role collection Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "usersCount": 1, "tenantId": null, "tenantName": null, "updatedAt": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/roles?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/roles` Create role Creates a new role anchored to the caller's tenant. Non-superadmins cannot target another tenant; supplying a foreign `tenantId` is rejected. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "name": "string" } ``` ### Responses **201** – Role created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"name\": \"string\" }" ``` ## PUT `/auth/roles` Update role Updates mutable fields on an existing role. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Role updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/auth/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/auth/roles/acl` Fetch role ACL Returns the feature and organization assignments associated with a role within the current tenant. **Tags:** Authentication & Accounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | roleId | query | any | Required | | tenantId | query | any | Optional | ### Responses **200** – Role ACL entry Content-Type: `application/json` ```json { "isSuperAdmin": true, "features": [ "string" ], "organizations": null, "updatedAt": null } ``` **400** – Invalid role id Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/roles/acl?roleId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/roles/acl` Update role ACL Replaces the feature list, super admin flag, and optional organization assignments for a role. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "roleId": "00000000-0000-4000-8000-000000000000", "organizations": null } ``` ### Responses **200** – Role ACL updated Content-Type: `application/json` ```json { "ok": true, "sanitized": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient privileges to modify ACL Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/auth/roles/acl" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"roleId\": \"00000000-0000-4000-8000-000000000000\", \"organizations\": null }" ``` ## GET `/auth/session/refresh` Refresh auth cookie from session token (browser) Exchanges an existing `session_token` cookie for a fresh JWT auth cookie and redirects the browser. **Tags:** Authentication & Accounts ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | redirect | query | any | Optional. Absolute or relative URL to redirect after refresh | ### Responses **200** – Success response Content-Type: `application/json` **302** – Redirect to target location when session is valid Content-Type: `text/html` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/session/refresh" \ -H "Accept: application/json" ``` ## POST `/auth/session/refresh` Refresh access token (API/mobile) Exchanges a refresh token for a new JWT access token. Pass the refresh token obtained from login in the request body. **Tags:** Authentication & Accounts ### Request Body Content-Type: `application/json` ```json { "refreshToken": "string" } ``` ### Responses **200** – New access token issued Content-Type: `application/json` ```json { "ok": true, "accessToken": "string", "expiresIn": 1 } ``` **400** – Missing refresh token Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Invalid or expired token Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Request was submitted cross-site Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **429** – Too many refresh attempts Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/session/refresh" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"refreshToken\": \"string\" }" ``` ## DELETE `/auth/sidebar/preferences` Delete a role sidebar variant Removes the role variant for the current tenant + locale. Idempotent. Requires `auth.sidebar.manage`. **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Variant deleted (or never existed) Content-Type: `application/json` ```json { "ok": true, "scope": { "type": "user" } } ``` **400** – Missing roleId query parameter Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing features Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found in current tenant scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/auth/sidebar/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/sidebar/preferences` Get sidebar preferences Returns sidebar customization for the current user (default) or the specified role (`?roleId=…`, requires `auth.sidebar.manage`). **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Current sidebar configuration Content-Type: `application/json` ```json { "locale": "string", "settings": { "version": 1, "groupOrder": [ "string" ], "groupLabels": { "key": "string" }, "itemLabels": { "key": "string" }, "hiddenItems": [ "string" ], "itemOrder": { "key": [ "string" ] } }, "canApplyToRoles": true, "roles": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "hasPreference": true } ], "scope": { "type": "user" }, "updatedAt": null } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing features for role-scope read Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found in current tenant scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/sidebar/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/sidebar/preferences` Update sidebar preferences Updates sidebar configuration. With `scope.type === "user"` (default) writes the calling user's personal preferences and may optionally apply the same settings to selected roles via `applyToRoles[]`. With `scope.type === "role"` writes the named role variant directly (requires `auth.sidebar.manage`); `applyToRoles[]` and `clearRoleIds[]` are rejected in this mode. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Preferences saved Content-Type: `application/json` ```json { "locale": "string", "settings": { "version": 1, "groupOrder": [ "string" ], "groupLabels": { "key": "string" }, "itemLabels": { "key": "string" }, "hiddenItems": [ "string" ], "itemOrder": { "key": [ "string" ] } }, "canApplyToRoles": true, "roles": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "hasPreference": true } ], "scope": { "type": "user" }, "updatedAt": null, "appliedRoles": [ "00000000-0000-4000-8000-000000000000" ], "clearedRoles": [ "00000000-0000-4000-8000-000000000000" ] } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing features for role-wide updates Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found in current tenant scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/auth/sidebar/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## GET `/auth/sidebar/variants` List sidebar variants Returns the named sidebar variants saved by the current user for the current tenant + locale. **Tags:** Authentication & Accounts **Requires authentication.** ### Responses **200** – Variant list Content-Type: `application/json` ```json { "locale": "string", "variants": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "isActive": true, "settings": { "version": 1, "groupOrder": [ "string" ], "groupLabels": { "key": "string" }, "itemLabels": { "key": "string" }, "hiddenItems": [ "string" ], "itemOrder": { "key": [ "string" ] } }, "createdAt": "string", "updatedAt": null } ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/sidebar/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/sidebar/variants` Create a sidebar variant Creates a new variant. If `name` is omitted or blank, an auto-name like "My preferences", "My preferences 2", … is assigned. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Variant created Content-Type: `application/json` ```json { "locale": "string", "variant": { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "isActive": true, "settings": { "version": 1, "groupOrder": [ "string" ], "groupLabels": { "key": "string" }, "itemLabels": { "key": "string" }, "hiddenItems": [ "string" ], "itemOrder": { "key": [ "string" ] } }, "createdAt": "string", "updatedAt": null } } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/sidebar/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## DELETE `/auth/sidebar/variants/{id}` Delete a sidebar variant Soft-deletes the variant (sets deleted_at). **Tags:** Authentication & Accounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Variant deleted Content-Type: `application/json` ```json { "ok": true } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Variant not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/auth/sidebar/variants/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/sidebar/variants/{id}` Get a sidebar variant **Tags:** Authentication & Accounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Variant Content-Type: `application/json` ```json { "locale": "string", "variant": { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "isActive": true, "settings": { "version": 1, "groupOrder": [ "string" ], "groupLabels": { "key": "string" }, "itemLabels": { "key": "string" }, "hiddenItems": [ "string" ], "itemOrder": { "key": [ "string" ] } }, "createdAt": "string", "updatedAt": null } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Variant not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/sidebar/variants/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/sidebar/variants/{id}` Update a sidebar variant Updates the variant's name, settings, and/or isActive flag. Setting `isActive: true` deactivates other variants in the same scope (only one active per user/tenant/locale). **Tags:** Authentication & Accounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Variant updated Content-Type: `application/json` ```json { "locale": "string", "variant": { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "isActive": true, "settings": { "version": 1, "groupOrder": [ "string" ], "groupLabels": { "key": "string" }, "itemLabels": { "key": "string" }, "hiddenItems": [ "string" ], "itemOrder": { "key": [ "string" ] } }, "createdAt": "string", "updatedAt": null } } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Variant not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/auth/sidebar/variants/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## DELETE `/auth/users` Delete user Deletes a user by identifier. Rejected when the target is the last active holder of a protected role in the tenant. Undo support is provided via the command bus. **Tags:** Authentication & Accounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required. User identifier | ### Responses **200** – User deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – User cannot be deleted, or is the last active holder of a protected role Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/auth/users?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/auth/users` List users Non-superadmins with auth.users.list receive a tenant-wide staff directory by default, excluding superadmin accounts. Neither the active organization nor the caller's organization visibility list narrows this default. Directory visibility does not grant access to organization-owned records. Super administrators may scope the response via the topbar tenant and organization selection; without a selected tenant, their list can span tenants. Search matches email, organization name, and role name. Pass organizationId for an exact organization filter, or scopeToActiveOrganization=1 to restrict results to the caller's exact active organization (used by recipient/assignee pickers); when the caller has no active organization, this selects only users with no organization. Both filters apply when supplied together. These are optional list filters, not authorization boundaries. Pass ids=, (max 100) to resolve a known set of users in one request, for example to label a list of foreign keys; it intersects with id and roleId, and a supplied ids value that contains no valid identifier matches nothing. **Tags:** Authentication & Accounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | ids | query | any | Optional. Comma-separated user identifiers, at most 100 | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | name | query | any | Optional | | organizationId | query | any | Optional | | scopeToActiveOrganization | query | any | Optional | | roleIds | query | any | Optional | ### Responses **200** – User collection Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "email": "user@example.com", "name": null, "organizationId": null, "organizationName": null, "tenantId": null, "tenantName": null, "roles": [ "string" ], "isConfirmed": true, "updatedAt": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/users?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/users` Create user Creates a new confirmed user within the specified organization, optional display name, and optional roles. The organization must be within the caller's descendant-expanded organization scope, whether or not roles are sent, and the roles must belong to its tenant and be grantable by the caller. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "email": "user@example.com", "name": null, "organizationId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – User created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload or duplicate email Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Attempted to assign privileged roles, or the organization is outside the caller's organization scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/users" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"email\": \"user@example.com\", \"name\": null, \"organizationId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## PUT `/auth/users` Update user Updates profile fields including display name, organization assignment, credentials, or role memberships. A destination organization must be within the caller's descendant-expanded organization scope. Retained and newly assigned roles must belong to the destination tenant and be grantable by the caller. Setting isConfirmed=false deactivates the account: the user can no longer sign in and every active session is revoked; isConfirmed=true reactivates it. A tenant cannot drop below a protected role's minimum active holder count, so revoking the role from, deactivating, moving, or deleting the last active administrator is rejected. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "name": null } ``` ### Responses **200** – User updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload, duplicate email, or the update would remove the last active holder of a protected role Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Destination organization is outside caller scope, or a retained or assigned role is not grantable Content-Type: `application/json` ```json { "error": "string" } ``` **404** – User or destination organization not found in the caller tenant scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/auth/users" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"name\": null }" ``` ## GET `/auth/users/acl` Fetch user ACL Returns custom ACL overrides for a user, scoped to the requested tenant when supplied and to the actor or target user tenant otherwise. **Tags:** Authentication & Accounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | userId | query | any | Required | | tenantId | query | any | Optional | ### Responses **200** – User ACL entry Content-Type: `application/json` ```json { "hasCustomAcl": true, "isSuperAdmin": true, "features": [ "string" ], "organizations": null, "updatedAt": null } ``` **400** – Invalid user id Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient privileges for the requested tenant scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/users/acl?userId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/auth/users/acl` Update user ACL Updates a per-user ACL override. Omitted super admin, feature, and organization fields preserve their stored values. Authorization evaluates the merged ACL, so a partial request returns 403 when a preserved grant is outside the actor's grantable ACL. An organization-scoped non-super-admin override requires at least one feature grant. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "userId": "00000000-0000-4000-8000-000000000000", "organizations": null } ``` ### Responses **200** – User ACL updated Content-Type: `application/json` ```json { "ok": true, "sanitized": true } ``` **400** – Invalid payload or unresolved tenant scope Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient privileges to modify ACL Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/auth/users/acl" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"userId\": \"00000000-0000-4000-8000-000000000000\", \"organizations\": null }" ``` ## GET `/auth/users/consents` List user consents Returns all consent records for a given user, with integrity verification status. **Tags:** Auth **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | userId | query | any | Required | ### Responses **200** – Consent list returned Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/auth/users/consents?userId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/auth/users/resend-invite` Resend invitation email Resends the invitation email to a user who has not yet set up their password. Generates a new 48-hour setup token and invalidates prior tokens. **Tags:** Authentication & Accounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Invite email sent Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid request origin Content-Type: `application/json` ```json { "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – User already has a password Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Validation error Content-Type: `application/json` ```json { "error": "string" } ``` **429** – Rate limit exceeded Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Invitation email origin is not configured Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/auth/users/resend-invite" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## POST `/business_rules/execute` Execute rules for given context Manually executes applicable business rules for the specified entity type, event, and data. Supports dry-run mode to test rules without executing actions. **Tags:** Business Rules **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityType": "string", "dryRun": false } ``` ### Responses **200** – Rules executed successfully Content-Type: `application/json` ```json { "allowed": true, "executedRules": [ { "ruleId": "string", "ruleName": "string", "conditionResult": true, "executionTime": 1 } ], "totalExecutionTime": 1 } ``` **400** – Invalid request payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Execution error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/business_rules/execute" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityType\": \"string\", \"dryRun\": false }" ``` ## POST `/business_rules/execute/{ruleId}` Execute a specific rule by its database UUID Directly executes a specific business rule identified by its UUID, bypassing the normal entityType/eventType discovery mechanism. Useful for workflows and targeted rule execution. **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | ruleId | path | any | Required. The database UUID of the business rule to execute | ### Request Body Content-Type: `application/json` ```json { "dryRun": false } ``` ### Responses **200** – Rule executed successfully Content-Type: `application/json` ```json { "success": true, "ruleId": "string", "ruleName": "string", "conditionResult": true, "actionsExecuted": null, "executionTime": 1 } ``` **400** – Invalid request payload or rule ID Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Rule not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Execution error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/business_rules/execute/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"dryRun\": false }" ``` ## GET `/business_rules/logs` List rule execution logs Returns rule execution history for the current tenant and organization with filtering and pagination. Useful for audit trails and debugging. **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | ruleId | query | any | Optional | | entityId | query | any | Optional | | entityType | query | any | Optional | | executionResult | query | any | Optional | | executedBy | query | any | Optional | | executedAtFrom | query | any | Optional | | executedAtTo | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Rule execution logs collection Content-Type: `application/json` ```json { "items": [ { "id": "string", "ruleId": "string", "ruleName": "string", "ruleType": "string", "entityId": "00000000-0000-4000-8000-000000000000", "entityType": "string", "executionResult": "SUCCESS", "inputContext": null, "outputContext": null, "errorMessage": null, "executionTimeMs": 1, "executedAt": "string", "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": null, "executedBy": null } ], "total": 1, "totalPages": 1 } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/business_rules/logs?page=1&pageSize=50&sortDir=desc" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/logs/{id}` Get execution log detail Returns detailed information about a specific rule execution, including full context and results. **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Log entry details Content-Type: `application/json` ```json { "id": "string", "rule": { "id": "00000000-0000-4000-8000-000000000000", "ruleId": "string", "ruleName": "string", "ruleType": "string", "entityType": "string" }, "entityId": "00000000-0000-4000-8000-000000000000", "entityType": "string", "executionResult": "SUCCESS", "inputContext": null, "outputContext": null, "errorMessage": null, "executionTimeMs": 1, "executedAt": "string", "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": null, "executedBy": null } ``` **400** – Invalid log id Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Log entry not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/business_rules/logs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/openmercato-call-options` List OpenMercato call action options Returns executable Open Mercato API endpoint options and safe API key profile metadata for business-rule actions. Only API keys whose roles the caller can grant are listed; session and one-time keys are never listed. **Tags:** Business Rules **Requires authentication.** ### Responses **200** – OpenMercato call options Content-Type: `application/json` ```json { "endpoints": [ { "id": "string", "path": "string", "method": "GET", "label": "string", "summary": null, "operationId": null } ], "apiKeys": [ { "id": "string", "name": "string", "keyPrefix": "string", "organizationId": null, "organizationName": null, "roles": [ { "id": "string", "name": null } ] } ] } ``` **400** – Tenant context missing Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing required features Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/business_rules/openmercato-call-options" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/business_rules/rules` Delete business rule Soft deletes a business rule by identifier. **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required. Business rule identifier | ### Responses **200** – Business rule deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Business rule not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/business_rules/rules?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/rules` List business rules Returns business rules for the current tenant and organization with filtering and pagination. **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | ruleId | query | any | Optional | | ruleType | query | any | Optional | | entityType | query | any | Optional | | eventType | query | any | Optional | | enabled | query | any | Optional | | ruleCategory | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Business rules collection Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "ruleId": "string", "ruleName": "string", "description": null, "ruleType": "GUARD", "ruleCategory": null, "entityType": "string", "eventType": null, "enabled": true, "priority": 1, "version": 1, "effectiveFrom": null, "effectiveTo": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string" } ], "total": 1, "totalPages": 1 } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/business_rules/rules?page=1&pageSize=50&sortDir=desc" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/business_rules/rules` Create business rule Creates a new business rule for the current tenant and organization. **Tags:** Business Rules **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "ruleId": "string", "ruleName": "string", "description": null, "ruleType": "GUARD", "ruleCategory": null, "entityType": "string", "eventType": null, "enabled": true, "priority": 100, "version": 1, "effectiveFrom": null, "effectiveTo": null, "tenantId": "string", "organizationId": "string", "createdBy": null, "conditionExpression": null, "successActions": null, "failureActions": null } ``` ### Responses **201** – Business rule created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **409** – A rule with this Rule ID already exists for the tenant Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/business_rules/rules" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"ruleId\": \"string\", \"ruleName\": \"string\", \"description\": null, \"ruleType\": \"GUARD\", \"ruleCategory\": null, \"entityType\": \"string\", \"eventType\": null, \"enabled\": true, \"priority\": 100, \"version\": 1, \"effectiveFrom\": null, \"effectiveTo\": null, \"tenantId\": \"string\", \"organizationId\": \"string\", \"createdBy\": null, \"conditionExpression\": null, \"successActions\": null, \"failureActions\": null }" ``` ## PUT `/business_rules/rules` Update business rule Updates an existing business rule. **Tags:** Business Rules **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "description": null, "ruleCategory": null, "eventType": null, "effectiveFrom": null, "effectiveTo": null, "conditionExpression": null, "successActions": null, "failureActions": null, "id": "string" } ``` ### Responses **200** – Business rule updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Business rule not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/business_rules/rules" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"description\": null, \"ruleCategory\": null, \"eventType\": null, \"effectiveFrom\": null, \"effectiveTo\": null, \"conditionExpression\": null, \"successActions\": null, \"failureActions\": null, \"id\": \"string\" }" ``` ## GET `/business_rules/rules/{id}` Fetch business rule by ID Returns complete details of a business rule including conditions and actions. **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Business rule detail Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "ruleId": "string", "ruleName": "string", "description": null, "ruleType": "GUARD", "ruleCategory": null, "entityType": "string", "eventType": null, "successActions": null, "failureActions": null, "enabled": true, "priority": 1, "version": 1, "effectiveFrom": null, "effectiveTo": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdBy": null, "updatedBy": null, "createdAt": "string", "updatedAt": "string" } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Business rule not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/business_rules/rules/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/business_rules/sets` Delete rule set Soft deletes a rule set by identifier. **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required. Rule set identifier | ### Responses **200** – Rule set deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Rule set not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/business_rules/sets?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/business_rules/sets` List rule sets Returns rule sets for the current tenant and organization with filtering and pagination. **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | setId | query | any | Optional | | enabled | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – Rule sets collection Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "setId": "string", "setName": "string", "description": null, "enabled": true, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdBy": null, "updatedBy": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "totalPages": 1 } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/business_rules/sets?page=1&pageSize=50&sortDir=asc" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/business_rules/sets` Create rule set Creates a new rule set for organizing business rules. **Tags:** Business Rules **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "setId": "string", "setName": "string", "description": null, "enabled": true, "tenantId": "string", "organizationId": "string", "createdBy": null } ``` ### Responses **201** – Rule set created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/business_rules/sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"setId\": \"string\", \"setName\": \"string\", \"description\": null, \"enabled\": true, \"tenantId\": \"string\", \"organizationId\": \"string\", \"createdBy\": null }" ``` ## PUT `/business_rules/sets` Update rule set Updates an existing rule set. **Tags:** Business Rules **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "description": null, "id": "string" } ``` ### Responses **200** – Rule set updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Rule set not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/business_rules/sets" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"description\": null, \"id\": \"string\" }" ``` ## GET `/business_rules/sets/{id}` Get rule set detail Returns detailed information about a specific rule set, including all member rules. **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Rule set details Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "setId": "string", "setName": "string", "description": null, "enabled": true, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdBy": null, "updatedBy": null, "createdAt": "string", "updatedAt": "string", "members": [ { "id": "00000000-0000-4000-8000-000000000000", "ruleId": "00000000-0000-4000-8000-000000000000", "ruleName": "string", "ruleType": "string", "sequence": 1, "enabled": true } ] } ``` **400** – Invalid rule set id Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Rule set not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/business_rules/sets/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/business_rules/sets/{id}/members` Remove rule from set Removes a business rule from a rule set (hard delete). **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | memberId | query | any | Required. Member identifier | ### Responses **200** – Member removed Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Member not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/business_rules/sets/:id/members?memberId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/business_rules/sets/{id}/members` Add rule to set Adds a business rule to a rule set with specified sequence and enabled state. **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "ruleId": "00000000-0000-4000-8000-000000000000", "sequence": 0, "enabled": true } ``` ### Responses **201** – Member added Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Rule set or rule not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Rule already in set Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/business_rules/sets/:id/members" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"ruleId\": \"00000000-0000-4000-8000-000000000000\", \"sequence\": 0, \"enabled\": true }" ``` ## PUT `/business_rules/sets/{id}/members` Update set member Updates sequence or enabled state of a rule set member. **Tags:** Business Rules **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "memberId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Member updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Member not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/business_rules/sets/:id/members" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"memberId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## POST `/catalog/bulk-delete` Start bulk deleting catalog products **Tags:** Product Catalog **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/catalog/bulk-delete" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/categories` Delete category Deletes a category by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Category deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/catalog/categories" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/catalog/categories` List categories Returns a paginated collection of categories scoped to the authenticated organization. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | view | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | status | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated categories Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": null, "description": null, "parentId": null, "parentName": null, "depth": 1, "treePath": "string", "pathLabel": "string", "childCount": 1, "descendantCount": 1, "isActive": true, "updatedAt": null, "organizationId": null, "tenantId": "00000000-0000-4000-8000-000000000000" } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/categories?view=manage&page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/categories` Create category Creates a new product category. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": null, "parentId": null } ``` ### Responses **201** – Category created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/catalog/categories" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"name\": \"string\", \"slug\": null, \"parentId\": null }" ``` ## PUT `/catalog/categories` Update category Updates an existing category by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "slug": null, "parentId": null } ``` ### Responses **200** – Category updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/catalog/categories" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"slug\": null, \"parentId\": null }" ``` ## POST `/catalog/categories/bulk-create` Start bulk creating catalog categories **Tags:** Product Catalog **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/catalog/categories/bulk-create" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/config/omnibus` Read the tenant Omnibus configuration Returns the tenant-scoped Omnibus configuration with defaults applied, or an empty object when it has never been configured. **Tags:** Catalog **Requires authentication.** ### Responses **200** – Tenant Omnibus configuration ({} when unset) Content-Type: `application/json` ```json { "enabled": false, "enabledCountryCodes": [], "noChannelMode": "best_effort", "lookbackDays": 30, "minimizationAxis": "gross", "backfillCoverage": {}, "channels": {} } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/config/omnibus" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/catalog/config/omnibus` Update the tenant Omnibus configuration Shallow-merges the provided top-level fields into the stored tenant configuration (a provided `channels` map replaces the stored one; `null` clears `defaultPresentedPriceKindId`). Member-state derogation fields and `backfillCoverage` are rejected. Enabling requires a resolvable presented price kind and completed backfill coverage for every in-scope EU channel. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "defaultPresentedPriceKindId": null } ``` ### Responses **200** – Merged Omnibus configuration Content-Type: `application/json` ```json { "enabled": false, "enabledCountryCodes": [], "noChannelMode": "best_effort", "lookbackDays": 30, "minimizationAxis": "gross", "backfillCoverage": {}, "channels": {} } ``` **400** – Invalid JSON body or invalid config Content-Type: `application/json` ```json { "error": "Invalid config", "details": { "fieldErrors": { "key": [ "string" ] } } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Backfill required before enabling, or blocked by a mutation guard Content-Type: `application/json` ```json { "field": "enabled", "error": "backfill_required_before_enable", "channels": [ "string" ] } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/catalog/config/omnibus" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"defaultPresentedPriceKindId\": null }" ``` ## GET `/catalog/dictionaries/{key}` Get dictionary entries by key Returns dictionary entries for a specific key (e.g., currency, unit). **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | key | path | any | Required | ### Responses **200** – Dictionary entries Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "entries": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": "string", "color": null, "icon": null } ] } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/dictionaries/:key" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/offers` Delete offer Deletes an offer by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Offer deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/catalog/offers" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/catalog/offers` List offers Returns a paginated collection of offers scoped to the authenticated organization. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | productId | query | any | Optional | | channelId | query | any | Optional | | channelIds | query | any | Optional | | id | query | any | Optional | | search | query | any | Optional | | isActive | query | any | Optional | | withDeleted | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated offers Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "productId": null, "organizationId": null, "tenantId": null, "channelId": null, "title": "string", "description": null, "defaultMediaId": null, "defaultMediaUrl": null, "metadata": null, "isActive": null, "createdAt": null, "updatedAt": null, "product": null, "productChannelPrice": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/offers?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/offers` Create offer Creates a new offer linking a product to a sales channel. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "channelId": "00000000-0000-4000-8000-000000000000", "title": "string", "defaultMediaId": null, "defaultMediaUrl": null, "productId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Offer created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/catalog/offers" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"channelId\": \"00000000-0000-4000-8000-000000000000\", \"title\": \"string\", \"defaultMediaId\": null, \"defaultMediaUrl\": null, \"productId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## PUT `/catalog/offers` Update offer Updates an existing offer by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "defaultMediaId": null, "defaultMediaUrl": null } ``` ### Responses **200** – Offer updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/catalog/offers" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"defaultMediaId\": null, \"defaultMediaUrl\": null }" ``` ## DELETE `/catalog/option-schemas` Delete option schema Deletes an option schema by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Option Schema deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/catalog/option-schemas" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/catalog/option-schemas` List option schemas Returns a paginated collection of option schemas scoped to the authenticated organization. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | id | query | any | Optional | | search | query | any | Optional | | isActive | query | any | Optional | | withDeleted | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated option schemas Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "code": null, "description": null, "schema": null, "metadata": null, "is_active": null, "created_at": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/option-schemas?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/option-schemas` Create option schema Creates a new option schema template for product configurations. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string", "schema": { "options": [ { "code": "string", "label": "string", "inputType": "select" } ] } } ``` ### Responses **201** – Option Schema created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/catalog/option-schemas" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"name\": \"string\", \"schema\": { \"options\": [ { \"code\": \"string\", \"label\": \"string\", \"inputType\": \"select\" } ] } }" ``` ## PUT `/catalog/option-schemas` Update option schema Updates an existing option schema by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Option Schema updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/catalog/option-schemas" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## DELETE `/catalog/price-kinds` Delete price kind Deletes a price kind by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Price Kind deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/catalog/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/catalog/price-kinds` List price kinds Returns a paginated collection of price kinds scoped to the authenticated organization. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | isPromotion | query | any | Optional | | isActive | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated price kinds Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "organization_id": null, "tenant_id": null, "code": "string", "title": "string", "display_mode": null, "currency_code": null, "is_promotion": null, "is_active": null, "created_at": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/price-kinds?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/price-kinds` Create price kind Creates a new price kind for categorizing product prices. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "tenantId": "00000000-0000-4000-8000-000000000000", "code": "string", "title": "string", "displayMode": "excluding-tax" } ``` ### Responses **201** – Price Kind created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/catalog/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"code\": \"string\", \"title\": \"string\", \"displayMode\": \"excluding-tax\" }" ``` ## PUT `/catalog/price-kinds` Update price kind Updates an existing price kind by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Price Kind updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/catalog/price-kinds" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## DELETE `/catalog/prices` Delete price Deletes a price by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Price deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/catalog/prices" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/catalog/prices` List prices Returns a paginated collection of prices scoped to the authenticated organization. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | productId | query | any | Optional | | variantId | query | any | Optional | | offerId | query | any | Optional | | channelId | query | any | Optional | | currencyCode | query | any | Optional | | priceKindId | query | any | Optional | | kind | query | any | Optional | | userId | query | any | Optional | | userGroupId | query | any | Optional | | customerId | query | any | Optional | | customerGroupId | query | any | Optional | | quantity | query | any | Optional | | quantityUnit | query | any | Optional | | withDeleted | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated prices Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "product_id": null, "variant_id": null, "offer_id": null, "currency_code": null, "price_kind_id": null, "kind": null, "min_quantity": null, "max_quantity": null, "unit_price_net": null, "unit_price_gross": null, "tax_rate": null, "tax_amount": null, "channel_id": null, "user_id": null, "user_group_id": null, "customer_id": null, "customer_group_id": null, "metadata": null, "starts_at": null, "ends_at": null, "created_at": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/prices?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/prices` Create price Creates a new price entry for a product or variant. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "currencyCode": "string", "priceKindId": "00000000-0000-4000-8000-000000000000", "taxRateId": null } ``` ### Responses **201** – Price created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/catalog/prices" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"currencyCode\": \"string\", \"priceKindId\": \"00000000-0000-4000-8000-000000000000\", \"taxRateId\": null }" ``` ## PUT `/catalog/prices` Update price Updates an existing price by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "taxRateId": null } ``` ### Responses **200** – Price updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/catalog/prices" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"taxRateId\": null }" ``` ## GET `/catalog/prices/history` List recorded price history entries Returns immutable price history snapshots for one product and/or variant, ordered by recordedAt DESC, id DESC with keyset pagination. At least one of productId or variantId is required (400 otherwise) so every read stays on a scoped index. Monetary values are fixed 4-decimal strings. An invalid cursor returns the first page. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | productId | query | any | Optional | | variantId | query | any | Optional | | priceKindId | query | any | Optional | | channelId | query | any | Optional | | currencyCode | query | any | Optional | | from | query | any | Optional | | to | query | any | Optional | | pageSize | query | any | Optional | | cursor | query | any | Optional | | includeTotal | query | any | Optional | ### Responses **200** – Price history page Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "priceId": "00000000-0000-4000-8000-000000000000", "productId": "00000000-0000-4000-8000-000000000000", "variantId": null, "offerId": null, "channelId": null, "priceKindId": "00000000-0000-4000-8000-000000000000", "priceKindCode": "string", "currencyCode": "string", "unitPriceNet": null, "unitPriceGross": null, "taxRate": null, "taxAmount": null, "minQuantity": null, "maxQuantity": null, "startsAt": null, "endsAt": null, "recordedAt": "string", "changeType": "create", "source": "api", "isAnnounced": true } ], "nextCursor": null } ``` **400** – Invalid query, or neither productId nor variantId provided Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing catalog.price_history.view Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/prices/history?pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/prices/omnibus-preview` Preview the Omnibus reference-price block Resolves the EU Omnibus reference-price block for one product, variant or offer and price kind, using the current active price of that kind as the presented entry. Returns null when Omnibus is disabled for the tenant. Monetary values are fixed 4-decimal strings. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | priceKindId | query | any | Required | | currencyCode | query | any | Required | | productId | query | any | Optional | | variantId | query | any | Optional | | offerId | query | any | Optional | | channelId | query | any | Optional | ### Responses **200** – Omnibus block, or null when Omnibus is disabled Content-Type: `application/json` **400** – Invalid query Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing catalog.price_history.view Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Product, variant, offer or price kind not found in scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/prices/omnibus-preview?priceKindId=00000000-0000-4000-8000-000000000000¤cyCode=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/product-media` List product media Returns a list of media attachments for a specific product. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | productId | query | any | Required | ### Responses **200** – List of product media Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "fileName": "string", "url": "string", "thumbnailUrl": "string" } ] } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/product-media?productId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/product-unit-conversions` Delete product unit conversion Deletes a product unit conversion by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Product unit conversion deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/catalog/product-unit-conversions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/catalog/product-unit-conversions` List product unit conversions Returns a paginated collection of product unit conversions scoped to the authenticated organization. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | id | query | any | Optional | | productId | query | any | Optional | | unitCode | query | any | Optional | | isActive | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated product unit conversions Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "product_id": "00000000-0000-4000-8000-000000000000", "unit_code": "string", "to_base_factor": 1, "sort_order": null, "is_active": null, "metadata": null, "created_at": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/product-unit-conversions?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/product-unit-conversions` Create product unit conversion Creates a product unit conversion. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "productId": "00000000-0000-4000-8000-000000000000", "unitCode": "string", "toBaseFactor": 1 } ``` ### Responses **201** – Product unit conversion created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/catalog/product-unit-conversions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"productId\": \"00000000-0000-4000-8000-000000000000\", \"unitCode\": \"string\", \"toBaseFactor\": 1 }" ``` ## PUT `/catalog/product-unit-conversions` Update product unit conversion Updates an existing product unit conversion by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Product unit conversion updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/catalog/product-unit-conversions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## DELETE `/catalog/products` Delete product Deletes a product by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Product deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/catalog/products" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/catalog/products` List products Returns a paginated collection of products scoped to the authenticated organization. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | id | query | any | Optional | | search | query | any | Optional | | status | query | any | Optional | | isActive | query | any | Optional | | configurable | query | any | Optional | | productType | query | any | Optional | | channelIds | query | any | Optional | | channelId | query | any | Optional | | categoryIds | query | any | Optional | | tagIds | query | any | Optional | | offerId | query | any | Optional | | userId | query | any | Optional | | userGroupId | query | any | Optional | | customerId | query | any | Optional | | customerGroupId | query | any | Optional | | quantity | query | any | Optional | | quantityUnit | query | any | Optional | | priceDate | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | withDeleted | query | any | Optional | | customFieldset | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated products Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "title": null, "subtitle": null, "description": null, "sku": null, "handle": null, "product_type": null, "status_entry_id": null, "primary_currency_code": null, "default_unit": null, "default_sales_unit": null, "default_sales_unit_quantity": null, "uom_rounding_scale": null, "uom_rounding_mode": null, "unit_price_enabled": null, "unit_price_reference_unit": null, "unit_price_base_quantity": null, "default_media_id": null, "default_media_url": null, "weight_value": null, "weight_unit": null, "dimensions": null, "is_configurable": null, "is_active": null, "country_of_origin_code": null, "pkwiu_code": null, "cn_code": null, "hs_code": null, "tax_classification_code": null, "gtu_codes": null, "age_min": null, "is_excise_good": null, "excise_category": null, "requires_prescription": null, "hazmat_class": null, "un_number": null, "hazmat_packing_group": null, "contains_lithium_battery": null, "launch_at": null, "end_of_life_at": null, "available_from": null, "available_until": null, "min_order_qty": null, "max_order_qty": null, "order_qty_increment": null, "requires_shipping": null, "is_quote_only": null, "seo_title": null, "seo_description": null, "canonical_url": null, "metadata": null, "custom_fieldset_code": null, "option_schema_id": null, "created_at": null, "updated_at": null, "pricing": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/products?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/products` Create product Creates a new product in the catalog. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "title": "string", "subtitle": null, "sku": null, "taxRateId": null, "taxRate": null, "productType": "simple", "defaultUnit": null, "defaultSalesUnit": null, "unitPriceReferenceUnit": null, "defaultMediaId": null, "defaultMediaUrl": null, "weightValue": null, "weightUnit": null, "dimensions": null, "optionSchemaId": null, "customFieldsetCode": null, "countryOfOriginCode": null, "pkwiuCode": null, "cnCode": null, "hsCode": null, "taxClassificationCode": null, "gtuCodes": null, "ageMin": null, "exciseCategory": null, "hazmatClass": null, "unNumber": null, "hazmatPackingGroup": null, "launchAt": null, "endOfLifeAt": null, "availableFrom": null, "availableUntil": null, "minOrderQty": null, "maxOrderQty": null, "orderQtyIncrement": null, "seoTitle": null, "seoDescription": null, "canonicalUrl": null } ``` ### Responses **201** – Product created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/catalog/products" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"title\": \"string\", \"subtitle\": null, \"sku\": null, \"taxRateId\": null, \"taxRate\": null, \"productType\": \"simple\", \"defaultUnit\": null, \"defaultSalesUnit\": null, \"unitPriceReferenceUnit\": null, \"defaultMediaId\": null, \"defaultMediaUrl\": null, \"weightValue\": null, \"weightUnit\": null, \"dimensions\": null, \"optionSchemaId\": null, \"customFieldsetCode\": null, \"countryOfOriginCode\": null, \"pkwiuCode\": null, \"cnCode\": null, \"hsCode\": null, \"taxClassificationCode\": null, \"gtuCodes\": null, \"ageMin\": null, \"exciseCategory\": null, \"hazmatClass\": null, \"unNumber\": null, \"hazmatPackingGroup\": null, \"launchAt\": null, \"endOfLifeAt\": null, \"availableFrom\": null, \"availableUntil\": null, \"minOrderQty\": null, \"maxOrderQty\": null, \"orderQtyIncrement\": null, \"seoTitle\": null, \"seoDescription\": null, \"canonicalUrl\": null }" ``` ## PUT `/catalog/products` Update product Updates an existing product by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "subtitle": null, "sku": null, "taxRateId": null, "taxRate": null, "defaultUnit": null, "defaultSalesUnit": null, "unitPriceReferenceUnit": null, "defaultMediaId": null, "defaultMediaUrl": null, "weightValue": null, "weightUnit": null, "dimensions": null, "optionSchemaId": null, "customFieldsetCode": null, "countryOfOriginCode": null, "pkwiuCode": null, "cnCode": null, "hsCode": null, "taxClassificationCode": null, "gtuCodes": null, "ageMin": null, "exciseCategory": null, "hazmatClass": null, "unNumber": null, "hazmatPackingGroup": null, "launchAt": null, "endOfLifeAt": null, "availableFrom": null, "availableUntil": null, "minOrderQty": null, "maxOrderQty": null, "orderQtyIncrement": null, "seoTitle": null, "seoDescription": null, "canonicalUrl": null } ``` ### Responses **200** – Product updated Content-Type: `application/json` ```json { "ok": true, "updatedAt": null } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/catalog/products" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"subtitle\": null, \"sku\": null, \"taxRateId\": null, \"taxRate\": null, \"defaultUnit\": null, \"defaultSalesUnit\": null, \"unitPriceReferenceUnit\": null, \"defaultMediaId\": null, \"defaultMediaUrl\": null, \"weightValue\": null, \"weightUnit\": null, \"dimensions\": null, \"optionSchemaId\": null, \"customFieldsetCode\": null, \"countryOfOriginCode\": null, \"pkwiuCode\": null, \"cnCode\": null, \"hsCode\": null, \"taxClassificationCode\": null, \"gtuCodes\": null, \"ageMin\": null, \"exciseCategory\": null, \"hazmatClass\": null, \"unNumber\": null, \"hazmatPackingGroup\": null, \"launchAt\": null, \"endOfLifeAt\": null, \"availableFrom\": null, \"availableUntil\": null, \"minOrderQty\": null, \"maxOrderQty\": null, \"orderQtyIncrement\": null, \"seoTitle\": null, \"seoDescription\": null, \"canonicalUrl\": null }" ``` ## POST `/catalog/products/bulk-create` Start bulk creating catalog products **Tags:** Product Catalog **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/catalog/products/bulk-create" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/catalog/settings` Read catalog settings **Tags:** Catalog **Requires authentication.** ### Responses **200** – Catalog settings Content-Type: `application/json` ```json { "unitPriceDisplayEnabled": true } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/catalog/settings` Update catalog settings **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "unitPriceDisplayEnabled": true } ``` ### Responses **200** – Updated catalog settings Content-Type: `application/json` ```json { "unitPriceDisplayEnabled": true } ``` **400** – Invalid request body Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/catalog/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"unitPriceDisplayEnabled\": true }" ``` ## GET `/catalog/tags` List product tags Returns a paginated collection of product tags scoped to the authenticated organization. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | search | query | any | Optional | | ids | query | any | Optional. Comma-separated tag ids to return; malformed ids match nothing. | | page | query | any | Optional | | pageSize | query | any | Optional | ### Responses **200** – Paginated product tags Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "slug": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/tags?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/catalog/variants` Delete variant Deletes a variant by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Variant deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/catalog/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/catalog/variants` List variants Returns a paginated collection of variants scoped to the authenticated organization. **Tags:** Catalog **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | id | query | any | Optional | | search | query | any | Optional | | productId | query | any | Optional | | sku | query | any | Optional | | isActive | query | any | Optional | | isDefault | query | any | Optional | | withDeleted | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated variants Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "product_id": null, "name": null, "sku": null, "barcode": null, "gtin_type": null, "hs_code": null, "status_entry_id": null, "is_default": null, "is_active": null, "weight_value": null, "weight_unit": null, "dimensions": null, "metadata": null, "option_values": null, "custom_fieldset_code": null, "default_media_id": null, "default_media_url": null, "created_at": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/catalog/variants?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/catalog/variants` Create variant Creates a new product variant. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "productId": "00000000-0000-4000-8000-000000000000", "gtinType": null, "hsCode": null, "defaultMediaId": null, "defaultMediaUrl": null, "taxRateId": null, "taxRate": null, "customFieldsetCode": null } ``` ### Responses **201** – Variant created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/catalog/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"productId\": \"00000000-0000-4000-8000-000000000000\", \"gtinType\": null, \"hsCode\": null, \"defaultMediaId\": null, \"defaultMediaUrl\": null, \"taxRateId\": null, \"taxRate\": null, \"customFieldsetCode\": null }" ``` ## PUT `/catalog/variants` Update variant Updates an existing variant by id. **Tags:** Catalog **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "gtinType": null, "hsCode": null, "defaultMediaId": null, "defaultMediaUrl": null, "taxRateId": null, "taxRate": null, "customFieldsetCode": null } ``` ### Responses **200** – Variant updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/catalog/variants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"gtinType\": null, \"hsCode\": null, \"defaultMediaId\": null, \"defaultMediaUrl\": null, \"taxRateId\": null, \"taxRate\": null, \"customFieldsetCode\": null }" ``` ## DELETE `/communication_channels/admin/channels/{id}` Admin delete (soft-delete) a tenant-wide communication channel **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Channel deleted **400** – Invalid channel id Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Channel not found or not a tenant-wide channel Content-Type: `application/json` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/communication_channels/admin/channels/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/communication_channels/channels` List communication channels for the current tenant **Tags:** CommunicationChannels **Requires authentication.** ### Responses **200** – Channel list (paginated) Content-Type: `application/json` **400** – Invalid query parameters Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/communication_channels/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/communication_channels/channels/{id}` DELETE /communication_channels/channels/{id} **Tags:** Communication Channels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/communication_channels/channels/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/communication_channels/channels/{id}` Get a single communication channel by id **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Channel detail Content-Type: `application/json` **400** – Invalid channel id Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Channel not found Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/communication_channels/channels/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/communication_channels/channels/{id}/health` Snapshot of channel delivery health (last 24h) **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Health snapshot Content-Type: `application/json` **400** – Invalid channel id Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Channel not found Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/communication_channels/channels/:id/health" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/{id}/import-history` Queue a backlog import for a channel (Spec B § Phase B6) **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "sinceDays": 30, "maxMessages": 1000 } ``` ### Responses **202** – Import job queued; returns { progressJobId } Content-Type: `application/json` **400** – Invalid channel id or unsupported provider Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Channel not found / not accessible Content-Type: `application/json` **409** – Channel is not connected (requires reauth / error) Content-Type: `application/json` **429** – Another import is already running for this channel Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/channels/:id/import-history" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"sinceDays\": 30, \"maxMessages\": 1000 }" ``` ## POST `/communication_channels/channels/{id}/poll-now` Manually trigger a poll cycle for a channel (demo / operator override) **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **202** – Poll job enqueued Content-Type: `application/json` **400** – Invalid channel id Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Channel not found Content-Type: `application/json` **409** – Channel disabled, not connected, or push-driven (never polled) Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/channels/:id/poll-now" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/{id}/push/register` Force-register push delivery for a channel (Spec C § Phase C5) **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **202** – Push registration attempted; check result.pushStatus Content-Type: `application/json` **400** – Invalid id or unsupported provider Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **403** – Missing push.manage feature Content-Type: `application/json` **404** – Channel not found Content-Type: `application/json` **409** – Provider does not support push (IMAP) Content-Type: `application/json` **502** – Provider returned an error during registration Content-Type: `application/json` **503** – Webhook base URL or Pub/Sub topic not configured Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/channels/:id/push/register" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/{id}/set-primary` Mark a per-user channel as primary **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Channel set as primary (or already primary) Content-Type: `application/json` **400** – Invalid channel id Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Channel not found or not owned by current user Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/channels/:id/set-primary" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/{id}/test-send` Diagnostic — send a test message through the channel without persisting **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Test send result Content-Type: `application/json` **400** – Invalid channel id Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **403** – Not allowed to manage this channel Content-Type: `application/json` **404** – Channel or adapter not found Content-Type: `application/json` **409** – Channel not connected Content-Type: `application/json` **422** – Invalid request body Content-Type: `application/json` **502** – Provider error Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/channels/:id/test-send" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/communication_channels/channels/{id}/visibility` Mark your own personal channel as a shared team mailbox (or private again) **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Visibility updated (or already at that value) Content-Type: `application/json` **400** – Invalid channel id Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Channel not found or not owned by current user Content-Type: `application/json` **409** – Optimistic lock conflict Content-Type: `application/json` **422** – Invalid body Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/communication_channels/channels/:id/visibility" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/connect/credentials` Connect a credential-based per-user channel (IMAP/SMTP) **Tags:** CommunicationChannels **Requires authentication.** ### Responses **201** – Channel connected Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **403** – Provider is tenant-scoped — use the tenant connect route Content-Type: `application/json` **404** – Unknown provider Content-Type: `application/json` **409** – Mailbox already connected via another provider Content-Type: `application/json` **422** – Invalid body or credential validation failed Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/channels/connect/credentials" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/channels/connect/tenant-credentials` Connect a tenant-wide credential-based channel (push: FCM/APNs/Expo) **Tags:** CommunicationChannels **Requires authentication.** ### Responses **201** – Channel connected Content-Type: `application/json` **400** – Provider is not tenant-scoped Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Unknown provider Content-Type: `application/json` **422** – Invalid body or credential validation failed Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/channels/connect/tenant-credentials" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/communication_channels/me/channels` List the current user's connected channels **Tags:** CommunicationChannels **Requires authentication.** ### Responses **200** – List of user-owned channels Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/communication_channels/me/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/messages/{messageId}/reactions` Add a reaction to a channel-linked message **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | messageId | path | any | Required | ### Responses **201** – Reaction added Content-Type: `application/json` **400** – Invalid messageId Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Message not found or not accessible Content-Type: `application/json` **409** – Message not channel-linked or duplicate reaction Content-Type: `application/json` **422** – Invalid request body Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/messages/:messageId/reactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/communication_channels/messages/{messageId}/reactions/{reactionId}` Remove a reaction from a channel-linked message **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | messageId | path | any | Required | | reactionId | path | any | Required | ### Responses **204** – Reaction removed **400** – Invalid params Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Reaction not found or not accessible Content-Type: `application/json` **409** – Message not channel-linked Content-Type: `application/json` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/communication_channels/messages/:messageId/reactions/:reactionId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/communication_channels/oauth/{provider}/callback` OAuth callback — exchange code, persist credentials, create per-user channel **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | provider | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` **302** – Redirect back to returnUrl with flash query params Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/communication_channels/oauth/:provider/callback" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/oauth/{provider}/initiate` Start a per-user channel OAuth flow **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | provider | path | any | Required | ### Responses **200** – Authorize URL + state cookie set Content-Type: `application/json` **400** – Invalid provider or unsupported (no OAuth) Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **422** – Invalid request body Content-Type: `application/json` **500** – OAuth state secret missing or state encryption failed Content-Type: `application/json` **502** – Adapter failed to build authorize URL Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/oauth/:provider/initiate" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/send-as-user` Send a message through the current user's own channel **Tags:** CommunicationChannels **Requires authentication.** ### Responses **202** – Message persisted; outbound delivery enqueued Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **403** – Cannot send through a channel you don't own Content-Type: `application/json` **404** – Channel not found Content-Type: `application/json` **409** – Channel in a non-deliverable transitional status Content-Type: `application/json` **422** – Invalid body, or channel requires_reauth / disconnected Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/send-as-user" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/test-seed` Test-only: seed a connected channel, ingest a real inbound message, emit a seeded inbound link, or purge one (env-gated) **Tags:** CommunicationChannels **Requires authentication.** ### Responses **201** – Channel seeded / inbound message emitted Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Test channel seeding disabled (production default), or the requested channel does not belong to the caller Content-Type: `application/json` **422** – Invalid request body Content-Type: `application/json` **500** – Seed failed Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/test-seed" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/communication_channels/threads/{threadId}/assign` Reassign a channel-linked conversation to a different owner **Tags:** CommunicationChannels **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | threadId | path | any | Required | ### Responses **200** – Conversation reassigned (or unchanged) Content-Type: `application/json` **400** – Invalid threadId Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Conversation not channel-linked, or its channel is a personal mailbox owned by another user Content-Type: `application/json` **422** – Invalid request body Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/communication_channels/threads/:threadId/assign" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/communication_channels/webhook/{provider}` Process an inbound channel webhook (Slack, WhatsApp, Email, ...) **Tags:** CommunicationChannels ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | provider | path | any | Required | ### Responses **202** – Webhook accepted for async processing Content-Type: `application/json` **401** – Signature verification failed against every candidate channel Content-Type: `application/json` **404** – Unknown provider Content-Type: `application/json` **413** – Webhook payload too large Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/webhook/:provider" \ -H "Accept: application/json" ``` ## POST `/communication_channels/webhooks/gmail` Gmail Pub/Sub push notification webhook (Spec C § Phase C2) **Tags:** CommunicationChannels ### Responses **204** – Notification verified + history-sync job enqueued **400** – Body not a valid Pub/Sub envelope Content-Type: `application/json` **401** – Invalid JWT or email claim Content-Type: `application/json` **403** – Wrong audience Content-Type: `application/json` **413** – Webhook payload too large Content-Type: `application/json` **503** – Webhook not configured / Google certs unreachable Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/communication_channels/webhooks/gmail" \ -H "Accept: application/json" ``` ## GET `/configs/cache` Get cache statistics Returns detailed cache statistics including total entries and breakdown by cache segments. Requires cache service to be available. **Tags:** Configs **Requires authentication.** ### Responses **200** – Cache statistics Content-Type: `application/json` ```json { "generatedAt": "string", "totalKeys": 1, "segments": [ { "segment": "string", "resource": null, "method": null, "path": null, "keyCount": 1, "keys": [ "string" ] } ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to resolve cache stats Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Cache service unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/configs/cache" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/configs/cache` Purge cache Purges cache entries. Supports two actions: purgeAll (clears entire cache) or purgeSegment (clears specific segment). Returns updated cache statistics after purge. **Tags:** Configs **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "action": "purgeAll" } ``` ### Responses **200** – Cache segment cleared successfully Content-Type: `application/json` ```json { "action": "purgeSegment", "segment": "string", "deleted": 1, "stats": { "generatedAt": "string", "totalKeys": 1, "segments": [ { "segment": "string", "resource": null, "method": null, "path": null, "keyCount": 1, "keys": [ "string" ] } ] } } ``` **400** – Invalid request - missing segment identifier for purgeSegment action Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to purge cache Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Cache service unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/configs/cache" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"action\": \"purgeAll\" }" ``` ## DELETE `/configs/module-telemetry` Clear module telemetry data Development-only endpoint that clears in-memory module telemetry and local process telemetry files. **Tags:** Configs **Requires authentication.** ### Responses **200** – Module telemetry cleared Content-Type: `application/json` ```json { "cleared": true } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden outside development mode Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/configs/module-telemetry" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/configs/module-telemetry` Get module resource usage telemetry Returns in-process module resource attribution for API routes, event subscribers, and queue workers. **Tags:** Configs **Requires authentication.** ### Responses **200** – Module resource usage report Content-Type: `application/json` ```json { "generatedAt": "string", "startedAt": "string", "enabled": true, "bucketIntervalMs": 1, "totals": { "modules": 1, "operations": 1, "calls": 1, "errors": 1, "totalDurationMs": 1, "totalCpuMs": 1, "positiveHeapDeltaBytes": 1, "positiveRssDeltaBytes": 1 }, "thresholds": { "p95DurationMs": 1, "cpuMs": 1, "positiveHeapDeltaBytes": 1, "positiveRssDeltaBytes": 1, "errors": 1 }, "modules": [ { "moduleId": "string", "calls": 1, "errors": 1, "totalDurationMs": 1, "p95DurationMs": 1, "totalCpuMs": 1, "positiveHeapDeltaBytes": 1, "positiveRssDeltaBytes": 1, "surfaces": [ { "surface": "api", "calls": 1, "errors": 1, "totalDurationMs": 1, "p95DurationMs": 1, "totalCpuMs": 1, "positiveHeapDeltaBytes": 1, "positiveRssDeltaBytes": 1 } ], "topOperations": [ { "moduleId": "string", "surface": "api", "operation": "string", "resourceId": null, "calls": 1, "errors": 1, "totalDurationMs": 1, "maxDurationMs": 1, "p95DurationMs": 1, "totalCpuUserMs": 1, "totalCpuSystemMs": 1, "maxCpuMs": 1, "totalHeapDeltaBytes": 1, "positiveHeapDeltaBytes": 1, "maxHeapDeltaBytes": 1, "totalRssDeltaBytes": 1, "positiveRssDeltaBytes": 1, "maxRssDeltaBytes": 1, "firstSeenAt": "string", "lastSeenAt": "string" } ], "candidateReasons": [ "string" ] } ], "candidates": [ { "moduleId": "string", "calls": 1, "errors": 1, "totalDurationMs": 1, "p95DurationMs": 1, "totalCpuMs": 1, "positiveHeapDeltaBytes": 1, "positiveRssDeltaBytes": 1, "surfaces": [ { "surface": "api", "calls": 1, "errors": 1, "totalDurationMs": 1, "p95DurationMs": 1, "totalCpuMs": 1, "positiveHeapDeltaBytes": 1, "positiveRssDeltaBytes": 1 } ], "topOperations": [ { "moduleId": "string", "surface": "api", "operation": "string", "resourceId": null, "calls": 1, "errors": 1, "totalDurationMs": 1, "maxDurationMs": 1, "p95DurationMs": 1, "totalCpuUserMs": 1, "totalCpuSystemMs": 1, "maxCpuMs": 1, "totalHeapDeltaBytes": 1, "positiveHeapDeltaBytes": 1, "maxHeapDeltaBytes": 1, "totalRssDeltaBytes": 1, "positiveRssDeltaBytes": 1, "maxRssDeltaBytes": 1, "firstSeenAt": "string", "lastSeenAt": "string" } ], "candidateReasons": [ "string" ] } ], "buckets": [ { "bucketStart": "string", "bucketEnd": "string", "bucketIntervalMs": 1, "stage": "startup", "partial": true, "totals": { "modules": 1, "calls": 1, "errors": 1, "totalDurationMs": 1, "totalCpuMs": 1, "positiveHeapDeltaBytes": 1, "positiveRssDeltaBytes": 1 }, "modules": [ { "moduleId": "string", "calls": 1, "errors": 1, "totalDurationMs": 1, "p95DurationMs": 1, "totalCpuMs": 1, "positiveHeapDeltaBytes": 1, "positiveRssDeltaBytes": 1, "surfaces": [ { "surface": "api", "calls": 1, "errors": 1, "totalDurationMs": 1, "p95DurationMs": 1, "totalCpuMs": 1, "positiveHeapDeltaBytes": 1, "positiveRssDeltaBytes": 1 } ], "topOperations": [ { "moduleId": "string", "surface": "api", "operation": "string", "resourceId": null, "calls": 1, "errors": 1, "totalDurationMs": 1, "maxDurationMs": 1, "p95DurationMs": 1, "totalCpuUserMs": 1, "totalCpuSystemMs": 1, "maxCpuMs": 1, "totalHeapDeltaBytes": 1, "positiveHeapDeltaBytes": 1, "maxHeapDeltaBytes": 1, "totalRssDeltaBytes": 1, "positiveRssDeltaBytes": 1, "maxRssDeltaBytes": 1, "firstSeenAt": "string", "lastSeenAt": "string" } ], "candidateReasons": [ "string" ] } ] } ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/configs/module-telemetry" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/configs/system-status` Get system health status Returns comprehensive system health information including environment details, version, resource usage, and service connectivity status. **Tags:** Configs **Requires authentication.** ### Responses **200** – System status snapshot Content-Type: `application/json` ```json { "generatedAt": "string", "runtimeMode": "development", "categories": [ { "key": "profiling", "labelKey": "string", "descriptionKey": null, "items": [ { "key": "string", "category": "profiling", "kind": "boolean", "labelKey": "string", "descriptionKey": "string", "docUrl": null, "defaultValue": null, "state": "enabled", "value": null, "normalizedValue": null } ] } ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to load system status Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/configs/system-status" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/configs/system-status` Clear system cache Purges the entire cache for the current tenant. Useful for troubleshooting or forcing fresh data loading. **Tags:** Configs **Requires authentication.** ### Responses **200** – Cache cleared successfully Content-Type: `application/json` ```json { "cleared": true } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to purge cache Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Cache service unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/configs/system-status" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/configs/upgrade-actions` List pending upgrade actions Returns a list of pending upgrade actions for the current version. These are one-time setup tasks that need to be executed after upgrading to a new version. Requires organization and tenant context. **Tags:** Configs **Requires authentication.** ### Responses **200** – List of pending upgrade actions Content-Type: `application/json` ```json { "version": "string", "actions": [ { "id": "string", "version": "string", "message": "string", "ctaLabel": "string", "successMessage": "string", "loadingLabel": "string" } ] } ``` **400** – Missing organization or tenant context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to load upgrade actions Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/configs/upgrade-actions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/configs/upgrade-actions` Execute upgrade action Executes a specific upgrade action by ID. Typically used for one-time setup tasks like seeding example data after version upgrade. Returns execution status and localized success message. **Tags:** Configs **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "actionId": "string" } ``` ### Responses **200** – Upgrade action executed successfully Content-Type: `application/json` ```json { "status": "string", "message": "string", "version": "string" } ``` **400** – Invalid request body or missing context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Upgrade actions are disabled Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to execute upgrade action Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/configs/upgrade-actions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"actionId\": \"string\" }" ``` ## DELETE `/currencies/currencies` Delete currency Deletes a currency by id. **Tags:** Currencies **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Currency deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/currencies/currencies" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/currencies/currencies` List currencies Returns a paginated collection of currencies scoped to the authenticated organization. **Tags:** Currencies **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | isBase | query | any | Optional | | isActive | query | any | Optional | | code | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated currencies Content-Type: `application/json` ```json { "items": [ { "id": "string", "code": "string", "name": "string", "symbol": null, "decimalPlaces": 1, "thousandsSeparator": null, "decimalSeparator": null, "isBase": true, "isActive": true, "createdAt": null, "updatedAt": null, "organizationId": "string", "tenantId": "string" } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/currencies/currencies?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/currencies/currencies` Create currency Creates a new currency. **Tags:** Currencies **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "string", "tenantId": "string", "code": "string", "name": "string", "symbol": null, "thousandsSeparator": null, "decimalSeparator": null } ``` ### Responses **201** – Currency created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/currencies/currencies" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"string\", \"tenantId\": \"string\", \"code\": \"string\", \"name\": \"string\", \"symbol\": null, \"thousandsSeparator\": null, \"decimalSeparator\": null }" ``` ## PUT `/currencies/currencies` Update currency Updates an existing currency by id. **Tags:** Currencies **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "string", "symbol": null, "thousandsSeparator": null, "decimalSeparator": null } ``` ### Responses **200** – Currency updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/currencies/currencies" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"string\", \"symbol\": null, \"thousandsSeparator\": null, \"decimalSeparator\": null }" ``` ## GET `/currencies/currencies/options` List currency options Returns currencies formatted for select inputs. **Tags:** Currencies **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | q | query | any | Optional | | query | query | any | Optional | | search | query | any | Optional | | includeInactive | query | any | Optional | | limit | query | any | Optional | ### Responses **200** – Option list Content-Type: `application/json` ```json { "items": [ { "value": "string", "label": "string" } ] } ``` **400** – Invalid query Content-Type: `application/json` ```json { "items": [] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "items": [] } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/currencies/currencies/options?limit=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/currencies/exchange-rates` Delete exchangerate Deletes an exchange rate by id. **Tags:** Currencies **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – ExchangeRate deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/currencies/exchange-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/currencies/exchange-rates` List exchangerates Returns a paginated collection of exchangerates scoped to the authenticated organization. **Tags:** Currencies **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | fromCurrencyCode | query | any | Optional | | toCurrencyCode | query | any | Optional | | isActive | query | any | Optional | | source | query | any | Optional | | type | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated exchangerates Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "fromCurrencyCode": "string", "toCurrencyCode": "string", "rate": "string", "date": "string", "source": "string", "type": null, "isActive": true, "createdAt": null, "updatedAt": null, "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000" } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/currencies/exchange-rates?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/currencies/exchange-rates` Create exchangerate Creates a new exchange rate. **Tags:** Currencies **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "string", "tenantId": "string", "fromCurrencyCode": "string", "toCurrencyCode": "string", "rate": "string", "type": null } ``` ### Responses **201** – ExchangeRate created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/currencies/exchange-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"string\", \"tenantId\": \"string\", \"fromCurrencyCode\": \"string\", \"toCurrencyCode\": \"string\", \"rate\": \"string\", \"type\": null }" ``` ## PUT `/currencies/exchange-rates` Update exchangerate Updates an existing exchange rate by id. **Tags:** Currencies **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "string", "type": null } ``` ### Responses **200** – ExchangeRate updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/currencies/exchange-rates" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"string\", \"type\": null }" ``` ## DELETE `/currencies/fetch-configs` Delete currency fetch configuration Deletes a currency fetch configuration by id. **Tags:** Currencies **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required. Currency fetch configuration identifier to delete | ### Responses **200** – Currency fetch configuration deleted successfully Content-Type: `application/json` ```json { "success": true } ``` **400** – Bad request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/currencies/fetch-configs?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/currencies/fetch-configs` List currency fetch configurations Returns all currency fetch configurations scoped to the authenticated organization. **Tags:** Currencies **Requires authentication.** ### Responses **200** – A list of currency fetch configurations Content-Type: `application/json` ```json { "configs": [ { "id": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "provider": "string", "isEnabled": true, "syncTime": null, "lastSyncAt": null, "lastSyncStatus": null, "lastSyncMessage": null, "lastSyncCount": null, "config": null, "createdAt": "string", "updatedAt": "string" } ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/currencies/fetch-configs" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/currencies/fetch-configs` Create currency fetch configuration Creates a new currency fetch configuration. **Tags:** Currencies **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "provider": "NBP", "isEnabled": false, "syncTime": null, "config": null } ``` ### Responses **201** – Currency fetch configuration created successfully Content-Type: `application/json` ```json { "config": { "id": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "provider": "string", "isEnabled": true, "syncTime": null, "lastSyncAt": null, "lastSyncStatus": null, "lastSyncMessage": null, "lastSyncCount": null, "config": null, "createdAt": "string", "updatedAt": "string" } } ``` **400** – Bad request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/currencies/fetch-configs" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"provider\": \"NBP\", \"isEnabled\": false, \"syncTime\": null, \"config\": null }" ``` ## PUT `/currencies/fetch-configs` Update currency fetch configuration Updates an existing currency fetch configuration by id. **Tags:** Currencies **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "syncTime": null, "config": null, "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Currency fetch configuration updated successfully Content-Type: `application/json` ```json { "config": { "id": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "provider": "string", "isEnabled": true, "syncTime": null, "lastSyncAt": null, "lastSyncStatus": null, "lastSyncMessage": null, "lastSyncCount": null, "config": null, "createdAt": "string", "updatedAt": "string" } } ``` **400** – Bad request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/currencies/fetch-configs" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"syncTime\": null, \"config\": null, \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## POST `/currencies/fetch-rates` Fetch currency rates Fetches currency exchange rates from configured providers for a specific date. **Tags:** Currencies ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Currency rates fetched successfully Content-Type: `application/json` ```json { "totalFetched": 1, "byProvider": { "key": { "count": 1 } }, "errors": [ "string" ] } ``` **400** – Bad request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "totalFetched": 1, "byProvider": { "key": { "count": 1 } }, "errors": [ "string" ] } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/currencies/fetch-rates" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{}" ``` ## GET `/customer_accounts/admin/demo-accounts` List seeded demo portal accounts (admin) Returns the example-data portal accounts that exist in the caller’s organization and can still be logged into with the credentials the seeding hook created them with. Accounts that were deactivated, left unverified, soft-deleted, or had their password changed are omitted, as is every account when example data was not seeded. **Tags:** Customer Accounts Admin **Requires authentication.** ### Responses **200** – Seeded demo accounts present in the current organization Content-Type: `application/json` ```json { "ok": true, "items": [ { "email": "user@example.com", "password": "string", "roles": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": "string" } ] } ] } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/demo-accounts" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customer_accounts/admin/domain-mappings` Remove a custom domain Removes the domain mapping identified by ?id=. Cache and Traefik routing drain within TTL. **Tags:** CustomerAccounts **Requires authentication.** ### Responses **200** – OK Content-Type: `application/json` ```json { "ok": true } ``` **400** – Bad request Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/domain-mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customer_accounts/admin/domain-mappings` List domain mappings Returns custom-domain mappings for authorized organizations in the current tenant, optionally filtered by organization. **Tags:** CustomerAccounts **Requires authentication.** ### Responses **200** – OK Content-Type: `application/json` ```json { "ok": true, "domainMappings": [ { "id": "00000000-0000-4000-8000-000000000000", "hostname": "string", "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "provider": "traefik", "status": "pending", "verifiedAt": null, "lastDnsCheckAt": null, "dnsFailureReason": null, "tlsFailureReason": null, "tlsRetryCount": 1, "cnameTarget": null, "aRecordTarget": null, "createdAt": "string", "updatedAt": null } ], "config": { "cnameTarget": null, "aRecordTarget": null } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/domain-mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customer_accounts/admin/domain-mappings` Register a custom domain Registers a new custom domain mapping for an organization. Verifies via DNS asynchronously. **Tags:** CustomerAccounts **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "hostname": "string", "organizationId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Created Content-Type: `application/json` ```json { "ok": true, "domainMapping": { "id": "00000000-0000-4000-8000-000000000000", "hostname": "string", "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "provider": "traefik", "status": "pending", "verifiedAt": null, "lastDnsCheckAt": null, "dnsFailureReason": null, "tlsFailureReason": null, "tlsRetryCount": 1, "cnameTarget": null, "aRecordTarget": null, "createdAt": "string", "updatedAt": null } } ``` **400** – Validation error Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **409** – Conflict Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/domain-mappings" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"hostname\": \"string\", \"organizationId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## POST `/customer_accounts/admin/domain-mappings/{id}/health-check` Trigger TLS health check Runs an HTTPS probe to verify Traefik has provisioned a certificate. On success: transitions the mapping to active. **Tags:** CustomerAccounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – OK Content-Type: `application/json` ```json { "ok": true, "domainMapping": { "id": "00000000-0000-4000-8000-000000000000", "hostname": "string", "status": "string", "tlsRetryCount": 1, "tlsFailureReason": null } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/domain-mappings/:id/health-check" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customer_accounts/admin/domain-mappings/{id}/verify` Trigger DNS verification Runs DNS verification (CNAME → A → reverse-resolve fallback) for the domain mapping. Returns diagnostics on failure. **Tags:** CustomerAccounts **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – OK — see status Content-Type: `application/json` ```json { "ok": true, "domainMapping": { "id": "00000000-0000-4000-8000-000000000000", "hostname": "string", "status": "string", "verifiedAt": null, "lastDnsCheckAt": null, "dnsFailureReason": null }, "diagnostics": null } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/domain-mappings/:id/verify" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customer_accounts/admin/roles` List customer roles (admin) Returns all customer roles for the tenant. **Tags:** Customer Accounts Admin ### Responses **200** – Role list Content-Type: `application/json` ```json { "ok": true, "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": "string", "description": null, "isDefault": true, "isSystem": true, "customerAssignable": true, "createdAt": "string", "updatedAt": null } ], "total": 1, "totalPages": 1, "page": 1 } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/roles" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/admin/roles` Create customer role (admin) Creates a new customer role with an empty ACL. **Tags:** Customer Accounts Admin ### Request Body Content-Type: `application/json` ```json { "name": "string", "slug": "string" } ``` ### Responses **201** – Role created Content-Type: `application/json` ```json { "ok": true, "role": { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": "string", "description": null, "isDefault": true, "isSystem": true, "customerAssignable": true, "createdAt": "string" } } ``` **400** – Validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **409** – Slug already exists Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/roles" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"name\": \"string\", \"slug\": \"string\" }" ``` ## DELETE `/customer_accounts/admin/roles/{id}` Delete customer role (admin) Soft deletes a customer role and its ACL. The default role (auto-assigned to new portal users) and roles with assigned users cannot be deleted. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Role deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Default role or has assigned users Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/admin/roles/{id}` Get customer role detail (admin) Returns full customer role details including ACL features. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Role detail with ACL Content-Type: `application/json` ```json { "ok": true, "role": { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": "string", "description": null, "isDefault": true, "isSystem": true, "customerAssignable": true, "createdAt": "string", "updatedAt": null, "acl": { "features": [ "string" ], "isPortalAdmin": true } } } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/admin/roles/{id}` Update customer role (admin) Updates a customer role. System roles are protected from name changes. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Role updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed or system role restriction Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{}" ``` ## PUT `/customer_accounts/admin/roles/{id}/acl` Update customer role ACL (admin) Updates the ACL (features and portal admin flag) for a customer role. Invalidates RBAC cache after update. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "features": [ "string" ] } ``` ### Responses **200** – ACL updated Content-Type: `application/json` ```json { "ok": true, "updatedAt": "string" } ``` **400** – Validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **409** – Stale ACL write (optimistic-lock conflict) Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/roles/00000000-0000-4000-8000-000000000000/acl" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"features\": [ \"string\" ] }" ``` ## GET `/customer_accounts/admin/users` List customer users (admin) Returns a paginated list of customer users with roles. Supports filtering by status, company, role, and search. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | status | query | any | Optional | | customerEntityId | query | any | Optional | | roleId | query | any | Optional | | search | query | any | Optional | ### Responses **200** – Paginated user list Content-Type: `application/json` ```json { "ok": true, "items": [ { "id": "00000000-0000-4000-8000-000000000000", "email": "string", "displayName": "string", "emailVerified": true, "isActive": true, "lockedUntil": null, "lastLoginAt": null, "customerEntityId": null, "personEntityId": null, "organizationId": null, "organizationName": null, "createdAt": "string", "updatedAt": null, "roles": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": "string" } ] } ], "total": 1, "totalPages": 1, "page": 1 } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/users" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/admin/users` Create customer user (admin) Creates a new customer user directly. Staff-initiated, bypasses signup flow. **Tags:** Customer Accounts Admin ### Request Body Content-Type: `application/json` ```json { "email": "user@example.com", "password": "string", "displayName": "string" } ``` ### Responses **201** – User created Content-Type: `application/json` ```json { "ok": true, "user": { "id": "00000000-0000-4000-8000-000000000000", "email": "string", "displayName": "string" } } ``` **400** – Validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **409** – Email already exists Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/users" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"email\": \"user@example.com\", \"password\": \"string\", \"displayName\": \"string\" }" ``` ## GET `/customer_accounts/admin/users-invite` List pending customer invitations (admin) Lists invitations that are still pending — not accepted, not cancelled, and not expired — for the caller's tenant and organization. The invitation token is never returned. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | personEntityId | query | any | Optional | | customerEntityId | query | any | Optional | | email | query | any | Optional | ### Responses **200** – Pending invitations Content-Type: `application/json` ```json { "ok": true, "items": [ { "id": "00000000-0000-4000-8000-000000000000", "email": "string", "displayName": null, "customerEntityId": null, "personEntityId": null, "roleIds": [ "00000000-0000-4000-8000-000000000000" ], "invitedByUserId": null, "expiresAt": "string", "createdAt": "string" } ], "total": 1, "totalPages": 1, "page": 1 } ``` **400** – Validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/users-invite" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/admin/users-invite` Invite customer user (admin) Creates a staff-initiated invitation for a new customer user. The invitedByUserId is set from the staff auth context. **Tags:** Customer Accounts Admin ### Request Body Content-Type: `application/json` ```json { "email": "user@example.com", "roleIds": [ "00000000-0000-4000-8000-000000000000" ] } ``` ### Responses **201** – Invitation created Content-Type: `application/json` ```json { "ok": true, "invitation": { "id": "00000000-0000-4000-8000-000000000000", "email": "string", "customerEntityId": null, "personEntityId": null, "expiresAt": "string" } } ``` **400** – Validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **429** – Too many invitation requests Content-Type: `application/json` ```json { "error": "string" } ``` **502** – Invitation email could not be sent Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/users-invite" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"email\": \"user@example.com\", \"roleIds\": [ \"00000000-0000-4000-8000-000000000000\" ] }" ``` ## DELETE `/customer_accounts/admin/users/{id}` Delete customer user (admin) Soft deletes a customer user and revokes all their active sessions. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – User deleted Content-Type: `application/json` ```json { "ok": true } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/admin/users/{id}` Get customer user detail (admin) Returns full customer user details including CRM links, roles, and active session count. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – User detail Content-Type: `application/json` ```json { "ok": true, "user": { "id": "00000000-0000-4000-8000-000000000000", "email": "string", "displayName": "string", "emailVerified": true, "isActive": true, "lockedUntil": null, "lastLoginAt": null, "failedLoginAttempts": 1, "customerEntityId": null, "personEntityId": null, "createdAt": "string", "updatedAt": null, "roles": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": "string" } ], "activeSessionCount": 1 } } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/admin/users/{id}` Update customer user (admin) Updates a customer user. Staff can update status, lock, CRM links, and roles. Role assignment bypasses customer_assignable check. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "lockedUntil": null, "personEntityId": null, "customerEntityId": null } ``` ### Responses **200** – User updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed or role not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"lockedUntil\": null, \"personEntityId\": null, \"customerEntityId\": null }" ``` ## POST `/customer_accounts/admin/users/{id}/reset-password` Reset customer user password (admin) Allows staff to set a new password for a customer user. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "newPassword": "string" } ``` ### Responses **200** – Password reset Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000/reset-password" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"newPassword\": \"string\" }" ``` ## POST `/customer_accounts/admin/users/{id}/send-reset-link` Send password reset link for customer user (admin) Creates a password reset token for a customer user and returns a reset link URL. The admin must prepend the appropriate portal domain/slug to the relative URL. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Reset link generated Content-Type: `application/json` ```json { "ok": true, "resetLink": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000/send-reset-link" \ -H "Accept: application/json" ``` ## DELETE `/customer_accounts/admin/users/{id}/sessions/{sessionId}` Revoke a customer user session (admin) Allows staff to end one active portal session of a customer user. The customer is signed out of that session on the next request. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | sessionId | path | any | Required | ### Responses **200** – Session revoked Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – User or session not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000/sessions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/admin/users/{id}/verify-email` Verify customer user email (admin) Allows staff to manually mark a customer user email as verified. **Tags:** Customer Accounts Admin ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Email verified Content-Type: `application/json` ```json { "ok": true } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/admin/users/00000000-0000-4000-8000-000000000000/verify-email" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/domain-check` Verify a hostname is allowed for TLS provisioning Called by Traefik before issuing a Let's Encrypt certificate. Requires the X-Domain-Check-Secret header to match DOMAIN_CHECK_SECRET. **Tags:** CustomerAccounts ### Responses **200** – Hostname allowed Content-Type: `application/json` ```json { "ok": true } ``` **403** – Forbidden Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Hostname not registered or not yet verified Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **503** – Server misconfiguration Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/domain-check" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/domain-resolve` Single-host resolve for the Node middleware Internal endpoint used by the portal middleware to populate its in-memory cache. Requires X-Domain-Resolve-Secret header. **Tags:** CustomerAccounts ### Responses **200** – OK Content-Type: `application/json` ```json { "ok": true, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "orgSlug": null, "status": "active" } ``` **400** – Bad request Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **503** – Server misconfiguration Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/domain-resolve" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/domain-resolve/all` Batch warm-up for the Node middleware Returns every active domain mapping in a single payload so the middleware can populate its cache on process start. Requires X-Domain-Resolve-Secret header. **Tags:** CustomerAccounts ### Responses **200** – OK Content-Type: `application/json` ```json { "ok": true, "domains": [ { "hostname": "string", "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "orgSlug": null, "status": "active" } ] } ``` **403** – Forbidden Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **429** – Too many requests Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Server misconfiguration Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/domain-resolve/all" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/email/verify` Verify customer email address Validates the email verification token and marks the email as verified. **Tags:** Customer Authentication ### Request Body Content-Type: `application/json` ```json { "token": "string" } ``` ### Responses **200** – Email verified Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid or expired token Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/email/verify" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"token\": \"string\" }" ``` ## POST `/customer_accounts/invitations/accept` Accept customer invitation Accepts an invitation, creates the user account, assigns roles, and auto-logs in. **Tags:** Customer Authentication ### Request Body Content-Type: `application/json` ```json { "token": "string", "password": "string", "displayName": "string" } ``` ### Responses **201** – Invitation accepted and user created Content-Type: `application/json` ```json { "ok": true, "user": { "id": "00000000-0000-4000-8000-000000000000", "email": "user@example.com", "displayName": "string", "emailVerified": true }, "resolvedFeatures": [ "string" ] } ``` **400** – Invalid or expired invitation Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Request was submitted cross-site Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **409** – An account with this email address already exists Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/invitations/accept" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"token\": \"string\", \"password\": \"string\", \"displayName\": \"string\" }" ``` ## POST `/customer_accounts/login` Authenticate customer credentials Validates customer credentials and issues JWT + session cookies. **Tags:** Customer Authentication ### Request Body Content-Type: `application/json` ```json { "email": "user@example.com", "password": "string" } ``` ### Responses **200** – Login successful Content-Type: `application/json` ```json { "ok": true, "user": { "id": "00000000-0000-4000-8000-000000000000", "email": "user@example.com", "displayName": "string", "emailVerified": true }, "resolvedFeatures": [ "string" ] } ``` **400** – Validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Invalid credentials Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Request was submitted cross-site Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **429** – Too many login attempts Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/login" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"email\": \"user@example.com\", \"password\": \"string\" }" ``` ## POST `/customer_accounts/magic-link/request` Request magic link login Sends a magic link to the customer email. Always returns 200 to prevent enumeration. **Tags:** Customer Authentication ### Request Body Content-Type: `application/json` ```json { "email": "user@example.com" } ``` ### Responses **200** – Request accepted Content-Type: `application/json` ```json { "ok": true } ``` **429** – Too many requests Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/magic-link/request" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"email\": \"user@example.com\" }" ``` ## POST `/customer_accounts/magic-link/verify` Verify magic link token Validates the magic link token, auto-verifies email, and creates a session. **Tags:** Customer Authentication ### Request Body Content-Type: `application/json` ```json { "token": "string" } ``` ### Responses **200** – Login successful Content-Type: `application/json` ```json { "ok": true, "user": { "id": "00000000-0000-4000-8000-000000000000", "email": "user@example.com", "displayName": "string", "emailVerified": true }, "resolvedFeatures": [ "string" ] } ``` **400** – Invalid or expired token Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Account not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Request was submitted cross-site Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/magic-link/verify" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"token\": \"string\" }" ``` ## POST `/customer_accounts/password/reset-confirm` Confirm customer password reset Validates the reset token and sets a new password. Revokes all existing sessions. **Tags:** Customer Authentication ### Request Body Content-Type: `application/json` ```json { "token": "string", "password": "string" } ``` ### Responses **200** – Password reset successful Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid or expired token Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/password/reset-confirm" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"token\": \"string\", \"password\": \"string\" }" ``` ## POST `/customer_accounts/password/reset-request` Request customer password reset Initiates a password reset flow. Always returns 200 to prevent email enumeration. **Tags:** Customer Authentication ### Request Body Content-Type: `application/json` ```json { "email": "user@example.com" } ``` ### Responses **200** – Request accepted Content-Type: `application/json` ```json { "ok": true } ``` **429** – Too many requests Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/password/reset-request" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"email\": \"user@example.com\" }" ``` ## GET `/customer_accounts/portal/events/stream` Subscribe to portal events via SSE (Portal Event Bridge) Long-lived SSE connection that receives server-side events marked with portalBroadcast: true. Events are filtered by the customer's tenant, organization, and recipient user audience. **Tags:** Customer Portal ### Responses **200** – Event stream (text/event-stream) Content-Type: `application/json` **401** – Not authenticated Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/events/stream" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/portal/feature-check` Check customer portal feature access Checks which of the requested features the authenticated customer user has. Used by portal menu injection for feature-gating. **Tags:** Customer Portal ### Request Body Content-Type: `application/json` ```json { "features": [ "string" ] } ``` ### Responses **200** – Feature check result Content-Type: `application/json` ```json { "ok": true, "granted": [ "string" ] } ``` **400** – Invalid request Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/feature-check" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"features\": [ \"string\" ] }" ``` ## POST `/customer_accounts/portal/logout` Customer logout Revokes the current session and clears authentication cookies. **Tags:** Customer Portal ### Responses **200** – Logged out Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/logout" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/portal/nav` Portal sidebar navigation Returns the portal sidebar for the authenticated customer. Items are derived from each portal page's `nav` metadata and filtered by `requireCustomerFeatures` against concrete effective features. **Tags:** Customer Portal ### Responses **200** – Portal sidebar groups Content-Type: `application/json` ```json { "ok": true, "orgSlug": "string", "groups": [ { "id": "main", "items": [ { "id": "string", "label": "string", "href": "string", "order": 1 } ] } ], "grantedFeatures": [ "string" ], "isPortalAdmin": true } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Organization not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/nav" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/portal/notifications` List customer notifications Returns paginated notifications for the authenticated customer user. Dismissed notifications are excluded by default unless ?status=dismissed is specified. **Tags:** Customer Portal ### Responses **200** – Notification list Content-Type: `application/json` ```json { "ok": true, "items": [ { "id": "00000000-0000-4000-8000-000000000000", "type": "string", "title": "string", "body": null, "titleKey": null, "bodyKey": null, "titleVariables": null, "bodyVariables": null, "icon": null, "severity": "info", "status": "unread", "actions": [ { "id": "string", "label": "string" } ], "sourceModule": null, "sourceEntityType": null, "sourceEntityId": null, "linkHref": null, "createdAt": "string", "readAt": null, "actionTaken": null } ], "total": 1, "page": 1, "pageSize": 1 } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/notifications" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/portal/notifications/{id}/dismiss` Dismiss notification Dismisses a single notification for the authenticated customer user. **Tags:** Customer Portal ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Notification dismissed Content-Type: `application/json` ```json { "ok": true } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Notification not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/notifications/00000000-0000-4000-8000-000000000000/dismiss" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/portal/notifications/{id}/read` Mark notification as read Marks a single notification as read for the authenticated customer user. **Tags:** Customer Portal ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Notification marked as read Content-Type: `application/json` ```json { "ok": true } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Notification not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/notifications/00000000-0000-4000-8000-000000000000/read" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/portal/notifications/mark-all-read` Mark all notifications as read Marks all unread notifications as read for the authenticated customer user. **Tags:** Customer Portal ### Responses **200** – All notifications marked as read Content-Type: `application/json` ```json { "ok": true, "count": 1 } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/notifications/mark-all-read" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/portal/notifications/unread-count` Get unread notification count Returns the number of unread notifications for the authenticated customer user. **Tags:** Customer Portal ### Responses **200** – Unread count Content-Type: `application/json` ```json { "ok": true, "unreadCount": 1 } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/notifications/unread-count" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/portal/password-change` Change customer password Changes the authenticated customer user password after verifying the current password. Revokes all existing sessions. **Tags:** Customer Portal ### Request Body Content-Type: `application/json` ```json { "currentPassword": "string", "newPassword": "string" } ``` ### Responses **200** – Password changed Content-Type: `application/json` ```json { "ok": true } ``` **400** – Current password incorrect or validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/password-change" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"currentPassword\": \"string\", \"newPassword\": \"string\" }" ``` ## GET `/customer_accounts/portal/profile` Get customer profile Returns the authenticated customer user profile with roles and permissions. **Tags:** Customer Portal ### Responses **200** – Profile data Content-Type: `application/json` ```json { "ok": true, "user": { "id": "00000000-0000-4000-8000-000000000000", "email": "string", "displayName": "string", "emailVerified": true, "customerEntityId": null, "personEntityId": null, "isActive": true, "lastLoginAt": null, "createdAt": "string" }, "roles": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": "string" } ], "resolvedFeatures": [ "string" ], "isPortalAdmin": true } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/profile" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/portal/profile` Update customer profile Updates the authenticated customer user profile. **Tags:** Customer Portal ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Profile updated Content-Type: `application/json` ```json { "ok": true, "user": { "id": "00000000-0000-4000-8000-000000000000", "email": "string", "displayName": "string" } } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/profile" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{}" ``` ## GET `/customer_accounts/portal/sessions` List customer sessions Returns active sessions for the authenticated customer user. **Tags:** Customer Portal ### Responses **200** – Session list Content-Type: `application/json` ```json { "ok": true, "sessions": [ { "id": "00000000-0000-4000-8000-000000000000", "ipAddress": null, "userAgent": null, "lastUsedAt": null, "createdAt": "string", "expiresAt": "string", "isCurrent": true } ] } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/sessions" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/portal/sessions-refresh` Refresh customer JWT from session token Uses the session cookie to issue a fresh JWT access token. **Tags:** Customer Portal ### Responses **200** – Token refreshed Content-Type: `application/json` ```json { "ok": true, "resolvedFeatures": [ "string" ] } ``` **401** – Invalid session Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/sessions-refresh" \ -H "Accept: application/json" ``` ## DELETE `/customer_accounts/portal/sessions/{id}` Revoke a customer session Revokes a specific session (not the current one). **Tags:** Customer Portal ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Session revoked Content-Type: `application/json` ```json { "ok": true } ``` **400** – Cannot revoke current session Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Session not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/sessions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" ``` ## GET `/customer_accounts/portal/users` List company portal users Lists portal users associated with the same company. Paginated (default pageSize 25, max 100). **Tags:** Customer Portal ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | ### Responses **200** – Paginated user list Content-Type: `application/json` ```json { "ok": true, "users": [ { "id": "00000000-0000-4000-8000-000000000000", "email": "string", "displayName": "string", "emailVerified": true, "isActive": true, "lastLoginAt": null, "createdAt": "string", "roles": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "slug": "string" } ] } ], "total": 1, "totalPages": 1, "page": 1, "pageSize": 1 } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/users" \ -H "Accept: application/json" ``` ## POST `/customer_accounts/portal/users-invite` Invite a user to the company portal Creates an invitation for a new user to join the company portal. **Tags:** Customer Portal ### Request Body Content-Type: `application/json` ```json { "email": "user@example.com", "roleIds": [ "00000000-0000-4000-8000-000000000000" ] } ``` ### Responses **201** – Invitation created Content-Type: `application/json` ```json { "ok": true, "invitation": { "id": "00000000-0000-4000-8000-000000000000", "email": "string", "expiresAt": "string" } } ``` **400** – Validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions or non-assignable role Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **429** – Too many invitation requests Content-Type: `application/json` ```json { "error": "string" } ``` **502** – Invitation email could not be sent Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/users-invite" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"email\": \"user@example.com\", \"roleIds\": [ \"00000000-0000-4000-8000-000000000000\" ] }" ``` ## DELETE `/customer_accounts/portal/users/{id}` Delete a company portal user Soft deletes a portal user and revokes all their sessions. **Tags:** Customer Portal ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – User deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Cannot delete self Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/users/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" ``` ## PUT `/customer_accounts/portal/users/{id}/roles` Update portal user roles Assigns new roles to a company portal user. **Tags:** Customer Portal ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "roleIds": [ "00000000-0000-4000-8000-000000000000" ] } ``` ### Responses **200** – Roles updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – User not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customer_accounts/portal/users/00000000-0000-4000-8000-000000000000/roles" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"roleIds\": [ \"00000000-0000-4000-8000-000000000000\" ] }" ``` ## POST `/customer_accounts/signup` Register a new customer account Accepts a signup request and always returns 202 to prevent account enumeration. **Tags:** Customer Authentication ### Request Body Content-Type: `application/json` ```json { "email": "user@example.com", "password": "string", "displayName": "string" } ``` ### Responses **202** – Signup accepted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed or invalid request origin Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **429** – Too many signup attempts Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Signup email origin is not configured Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customer_accounts/signup" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"email\": \"user@example.com\", \"password\": \"string\", \"displayName\": \"string\" }" ``` ## DELETE `/customers/activities` Delete activity DEPRECATED (sunset 2026-06-30): Deletes an activity. Use DELETE /api/customers/interactions instead. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Activity deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/activities" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/activities` List activitys Returns a paginated collection of activitys scoped to the authenticated organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | entityId | query | any | Optional | | dealId | query | any | Optional | | activityType | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated activitys Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "activityType": "string", "subject": null, "body": null, "occurredAt": null, "createdAt": "string", "appearanceIcon": null, "appearanceColor": null, "entityId": null, "authorUserId": null, "authorName": null, "authorEmail": null, "dealId": null, "dealTitle": null, "customValues": null, "activityTypeLabel": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/activities?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/activities` Create activity DEPRECATED (sunset 2026-06-30): Creates a timeline activity. Use POST /api/customers/interactions instead. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "00000000-0000-4000-8000-000000000000", "activityType": "string", "date": null, "time": null, "phoneNumber": null, "appearanceIcon": null, "appearanceColor": null } ``` ### Responses **201** – Activity created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/activities" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"00000000-0000-4000-8000-000000000000\", \"activityType\": \"string\", \"date\": null, \"time\": null, \"phoneNumber\": null, \"appearanceIcon\": null, \"appearanceColor\": null }" ``` ## PUT `/customers/activities` Update activity DEPRECATED (sunset 2026-06-30): Updates an activity. Use PUT /api/customers/interactions instead. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "date": null, "time": null, "phoneNumber": null, "appearanceIcon": null, "appearanceColor": null } ``` ### Responses **200** – Activity updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/activities" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"date\": null, \"time\": null, \"phoneNumber\": null, \"appearanceIcon\": null, \"appearanceColor\": null }" ``` ## GET `/customers/activity-types` List effective calendar activity types Returns the tenant and organization scoped calendar activity-type catalog. Requires customers.interactions.view or customers.settings.manage. **Tags:** Customers **Requires authentication.** ### Responses **200** – Effective activity-type catalog Content-Type: `application/json` ```json { "fallbackKey": "meeting", "items": [ { "key": "string", "label": "string", "icon": null, "color": null, "behavior": { "schemaVersion": 1, "baseKind": "meeting", "selectable": true, "order": 1, "fields": { "endTime": true, "allDay": true, "recurrence": true, "location": "none", "people": "none", "priority": true, "resources": true }, "customFieldsetIds": [ "string" ] }, "selectable": true, "source": "string", "provenance": {}, "historical": true, "adminConfigurable": true, "isInherited": true, "isLocalOverride": true, "updatedAt": null, "missingCustomFieldsetIds": [ "string" ] } ] } ``` **400** – Organization scope is required Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/activity-types" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/addresses` Delete address Deletes an address by id. The identifier may be included in the body or query. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Address deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/addresses` List addresss Returns a paginated collection of addresss scoped to the authenticated organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | entityId | query | any | Optional | | id | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated addresss Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "entity_id": "00000000-0000-4000-8000-000000000000", "name": null, "purpose": null, "company_name": null, "address_line1": null, "address_line2": null, "building_number": null, "flat_number": null, "city": null, "region": null, "postal_code": null, "country": null, "latitude": null, "longitude": null, "is_primary": null, "organization_id": null, "tenant_id": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/addresses?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/addresses` Create address Creates a customer address record and associates it with the referenced entity. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "addressLine1": "string", "latitude": null, "longitude": null } ``` ### Responses **201** – Address created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"entityId\": \"00000000-0000-4000-8000-000000000000\", \"addressLine1\": \"string\", \"latitude\": null, \"longitude\": null }" ``` ## PUT `/customers/addresses` Update address Updates fields on an existing customer address. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "latitude": null, "longitude": null } ``` ### Responses **200** – Address updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/addresses" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"latitude\": null, \"longitude\": null }" ``` ## GET `/customers/assignable-staff` DEPRECATED: use GET /api/staff/team-members/assignable instead. Deprecated. Returns 308 Permanent Redirect to /api/staff/team-members/assignable preserving the query string. Will be removed no earlier than the next major release. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | ### Responses **200** – Assignable staff members (only reachable by following the redirect). Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "teamMemberId": "00000000-0000-4000-8000-000000000000", "userId": "00000000-0000-4000-8000-000000000000", "displayName": "string", "email": null, "teamName": null, "user": null, "team": null } ], "total": 1, "totalPages": 1 } ``` **308** – Permanent redirect to /api/staff/team-members/assignable. Content-Type: `application/json` ```json { "error": "string" } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/assignable-staff?page=1&pageSize=24" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/comments` Delete comment Deletes a comment identified by `id` supplied via body or query string. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Comment deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/comments` List comments Returns a paginated collection of comments scoped to the authenticated organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | entityId | query | any | Optional | | dealId | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated comments Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "entity_id": null, "deal_id": null, "body": null, "author_user_id": null, "appearance_icon": null, "appearance_color": null, "organization_id": null, "tenant_id": null, "created_at": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/comments?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/comments` Create comment Adds a comment to a customer timeline. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000", "body": "string", "appearanceIcon": null, "appearanceColor": null } ``` ### Responses **201** – Comment created Content-Type: `application/json` ```json { "id": null, "authorUserId": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"entityId\": \"00000000-0000-4000-8000-000000000000\", \"body\": \"string\", \"appearanceIcon\": null, \"appearanceColor\": null }" ``` ## PUT `/customers/comments` Update comment Updates an existing timeline comment. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "appearanceIcon": null, "appearanceColor": null } ``` ### Responses **200** – Comment updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"appearanceIcon\": null, \"appearanceColor\": null }" ``` ## DELETE `/customers/companies` Delete company Deletes a company by id. The identifier can be provided via body or query. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Company deleted Content-Type: `application/json` ```json { "ok": true } ``` **422** – Company has dependent records (people, deals, or direct staff); unlink or reassign before delete. Content-Type: `application/json` ```json { "error": "string", "code": "COMPANY_HAS_DEPENDENTS" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/companies` List companies Returns a paginated collection of companies scoped to the authenticated organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | email | query | any | Optional | | emailStartsWith | query | any | Optional | | emailContains | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | status | query | any | Optional | | lifecycleStage | query | any | Optional | | source | query | any | Optional | | hasEmail | query | any | Optional | | hasPhone | query | any | Optional | | hasNextInteraction | query | any | Optional | | createdFrom | query | any | Optional | | createdTo | query | any | Optional | | id | query | any | Optional | | tagIds | query | any | Optional | | tagIdsEmpty | query | any | Optional | | excludeIds | query | any | Optional | | excludeLinkedPersonId | query | any | Optional | | excludeLinkedCompanyId | query | any | Optional | | excludeLinkedDealId | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated companies Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "description": null, "owner_user_id": null, "primary_email": null, "primary_phone": null, "status": null, "lifecycle_stage": null, "source": null, "next_interaction_at": null, "next_interaction_name": null, "next_interaction_ref_id": null, "next_interaction_icon": null, "next_interaction_color": null, "organization_id": null, "tenant_id": null, "created_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/companies?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/companies` Create company Creates a company record and associated profile data. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "displayName": "string", "description": null, "primaryEmail": null, "primaryPhone": null, "nextInteraction": null, "legalName": null, "brandName": null, "domain": null, "websiteUrl": null, "sizeBucket": null, "annualRevenue": null } ``` ### Responses **201** – Company created Content-Type: `application/json` ```json { "id": null, "companyId": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"displayName\": \"string\", \"description\": null, \"primaryEmail\": null, \"primaryPhone\": null, \"nextInteraction\": null, \"legalName\": null, \"brandName\": null, \"domain\": null, \"websiteUrl\": null, \"sizeBucket\": null, \"annualRevenue\": null }" ``` ## PUT `/customers/companies` Update company Updates company profile fields, tags, or custom attributes. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "description": null, "primaryEmail": null, "primaryPhone": null, "nextInteraction": null, "legalName": null, "brandName": null, "domain": null, "websiteUrl": null, "sizeBucket": null, "annualRevenue": null } ``` ### Responses **200** – Company updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"description\": null, \"primaryEmail\": null, \"primaryPhone\": null, \"nextInteraction\": null, \"legalName\": null, \"brandName\": null, \"domain\": null, \"websiteUrl\": null, \"sizeBucket\": null, \"annualRevenue\": null }" ``` ## GET `/customers/companies/{id}` Fetch company with related data Returns a company customer record with optional related resources such as addresses, comments, activities, interactions, deals, todos, and linked people. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | include | query | any | Optional. Comma-separated list of relations to include (addresses, comments, activities, interactions, deals, todos, people). | ### Responses **200** – Company detail payload Content-Type: `application/json` ```json { "interactionMode": "canonical", "company": { "id": "00000000-0000-4000-8000-000000000000", "displayName": null, "description": null, "ownerUserId": null, "primaryEmail": null, "primaryPhone": null, "status": null, "lifecycleStage": null, "source": null, "nextInteractionAt": null, "nextInteractionName": null, "nextInteractionRefId": null, "nextInteractionIcon": null, "nextInteractionColor": null, "organizationId": null, "tenantId": null, "temperature": null, "renewalQuarter": null, "createdAt": "string", "updatedAt": "string" }, "profile": null, "customFields": {}, "tags": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "color": null } ], "addresses": [ { "id": "00000000-0000-4000-8000-000000000000", "name": null, "purpose": null, "addressLine1": null, "addressLine2": null, "buildingNumber": null, "flatNumber": null, "city": null, "region": null, "postalCode": null, "country": null, "latitude": null, "longitude": null, "isPrimary": null, "createdAt": "string" } ], "comments": [ { "id": "00000000-0000-4000-8000-000000000000", "body": null, "authorUserId": null, "authorName": null, "authorEmail": null, "dealId": null, "createdAt": "string", "appearanceIcon": null, "appearanceColor": null } ], "activities": [ { "id": "00000000-0000-4000-8000-000000000000", "activityType": "string", "subject": null, "body": null, "occurredAt": null, "dealId": null, "authorUserId": null, "authorName": null, "authorEmail": null, "createdAt": "string", "appearanceIcon": null, "appearanceColor": null } ], "interactions": [ { "id": "00000000-0000-4000-8000-000000000000", "entityId": null, "interactionType": "string", "title": null, "body": null, "status": "string", "scheduledAt": null, "occurredAt": null, "priority": null, "authorUserId": null, "ownerUserId": null, "dealId": null, "organizationId": null, "tenantId": null, "authorName": null, "authorEmail": null, "dealTitle": null, "customValues": null, "appearanceIcon": null, "appearanceColor": null, "source": null, "createdAt": "string", "updatedAt": "string" } ], "deals": [ { "id": "00000000-0000-4000-8000-000000000000", "title": null, "status": null, "pipelineStage": null, "valueAmount": null, "valueCurrency": null, "probability": null, "expectedCloseAt": null, "ownerUserId": null, "source": null, "createdAt": "string", "updatedAt": "string" } ], "todos": [ { "id": "00000000-0000-4000-8000-000000000000", "todoId": "00000000-0000-4000-8000-000000000000", "todoSource": "string", "createdAt": "string", "createdByUserId": null, "title": null, "isDone": null, "priority": null, "severity": null, "description": null, "dueAt": null, "todoOrganizationId": null, "customValues": null } ], "people": [ { "id": "00000000-0000-4000-8000-000000000000", "displayName": null, "primaryEmail": null, "primaryPhone": null, "status": null, "lifecycleStage": null, "jobTitle": null, "department": null, "createdAt": "string", "organizationId": null, "source": null, "temperature": null, "linkedAt": null } ], "viewer": { "userId": null, "name": null, "email": null } } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden — caller lacks the required feature Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Company not found, or its organization is not in the caller’s scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/companies/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/companies/{id}/people` List linked people for a company **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sort | query | any | Optional | ### Responses **200** – Paginated linked people Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "displayName": "string", "primaryEmail": null, "primaryPhone": null, "status": null, "lifecycleStage": null, "jobTitle": null, "department": null, "createdAt": "string", "organizationId": null, "temperature": null, "source": null, "linkedAt": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/companies/:id/people?page=1&pageSize=20&sort=name-asc" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/companies/{id}/roles` Remove a company role assignment **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | roleId | query | any | Required | ### Responses **200** – Role deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/companies/00000000-0000-4000-8000-000000000000/roles?roleId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/companies/{id}/roles` List roles for a company **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Role assignments Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "entityType": "company", "entityId": "00000000-0000-4000-8000-000000000000", "userId": "00000000-0000-4000-8000-000000000000", "userName": null, "userEmail": null, "userPhone": null, "roleType": "string", "createdAt": "string", "updatedAt": "string" } ] } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/companies/00000000-0000-4000-8000-000000000000/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/companies/{id}/roles` Assign a role to a company **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "roleType": "string", "userId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Role created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Role already assigned Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/companies/00000000-0000-4000-8000-000000000000/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"roleType\": \"string\", \"userId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## PUT `/customers/companies/{id}/roles` Update a company role assignment **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | roleId | query | any | Required | ### Request Body Content-Type: `application/json` ```json { "userId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Role updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/companies/00000000-0000-4000-8000-000000000000/roles?roleId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"userId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/dashboard/widgets/customer-todos` Fetch recent customer tasks Returns the most recent customer tasks for display on dashboards, including legacy compatibility rows when needed. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | limit | query | any | Optional | | tenantId | query | any | Optional | | organizationId | query | any | Optional | ### Responses **200** – Widget payload Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "todoId": "00000000-0000-4000-8000-000000000000", "todoSource": "string", "todoTitle": null, "createdAt": "string", "organizationId": null, "entity": { "id": null, "displayName": null, "kind": null, "ownerUserId": null } } ] } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Requested scope is not accessible Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Widget failed to load Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/dashboard/widgets/customer-todos?limit=5" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dashboard/widgets/new-customers` Fetch recently created customers Returns the latest customers created within the scoped tenant/organization for dashboard display. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | limit | query | any | Optional | | tenantId | query | any | Optional | | organizationId | query | any | Optional | | kind | query | any | Optional | ### Responses **200** – Widget payload Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "displayName": null, "kind": null, "organizationId": null, "createdAt": "string", "ownerUserId": null } ] } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Requested scope is not accessible Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Widget failed to load Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/dashboard/widgets/new-customers?limit=5" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dashboard/widgets/new-deals` Fetch recently created deals Returns the latest deals created within the scoped tenant/organization for dashboard display. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | limit | query | any | Optional | | tenantId | query | any | Optional | | organizationId | query | any | Optional | ### Responses **200** – Widget payload Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "title": null, "status": null, "organizationId": null, "createdAt": "string", "ownerUserId": null, "valueAmount": null, "valueCurrency": null } ] } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Requested scope is not accessible Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Widget failed to load Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/dashboard/widgets/new-deals?limit=5" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dashboard/widgets/next-interactions` Fetch upcoming customer interactions Lists upcoming (or optionally past) customer interaction reminders ordered by interaction date. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | limit | query | any | Optional | | tenantId | query | any | Optional | | organizationId | query | any | Optional | | includePast | query | any | Optional | ### Responses **200** – Widget payload Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "displayName": null, "kind": null, "organizationId": null, "nextInteractionAt": null, "nextInteractionName": null, "nextInteractionIcon": null, "nextInteractionColor": null, "ownerUserId": null } ], "now": "string" } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Requested scope is not accessible Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Widget failed to load Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/dashboard/widgets/next-interactions?limit=5" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/deals` Delete deal Deletes a deal by `id`. The identifier may be provided in the body or query parameters. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Deal deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/deals" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/deals` List deals Returns a paginated collection of deals scoped to the authenticated organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | id | query | any | Optional | | search | query | any | Optional | | status | query | any | Optional | | pipelineStage | query | any | Optional | | pipelineId | query | any | Optional | | pipelineStageId | query | any | Optional | | ownerUserId | query | any | Optional | | expectedCloseAtFrom | query | any | Optional | | expectedCloseAtTo | query | any | Optional | | isStuck | query | any | Optional | | isOverdue | query | any | Optional | | needsAttention | query | any | Optional | | valueCurrency | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | personEntityId | query | any | Optional. Deprecated; use personId | | companyEntityId | query | any | Optional. Deprecated; use companyId | | personId | query | any | Optional | | companyId | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated deals Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "title": null, "description": null, "status": null, "pipeline_stage": null, "pipeline_id": null, "pipeline_stage_id": null, "value_amount": null, "value_currency": null, "probability": null, "expected_close_at": null, "owner_user_id": null, "source": null, "organization_id": null, "tenant_id": null, "created_at": null, "updated_at": null, "organizationId": null, "tenantId": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/deals?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/deals` Create deal Creates a sales deal, optionally associating people and companies. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "title": "string", "ownerUserId": null, "primaryPersonEntityId": null } ``` ### Responses **201** – Deal created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/deals" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"title\": \"string\", \"ownerUserId\": null, \"primaryPersonEntityId\": null }" ``` ## PUT `/customers/deals` Update deal Updates pipeline position, metadata, or associations for an existing deal. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "ownerUserId": null, "primaryPersonEntityId": null } ``` ### Responses **200** – Deal updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/deals" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"ownerUserId\": null, \"primaryPersonEntityId\": null }" ``` ## GET `/customers/deals/{id}` Fetch deal with associations and pipeline context Returns a deal with linked people, companies, closure fields, optional pipeline history, custom fields, and viewer context. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | include | query | any | Optional | ### Responses **200** – Deal detail payload Content-Type: `application/json` ```json { "deal": { "id": "00000000-0000-4000-8000-000000000000", "title": null, "description": null, "status": null, "pipelineStage": null, "pipelineId": null, "pipelineStageId": null, "valueAmount": null, "valueCurrency": null, "probability": null, "expectedCloseAt": null, "ownerUserId": null, "source": null, "closureOutcome": null, "lossReasonId": null, "lossNotes": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" }, "people": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "subtitle": null, "kind": "person" } ], "companies": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "subtitle": null, "kind": "company" } ], "customFields": {}, "viewer": { "userId": null, "name": null, "email": null }, "pipelineStages": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "order": 1, "color": null, "icon": null } ], "stageTransitions": [ { "stageId": "00000000-0000-4000-8000-000000000000", "stageLabel": "string", "stageOrder": 1, "transitionedAt": "string" } ], "owner": null } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden — caller lacks the required feature Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Deal not found, or its organization is not in the caller’s scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/deals/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/{id}/companies` List linked companies for a deal **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sort | query | any | Optional | ### Responses **200** – Paginated linked companies Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "subtitle": null, "kind": "company", "linkedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/deals/:id/companies?page=1&pageSize=20&sort=label-asc" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/{id}/people` List linked people for a deal **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sort | query | any | Optional | ### Responses **200** – Paginated linked people Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "subtitle": null, "kind": "person", "linkedAt": "string", "isPrimary": true, "displayName": "string", "primaryEmail": null, "primaryPhone": null, "status": null, "lifecycleStage": null, "jobTitle": null, "department": null, "createdAt": "string", "organizationId": null, "temperature": null, "source": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/deals/:id/people?page=1&pageSize=20&sort=label-asc" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/{id}/stats` Fetch analytics for a closed deal Returns week-to-date closure counts, sales cycle length, quarter ranking, and loss reason context for a closed deal. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Deal closure stats payload Content-Type: `application/json` ```json { "dealValue": null, "dealCurrency": null, "closureOutcome": "won", "closedAt": "string", "pipelineName": null, "dealsClosedThisPeriod": 1, "salesCycleDays": null, "dealRankInQuarter": null, "lossReason": null } ``` **400** – Deal is not closed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden — caller lacks the required feature Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Deal not found, or its organization is not in the caller’s scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/deals/:id/stats" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/aggregate` Per-stage counts and currency totals for kanban lane headers Returns per-stage counts and totals for deals, with values converted to the tenant base currency where rates are available. Used to power kanban lane headers without loading every deal. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | pipelineId | query | any | Optional | | search | query | any | Optional | | status | query | any | Optional | | ownerUserId | query | any | Optional | | personId | query | any | Optional | | companyId | query | any | Optional | | isStuck | query | any | Optional | | isOverdue | query | any | Optional | | expectedCloseAtFrom | query | any | Optional | | expectedCloseAtTo | query | any | Optional | ### Responses **200** – Per-stage aggregate payload Content-Type: `application/json` ```json { "baseCurrencyCode": null, "perStage": [ { "stageId": "string", "count": 1, "openCount": 1, "totalInBaseCurrency": 1, "byCurrency": [ { "currency": "string", "total": 1, "count": 1 } ], "convertedAll": true, "missingRateCurrencies": [ "string" ] } ] } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/deals/aggregate" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/deals/bulk-update-owner` Bulk reassign deal owner Queues a background job that reassigns the listed deals to a new owner (or clears the owner when null). **Tags:** Customer Relationship Management **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/deals/bulk-update-owner" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/deals/bulk-update-stage` Bulk update deal pipeline stage Queues a background job that moves the listed deals to the same pipeline stage. Returns a progress job id to poll for completion. **Tags:** Customer Relationship Management **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/deals/bulk-update-stage" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/map` Paginated deals that have a resolvable map location Returns a page of deals that have a coordinate-bearing linked company/person address, each enriched with one resolved location (company primary first, then earliest created; person addresses as fallback). Deals with no coordinate-bearing address are excluded entirely, so every item carries a non-null location in normal operation; the schema keeps location nullable only for the rare case where the address is deleted between the located-deal resolution and the page fetch. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | id | query | any | Optional | | search | query | any | Optional | | status | query | any | Optional | | pipelineStage | query | any | Optional | | pipelineId | query | any | Optional | | pipelineStageId | query | any | Optional | | ownerUserId | query | any | Optional | | expectedCloseAtFrom | query | any | Optional | | expectedCloseAtTo | query | any | Optional | | isStuck | query | any | Optional | | isOverdue | query | any | Optional | | needsAttention | query | any | Optional | | valueCurrency | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | personEntityId | query | any | Optional. Deprecated; use personId | | companyEntityId | query | any | Optional. Deprecated; use companyId | | personId | query | any | Optional | | companyId | query | any | Optional | ### Responses **200** – Paged located deals Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "title": null, "status": null, "pipelineId": null, "pipelineStageId": null, "pipelineStage": null, "valueAmount": null, "valueCurrency": null, "probability": null, "expectedCloseAt": null, "ownerUserId": null, "updatedAt": null, "companies": [ { "id": "00000000-0000-4000-8000-000000000000", "label": null } ], "people": [ { "id": "00000000-0000-4000-8000-000000000000", "label": null } ], "location": null } ], "total": 1, "totalPages": 1 } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing required features Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/deals/map?page=1&pageSize=100" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/deals/summary` Pipeline KPI metrics with period-over-period deltas for the deals list Returns the four list-level KPI cards (pipeline value, active deals, won this quarter, win rate) with quarter-over-quarter deltas, per-stage open-pipeline breakdown, top owners, and a 6-month win-rate series. Values are converted to the tenant base currency where rates are available; partial conversions are disclosed via convertedAll/missingRateCurrencies. **Tags:** Customers **Requires authentication.** ### Responses **200** – Deals KPI summary payload Content-Type: `application/json` ```json { "baseCurrencyCode": null, "convertedAll": true, "missingRateCurrencies": [ "string" ], "pipelineValue": { "value": 1, "delta": { "value": 1, "direction": "up" }, "stages": [ { "stage": null, "count": 1, "value": 1 } ] }, "activeDeals": { "value": 1, "delta": { "value": 1, "direction": "up" }, "ownersCount": 1, "needAttention": 1, "owners": [ { "id": "string", "count": 1 } ], "ownersOverflow": 1 }, "wonThisQuarter": { "value": 1, "delta": { "value": 1, "direction": "up" }, "dealsClosed": 1, "avgDeal": 1 }, "winRate": { "value": 1, "deltaPp": 1, "direction": "up", "previousValue": 1, "series": [ { "period": "string", "rate": 1 } ] } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/deals/summary" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dictionaries/{kind}` List dictionary entries Returns dictionary entries for the requested kind within the currently selected organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | ### Responses **200** – Dictionary entries Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "behavior": null, "organizationId": null } ] } ``` **400** – Failed to resolve dictionary context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/dictionaries/:kind" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/dictionaries/{kind}` Create or override dictionary entry Creates a dictionary entry (or updates the existing entry for the same value) within the current organization scope. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "value": "string", "behavior": null } ``` ### Responses **200** – Dictionary entry updated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "behavior": null, "organizationId": null } ``` **201** – Dictionary entry created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "behavior": null, "organizationId": null } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Duplicate value conflict Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/dictionaries/:kind" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"value\": \"string\", \"behavior\": null }" ``` ## DELETE `/customers/dictionaries/{kind}/{id}` Delete dictionary entry Removes a customer dictionary entry by identifier. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | | id | path | any | Required | ### Responses **200** – Entry deleted Content-Type: `application/json` ```json { "success": true } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Entry not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Entry is in use and cannot be deleted Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/dictionaries/:kind/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/customers/dictionaries/{kind}/{id}` Update dictionary entry Updates value, label, color, or icon for an existing customer dictionary entry. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | path | any | Required | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "behavior": null } ``` ### Responses **200** – Updated dictionary entry Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null, "color": null, "icon": null, "behavior": null, "organizationId": null } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Entry not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Duplicate value conflict Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/customers/dictionaries/:kind/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"behavior\": null }" ``` ## GET `/customers/dictionaries/currency` Resolve currency dictionary Returns the active currency dictionary for the current organization scope, falling back to shared entries when required. **Tags:** Customers **Requires authentication.** ### Responses **200** – Currency dictionary entries Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "entries": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": null } ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Currency dictionary missing Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/dictionaries/currency" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/dictionaries/kind-settings` List kind settings Returns selection mode and visibility settings for each dictionary kind. **Tags:** Customers **Requires authentication.** ### Responses **200** – Kind settings Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "kind": "string", "selectionMode": "single", "visibleInTags": true, "sortOrder": 1 } ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/dictionaries/kind-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/customers/dictionaries/kind-settings` Update kind setting Creates or updates settings for a specific dictionary kind. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "kind": "string" } ``` ### Responses **200** – Setting updated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "kind": "string", "selectionMode": "single", "visibleInTags": true, "sortOrder": 1 } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/customers/dictionaries/kind-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"kind\": \"string\" }" ``` ## DELETE `/customers/interactions` Delete interaction Soft-deletes an interaction identified by `id`. Accepts id via body or query string. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Interaction deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/interactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/interactions` List interactions Returns a paginated collection of interactions scoped to the authenticated organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | limit | query | any | Optional | | cursor | query | any | Optional | | entityId | query | any | Optional | | dealId | query | any | Optional | | status | query | any | Optional | | interactionType | query | any | Optional | | type | query | any | Optional | | excludeInteractionType | query | any | Optional | | search | query | any | Optional | | from | query | any | Optional | | to | query | any | Optional | | recurrenceMasters | query | any | Optional | | pinned | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated interactions Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "entityId": null, "dealId": null, "interactionType": "string", "title": null, "body": null, "status": "string", "scheduledAt": null, "occurredAt": null, "priority": null, "authorUserId": null, "ownerUserId": null, "externalMessageId": null, "appearanceIcon": null, "appearanceColor": null, "source": null, "duration": null, "durationMinutes": null, "timezone": null, "location": null, "allDay": null, "recurrenceRule": null, "recurrenceEnd": null, "participants": null, "reminderMinutes": null, "visibility": null, "linkedEntities": null, "guestPermissions": null, "organizationId": null, "tenantId": null, "createdAt": null, "updatedAt": null, "authorName": null, "authorEmail": null, "dealTitle": null, "customValues": null } ] } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/interactions?limit=25" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/interactions` Create interaction Creates a new interaction linked to a customer entity or deal. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` No example available for this content type. ### Responses **201** – Interaction created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/interactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/interactions` Update interaction Updates fields for an existing interaction. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` No example available for this content type. ### Responses **200** – Interaction updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/interactions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/customers/interactions/{id}/visibility` Flip an email interaction visibility (private ↔ shared) **Tags:** Customers, Email **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Updated Content-Type: `application/json` **400** – Invalid id Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Email not found or not visible to caller Content-Type: `application/json` **422** – Invalid body Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/customers/interactions/:id/visibility" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/interactions/cancel` Cancel an interaction Marks an interaction as canceled. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Interaction canceled Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Interaction not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/interactions/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## POST `/customers/interactions/complete` Complete an interaction Marks an interaction as done and sets occurredAt to current time (or a provided timestamp). **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Interaction completed Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Interaction not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/interactions/complete" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/interactions/conflicts` Detect scheduling conflicts Checks for overlapping planned interactions within the requested time window. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | date | query | any | Required | | startTime | query | any | Required | | duration | query | any | Required | | excludeId | query | any | Optional | | userId | query | any | Optional | | timezoneOffsetMinutes | query | any | Optional | ### Responses **200** – Conflict detection result Content-Type: `application/json` ```json { "ok": true, "result": { "hasConflicts": true, "conflicts": [ { "id": "string", "title": null, "startTime": "string", "endTime": "string", "type": "string" } ] } } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/interactions/conflicts?date=string&startTime=string&duration=1" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/interactions/counts` Get interaction counts by type Returns per-type interaction counts scoped to an entity. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Required | | status | query | any | Optional | ### Responses **200** – Counts by interaction type Content-Type: `application/json` ```json { "ok": true, "result": { "call": 1, "email": 1, "meeting": 1, "note": 1, "task": 1, "total": 1 } } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/interactions/counts?entityId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/interactions/tasks` List customertasks Returns a paginated collection of customertasks scoped to the authenticated organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | all | query | any | Optional | | entityId | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated customertasks Content-Type: `application/json` ```json { "items": [ { "id": "string", "todoId": "string", "todoSource": "string", "todoTitle": null, "todoIsDone": null, "todoPriority": null, "todoSeverity": null, "todoDescription": null, "todoDueAt": null, "todoTimezone": null, "todoCustomValues": null, "todoOrganizationId": null, "organizationId": "string", "tenantId": "string", "createdAt": "string", "externalHref": null, "customer": { "id": null, "displayName": null, "kind": null } } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/interactions/tasks?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/labels` List labels Returns labels for the current user within the selected organization. Optionally includes assignment status for a specific entity. **Tags:** Customers **Requires authentication.** ### Responses **200** – Labels list Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "slug": "string", "label": "string" } ], "assignedIds": [ "00000000-0000-4000-8000-000000000000" ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/labels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/labels` Create label Creates a new label scoped to the current user and selected organization. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "label": "string" } ``` ### Responses **201** – Label created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "slug": "string", "label": "string" } ``` **409** – Duplicate slug Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/labels" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"label\": \"string\" }" ``` ## POST `/customers/labels/assign` Assign label **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "labelId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Already assigned Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **201** – Assigned Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **404** – Label or entity not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/labels/assign" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"labelId\": \"00000000-0000-4000-8000-000000000000\", \"entityId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## POST `/customers/labels/unassign` Unassign label **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "labelId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Unassigned Content-Type: `application/json` ```json { "id": null } ``` **404** – Label or entity not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/labels/unassign" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"labelId\": \"00000000-0000-4000-8000-000000000000\", \"entityId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## DELETE `/customers/people` Delete person Deletes a person by id. Request body or query may provide the identifier. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Person deleted Content-Type: `application/json` ```json { "ok": true } ``` **422** – Person has dependent records (e.g. linked deals); unlink or reassign before delete. Content-Type: `application/json` ```json { "error": "string", "code": "PERSON_HAS_DEPENDENTS" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/people` List people Returns a paginated collection of people scoped to the authenticated organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | email | query | any | Optional | | emailStartsWith | query | any | Optional | | emailContains | query | any | Optional | | status | query | any | Optional | | lifecycleStage | query | any | Optional | | source | query | any | Optional | | hasEmail | query | any | Optional | | hasPhone | query | any | Optional | | hasNextInteraction | query | any | Optional | | createdFrom | query | any | Optional | | createdTo | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | id | query | any | Optional | | tagIds | query | any | Optional | | tagIdsEmpty | query | any | Optional | | excludeIds | query | any | Optional | | excludeLinkedCompanyId | query | any | Optional | | excludeLinkedDealId | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated people Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "description": null, "owner_user_id": null, "primary_email": null, "primary_phone": null, "status": null, "lifecycle_stage": null, "source": null, "next_interaction_at": null, "next_interaction_name": null, "next_interaction_ref_id": null, "next_interaction_icon": null, "next_interaction_color": null, "organization_id": null, "tenant_id": null, "created_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/people?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/people` Create person Creates a person contact using scoped organization and tenant identifiers. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "description": null, "primaryEmail": null, "primaryPhone": null, "nextInteraction": null, "firstName": "string", "lastName": "string", "linkedInUrl": null, "twitterUrl": null, "companyEntityId": null } ``` ### Responses **201** – Person created Content-Type: `application/json` ```json { "id": null, "personId": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"description\": null, \"primaryEmail\": null, \"primaryPhone\": null, \"nextInteraction\": null, \"firstName\": \"string\", \"lastName\": \"string\", \"linkedInUrl\": null, \"twitterUrl\": null, \"companyEntityId\": null }" ``` ## PUT `/customers/people` Update person Updates contact details or custom fields for a person. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "description": null, "primaryEmail": null, "primaryPhone": null, "nextInteraction": null, "linkedInUrl": null, "twitterUrl": null, "companyEntityId": null } ``` ### Responses **200** – Person updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/people" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"description\": null, \"primaryEmail\": null, \"primaryPhone\": null, \"nextInteraction\": null, \"linkedInUrl\": null, \"twitterUrl\": null, \"companyEntityId\": null }" ``` ## GET `/customers/people/{id}` Fetch person with related data Returns a person customer record with optional related resources such as addresses, comments, activities, interactions, deals, and todos. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | include | query | any | Optional. Comma-separated list of relations to include (addresses, comments, activities, interactions, deals, todos). | ### Responses **200** – Person detail payload Content-Type: `application/json` ```json { "interactionMode": "canonical", "person": { "id": "00000000-0000-4000-8000-000000000000", "displayName": null, "description": null, "ownerUserId": null, "primaryEmail": null, "primaryPhone": null, "status": null, "lifecycleStage": null, "source": null, "nextInteractionAt": null, "nextInteractionName": null, "nextInteractionRefId": null, "nextInteractionIcon": null, "nextInteractionColor": null, "organizationId": null, "tenantId": null, "createdAt": "string", "updatedAt": "string" }, "profile": null, "customFields": {}, "tags": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "color": null } ], "addresses": [ { "id": "00000000-0000-4000-8000-000000000000", "name": null, "purpose": null, "addressLine1": null, "addressLine2": null, "buildingNumber": null, "flatNumber": null, "city": null, "region": null, "postalCode": null, "country": null, "latitude": null, "longitude": null, "isPrimary": null, "createdAt": "string" } ], "comments": [ { "id": "00000000-0000-4000-8000-000000000000", "body": null, "authorUserId": null, "authorName": null, "authorEmail": null, "dealId": null, "createdAt": "string", "appearanceIcon": null, "appearanceColor": null } ], "activities": [ { "id": "00000000-0000-4000-8000-000000000000", "activityType": "string", "subject": null, "body": null, "occurredAt": null, "dealId": null, "authorUserId": null, "authorName": null, "authorEmail": null, "createdAt": "string", "appearanceIcon": null, "appearanceColor": null } ], "interactions": [ { "id": "00000000-0000-4000-8000-000000000000", "entityId": null, "interactionType": "string", "title": null, "body": null, "status": "string", "scheduledAt": null, "occurredAt": null, "priority": null, "authorUserId": null, "ownerUserId": null, "dealId": null, "organizationId": null, "tenantId": null, "authorName": null, "authorEmail": null, "dealTitle": null, "customValues": null, "appearanceIcon": null, "appearanceColor": null, "source": null, "createdAt": "string", "updatedAt": "string" } ], "deals": [ { "id": "00000000-0000-4000-8000-000000000000", "title": null, "status": null, "pipelineStage": null, "valueAmount": null, "valueCurrency": null, "probability": null, "expectedCloseAt": null, "ownerUserId": null, "source": null, "closureOutcome": null, "lossReasonId": null, "lossNotes": null, "createdAt": "string", "updatedAt": "string" } ], "todos": [ { "id": "00000000-0000-4000-8000-000000000000", "todoId": "00000000-0000-4000-8000-000000000000", "todoSource": "string", "createdAt": "string", "createdByUserId": null, "title": null, "isDone": null, "priority": null, "severity": null, "description": null, "dueAt": null, "todoOrganizationId": null, "customValues": null } ], "isPrimary": true, "companies": [ { "id": "00000000-0000-4000-8000-000000000000", "displayName": "string", "isPrimary": true } ], "viewer": { "userId": null, "name": null, "email": null } } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden — caller lacks the required feature Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Person not found, or its organization is not in the caller’s scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/people/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people/{id}/companies` List linked companies for a person **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Linked company rows Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "companyId": "00000000-0000-4000-8000-000000000000", "displayName": "string", "isPrimary": true } ] } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/people/:id/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/people/{id}/companies` Link a company to a person **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "companyId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Linked company row Content-Type: `application/json` ```json { "ok": true, "result": { "id": "00000000-0000-4000-8000-000000000000", "companyId": "00000000-0000-4000-8000-000000000000", "displayName": "string", "isPrimary": true } } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/people/:id/companies" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"companyId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## DELETE `/customers/people/{id}/companies/{linkId}` Remove a linked company from a person **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | linkId | path | any | Required | ### Responses **200** – Deletion result Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/people/:id/companies/:linkId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/customers/people/{id}/companies/{linkId}` Update a linked company for a person **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | linkId | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Updated company link Content-Type: `application/json` ```json { "ok": true, "result": null } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/customers/people/:id/companies/:linkId" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## GET `/customers/people/{id}/companies/enriched` Get enriched company data for a person's linked companies **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sort | query | any | Optional | ### Responses **200** – Enriched company rows with profile, billing, tags, deals and more Content-Type: `application/json` ```json { "items": [ { "linkId": "00000000-0000-4000-8000-000000000000", "companyId": "00000000-0000-4000-8000-000000000000", "displayName": "string", "isPrimary": true, "subtitle": null, "profile": null, "billing": null, "primaryAddress": null, "tags": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "color": null } ], "roles": [ { "id": "00000000-0000-4000-8000-000000000000", "roleValue": "string" } ], "activeDeal": null, "lastContactAt": null, "clv": null, "status": null, "lifecycleStage": null, "temperature": null, "renewalQuarter": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/people/:id/companies/enriched?page=1&pageSize=20&sort=name-asc" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people/{id}/email-share` Read the conversation-share state for a Person **Tags:** Customers, Email **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Share state for the calling user Content-Type: `application/json` **400** – Invalid person id Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Person not found or not visible to caller Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/people/:id/email-share" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/people/{id}/email-share` Share or un-share your own email conversation with a Person **Tags:** Customers, Email **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Share state updated Content-Type: `application/json` **400** – Invalid id, or no private conversation to share Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **404** – Person not found or not visible to caller Content-Type: `application/json` **409** – Optimistic lock conflict Content-Type: `application/json` **422** – Invalid body Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/people/:id/email-share" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people/{id}/email-threads` List a Person's email threads (Gmail-style conversation grouping) **Tags:** Customers, Email **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Email threads for the person, grouped by conversation Content-Type: `application/json` **400** – Invalid person id Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **403** – Missing customers.people.view feature Content-Type: `application/json` **404** – Person not found Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/people/:id/email-threads" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/people/{id}/emails` Compose + send an email anchored to a Person **Tags:** Customers, Email **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Email queued for send Content-Type: `application/json` **400** – Invalid person id Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` **403** – Missing customers.email.compose feature or mutation guard rejection Content-Type: `application/json` **404** – Person or channel not found, or the reply parent is not an email the caller can see on this Person Content-Type: `application/json` **409** – Channel not connected Content-Type: `application/json` **422** – Invalid request body Content-Type: `application/json` **500** – Send failed Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/people/:id/emails" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/people/{id}/roles` Remove a person role assignment **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | roleId | query | any | Required | ### Responses **200** – Role deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/people/00000000-0000-4000-8000-000000000000/roles?roleId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/customers/people/{id}/roles` List roles for a person **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Role assignments Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "entityType": "company", "entityId": "00000000-0000-4000-8000-000000000000", "userId": "00000000-0000-4000-8000-000000000000", "userName": null, "userEmail": null, "userPhone": null, "roleType": "string", "createdAt": "string", "updatedAt": "string" } ] } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/people/00000000-0000-4000-8000-000000000000/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/people/{id}/roles` Assign a role to a person **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "roleType": "string", "userId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Role created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Role already assigned Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/people/00000000-0000-4000-8000-000000000000/roles" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"roleType\": \"string\", \"userId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## PUT `/customers/people/{id}/roles` Update a person role assignment **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | roleId | query | any | Required | ### Request Body Content-Type: `application/json` ```json { "userId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Role updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Role not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/people/00000000-0000-4000-8000-000000000000/roles?roleId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"userId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/people/check-phone` Find person by phone digits Performs an exact digits comparison (stripping non-numeric characters) to determine whether a customer contact matches the provided phone fragment. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | digits | query | any | Required | ### Responses **200** – Matching contact (if any) Content-Type: `application/json` ```json { "match": null } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/people/check-phone" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/customers/pipeline-stages` Delete pipeline stage Deletes a pipeline stage. Returns 409 if active deals use this stage. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Stage deleted Content-Type: `application/json` ```json { "ok": true } ``` **404** – Stage not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Stage has active deals Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/pipeline-stages" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/pipeline-stages` List pipeline stages Returns pipeline stages for the authenticated organization, optionally filtered by pipelineId. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | pipelineId | query | any | Optional | ### Responses **200** – Stage list Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "pipelineId": "00000000-0000-4000-8000-000000000000", "label": "string", "order": 1, "color": null, "icon": null, "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "createdAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z" } ], "total": 1 } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/pipeline-stages" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/pipeline-stages` Create pipeline stage Creates a new pipeline stage. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "pipelineId": "00000000-0000-4000-8000-000000000000", "label": "string", "color": null, "icon": null } ``` ### Responses **201** – Stage created Content-Type: `application/json` ```json { "id": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/pipeline-stages" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"pipelineId\": \"00000000-0000-4000-8000-000000000000\", \"label\": \"string\", \"color\": null, \"icon\": null }" ``` ## PUT `/customers/pipeline-stages` Update pipeline stage Updates an existing pipeline stage. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "color": null, "icon": null } ``` ### Responses **200** – Stage updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Stage not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/pipeline-stages" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"color\": null, \"icon\": null }" ``` ## POST `/customers/pipeline-stages/reorder` Reorder pipeline stages Updates the order of pipeline stages in bulk. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "stages": [ { "id": "00000000-0000-4000-8000-000000000000", "order": 1 } ] } ``` ### Responses **200** – Stages reordered Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/pipeline-stages/reorder" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"stages\": [ { \"id\": \"00000000-0000-4000-8000-000000000000\", \"order\": 1 } ] }" ``` ## DELETE `/customers/pipelines` Delete pipeline Deletes a pipeline. Returns 409 if active deals exist. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Pipeline deleted Content-Type: `application/json` ```json { "ok": true } ``` **404** – Pipeline not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Pipeline has active deals Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/pipelines" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/pipelines` List pipelines Returns a list of pipelines scoped to the authenticated organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | isDefault | query | any | Optional | ### Responses **200** – Pipeline list Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "isDefault": true, "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "createdAt": "2025-01-01T00:00:00.000Z", "updatedAt": "2025-01-01T00:00:00.000Z" } ], "total": 1 } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/pipelines" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/pipelines` Create pipeline Creates a new pipeline within the authenticated organization. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "name": "string" } ``` ### Responses **201** – Pipeline created Content-Type: `application/json` ```json { "id": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/pipelines" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"name\": \"string\" }" ``` ## PUT `/customers/pipelines` Update pipeline Updates an existing pipeline. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Pipeline updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Pipeline not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/pipelines" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/settings/address-format` Retrieve address format Returns the current address formatting preference for the selected organization. **Tags:** Customers **Requires authentication.** ### Responses **200** – Current address format Content-Type: `application/json` ```json { "addressFormat": "string" } ``` **400** – Organization context missing Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/settings/address-format" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/settings/address-format` Update address format Updates the address format preference for the selected organization. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "addressFormat": "line_first" } ``` ### Responses **200** – Updated address format Content-Type: `application/json` ```json { "addressFormat": "string" } ``` **400** – Invalid payload or organization context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/settings/address-format" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"addressFormat\": \"line_first\" }" ``` ## GET `/customers/settings/dictionary-sort-modes` Retrieve dictionary sort modes Returns entry sort preferences for customer dictionaries in the selected organization. **Tags:** Customers **Requires authentication.** ### Responses **200** – Current dictionary sort modes Content-Type: `application/json` ```json { "dictionarySortModes": { "key": "label_asc" } } ``` **400** – Organization context missing Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/settings/dictionary-sort-modes" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/customers/settings/dictionary-sort-modes` Update dictionary sort modes Updates entry sort preferences for customer dictionaries in the selected organization. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "dictionarySortModes": { "key": "label_asc" } } ``` ### Responses **200** – Updated dictionary sort modes Content-Type: `application/json` ```json { "dictionarySortModes": { "key": "label_asc" } } ``` **400** – Invalid payload or organization context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/customers/settings/dictionary-sort-modes" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"dictionarySortModes\": { \"key\": \"label_asc\" } }" ``` ## GET `/customers/settings/stuck-threshold` Retrieve stuck-threshold days Returns the current stuck-deal threshold (in days) for the selected organization. **Tags:** Customers **Requires authentication.** ### Responses **200** – Current threshold Content-Type: `application/json` ```json { "stuckThresholdDays": 1 } ``` **400** – Organization context missing Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/settings/stuck-threshold" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/customers/settings/stuck-threshold` Update stuck-threshold days Updates the stuck-deal threshold for the selected organization. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "stuckThresholdDays": 1 } ``` ### Responses **200** – Updated threshold Content-Type: `application/json` ```json { "stuckThresholdDays": 1 } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/settings/stuck-threshold" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"stuckThresholdDays\": 1 }" ``` ## DELETE `/customers/tags` Delete tag Deletes a tag identified by `id`. The identifier may be provided via body or query string. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Tag deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/tags` List tags Returns a paginated collection of tags scoped to the authenticated organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated tags Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "slug": "string", "label": "string", "color": null, "description": null, "organization_id": null, "tenant_id": null, "updated_at": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/tags?page=1&pageSize=100" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/tags` Create tag Creates a tag scoped to the current tenant and organization. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "slug": "string", "label": "string" } ``` ### Responses **201** – Tag created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"slug\": \"string\", \"label\": \"string\" }" ``` ## PUT `/customers/tags` Update tag Updates label, color, or description for an existing tag. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Tag updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/tags" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## POST `/customers/tags/assign` Assign tag to customer entity Links a tag to a customer entity within the validated tenant / organization scope. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "tagId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Tag assigned to customer Content-Type: `application/json` ```json { "id": null } ``` **400** – Validation or assignment failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient tenant/organization access Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/tags/assign" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"tagId\": \"00000000-0000-4000-8000-000000000000\", \"entityId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## POST `/customers/tags/unassign` Remove tag from customer entity Detaches a tag from a customer entity within the validated tenant / organization scope. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "tenantId": "00000000-0000-4000-8000-000000000000", "tagId": "00000000-0000-4000-8000-000000000000", "entityId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Tag unassigned from customer Content-Type: `application/json` ```json { "id": null } ``` **400** – Validation or unassignment failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient tenant/organization access Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/tags/unassign" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"organizationId\": \"00000000-0000-4000-8000-000000000000\", \"tenantId\": \"00000000-0000-4000-8000-000000000000\", \"tagId\": \"00000000-0000-4000-8000-000000000000\", \"entityId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## DELETE `/customers/todos` Delete customertodo DEPRECATED (sunset 2026-06-30): Deletes a customer task. Use DELETE /api/customers/interactions instead. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – CustomerTodo deleted Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/customers/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/customers/todos` List customertodos Returns a paginated collection of customertodos scoped to the authenticated organization. **Tags:** Customers **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | all | query | any | Optional | | entityId | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated customertodos Content-Type: `application/json` ```json { "items": [ { "id": "string", "todoId": "string", "todoSource": "string", "todoTitle": null, "todoIsDone": null, "todoPriority": null, "todoSeverity": null, "todoDescription": null, "todoDueAt": null, "todoCustomValues": null, "todoOrganizationId": null, "todoUpdatedAt": null, "organizationId": "string", "tenantId": "string", "createdAt": "string", "externalHref": null, "customer": { "id": null, "displayName": null, "kind": null } } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/customers/todos?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/customers/todos` Create customertodo DEPRECATED (sunset 2026-06-30): Creates a customer task. Use POST /api/customers/interactions instead. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "00000000-0000-4000-8000-000000000000", "title": "string", "todoSource": "customers:interaction" } ``` ### Responses **201** – CustomerTodo created Content-Type: `application/json` ```json { "linkId": null, "todoId": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/customers/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"00000000-0000-4000-8000-000000000000\", \"title\": \"string\", \"todoSource\": \"customers:interaction\" }" ``` ## PUT `/customers/todos` Update customertodo DEPRECATED (sunset 2026-06-30): Updates a customer task. Use PUT /api/customers/interactions instead. **Tags:** Customers **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – CustomerTodo updated Content-Type: `application/json` ```json { "ok": true } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/customers/todos" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/dashboards/layout` Load the current dashboard layout Returns the saved widget layout together with the widgets the current user is allowed to place. **Tags:** Dashboards **Requires authentication.** ### Responses **200** – Current dashboard layout and available widgets. Content-Type: `application/json` ```json { "layout": { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "widgetId": "string", "order": 1 } ] }, "allowedWidgetIds": [ "string" ], "canConfigure": true, "context": { "userId": "00000000-0000-4000-8000-000000000000", "tenantId": null, "organizationId": null, "userName": null, "userEmail": null, "userLabel": "string" }, "widgets": [ { "id": "string", "title": "string", "description": null, "defaultSize": "sm", "defaultEnabled": true, "defaultSettings": null, "features": [ "string" ], "moduleId": "string", "icon": null, "loaderKey": "string", "supportsRefresh": true } ] } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – No user binding in the authenticated scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/dashboards/layout" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/dashboards/layout` Persist dashboard layout changes Saves the provided widget ordering, sizes, and settings for the current user. **Tags:** Dashboards **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "widgetId": "string", "order": 1 } ] } ``` ### Responses **200** – Layout updated successfully. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid layout payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing dashboards.configure feature Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Widget registry unavailable — the layout was not saved Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/dashboards/layout" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"items\": [ { \"id\": \"00000000-0000-4000-8000-000000000000\", \"widgetId\": \"string\", \"order\": 1 } ] }" ``` ## PATCH `/dashboards/layout/{itemId}` Update a dashboard layout item Adjusts the size or settings for a single widget within the dashboard layout. **Tags:** Dashboards **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | itemId | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Layout item updated. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid payload or missing item id Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing dashboards.configure feature Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Item not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/dashboards/layout/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## GET `/dashboards/roles/widgets` Fetch widget assignments for a role Returns the widgets explicitly assigned to the given role together with the evaluation scope. **Tags:** Dashboards **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | roleId | query | any | Required | | tenantId | query | any | Optional | | organizationId | query | any | Optional | ### Responses **200** – Current widget configuration for the role. Content-Type: `application/json` ```json { "widgetIds": [ "string" ], "hasCustom": true, "scope": { "tenantId": null, "organizationId": null } } ``` **400** – Missing role identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions to manage role widgets Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/dashboards/roles/widgets?roleId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/dashboards/roles/widgets` Update widgets assigned to a role Persists the widget list for a role within the provided tenant and organization scope. **Tags:** Dashboards **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "roleId": "00000000-0000-4000-8000-000000000000", "widgetIds": [ "string" ] } ``` ### Responses **200** – Widgets updated successfully. Content-Type: `application/json` ```json { "ok": true, "widgetIds": [ "string" ] } ``` **400** – Invalid payload or unknown widgets Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions to manage role widgets Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/dashboards/roles/widgets" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"roleId\": \"00000000-0000-4000-8000-000000000000\", \"widgetIds\": [ \"string\" ] }" ``` ## GET `/dashboards/users/widgets` Read widget overrides for a user Returns the widgets inherited and explicitly configured for the requested user within the current scope. **Tags:** Dashboards **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | userId | query | any | Required | | tenantId | query | any | Optional | | organizationId | query | any | Optional | ### Responses **200** – Widget settings for the user. Content-Type: `application/json` ```json { "mode": "inherit", "widgetIds": [ "string" ], "hasCustom": true, "effectiveWidgetIds": [ "string" ], "scope": { "tenantId": null, "organizationId": null } } ``` **400** – Missing user identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions to manage user widgets Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/dashboards/users/widgets?userId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/dashboards/users/widgets` Update user-specific dashboard widgets Sets the widget override mode and allowed widgets for a user. Passing `mode: inherit` clears overrides. **Tags:** Dashboards **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "userId": "00000000-0000-4000-8000-000000000000", "mode": "inherit", "widgetIds": [ "string" ] } ``` ### Responses **200** – Overrides saved. Content-Type: `application/json` ```json { "ok": true, "mode": "inherit", "widgetIds": [ "string" ] } ``` **400** – Invalid payload or unknown widgets Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions to manage user widgets Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/dashboards/users/widgets" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"userId\": \"00000000-0000-4000-8000-000000000000\", \"mode\": \"inherit\", \"widgetIds\": [ \"string\" ] }" ``` ## GET `/dashboards/widgets/catalog` List available dashboard widgets Returns the catalog of widgets that modules expose, including defaults and feature requirements. **Tags:** Dashboards **Requires authentication.** ### Responses **200** – Widgets available for assignment. Content-Type: `application/json` ```json { "items": [ { "id": "string", "title": "string", "description": null, "defaultSize": "sm", "defaultEnabled": true, "defaultSettings": null, "features": [ "string" ], "moduleId": "string", "icon": null, "loaderKey": "string", "supportsRefresh": true } ] } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions to view widget catalog Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/dashboards/widgets/catalog" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/dashboards/widgets/data` Fetch aggregated data for dashboard widgets Executes an aggregation query against the specified entity type and returns the result. Supports date range filtering, grouping, and period-over-period comparison. **Tags:** Dashboards **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityType": "string", "metric": { "field": "string", "aggregate": "count" } } ``` ### Responses **200** – Aggregated data for the widget. Content-Type: `application/json` ```json { "value": null, "data": [ { "value": null } ], "metadata": { "fetchedAt": "string", "recordCount": 1, "currency": null } } ``` **400** – Invalid request payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing analytics.view feature Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Too many rows to group an encrypted field in application code Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Encryption is configured but the group source cannot currently be resolved Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/dashboards/widgets/data" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityType\": \"string\", \"metric\": { \"field\": \"string\", \"aggregate\": \"count\" } }" ``` ## POST `/dashboards/widgets/data/batch` Fetch aggregated data for multiple dashboard widgets in one request Resolves a batch of widget data requests with a single authentication, RBAC, organization-scope, and database-context setup. Each request is keyed by an opaque widget id and resolved independently, so a failure in one widget does not fail the batch. **Tags:** Dashboards **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "requests": [ { "id": "string", "request": { "entityType": "string", "metric": { "field": "string", "aggregate": "count" } } } ] } ``` ### Responses **200** – Per-widget aggregation results keyed by request id. Content-Type: `application/json` ```json { "results": [ { "id": "string", "ok": true, "data": { "value": null, "data": [ { "value": null } ], "metadata": { "fetchedAt": "string", "recordCount": 1, "currency": null } } } ] } ``` **400** – Invalid request payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/dashboards/widgets/data/batch" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"requests\": [ { \"id\": \"string\", \"request\": { \"entityType\": \"string\", \"metric\": { \"field\": \"string\", \"aggregate\": \"count\" } } } ] }" ``` ## GET `/dictionaries` List dictionaries Returns dictionaries accessible to the current organization, optionally including inactive records. **Tags:** Dictionaries **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | includeInactive | query | any | Optional | ### Responses **200** – Dictionary collection. Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "description": null, "isSystem": true, "isActive": true, "managerVisibility": null, "organizationId": null, "createdAt": "string", "updatedAt": null } ] } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to load dictionaries Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/dictionaries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/dictionaries` Create dictionary Registers a dictionary scoped to the current organization. **Tags:** Dictionaries **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "key": "string", "name": "string" } ``` ### Responses **201** – Dictionary created. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "description": null, "isSystem": true, "isActive": true, "managerVisibility": null, "organizationId": null, "createdAt": "string", "updatedAt": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Dictionary key already exists Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to create dictionary Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/dictionaries" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"key\": \"string\", \"name\": \"string\" }" ``` ## DELETE `/dictionaries/{dictionaryId}` Delete dictionary Soft deletes the dictionary unless it is the protected currency dictionary. **Tags:** Dictionaries **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **200** – Dictionary archived. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Protected dictionary cannot be deleted Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to delete dictionary Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/dictionaries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/dictionaries/{dictionaryId}` Get dictionary Returns details for the specified dictionary, including inheritance flags. **Tags:** Dictionaries **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Responses **200** – Dictionary details. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "description": null, "isSystem": true, "isActive": true, "managerVisibility": null, "organizationId": null, "createdAt": "string", "updatedAt": null } ``` **400** – Invalid parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to load dictionary Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/dictionaries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/dictionaries/{dictionaryId}` Update dictionary Updates mutable attributes of the dictionary. Currency dictionaries are protected from modification. **Tags:** Dictionaries **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Dictionary updated. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "description": null, "isSystem": true, "isActive": true, "managerVisibility": null, "organizationId": null, "createdAt": "string", "updatedAt": null } ``` **400** – Validation failed or protected dictionary Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Dictionary key already exists Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to update dictionary Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/dictionaries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## GET `/dictionaries/{dictionaryId}/entries` List dictionary entries Returns entries for the specified dictionary ordered by its configured entry sort mode. The number of entries returned per request is capped at 500; use `limit` and `offset` with the `total`/`hasMore` response fields to page through larger dictionaries. **Tags:** Dictionaries **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | | limit | query | any | Optional. Maximum entries to return. Defaults to and is capped at 500. | | offset | query | any | Optional. Number of entries to skip. Defaults to 0. | ### Responses **200** – Dictionary entries. Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": "string", "color": null, "icon": null, "position": 1, "isDefault": true, "createdAt": "string", "updatedAt": null } ], "total": 1, "limit": 1, "offset": 1, "hasMore": true, "sortMode": "label_asc" } ``` **400** – Invalid parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to load dictionary entries Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/dictionaries/00000000-0000-4000-8000-000000000000/entries" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/dictionaries/{dictionaryId}/entries` Create dictionary entry Creates a new entry in the specified dictionary. **Tags:** Dictionaries **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "value": "string", "color": null, "icon": null } ``` ### Responses **201** – Dictionary entry created. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": "string", "color": null, "icon": null, "position": 1, "isDefault": true, "createdAt": "string", "updatedAt": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to create dictionary entry Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/dictionaries/00000000-0000-4000-8000-000000000000/entries" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"value\": \"string\", \"color\": null, \"icon\": null }" ``` ## DELETE `/dictionaries/{dictionaryId}/entries/{entryId}` Delete dictionary entry Deletes the specified dictionary entry via the command bus. **Tags:** Dictionaries **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | | entryId | path | any | Required | ### Responses **200** – Entry deleted. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary or entry not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to delete entry Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/dictionaries/00000000-0000-4000-8000-000000000000/entries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/dictionaries/{dictionaryId}/entries/{entryId}` Update dictionary entry Updates the specified dictionary entry using the command bus pipeline. **Tags:** Dictionaries **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | | entryId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "color": null, "icon": null } ``` ### Responses **200** – Dictionary entry updated. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "value": "string", "label": "string", "color": null, "icon": null, "position": 1, "isDefault": true, "createdAt": "string", "updatedAt": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary or entry not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to update entry Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/dictionaries/00000000-0000-4000-8000-000000000000/entries/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"color\": null, \"icon\": null }" ``` ## POST `/dictionaries/{dictionaryId}/entries/reorder` Reorder dictionary entries Updates the position of dictionary entries for drag-and-drop reordering. **Tags:** Dictionaries **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "entries": [ { "id": "00000000-0000-4000-8000-000000000000", "position": 1 } ] } ``` ### Responses **200** – Entries reordered. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to reorder entries Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/dictionaries/00000000-0000-4000-8000-000000000000/entries/reorder" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entries\": [ { \"id\": \"00000000-0000-4000-8000-000000000000\", \"position\": 1 } ] }" ``` ## POST `/dictionaries/{dictionaryId}/entries/set-default` Set default dictionary entry Marks the specified entry as the default for this dictionary, clearing any previous default. **Tags:** Dictionaries **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dictionaryId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "entryId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Default entry set. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Dictionary or entry not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to set default entry Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/dictionaries/00000000-0000-4000-8000-000000000000/entries/set-default" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entryId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/directory/organization-branding` Read sidebar branding for the selected organization Returns the logo URL used by the backend sidebar for the currently selected organization. **Tags:** Directory **Requires authentication.** ### Responses **200** – Organization branding Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "organizationName": "string", "tenantId": "00000000-0000-4000-8000-000000000000", "logoUrl": null, "logoPreserveAspectRatio": true, "updatedAt": null } ``` **400** – A concrete organization scope is required Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Organization not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/directory/organization-branding" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/directory/organization-branding` Update sidebar branding for the selected organization Stores an external image URL or an internal attachment image URL as the selected organization logo. **Tags:** Directory **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "logoUrl": null } ``` ### Responses **200** – Updated organization branding Content-Type: `application/json` ```json { "organizationId": "00000000-0000-4000-8000-000000000000", "organizationName": "string", "tenantId": "00000000-0000-4000-8000-000000000000", "logoUrl": null, "logoPreserveAspectRatio": true, "updatedAt": null } ``` **400** – Save failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Organization branding changed since it was loaded Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Invalid logo URL Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/directory/organization-branding" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"logoUrl\": null }" ``` ## GET `/directory/organization-switcher` Load organization switcher menu Returns the hierarchical menu of organizations the current user may switch to within the active tenant. **Tags:** Directory **Requires authentication.** ### Responses **200** – Organization switcher payload. Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "depth": 1, "selectable": true, "children": [] } ], "selectedId": null, "canManage": true, "canViewAllOrganizations": true, "tenantId": null, "tenants": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "isActive": true } ], "isSuperAdmin": true } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/directory/organization-switcher" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/directory/organizations` Delete organization Soft deletes an organization identified by id. **Tags:** Directory **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Organization deleted. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing directory.organizations.manage feature Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/directory/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/directory/organizations` List organizations Returns organizations using options, tree, or paginated manage view depending on the `view` parameter. **Tags:** Directory **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | view | query | any | Optional | | ids | query | any | Optional | | tenantId | query | any | Optional | | includeInactive | query | any | Optional | | status | query | any | Optional | ### Responses **200** – Organization data for the requested view. Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "parentId": null, "parentName": null, "tenantId": null, "tenantName": null, "rootId": null, "treePath": null } ] } ``` **400** – Invalid query or tenant scope Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/directory/organizations?page=1&pageSize=50&view=options" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/directory/organizations` Create organization Creates a new organization within a tenant and optionally assigns hierarchy relationships. **Tags:** Directory **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "name": "string", "slug": null, "logoUrl": null, "parentId": null } ``` ### Responses **201** – Organization created. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing directory.organizations.manage feature Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/directory/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"name\": \"string\", \"slug\": null, \"logoUrl\": null, \"parentId\": null }" ``` ## PUT `/directory/organizations` Update organization Updates organization details and hierarchy assignments. Fields that are omitted keep their current value; send `parentId: null` or `childIds: []` to clear the parent or the children. **Tags:** Directory **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "slug": null, "logoUrl": null, "parentId": null } ``` ### Responses **200** – Organization updated. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing directory.organizations.manage feature Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/directory/organizations" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"slug\": null, \"logoUrl\": null, \"parentId\": null }" ``` ## GET `/directory/organizations/lookup` Public organization lookup by slug **Tags:** Directory (Tenants & Organizations) ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/directory/organizations/lookup" \ -H "Accept: application/json" ``` ## DELETE `/directory/tenants` Delete tenant Soft deletes the tenant identified by id. **Tags:** Directory **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Tenant removed. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing directory.tenants.manage feature Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/directory/tenants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/directory/tenants` List tenants Returns tenants visible to the current user with optional search and pagination. **Tags:** Directory **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | isActive | query | any | Optional | ### Responses **200** – Paged list of tenants. Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "isActive": true, "createdAt": null, "updatedAt": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Requires super-admin Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/directory/tenants?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/directory/tenants` Create tenant Creates a new tenant and returns its identifier. **Tags:** Directory **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "name": "string" } ``` ### Responses **201** – Tenant created. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing directory.tenants.manage feature Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/directory/tenants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"name\": \"string\" }" ``` ## PUT `/directory/tenants` Update tenant Updates tenant properties such as name or activation state. **Tags:** Directory **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Tenant updated. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing directory.tenants.manage feature Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/directory/tenants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/directory/tenants/lookup` Public tenant lookup **Tags:** Directory (Tenants & Organizations) ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/directory/tenants/lookup" \ -H "Accept: application/json" ``` ## GET `/documents` List visible documents **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | id | query | any | Optional | | archived | query | any | Optional | | favorite | query | any | Required | | folderId | query | any | Optional | | entityType | query | any | Optional | | entityId | query | any | Optional | ### Responses **200** – Visible document metadata Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "title": "string", "folderId": null, "ownerUserId": "00000000-0000-4000-8000-000000000000", "ownerLabel": null, "createdByUserId": "00000000-0000-4000-8000-000000000000", "isActive": true, "archivedAt": null, "isFavorite": true, "sharedWithCount": 1, "createdAt": "string", "updatedAt": "string", "relationshipTier": null, "capabilities": { "canView": true, "canComment": true, "canEdit": true, "canShare": true, "canDelete": true, "canCreate": true, "canManageTemplates": true, "canArchive": true, "canDuplicate": true } } ], "collectionCapabilities": { "canCreateDocument": true, "canCreateFolder": true, "canLinkDocuments": true, "canInstantiateTemplate": true, "canManageTemplates": true }, "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents?page=1&pageSize=50&archived=exclude" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents` Create document **Tags:** Documents **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "title": "string", "folderId": null } ``` ### Responses **201** – Document created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"title\": \"string\", \"folderId\": null }" ``` ## DELETE `/documents/{id}` Delete document Transactionally releases every document-owned attachment row and its quota usage, soft-deletes the document record, then runs reference-checked provider cleanup after commit. Because attachment bytes cannot be restored, this operation is intentionally not undoable. **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Document deleted Content-Type: `application/json` ```json { "ok": true, "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/documents/{id}` Get document metadata **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Document metadata Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "title": "string", "folderId": null, "ownerUserId": "00000000-0000-4000-8000-000000000000", "createdByUserId": "00000000-0000-4000-8000-000000000000", "isActive": true, "archivedAt": null, "isFavorite": true, "isWatching": true, "createdAt": "string", "updatedAt": "string", "tier": "owner", "canShare": true, "capabilities": { "canView": true, "canComment": true, "canEdit": true, "canShare": true, "canDelete": true, "canCreate": true, "canManageTemplates": true, "canArchive": true, "canDuplicate": true } } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/documents/{id}` Update document metadata **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "folderId": null } ``` ### Responses **200** – Document updated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"folderId\": null }" ``` ## POST `/documents/{id}/archive` Archive a document, making it read-only and hidden from default listings **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Archived document state Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "archivedAt": null, "updatedAt": "string" } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Document not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Document changed concurrently Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents/{id}/attachments` Upload document attachment **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `multipart/form-data` ```text file=string ``` ### Responses **201** – Document-scoped attachment uploaded Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "attachmentId": "00000000-0000-4000-8000-000000000000", "updatedAt": "string", "url": "string" } ``` **400** – Payload validation error, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Attachment too large Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Attachment service unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: multipart/form-data" \ -d "{ \"file\": \"string\" }" ``` ## DELETE `/documents/{id}/attachments/{attachmentId}` Detach a document-scoped attachment Transactionally removes the document attachment row and quota usage, then runs reference-checked provider cleanup after commit. This operation is audited and intentionally not undoable. **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | attachmentId | path | any | Required | ### Responses **200** – Attachment deletion committed Content-Type: `application/json` ```json { "ok": true } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Attachment not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict or attachment still referenced Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/attachments/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/documents/{id}/attachments/{attachmentId}` Read a document-scoped attachment **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | attachmentId | path | any | Required | ### Responses **200** – Attachment bytes Content-Type: `application/json` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Attachment not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Partition misconfigured Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Attachment service unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/attachments/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/documents/{id}/collab-token` Mint document collaboration token **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Collaboration token Content-Type: `application/json` ```json { "token": "string", "url": null, "documentId": "string", "tier": "owner", "expiresInSec": 1, "expiresAt": "string", "userName": "string", "userColor": "string", "canEdit": true, "readOnly": true, "user": { "id": "string", "name": "string", "color": "string" } } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/collab-token" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/documents/{id}/comments` List document comments **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | page | query | any | Optional | | pageSize | query | any | Required | ### Responses **200** – Threaded document comments Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "documentId": "00000000-0000-4000-8000-000000000000", "parentCommentId": null, "authorUserId": "00000000-0000-4000-8000-000000000000", "body": "string", "anchor": null, "mentions": [ { "userId": "00000000-0000-4000-8000-000000000000" } ], "resolvedAt": null, "resolvedByUserId": null, "createdAt": "string", "updatedAt": "string", "canResolve": true, "replies": [] } ], "userLabels": { "key": { "label": "string" } }, "page": 1, "pageSize": 1, "total": 1, "totalPages": 1, "totalComments": 1, "truncated": true } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/comments?page=1" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/documents/{id}/comments` Resolve or unresolve document comment **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "resolved": true } ``` ### Responses **200** – Comment resolution updated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "resolvedAt": null, "resolvedByUserId": null, "updatedAt": "string" } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Comment not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"resolved\": true }" ``` ## POST `/documents/{id}/comments` Create document comment Mentions may be sent out-of-band as mentions: [{ userId }]. Legacy bracketed @[user-uuid] tokens in the comment body are still honored. **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "body": "string", "anchor": null, "parentCommentId": null } ``` ### Responses **201** – Comment created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body or document comment limit exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/comments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"body\": \"string\", \"anchor\": null, \"parentCommentId\": null }" ``` ## POST `/documents/{id}/comments/access-check` Check which mentioned users lack access **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "userIds": [ "00000000-0000-4000-8000-000000000000" ] } ``` ### Responses **200** – Mention access check result Content-Type: `application/json` ```json { "withoutAccess": [ "00000000-0000-4000-8000-000000000000" ], "withoutAccessUsers": [ { "userId": "00000000-0000-4000-8000-000000000000", "label": null, "secondary": null } ] } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/comments/access-check" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"userIds\": [ \"00000000-0000-4000-8000-000000000000\" ] }" ``` ## GET `/documents/{id}/content` Get document content **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Document content Content-Type: `application/json` ```json { "contentHtml": "string", "contentText": "string", "updatedAt": null } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Not found Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Stored document content exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/content" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/documents/{id}/content` Update document content **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "contentHtml": "string", "contentText": null } ``` ### Responses **200** – Content persisted Content-Type: `application/json` ```json { "ok": true, "updatedAt": null } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Content changed since it was loaded Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Document content exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/content" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"contentHtml\": \"string\", \"contentText\": null }" ``` ## POST `/documents/{id}/duplicate` Create a copy of a visible document owned by the acting user **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **201** – Copy created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string", "copiedAttachments": 1, "copiedLinks": 1, "droppedLinks": 1 } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Document not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Source exceeds the duplicate fanout bounds, or The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/duplicate" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## GET `/documents/{id}/export` Export document Returns a binary .docx or PDF file attachment for a document. **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | format | query | any | Optional | ### Responses **200** – Document export file Content-Type: `application/octet-stream` ```text string ``` **400** – Unsupported format, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Not found Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Document or generated export exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Export runtime is unavailable, overloaded, or timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/export" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents/{id}/export` Export a paginated DOCX document Returns a DOCX attachment using the editor pagination snapshot supplied by the client. **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | format | query | any | Optional | ### Request Body Content-Type: `application/json` ```json { "contentHtml": "string", "pageBreakMarker": "string" } ``` ### Responses **200** – Paginated DOCX export file Content-Type: `application/vnd.openxmlformats-officedocument.wordprocessingml.document` ```text string ``` **400** – Invalid pagination snapshot or unsupported format, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Not found Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Document or generated export exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Export runtime is unavailable, overloaded, or timed out Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/export" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"contentHtml\": \"string\", \"pageBreakMarker\": \"string\" }" ``` ## DELETE `/documents/{id}/favorite` Remove the current user star from a document **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Favorite state Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "active": true } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/favorite" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents/{id}/favorite` Star a document for the current user **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Favorite state Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "active": true } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Document not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/favorite" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/documents/{id}/links` List entity links visible to the document viewer **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Document entity links Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "entityType": "customer-person", "entityId": null, "label": "string", "href": null, "canOpen": true, "archivedAt": null, "source": "chip", "createdAt": "string", "updatedAt": "string" } ] } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body or document link limit exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/links" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents/{id}/links` Link a document to an entity **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "entityType": "customer-person", "entityId": "00000000-0000-4000-8000-000000000000", "label": "string", "href": "string", "source": "chip" } ``` ### Responses **201** – Link created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "entityType": "customer-person", "entityId": null, "label": "string", "href": null, "canOpen": true, "archivedAt": null, "source": "chip", "createdAt": "string", "updatedAt": "string" } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Document link limit exceeded Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Target lookup unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/links" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityType\": \"customer-person\", \"entityId\": \"00000000-0000-4000-8000-000000000000\", \"label\": \"string\", \"href\": \"string\", \"source\": \"chip\" }" ``` ## DELETE `/documents/{id}/links/{linkId}` Soft-delete a document entity link **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | linkId | path | any | Required | ### Responses **200** – Link deleted Content-Type: `application/json` ```json { "ok": true, "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Link not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/links/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/documents/{id}/principals` List principals eligible for document mentions or sharing Returns a bounded, document-authorized user or role page without requiring broad Auth administration grants. **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | mode | query | any | Optional | | type | query | any | Optional | | search | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | ### Responses **200** – Eligible principal page Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "secondary": null } ], "page": 1, "pageSize": 1, "total": 1, "totalPages": 1 } ``` **400** – Invalid picker query, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Document capability denied Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/principals?mode=share&type=user&page=1&pageSize=20" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/documents/{id}/shares` Remove document share **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Share removed Content-Type: `application/json` ```json { "ok": true, "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/shares" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/documents/{id}/shares` List document shares **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Document shares Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "documentId": "00000000-0000-4000-8000-000000000000", "principalType": "user", "principalId": "00000000-0000-4000-8000-000000000000", "permission": "viewer", "createdByUserId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "principalLabel": null, "principalSecondary": null } ], "truncated": true } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/shares" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents/{id}/shares` Share document **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "principalType": "user", "principalId": "00000000-0000-4000-8000-000000000000", "permission": "viewer" } ``` ### Responses **201** – Document shared Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/shares" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"principalType\": \"user\", \"principalId\": \"00000000-0000-4000-8000-000000000000\", \"permission\": \"viewer\" }" ``` ## PUT `/documents/{id}/shares` Update document share **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "permission": "viewer" } ``` ### Responses **200** – Share updated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/shares" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"permission\": \"viewer\" }" ``` ## POST `/documents/{id}/unarchive` Restore an archived document to its active editable state **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Active document state Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "archivedAt": null, "updatedAt": "string" } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Document not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Document changed concurrently Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/unarchive" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/documents/{id}/versions` List document versions **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | page | query | any | Optional | | pageSize | query | any | Optional | ### Responses **200** – Document version metadata Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "label": null, "createdByUserId": "00000000-0000-4000-8000-000000000000", "createdByLabel": null, "createdAt": "string" } ], "page": 1, "pageSize": 1, "total": 1, "totalPages": 1 } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/versions?page=1&pageSize=100" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents/{id}/versions` Create document version snapshot **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "label": null } ``` ### Responses **201** – Version snapshot created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "label": null, "createdByUserId": "00000000-0000-4000-8000-000000000000", "createdAt": "string" } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body, document content, or version history exceeds its safe storage bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/versions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"label\": null }" ``` ## GET `/documents/{id}/versions/{versionId}` Read a sanitized historical document preview **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | versionId | path | any | Required | ### Responses **200** – Historical document preview Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "label": null, "creatorLabel": "string", "createdAt": "string", "contentHtml": "string" } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Version not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Version snapshot is invalid, or The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/versions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents/{id}/versions/{versionId}/restore` Restore and materialize a historical document version **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | versionId | path | any | Required | ### Responses **200** – Restored document content Content-Type: `application/json` ```json { "contentHtml": "string", "contentText": "string", "updatedAt": "string", "restoredVersionId": "00000000-0000-4000-8000-000000000000", "preRestoreVersionId": "00000000-0000-4000-8000-000000000000" } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Version or content not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Document content changed Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Version snapshot is invalid, or The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/versions/00000000-0000-4000-8000-000000000000/restore" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/documents/{id}/watch` Stop watching a document (allowed even after access loss) **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Watch state Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "active": true } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/watch" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents/{id}/watch` Watch a document for activity notifications **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Watch state Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "active": true } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Document not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Watcher limit reached, or The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/00000000-0000-4000-8000-000000000000/watch" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/documents/folders` Delete document folder **Tags:** Documents **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Folder deleted Content-Type: `application/json` ```json { "ok": true, "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/documents/folders" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/documents/folders` List document folders **Tags:** Documents **Requires authentication.** ### Responses **200** – Folder tree Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "parentFolderId": null, "ownerUserId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "canEdit": true, "visibility": "owned", "children": [] } ], "total": 1 } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/folders" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents/folders` Create document folder **Tags:** Documents **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "name": "string", "parentFolderId": null } ``` ### Responses **201** – Folder created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/folders" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"name\": \"string\", \"parentFolderId\": null }" ``` ## PUT `/documents/folders` Update document folder **Tags:** Documents **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "parentFolderId": null } ``` ### Responses **200** – Folder updated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Invalid folder hierarchy, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/documents/folders" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"parentFolderId\": null }" ``` ## POST `/documents/instantiate` Atomically create document metadata, content, and entity links **Tags:** Documents **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "templateUpdatedAt": "string", "title": "string", "locale": "string", "effectiveDate": "string", "slots": [ { "slot": "string", "entityType": "customer-person", "entityId": "00000000-0000-4000-8000-000000000000", "label": "string", "href": "string", "values": { "key": "string" } } ], "templateId": "00000000-0000-4000-8000-000000000000", "folderId": null, "previewDigest": "string" } ``` ### Responses **201** – Document instantiated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string", "links": [ { "id": "00000000-0000-4000-8000-000000000000", "entityType": "string", "label": "string", "href": "string" } ] } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Template or folder not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Preview or template revision changed Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Target lookup unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/instantiate" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"templateUpdatedAt\": \"string\", \"title\": \"string\", \"locale\": \"string\", \"effectiveDate\": \"string\", \"slots\": [ { \"slot\": \"string\", \"entityType\": \"customer-person\", \"entityId\": \"00000000-0000-4000-8000-000000000000\", \"label\": \"string\", \"href\": \"string\", \"values\": { \"key\": \"string\" } } ], \"templateId\": \"00000000-0000-4000-8000-000000000000\", \"folderId\": null, \"previewDigest\": \"string\" }" ``` ## DELETE `/documents/templates` Delete document template **Tags:** Documents **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Template deleted Content-Type: `application/json` ```json { "ok": true, "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/documents/templates" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/documents/templates` List document templates **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | search | query | any | Optional | | isActive | query | any | Optional | | includeBody | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | ### Responses **200** – Template list Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "description": null, "contextSlots": null, "isActive": true, "updatedAt": "string", "createdAt": "string" } ], "total": 1, "capabilities": { "canManageTemplates": true }, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/templates" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents/templates` Create document template **Tags:** Documents **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "name": "string", "description": null, "bodyHtml": "string", "contextSlots": null } ``` ### Responses **201** – Template created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/templates" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"name\": \"string\", \"description\": null, \"bodyHtml\": \"string\", \"contextSlots\": null }" ``` ## PUT `/documents/templates` Update document template **Tags:** Documents **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "description": null, "contextSlots": null } ``` ### Responses **200** – Template updated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/documents/templates" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"description\": null, \"contextSlots\": null }" ``` ## GET `/documents/templates/{templateId}` Get a document template including its body **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | templateId | path | any | Required | ### Responses **200** – Template detail Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "name": "string", "description": null, "bodyHtml": "string", "contextSlots": null, "isActive": true, "updatedAt": "string", "createdAt": "string" } ``` **400** – Invalid template id, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Template not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/documents/templates/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/documents/templates/{templateId}/preview` Render a template preview without writing data **Tags:** Documents **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | templateId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "templateUpdatedAt": "string", "title": "string", "locale": "string", "effectiveDate": "string", "slots": [ { "slot": "string", "entityType": "customer-person", "entityId": "00000000-0000-4000-8000-000000000000", "label": "string", "href": "string", "values": { "key": "string" } } ] } ``` ### Responses **200** – Rendered template preview Content-Type: `application/json` ```json { "contentHtml": "string", "unresolvedTokens": [ "string" ], "templateUpdatedAt": "string", "previewDigest": "string" } ``` **400** – Validation failed, or Organization scope could not be resolved (`code: organization_scope_required`) Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Template not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Template revision changed Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Request body exceeds the safe resource bound Content-Type: `application/json` ```json { "error": "string" } ``` **422** – The selected organization no longer resolves (`code: organization_selection_invalid`) Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Target lookup unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/documents/templates/00000000-0000-4000-8000-000000000000/preview" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"templateUpdatedAt\": \"string\", \"title\": \"string\", \"locale\": \"string\", \"effectiveDate\": \"string\", \"slots\": [ { \"slot\": \"string\", \"entityType\": \"customer-person\", \"entityId\": \"00000000-0000-4000-8000-000000000000\", \"label\": \"string\", \"href\": \"string\", \"values\": { \"key\": \"string\" } } ] }" ``` ## DELETE `/entities/definitions` Soft delete custom field definition Marks the specified definition inactive and tombstones it for the current scope. **Tags:** Entities **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "key": "string" } ``` ### Responses **200** – Definition deleted Content-Type: `application/json` ```json { "ok": true, "version": null } ``` **400** – Missing entity id or key Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Definition not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/entities/definitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"string\", \"key\": \"string\" }" ``` ## GET `/entities/definitions` List active custom field definitions Returns active custom field definitions for the supplied entity ids, respecting tenant scope and tombstones. **Tags:** Entities **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Optional | | entityIds | query | any | Optional | | fieldset | query | any | Optional | ### Responses **200** – Definition list Content-Type: `application/json` ```json { "items": [ { "key": "string", "kind": "string", "label": "string", "entityId": "string" } ] } ``` **400** – Missing entity id Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/entities/definitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/definitions` Upsert custom field definition Creates or updates a custom field definition for the current tenant/org scope. **Tags:** Entities **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "key": "string", "kind": "text" } ``` ### Responses **200** – Definition saved Content-Type: `application/json` ```json { "ok": true, "item": { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "kind": "string", "configJson": {} } } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/entities/definitions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"string\", \"key\": \"string\", \"kind\": \"text\" }" ``` ## POST `/entities/definitions.batch` Save multiple custom field definitions Creates or updates multiple definitions for a single entity in one transaction. **Tags:** Entities **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "definitions": [ { "key": "string", "kind": "text" } ] } ``` ### Responses **200** – Definitions saved Content-Type: `application/json` ```json { "ok": true, "version": null } ``` **400** – Validation error Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected failure Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/entities/definitions.batch" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"string\", \"definitions\": [ { \"key\": \"string\", \"kind\": \"text\" } ] }" ``` ## GET `/entities/definitions.manage` Get management snapshot Returns scoped custom field definitions (including inactive tombstones) for administration interfaces. **Tags:** Entities **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Required | ### Responses **200** – Scoped definitions and deleted keys Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "kind": "string", "configJson": null, "organizationId": null, "tenantId": null } ], "deletedKeys": [ "string" ], "version": null } ``` **400** – Missing entity id Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication or feature Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/entities/definitions.manage?entityId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/definitions.restore` Restore definition Reactivates a previously soft-deleted definition within the current tenant/org scope. **Tags:** Entities **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "key": "string" } ``` ### Responses **200** – Definition restored Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing entity id or key Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Definition not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/entities/definitions.restore" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"string\", \"key\": \"string\" }" ``` ## GET `/entities/encryption` Fetch encryption map Returns the encrypted field map for the current tenant/organization scope. **Tags:** Entities **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Required | ### Responses **200** – Map Content-Type: `application/json` ```json { "entityId": "string", "fields": [ { "field": "string", "hashField": null } ], "updatedAt": null } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/entities/encryption?entityId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/encryption` Upsert encryption map Creates or updates the encryption map for the current tenant/organization scope. Enforces optimistic locking when the caller sends the expected version header. **Tags:** Entities **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "tenantId": null, "organizationId": null, "fields": [ { "field": "string", "hashField": null } ] } ``` ### Responses **200** – Saved Content-Type: `application/json` ```json { "ok": true, "updatedAt": null } ``` **409** – Optimistic-lock conflict (stale write) Content-Type: `application/json` ```json { "error": "string", "code": "string", "currentUpdatedAt": "string", "expectedUpdatedAt": "string" } ``` **422** – Selected organization is unavailable Content-Type: `application/json` ```json { "error": "string", "code": "organization_selection_invalid" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/entities/encryption" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"string\", \"tenantId\": null, \"organizationId\": null, \"fields\": [ { \"field\": \"string\", \"hashField\": null } ] }" ``` ## DELETE `/entities/entities` Soft delete custom entity Marks the specified custom entity inactive within the current scope. **Tags:** Entities **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "string" } ``` ### Responses **200** – Entity deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing entity id Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Entity not found in scope Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/entities/entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"string\" }" ``` ## GET `/entities/entities` List available entities Returns generated and custom entities scoped to the caller with field counts per entity. **Tags:** Entities **Requires authentication.** ### Responses **200** – List of entities Content-Type: `application/json` ```json { "items": [ { "entityId": "string", "source": "code", "label": "string", "count": 1 } ] } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/entities/entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/entities` Upsert custom entity Creates or updates a tenant/org scoped custom entity definition. **Tags:** Entities **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "label": "string", "description": null, "showInSidebar": false, "accessRestricted": false } ``` ### Responses **200** – Entity saved Content-Type: `application/json` ```json { "ok": true, "item": { "id": "00000000-0000-4000-8000-000000000000", "entityId": "string", "label": "string" } } ``` **400** – Validation error Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/entities/entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"string\", \"label\": \"string\", \"description\": null, \"showInSidebar\": false, \"accessRestricted\": false }" ``` ## GET `/entities/entity-settings` Get custom entity settings Returns the tenant-scoped default-restricted policy for new custom entities. **Tags:** Entities **Requires authentication.** ### Responses **200** – Current settings Content-Type: `application/json` ```json { "newEntitiesRestrictedByDefault": true, "updatedAt": null } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/entities/entity-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/entities/entity-settings` Update custom entity settings Sets the tenant-scoped default-restricted policy for new custom entities. **Tags:** Entities **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "newEntitiesRestrictedByDefault": true } ``` ### Responses **200** – Updated settings Content-Type: `application/json` ```json { "ok": true, "newEntitiesRestrictedByDefault": true, "updatedAt": null } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Optimistic lock conflict Content-Type: `application/json` ```json { "code": "string", "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/entities/entity-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"newEntitiesRestrictedByDefault\": true }" ``` ## DELETE `/entities/records` Delete record Soft deletes the specified record within the current tenant/org scope. **Tags:** Entities **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "recordId": "string" } ``` ### Responses **200** – Record deleted Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing entity id or record id Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Record not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected failure Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/entities/records" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"string\", \"recordId\": \"string\" }" ``` ## GET `/entities/records` List records Returns paginated records for the supplied entity. Supports custom field filters, exports, and soft-delete toggles. **Tags:** Entities **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Required | | page | query | any | Optional | | pageSize | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | search | query | any | Optional | | searchFields | query | any | Optional | | withDeleted | query | any | Optional | | format | query | any | Optional | | exportScope | query | any | Optional | | export_scope | query | any | Optional | | all | query | any | Optional | | full | query | any | Optional | ### Responses **200** – Paginated records Content-Type: `application/json` ```json { "items": [ {} ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **400** – Missing entity id Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected failure Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/entities/records?entityId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/entities/records` Create record Creates a record for the given entity. When `recordId` is omitted or not a UUID the data engine will generate one automatically. **Tags:** Entities **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "values": {} } ``` ### Responses **200** – Record created Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failure Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected failure Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/entities/records" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"string\", \"values\": {} }" ``` ## PUT `/entities/records` Update record Updates an existing record. If the provided recordId is not a UUID the record will be created instead to support optimistic flows. **Tags:** Entities **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityId": "string", "recordId": "string", "values": {} } ``` ### Responses **200** – Record updated Content-Type: `application/json` ```json { "ok": true } ``` **400** – Validation failure Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Unexpected failure Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/entities/records" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityId\": \"string\", \"recordId\": \"string\", \"values\": {} }" ``` ## GET `/entities/relations/options` List relation options Returns up to 200 option entries for populating relation dropdowns, automatically resolving label fields when omitted. An entityId that matches neither an active custom entity nor a registered ORM entity yields an empty option list. **Tags:** Entities **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Required | | labelField | query | any | Optional | | q | query | any | Optional | | ids | query | any | Optional | | routeContextFields | query | any | Optional | ### Responses **200** – Option list Content-Type: `application/json` ```json { "items": [ { "value": "string", "label": "string" } ] } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/entities/relations/options?entityId=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/entities/sidebar-entities` Get sidebar entities Returns custom entities flagged with `showInSidebar` for the current tenant/org scope. **Tags:** Entities **Requires authentication.** ### Responses **200** – Sidebar entities for navigation Content-Type: `application/json` ```json { "items": [ { "entityId": "string", "label": "string", "href": "string" } ] } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/entities/sidebar-entities" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/events` List declared events Returns every declared event, including its declared payloadSchema when the module (or the generated CRUD default) provides one. Filters: category, module, excludeTriggerExcluded (default true). **Tags:** Events **Requires authentication.** ### Responses **200** – Declared events Content-Type: `application/json` ```json { "data": [ { "id": "string", "label": "string" } ], "total": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/events" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/events/stream` GET /events/stream **Tags:** Events **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/events/stream" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/check/boolean` Check if feature is enabled Checks if a feature toggle is enabled for the current context. **Tags:** Feature Toggles **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | identifier | query | any | Required. Feature toggle identifier | ### Responses **200** – Feature status Content-Type: `application/json` ```json { "enabled": true, "source": "override", "toggleId": "string", "identifier": "string", "tenantId": "string" } ``` **400** – Bad Request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Tenant not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/feature_toggles/check/boolean?identifier=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/check/json` Get json config Gets the json configuration for a feature toggle. **Tags:** Feature Toggles **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | identifier | query | any | Required. Feature toggle identifier | ### Responses **200** – Json config Content-Type: `application/json` ```json { "valueType": "json", "source": "override", "toggleId": "string", "identifier": "string", "tenantId": "string" } ``` **400** – Bad Request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Tenant not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/feature_toggles/check/json?identifier=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/check/number` Get number config Gets the number configuration for a feature toggle. **Tags:** Feature Toggles **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | identifier | query | any | Required. Feature toggle identifier | ### Responses **200** – Number config Content-Type: `application/json` ```json { "valueType": "number", "value": 1, "source": "override", "toggleId": "string", "identifier": "string", "tenantId": "string" } ``` **400** – Bad Request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Tenant not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/feature_toggles/check/number?identifier=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/check/string` Get string config Gets the string configuration for a feature toggle. **Tags:** Feature Toggles **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | identifier | query | any | Required. Feature toggle identifier | ### Responses **200** – String config Content-Type: `application/json` ```json { "valueType": "string", "value": "string", "source": "override", "toggleId": "string", "identifier": "string", "tenantId": "string" } ``` **400** – Bad Request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Tenant not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/feature_toggles/check/string?identifier=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/feature_toggles/global` Delete global feature toggle Soft deletes a global feature toggle by ID. Requires superadmin role. **Tags:** Feature Toggles **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required. Feature toggle identifier | ### Responses **200** – Feature toggle deleted Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden - superadmin role required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Feature toggle not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/feature_toggles/global?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/global` List global feature toggles Returns all global feature toggles with filtering and pagination. Requires superadmin role. **Tags:** Feature Toggles **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional. Page number for pagination | | pageSize | query | any | Optional. Number of items per page (max 200) | | search | query | any | Optional. Case-insensitive search across identifier, name, description, and category | | type | query | any | Optional. Filter by toggle type (boolean, string, number, json) | | category | query | any | Optional. Filter by category (case-insensitive partial match) | | name | query | any | Optional. Filter by name (case-insensitive partial match) | | identifier | query | any | Optional. Filter by identifier (case-insensitive partial match) | | sortField | query | any | Optional. Field to sort by | | sortDir | query | any | Optional. Sort direction (ascending or descending) | ### Responses **200** – Feature toggles collection Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "identifier": "string", "name": "string", "description": null, "category": null, "type": "boolean", "defaultValue": null, "createdAt": null, "updatedAt": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden - superadmin role required Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/feature_toggles/global?page=1&pageSize=50" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/feature_toggles/global` Create global feature toggle Creates a new global feature toggle. Requires superadmin role. **Tags:** Feature Toggles **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "identifier": "string", "name": "string", "description": null, "category": null, "type": "boolean", "defaultValue": null } ``` ### Responses **201** – Feature toggle created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden - superadmin role required Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/feature_toggles/global" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"identifier\": \"string\", \"name\": \"string\", \"description\": null, \"category\": null, \"type\": \"boolean\", \"defaultValue\": null }" ``` ## PUT `/feature_toggles/global` Update global feature toggle Updates an existing global feature toggle. Requires superadmin role. **Tags:** Feature Toggles **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "description": null, "category": null, "defaultValue": null } ``` ### Responses **200** – Feature toggle updated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden - superadmin role required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Feature toggle not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/feature_toggles/global" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"description\": null, \"category\": null, \"defaultValue\": null }" ``` ## GET `/feature_toggles/global/{id}` Fetch feature toggle by ID Returns complete details of a feature toggle. **Tags:** Feature Toggles **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Feature toggle detail Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "identifier": "string", "name": "string", "description": null, "category": null, "type": "boolean", "defaultValue": null, "createdAt": null, "updatedAt": null } ``` **400** – Invalid identifier Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Feature toggle not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/feature_toggles/global/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/global/{id}/override` Fetch feature toggle override Returns feature toggle override. **Tags:** Feature Toggles **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Feature toggle overrides Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "tenantName": "string", "tenantId": "00000000-0000-4000-8000-000000000000", "toggleType": "boolean", "updatedAt": null } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Feature toggle not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/feature_toggles/global/:id/override" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/feature_toggles/overrides` List overrides Returns list of feature toggle overrides. **Tags:** Feature Toggles **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | category | query | any | Optional | | name | query | any | Optional | | identifier | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | ### Responses **200** – List of overrides Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "toggleId": "00000000-0000-4000-8000-000000000000", "tenantName": "string", "tenantId": "00000000-0000-4000-8000-000000000000", "identifier": "string", "name": "string", "category": "string", "isOverride": true } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1, "isSuperAdmin": true } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/feature_toggles/overrides?page=1&pageSize=25" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/feature_toggles/overrides` Change override state Enable, disable or inherit a feature toggle for a specific tenant. **Tags:** Feature Toggles **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "toggleId": "00000000-0000-4000-8000-000000000000", "isOverride": true } ``` ### Responses **200** – Override updated Content-Type: `application/json` ```json { "ok": true, "overrideToggleId": null } ``` **400** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/feature_toggles/overrides" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"toggleId\": \"00000000-0000-4000-8000-000000000000\", \"isOverride\": true }" ``` ## GET `/forms` List forms Returns paginated forms scoped to the authenticated organization. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | status | query | any | Optional | | q | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | ### Responses **200** – Form list Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "description": null, "status": "draft", "defaultLocale": "string", "supportedLocales": [ "string" ], "currentPublishedVersionId": null, "currentPublishedVersionNumber": null, "draftVersionId": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **400** – Tenant or organization context missing Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/forms` Create form Creates a new form. Status starts as draft until a version is published. **Tags:** Forms **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "key": "string", "name": "string", "description": null, "defaultLocale": "string", "supportedLocales": [ "string" ], "retentionDays": null } ``` ### Responses **201** – Form created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Form key already taken Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"key\": \"string\", \"name\": \"string\", \"description\": null, \"defaultLocale\": \"string\", \"supportedLocales\": [ \"string\" ], \"retentionDays\": null }" ``` ## DELETE `/forms/{id}` Archive form Soft-archives the form (sets archived_at, status=archived). **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Form archived Content-Type: `application/json` ```json { "ok": true, "updatedAt": "string" } ``` **404** – Form not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/forms/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/forms/{id}` Get form detail Returns the form metadata + version summaries. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Form detail Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "description": null, "status": "draft", "defaultLocale": "string", "supportedLocales": [ "string" ], "currentPublishedVersionId": null, "createdAt": "string", "updatedAt": "string", "versions": [ { "id": "00000000-0000-4000-8000-000000000000", "versionNumber": 1, "status": "draft", "schemaHash": "string", "registryVersion": "string", "publishedAt": null, "publishedBy": null, "changelog": null, "archivedAt": null, "createdAt": "string", "updatedAt": "string" } ] } ``` **404** – Form not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/forms/{id}` Update form metadata Updates the form name, description, and/or locale set (supportedLocales + defaultLocale). **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "description": null, "retentionDays": null } ``` ### Responses **200** – Form updated Content-Type: `application/json` ```json { "ok": true, "updatedAt": "string" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Form not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/forms/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"description\": null, \"retentionDays\": null }" ``` ## GET `/forms/{id}/analytics` Aggregate analytics for a form Tenant-scoped, PII-safe aggregate analytics across all versions of a form: funnel/completion, daily volume, time-to-complete, per-field response counts (value distributions only for non-sensitive enumerable types), and best-effort draft drop-off. Counts only — never raw answer values. **Tags:** Forms Admin **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Aggregate analytics Content-Type: `application/json` ```json { "formId": "string", "window": { "from": null, "to": null }, "scan": { "limit": 1, "scanned": 1, "capped": true }, "funnel": { "started": 1, "submitted": 1, "completionRate": 1, "byStatus": { "key": 1 } }, "volume": [ { "date": "string", "started": 1, "submitted": 1 } ], "timeToComplete": { "sampleSize": 1, "medianSeconds": null, "averageSeconds": null }, "fields": [ { "fieldKey": "string", "type": "string", "sensitive": true, "answered": 1, "blank": 1 } ], "dropOff": [ { "sectionKey": "string", "count": 1 } ] } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Tenant scope required Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Bad query parameters Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Computation failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/:id/analytics" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/forms/{id}/distributions` List distributions Returns all distributions for a form scoped to the authenticated organization. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Distribution list Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "formId": "00000000-0000-4000-8000-000000000000", "mode": "open", "status": "active", "publicSlug": null, "title": null, "defaultLocale": "string", "pinnedVersionId": null, "requireCustomerAuth": true, "allowMultipleSubmissions": true, "maxResponses": null, "responseCount": 1, "opensAt": null, "closesAt": null, "redirectUrl": null, "createdAt": "string", "updatedAt": "string" } ], "total": 1 } ``` **400** – Organization context missing Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Form not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/00000000-0000-4000-8000-000000000000/distributions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/forms/{id}/distributions` Create distribution Creates an open (public link) or personal (per-recipient invitations) distribution. Open distributions mint a public_slug. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "mode": "open", "pinnedVersionId": null, "title": null, "defaultLocale": "string", "maxResponses": null, "opensAt": null, "closesAt": null, "redirectUrl": null, "settings": null } ``` ### Responses **201** – Distribution created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Form not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/00000000-0000-4000-8000-000000000000/distributions" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"mode\": \"open\", \"pinnedVersionId\": null, \"title\": null, \"defaultLocale\": \"string\", \"maxResponses\": null, \"opensAt\": null, \"closesAt\": null, \"redirectUrl\": null, \"settings\": null }" ``` ## GET `/forms/{id}/run/context` Get the published form version for the in-app runner. Returns the schema + uiSchema for the form's currently published version. Authenticated and scoped to the caller's tenant and organization — anonymous runs go through POST /api/forms/public/start instead. **Tags:** Forms Runtime **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Published form version Content-Type: `application/json` ```json { "form": { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "defaultLocale": "string", "supportedLocales": [ "string" ] }, "formVersion": { "id": "00000000-0000-4000-8000-000000000000", "versionNumber": 1, "schemaHash": "string", "registryVersion": "string" }, "schema": {}, "uiSchema": {}, "requiresCustomerAuth": true } ``` **400** – Missing tenant or organization context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthenticated Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Form or version not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Form not active or unpublished Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/:id/run/context" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/forms/{id}/run/submissions` Submit answers via the in-app runner with tamper validation. Server-side re-runs the evaluator against the posted answers and asserts the claimed ending is reachable. 422 on mismatch. Authenticated and scoped to the caller's tenant and organization; deprecated in favour of POST /api/forms/public/submissions/:id/submit. **Tags:** Forms Runtime **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Submission accepted (validation only — persistence in phase 1d). Content-Type: `application/json` ```json { "accepted": true, "reachedEndingKey": null } ``` **400** – Malformed body, or missing tenant/organization context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthenticated Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Form or version not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Form inactive or tamper detected Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/:id/run/submissions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/forms/{id}/submissions` List submissions for a form (admin inbox) Paginated submission listing scoped to the form id. **Tags:** Forms Admin **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Submission list Content-Type: `application/json` ```json { "items": [ {} ], "total": 1, "page": 1, "pageSize": 1 } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Bad query parameters Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/:id/submissions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/forms/{id}/theme-logo` Upload a form logo/header image Stores a brand logo as a public, unscoped attachment and returns its assetId for x-om-theme.logo. Requires forms.design. **Tags:** Forms Authoring **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Logo stored Content-Type: `application/json` ```json { "assetId": "00000000-0000-4000-8000-000000000000" } ``` **400** – Not a multipart upload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Form not found in scope Content-Type: `application/json` ```json { "error": "string" } ``` **413** – File too large Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Missing file or not a valid image Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/:id/theme-logo" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/forms/{id}/versions/{versionId}` Get version detail Returns the full schema/uiSchema/roles for a form version. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | versionId | path | any | Required | ### Responses **200** – Form version detail Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "formId": "00000000-0000-4000-8000-000000000000", "versionNumber": 1, "status": "draft", "schema": {}, "uiSchema": {}, "roles": [ "string" ], "schemaHash": "string", "registryVersion": "string", "publishedAt": null, "publishedBy": null, "changelog": null, "archivedAt": null, "createdAt": "string", "updatedAt": "string", "answerMappings": { "key": "string" } } ``` **404** – Version not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/00000000-0000-4000-8000-000000000000/versions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/forms/{id}/versions/{versionId}` Update draft version Updates schema/uiSchema/roles/changelog on a draft version. Rejects with 409 (version_is_frozen) for non-draft versions. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | versionId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "changelog": null } ``` ### Responses **200** – Draft updated Content-Type: `application/json` ```json { "ok": true, "updatedAt": "string" } ``` **404** – Version not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Version is frozen Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Schema validation failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/forms/00000000-0000-4000-8000-000000000000/versions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"changelog\": null }" ``` ## GET `/forms/{id}/versions/{versionId}/diff` Diff form versions Returns added/removed/modified fields between the URL `versionId` (newer) and the `against` query param (older). **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | versionId | path | any | Required | | against | query | any | Required | ### Responses **200** – Diff payload Content-Type: `application/json` ```json { "base": { "id": "00000000-0000-4000-8000-000000000000", "versionNumber": 1, "schemaHash": "string" }, "against": { "id": "00000000-0000-4000-8000-000000000000", "versionNumber": 1, "schemaHash": "string" }, "diff": [ { "kind": "added", "key": "string", "field": { "key": "string", "type": "string", "sectionKey": null, "sensitive": true, "editableBy": [ "string" ], "visibleTo": [ "string" ], "required": true } } ] } ``` **404** – Version not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/00000000-0000-4000-8000-000000000000/versions/00000000-0000-4000-8000-000000000000/diff?against=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/forms/{id}/versions/{versionId}/publish` Publish version Publishes a draft version. Emits forms.form_version.published, advances form.current_published_version_id, and pins registry_version. Rejects with 422 no_op_publish if schema is unchanged. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | versionId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "changelog": null } ``` ### Responses **200** – Version published Content-Type: `application/json` ```json { "versionId": "00000000-0000-4000-8000-000000000000", "versionNumber": 1, "updatedAt": "string" } ``` **404** – Version not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Version is frozen Content-Type: `application/json` ```json { "error": "string" } ``` **422** – No-op or schema invalid Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/00000000-0000-4000-8000-000000000000/versions/00000000-0000-4000-8000-000000000000/publish" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"changelog\": null }" ``` ## POST `/forms/{id}/versions/fork` Fork draft Creates a new draft version. Optionally clones from `fromVersionId`. Rejects if a draft already exists (422 draft_already_exists). **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "fromVersionId": null } ``` ### Responses **201** – Draft created Content-Type: `application/json` ```json { "versionId": "00000000-0000-4000-8000-000000000000" } ``` **404** – Form not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Draft already exists Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/00000000-0000-4000-8000-000000000000/versions/fork" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"fromVersionId\": null }" ``` ## GET `/forms/by-key/{key}/active` Get active form version by key Returns the published form version matching the supplied key, sliced to the caller's available roles. **Tags:** Forms Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | key | path | any | Required | ### Responses **200** – Active form version Content-Type: `application/json` ```json { "form": { "id": "00000000-0000-4000-8000-000000000000", "key": "string", "name": "string", "defaultLocale": "string", "supportedLocales": [ "string" ] }, "formVersion": { "id": "00000000-0000-4000-8000-000000000000", "versionNumber": 1, "schemaHash": "string", "registryVersion": "string", "roles": [ "string" ] }, "schema": {}, "uiSchema": {}, "fieldIndex": { "key": { "key": "string", "type": "string", "sectionKey": null, "sensitive": true, "editableBy": [ "string" ], "visibleTo": [ "string" ], "required": true } }, "callerRoles": [ "string" ] } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Form not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Form is not active or has no published version Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/by-key/:key/active" \ -H "Accept: application/json" ``` ## GET `/forms/distributions/{distributionId}` Get distribution Returns a single distribution scoped to the authenticated organization. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | distributionId | path | any | Required | ### Responses **200** – Distribution Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "formId": "00000000-0000-4000-8000-000000000000", "mode": "open", "status": "active", "publicSlug": null, "title": null, "defaultLocale": "string", "pinnedVersionId": null, "requireCustomerAuth": true, "allowMultipleSubmissions": true, "maxResponses": null, "responseCount": 1, "opensAt": null, "closesAt": null, "redirectUrl": null, "settings": null, "createdAt": "string", "updatedAt": "string" } ``` **404** – Distribution not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/distributions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/forms/distributions/{distributionId}` Update or close distribution Updates mutable distribution fields. A body of { "status": "closed" } closes the distribution and emits forms.distribution.closed. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | distributionId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "title": null, "maxResponses": null, "opensAt": null, "closesAt": null, "redirectUrl": null, "settings": null } ``` ### Responses **200** – Distribution updated Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": "string" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Distribution not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/forms/distributions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"title\": null, \"maxResponses\": null, \"opensAt\": null, \"closesAt\": null, \"redirectUrl\": null, \"settings\": null }" ``` ## GET `/forms/distributions/{distributionId}/invitations` List invitations Returns invitations for a distribution with recipient PII decrypted. Token hashes are never returned. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | distributionId | path | any | Required | ### Responses **200** – Invitation list Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "recipientEmail": null, "recipientName": null, "recipientRef": null, "role": null, "status": "pending", "locale": null, "sentAt": null, "openedAt": null, "startedAt": null, "submittedAt": null, "expiresAt": null, "sendCount": 1, "lastError": null, "createdAt": "string" } ], "total": 1 } ``` **404** – Distribution not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/distributions/00000000-0000-4000-8000-000000000000/invitations" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/forms/distributions/{distributionId}/invitations` Bulk-create invitations Creates one invitation per recipient. For personal distributions, the response returns each invitation rawToken exactly once so the admin can build the personal link. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | distributionId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "recipients": [ {} ] } ``` ### Responses **201** – Invitations created Content-Type: `application/json` ```json { "invitations": [ { "id": "00000000-0000-4000-8000-000000000000", "rawToken": null } ] } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Distribution not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/distributions/00000000-0000-4000-8000-000000000000/invitations" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"recipients\": [ {} ] }" ``` ## DELETE `/forms/distributions/{distributionId}/invitations/{invitationId}` Revoke invitation Soft-revokes an invitation — the row is retained and its status becomes revoked so a revoked token resolves to 410 (not 404); access tokens already issued for the invitation stop working (401). **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | distributionId | path | any | Required | | invitationId | path | any | Required | ### Responses **200** – Invitation revoked Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **404** – Invitation not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/forms/distributions/00000000-0000-4000-8000-000000000000/invitations/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/forms/distributions/{distributionId}/invitations/{invitationId}/send` Send invitation Marks the invitation sent (sent_at, send_count += 1) and emits forms.invitation.sent so the email subscriber dispatches a reminder. Also the resend path. **Tags:** Forms **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | distributionId | path | any | Required | | invitationId | path | any | Required | ### Responses **200** – Invitation send tracked Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **404** – Invitation not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Invitation revoked or already submitted Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Invitation has no recipient email Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/distributions/00000000-0000-4000-8000-000000000000/invitations/00000000-0000-4000-8000-000000000000/send" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/forms/form-submissions` Start a new form submission Starts a submission for the active version of a form, auto-assigning the starter to the default actor role. **Tags:** Forms Runtime ### Request Body Content-Type: `application/json` ```json { "form_key": "string", "subject_type": "string", "subject_id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Submission started Content-Type: `application/json` ```json { "submission": {}, "revision": {}, "decoded_data": {}, "actors": [ {} ] } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **403** – SUBJECT_FORBIDDEN: subject is not the caller's own customer subject Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Form not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Validation or form-state error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/form-submissions" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"form_key\": \"string\", \"subject_type\": \"string\", \"subject_id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/forms/form-submissions/{id}` Get current submission state (role-sliced) Returns the current revision payload sliced to the calling user's active actor role. **Tags:** Forms Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Submission state Content-Type: `application/json` ```json { "submission": {}, "revision": {}, "decoded_data": {}, "actors": [ {} ] } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/form-submissions/:id" \ -H "Accept: application/json" ``` ## PATCH `/forms/form-submissions/{id}` Save (autosave) a submission revision Appends a revision when the supplied base_revision_id matches; rate-limited to FORMS_AUTOSAVE_INTERVAL_MS / 2. **Tags:** Forms Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "base_revision_id": "00000000-0000-4000-8000-000000000000", "patch": {} } ``` ### Responses **200** – Revision saved Content-Type: `application/json` ```json { "revision": {}, "coalesced": true } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **403** – No active actor row for user Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Stale base_revision_id Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **429** – Save rate limit exceeded Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/forms/form-submissions/:id" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"base_revision_id\": \"00000000-0000-4000-8000-000000000000\", \"patch\": {} }" ``` ## POST `/forms/form-submissions/{id}/attachments` Upload an attachment (authenticated) Stores an encrypted file for a file-typed field. Caller must be an active actor on the submission. **Tags:** Forms Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Attachment stored Content-Type: `application/json` ```json { "id": "string", "filename": "string", "contentType": "string", "sizeBytes": 1 } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **403** – No active actor row for user Content-Type: `application/json` ```json { "error": "string" } ``` **413** – File empty or oversize Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Disallowed type / invalid field / scan rejected Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/form-submissions/:id/attachments" \ -H "Accept: application/json" ``` ## GET `/forms/form-submissions/{id}/resume-token` Issue a resume token for a submission Returns a signed token that another device can use to resume the submission. TTL governed by FORMS_RESUME_TOKEN_TTL_S. **Tags:** Forms Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Resume token issued Content-Type: `application/json` ```json { "token": "string", "expiresAt": "string" } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **403** – No active actor row for user Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/form-submissions/:id/resume-token" \ -H "Accept: application/json" ``` ## POST `/forms/form-submissions/{id}/submit` Submit a form submission Final submission of a draft submission. Verifies base_revision_id and stores the submit metadata. **Tags:** Forms Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "base_revision_id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Submission submitted Content-Type: `application/json` ```json { "submission": {} } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **403** – SUBJECT_FORBIDDEN: caller-started submission is not on the caller's own customer subject Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Stale base_revision_id Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Submission already in terminal state Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/form-submissions/:id/submit" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"base_revision_id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/forms/form-submissions/by-subject/{subject_type}/{subject_id}` List submissions for a subject Returns submissions accessible to the caller for the supplied (subject_type, subject_id). **Tags:** Forms Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | subject_type | path | any | Required | | subject_id | path | any | Required | ### Responses **200** – Submission list Content-Type: `application/json` ```json { "items": [ {} ] } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Bad subject identifier Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/form-submissions/by-subject/:subject_type/:subject_id" \ -H "Accept: application/json" ``` ## GET `/forms/public/distributions/{slug}` Resolve an open-link distribution Returns the form context served by an open-mode distribution identified by its public slug. **Tags:** Forms Public Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | slug | path | any | Required | ### Responses **200** – Distribution form context Content-Type: `application/json` ```json { "distribution_id": "00000000-0000-4000-8000-000000000000", "form": { "key": "string", "name": "string", "defaultLocale": "string", "supportedLocales": [ "string" ] }, "schema": {}, "ui_schema": {}, "fieldIndex": {}, "completion": { "title": null, "message": null }, "redirect_url": null, "embed": null, "requires_customer_auth": true, "default_locale": "string" } ``` **404** – Distribution or form not found Content-Type: `application/json` ```json { "error": "string" } ``` **410** – Distribution closed, not yet open, or response cap reached Content-Type: `application/json` ```json { "error": "string" } ``` **429** – Rate limit exceeded Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Rate limiting unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/public/distributions/:slug" \ -H "Accept: application/json" ``` ## GET `/forms/public/distributions/{slug}/embed-policy` Resolve the embed framing policy for a distribution Returns the Content-Security-Policy frame-ancestors directive authorizing which origins may frame the /embed/:slug host page. Fails closed to frame-ancestors none for non-embeddable or unknown distributions. **Tags:** Forms Public Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | slug | path | any | Required | ### Responses **200** – Embed framing policy Content-Type: `application/json` ```json { "frame_ancestors": "string", "embeddable": true } ``` **429** – Rate limit exceeded Content-Type: `application/json` **503** – Rate limiting unavailable Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/public/distributions/:slug/embed-policy" \ -H "Accept: application/json" ``` ## GET `/forms/public/embed-loader` Serve the external embed loader script Returns a framework-free JS loader that injects an iframe per [data-om-form] element pointing at /embed/:slug and wires postMessage auto-resize. **Tags:** Forms Public Runtime ### Responses **200** – The embed loader script (application/javascript) Content-Type: `application/json` ```json "string" ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/public/embed-loader" \ -H "Accept: application/json" ``` ## GET `/forms/public/invitations/{token}` Resolve a personal invitation Returns the form context for a personal-mode invitation identified by its raw token, marking the invitation opened. **Tags:** Forms Public Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | token | path | any | Required | ### Responses **200** – Invitation form context Content-Type: `application/json` ```json { "distribution_id": "00000000-0000-4000-8000-000000000000", "form": { "key": "string", "name": "string", "defaultLocale": "string", "supportedLocales": [ "string" ] }, "schema": {}, "ui_schema": {}, "fieldIndex": {}, "completion": { "title": null, "message": null }, "redirect_url": null, "requires_customer_auth": true, "default_locale": "string", "invitation": { "id": "00000000-0000-4000-8000-000000000000", "status": "string", "locale": null } } ``` **404** – Invitation, distribution, or form not found Content-Type: `application/json` ```json { "error": "string" } ``` **410** – Invitation submitted, expired, or revoked; distribution unavailable Content-Type: `application/json` ```json { "error": "string" } ``` **429** – Rate limit exceeded Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Rate limiting unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/public/invitations/:token" \ -H "Accept: application/json" ``` ## POST `/forms/public/start` Begin an anonymous submission Resolves a distribution by slug or token and bootstraps an anonymous submission, returning a submission access token. **Tags:** Forms Public Runtime ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **201** – Submission started Content-Type: `application/json` ```json { "submission": {}, "revision": {}, "decoded_data": {}, "access_token": "string", "expires_at": "string" } ``` **404** – Distribution, invitation, or form not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Distribution requires customer authentication Content-Type: `application/json` ```json { "error": "string" } ``` **410** – Distribution / invitation unavailable Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Validation failed, CAPTCHA required, or CAPTCHA verification failed Content-Type: `application/json` ```json { "error": "string" } ``` **429** – Rate limit exceeded Content-Type: `application/json` ```json { "error": "string" } ``` **503** – CAPTCHA or rate limiting is unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/public/start" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{}" ``` ## GET `/forms/public/submissions/{id}` Resume a public submission Returns the role-sliced current state for the submission named in the access token (or customer session). **Tags:** Forms Public Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Submission state Content-Type: `application/json` ```json { "submission": {}, "revision": {}, "decoded_data": {}, "actors": [ {} ] } ``` **401** – Missing or invalid access token / session Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` **429** – Rate limit exceeded Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Rate limiting unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/public/submissions/:id" \ -H "Accept: application/json" ``` ## PATCH `/forms/public/submissions/{id}` Autosave a public submission Appends a revision when base_revision_id matches; re-issues the access token (token-authorized requests) with a slid TTL. **Tags:** Forms Public Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "base_revision_id": "00000000-0000-4000-8000-000000000000", "patch": {} } ``` ### Responses **200** – Revision saved Content-Type: `application/json` ```json { "revision": {} } ``` **401** – Missing or invalid access token / session Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Stale base_revision_id Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Validation failed Content-Type: `application/json` ```json { "error": "string" } ``` **429** – Rate limit exceeded Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Rate limiting unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/forms/public/submissions/:id" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"base_revision_id\": \"00000000-0000-4000-8000-000000000000\", \"patch\": {} }" ``` ## POST `/forms/public/submissions/{id}/attachments` Upload an attachment (public/anonymous) Stores an encrypted file for a file-typed field. Authorized via access token or portal session. **Tags:** Forms Public Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Attachment stored Content-Type: `application/json` ```json { "id": "string", "filename": "string", "contentType": "string", "sizeBytes": 1 } ``` **401** – Missing or invalid access token / session Content-Type: `application/json` ```json { "error": "string" } ``` **413** – File empty or oversize Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Disallowed type / invalid field / scan rejected Content-Type: `application/json` ```json { "error": "string" } ``` **429** – Rate limit exceeded Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Rate limiting unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/public/submissions/:id/attachments" \ -H "Accept: application/json" ``` ## GET `/forms/public/submissions/{id}/attachments/{attachmentId}` Download a submission attachment (public/anonymous) Streams the decrypted user-upload bytes for the owning participant. Authorized via access token or portal session. **Tags:** Forms Public Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | attachmentId | path | any | Required | ### Responses **200** – Attachment stream Content-Type: `application/octet-stream` **401** – Missing or invalid access token / session Content-Type: `application/json` **404** – Attachment not found Content-Type: `application/json` **429** – Rate limit exceeded Content-Type: `application/json` **503** – Rate limiting unavailable Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/public/submissions/:id/attachments/:attachmentId" \ -H "Accept: application/json" ``` ## GET `/forms/public/submissions/{id}/pdf` Download a submission PDF snapshot (public/anonymous) Streams the participant's copy of the submission PDF. Authorized via access token or portal session. The copy contains only the answers the principal's role can read: the immutable canonical snapshot (generated on first request when missing) when the role can read every field, otherwise an uncached role-filtered copy. **Tags:** Forms Public Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – PDF stream Content-Type: `application/pdf` **401** – Missing or invalid access token / session Content-Type: `application/json` **404** – Submission not found Content-Type: `application/json` **409** – Submission not yet submitted Content-Type: `application/json` **429** – Rate limit exceeded Content-Type: `application/json` **503** – Rate limiting unavailable Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/public/submissions/:id/pdf" \ -H "Accept: application/json" ``` ## POST `/forms/public/submissions/{id}/submit` Submit a public submission Finalizes the submission named in the access token / session, enforcing the distribution response cap atomically before submitting. **Tags:** Forms Public Runtime ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "base_revision_id": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Submission submitted Content-Type: `application/json` ```json { "submission": {}, "redirect_url": null } ``` **401** – Missing or invalid access token / session Content-Type: `application/json` ```json { "error": "string" } ``` **403** – SUBJECT_FORBIDDEN: customer-started submission is not on the caller's own customer subject Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission or invitation not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Stale base_revision_id Content-Type: `application/json` ```json { "error": "string" } ``` **410** – Distribution response cap reached or unavailable Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Validation failed or submission in terminal state Content-Type: `application/json` ```json { "error": "string" } ``` **429** – Rate limit exceeded Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Rate limiting unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/public/submissions/:id/submit" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"base_revision_id\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/forms/subjects/{subjectType}/{subjectId}/consents` List consent records for a data subject Returns the subject's consent history projected from signed signature fields — active and superseded records. PII-free: clause SHA-256, signed-at, status timestamps, and ids only. Optional `status` and `formId` query filters. Requires `forms.view`. **Tags:** Forms Compliance **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | subjectType | path | any | Required | | subjectId | path | any | Required | ### Responses **200** – Consent records for the subject (newest signed first) Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "formId": "00000000-0000-4000-8000-000000000000", "formName": null, "formVersionId": "00000000-0000-4000-8000-000000000000", "versionNumber": 1, "submissionId": "00000000-0000-4000-8000-000000000000", "consentFieldKey": "string", "clauseSha256": "string", "signedAt": "string", "status": "string", "supersededAt": null, "supersededByRecordId": null } ] } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Tenant scope required Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Bad subject identifier or filter Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/subjects/:subjectType/:subjectId/consents" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/forms/subjects/{subjectType}/{subjectId}/export` Export all submissions for a data subject (GDPR Art. 15/20) Returns a structured JSON document with every submission for the subject — form key/name, version, status, timestamps, decrypted answers keyed by field with labels, and signature metadata. Attachments are referenced by id. Writes one `export` access-audit row per submission. Requires `forms.submissions.export`. **Tags:** Forms Compliance **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | subjectType | path | any | Required | | subjectId | path | any | Required | ### Responses **200** – Export document (downloaded as an attachment) Content-Type: `application/json` ```json {} ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Tenant scope required Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Bad subject identifier Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/subjects/:subjectType/:subjectId/export" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/forms/submissions/{submissionId}` Get a submission for the admin inbox Returns the current submission state for the admin role. Phase 2b will write a form_access_audit row at this call site. **Tags:** Forms Admin **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | submissionId | path | any | Required | ### Responses **200** – Submission state Content-Type: `application/json` ```json { "submission": {}, "revision": {}, "decoded_data": {}, "actors": [ {} ], "formVersion": {} } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/submissions/:submissionId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/forms/submissions/{submissionId}/access-audit` List submission access-audit rows Returns the access-audit trail for a submission (who/when/purpose/IP). Carries no payload content. Reading the list does not write a new audit row. **Tags:** Forms Compliance **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | submissionId | path | any | Required | ### Responses **200** – Access-audit rows Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "accessedBy": "00000000-0000-4000-8000-000000000000", "accessedAt": "string", "accessPurpose": "view", "ip": null, "revisionId": null } ] } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/submissions/:submissionId/access-audit" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/forms/submissions/{submissionId}/actors` Assign an actor to a submission Assigns a (user, role) pair as an active actor on the submission. The role MUST be declared on the form version. **Tags:** Forms Admin **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | submissionId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "user_id": "00000000-0000-4000-8000-000000000000", "role": "string" } ``` ### Responses **201** – Actor assigned Content-Type: `application/json` ```json { "actor": {} } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Invalid role for the form version Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/submissions/:submissionId/actors" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"user_id\": \"00000000-0000-4000-8000-000000000000\", \"role\": \"string\" }" ``` ## DELETE `/forms/submissions/{submissionId}/actors/{actorId}` Revoke a submission actor Revokes the supplied actor row by setting revoked_at. **Tags:** Forms Admin **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | submissionId | path | any | Required | | actorId | path | any | Required | ### Responses **200** – Actor revoked Content-Type: `application/json` ```json { "ok": true } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Actor not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/forms/submissions/:submissionId/actors/:actorId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/forms/submissions/{submissionId}/anonymize` Anonymize a submission (irreversible) Tombstones every sensitive field across every revision. Requires body `{ "confirm": "DELETE" }`. Preserves actor rows and access-audit rows. Emits `forms.submission.anonymized`. **Tags:** Forms Compliance **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | submissionId | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "confirm": "DELETE" } ``` ### Responses **200** – Anonymization complete Content-Type: `application/json` ```json { "submissionId": "00000000-0000-4000-8000-000000000000", "revisionsAnonymized": 1, "anonymizedAt": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Missing typed confirmation or other validation failure Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/submissions/:submissionId/anonymize" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"confirm\": \"DELETE\" }" ``` ## GET `/forms/submissions/{submissionId}/attachments/{attachmentId}` Download a submission attachment (admin) Streams the decrypted user-upload bytes. Writes an access-audit row with access_purpose = "export". **Tags:** Forms Compliance **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | submissionId | path | any | Required | | attachmentId | path | any | Required | ### Responses **200** – Attachment stream Content-Type: `application/octet-stream` **401** – Not authenticated Content-Type: `application/json` **403** – Tenant scope required Content-Type: `application/json` **404** – Attachment not found Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/submissions/:submissionId/attachments/:attachmentId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/forms/submissions/{submissionId}/export` Export a single submission (GDPR Art. 15/20) Returns the structured export document for one submission — decrypted answers keyed by field with labels, signature metadata, attachment references. Writes one `export` access-audit row. Requires `forms.submissions.export`. **Tags:** Forms Compliance **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | submissionId | path | any | Required | ### Responses **200** – Export document (downloaded as an attachment) Content-Type: `application/json` ```json {} ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Tenant scope required Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/submissions/:submissionId/export" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/forms/submissions/{submissionId}/pdf` Download the PDF snapshot of a submitted form Streams the immutable PDF snapshot, generating it on first request when the on-submit job has not produced it yet. Never re-renders an existing snapshot. Writes an audit row with `access_purpose = "export"`. **Tags:** Forms Compliance **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | submissionId | path | any | Required | ### Responses **200** – PDF stream Content-Type: `application/pdf` **404** – Submission not found or not yet submitted Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/submissions/:submissionId/pdf" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/forms/submissions/{submissionId}/reopen` Reopen a submitted submission Transitions status from submitted back to reopened so further saves are allowed. **Tags:** Forms Admin **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | submissionId | path | any | Required | ### Responses **200** – Submission reopened Content-Type: `application/json` ```json { "submission": {} } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Submission not in submitted state Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/forms/submissions/:submissionId/reopen" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/forms/submissions/{submissionId}/revisions` List submission revisions Returns the append-only revision timeline for an admin viewer. **Tags:** Forms Admin **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | submissionId | path | any | Required | ### Responses **200** – Revisions Content-Type: `application/json` ```json { "submission": {}, "revisions": [ {} ] } ``` **401** – Not authenticated Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Submission not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/forms/submissions/:submissionId/revisions" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/emails` List received emails Processing log of all received emails **Tags:** InboxOps **Requires authentication.** ### Responses **200** – Paginated list of emails Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/inbox_ops/emails" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/inbox_ops/emails/{id}` Soft-delete an inbox email **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Email deleted Content-Type: `application/json` **404** – Email not found Content-Type: `application/json` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/inbox_ops/emails/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/emails/{id}` Get email detail with parsed thread **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Email detail Content-Type: `application/json` **404** – Email not found Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/inbox_ops/emails/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/emails/{id}/reprocess` Re-trigger LLM extraction on a failed or low-confidence email **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Email queued for reprocessing Content-Type: `application/json` **404** – Email not found Content-Type: `application/json` **409** – Email is already processing or proposal cannot be superseded safely Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/inbox_ops/emails/:id/reprocess" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/extract` Submit raw text for LLM extraction Creates an InboxEmail record from raw text and triggers the extraction pipeline. The extraction runs asynchronously. **Tags:** InboxOps **Requires authentication.** ### Responses **200** – Extraction queued successfully Content-Type: `application/json` **400** – Invalid request body Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/inbox_ops/extract" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/proposals` List proposals List inbox proposals with optional status filter and pagination **Tags:** InboxOps **Requires authentication.** ### Responses **200** – Paginated list of proposals Content-Type: `application/json` **401** – Unauthorized Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/proposals/{id}` Get proposal detail Returns proposal with actions, discrepancies, and source email **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Full proposal detail Content-Type: `application/json` **404** – Proposal not found Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/accept-all` Accept and execute all pending actions in a proposal **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – All actions processed Content-Type: `application/json` **404** – Proposal not found Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals/:id/accept-all" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/inbox_ops/proposals/{id}/actions/{actionId}` Edit action payload before accepting **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | actionId | path | any | Required | ### Responses **200** – Action updated Content-Type: `application/json` **404** – Action not found Content-Type: `application/json` **409** – Action already processed or stale (optimistic-lock conflict) Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals/:id/actions/:actionId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/actions/{actionId}/accept` Accept and execute a proposal action Executes the action and creates the entity in the target module. Returns 409 if already processed. **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | actionId | path | any | Required | ### Responses **200** – Action executed successfully Content-Type: `application/json` **403** – Insufficient permissions in target module Content-Type: `application/json` **404** – Action not found Content-Type: `application/json` **409** – Action already processed Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals/:id/actions/:actionId/accept" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/inbox_ops/proposals/{id}/actions/{actionId}/complete` Mark an action as completed with an externally-created entity Used when an action is fulfilled through the normal sales form instead of the execution engine. Updates the action status without running the execution engine. **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | actionId | path | any | Required | ### Responses **200** – Action marked as completed Content-Type: `application/json` **400** – Invalid body Content-Type: `application/json` **404** – Action not found Content-Type: `application/json` **409** – Action already processed Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals/:id/actions/:actionId/complete" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/actions/{actionId}/reject` Reject a proposal action **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | actionId | path | any | Required | ### Responses **200** – Action rejected Content-Type: `application/json` **404** – Action not found Content-Type: `application/json` **409** – Action already processed Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals/:id/actions/:actionId/reject" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/categorize` Set or change the category of a proposal Assigns a category to a proposal. Returns the new and previous category for undo support. **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Category updated Content-Type: `application/json` **400** – Invalid category value Content-Type: `application/json` **404** – Proposal not found Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals/:id/categorize" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/reject` Reject entire proposal (all pending actions) **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Proposal rejected Content-Type: `application/json` **404** – Proposal not found Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals/:id/reject" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/replies/{replyId}/send` Send a draft reply email and register it in messages when available Sends the draft_reply action payload via the configured email provider. When the messages module is available, also records the sent reply as an internal message record. Sets In-Reply-To and References headers for threading. **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | replyId | path | any | Required | ### Responses **200** – Reply sent successfully Content-Type: `application/json` **400** – Missing required payload fields Content-Type: `application/json` **404** – Reply action not found Content-Type: `application/json` **409** – Action in invalid state for sending, or a send is already in progress / completed for this reply Content-Type: `application/json` **502** – Email delivery failed Content-Type: `application/json` **503** – Email service not configured or disabled Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals/:id/replies/:replyId/send" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/proposals/{id}/translate` Translate proposal content Translates the proposal summary and action descriptions to the target locale. Results are cached. **Tags:** InboxOps **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Translation result Content-Type: `application/json` **400** – Invalid target locale or same language Content-Type: `application/json` **404** – Proposal not found Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals/:id/translate" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/proposals/counts` Get proposal status and category counts Returns counts by status and by category for tab badges and filter dropdowns **Tags:** InboxOps **Requires authentication.** ### Responses **200** – Status and category counts object Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/inbox_ops/proposals/counts" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/inbox_ops/settings` Get tenant inbox configuration Returns the forwarding address and configuration for this tenant **Tags:** InboxOps **Requires authentication.** ### Responses **200** – Inbox settings Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/inbox_ops/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/inbox_ops/settings` Update tenant inbox configuration Updates working language and/or active status **Tags:** InboxOps **Requires authentication.** ### Responses **200** – Updated settings Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/inbox_ops/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/inbox_ops/webhook/inbound` Receive forwarded email from provider webhook Public endpoint — validated by provider HMAC signature or Resend/Svix signature. Rate limited per tenant. **Tags:** InboxOps ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Email received and queued for processing Content-Type: `application/json` **400** – Invalid payload or signature Content-Type: `application/json` **413** – Payload too large Content-Type: `application/json` **429** – Rate limit exceeded Content-Type: `application/json` **503** – Webhook secret not configured Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/inbox_ops/webhook/inbound" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{}" ``` ## GET `/integrations` List integrations Returns a paginated collection of integrations. **Tags:** Integrations **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | q | query | any | Optional | | category | query | any | Optional | | bundleId | query | any | Optional | | isEnabled | query | any | Optional | | healthStatus | query | any | Optional | | sort | query | any | Optional | | order | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated integrations Content-Type: `application/json` ```json { "items": [ { "id": "string", "title": "string", "description": null, "category": null, "tags": [ "string" ], "hub": null, "providerKey": null, "bundleId": null, "author": null, "company": null, "version": null, "hasCredentials": true, "isEnabled": true, "apiVersion": null, "healthStatus": "healthy", "lastHealthCheckedAt": null, "lastHealthLatencyMs": null, "enabledAt": null, "analytics": { "lastActivityAt": null, "totalCount": 1, "errorCount": 1, "errorRate": 1, "dailyCounts": [ 1 ] } } ], "total": 1, "totalPages": 1, "bundles": [ { "id": "string", "title": "string", "description": "string", "icon": null, "integrationCount": 1, "enabledCount": 1 } ] } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/integrations?order=asc&page=1&pageSize=100" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/integrations/{id}` Get integration detail Returns the integration definition (including detailPage.connectTabId), its state, credentials presence, health, analytics and oauthGrant: the status of the tenant-level OAuth grant of the active organization, or null without a live grant. **Tags:** Integrations **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Integration detail Content-Type: `application/json` ```json { "integration": { "id": "string", "title": "string" }, "bundleIntegrations": [ { "id": "string", "title": "string", "isEnabled": true, "state": { "isEnabled": true, "apiVersion": null, "reauthRequired": true, "lastHealthStatus": null, "lastHealthCheckedAt": null, "lastHealthLatencyMs": null, "enabledAt": null, "updatedAt": null } } ], "state": { "isEnabled": true, "apiVersion": null, "reauthRequired": true, "lastHealthStatus": null, "lastHealthCheckedAt": null, "lastHealthLatencyMs": null, "enabledAt": null, "updatedAt": null }, "hasCredentials": true, "credentialsUpdatedAt": null, "healthStatus": "healthy", "analytics": { "lastActivityAt": null, "totalCount": 1, "errorCount": 1, "errorRate": 1, "dailyCounts": [ 1 ] }, "oauthGrant": null } ``` **400** – Invalid integration id, or the organization scope cannot be resolved Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Integration not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/integrations/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/integrations/{id}/credentials` Get or save integration credentials **Tags:** Integrations **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/integrations/:id/credentials" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/integrations/{id}/credentials` Get or save integration credentials **Tags:** Integrations **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/integrations/:id/credentials" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/integrations/{id}/health` Run health check for an integration **Tags:** Integrations **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/integrations/:id/health" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/integrations/{id}/state` Update integration state **Tags:** Integrations **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/integrations/:id/state" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/integrations/{id}/version` Change integration API version **Tags:** Integrations **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/integrations/:id/version" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/integrations/logs` List integration logs **Tags:** Integrations **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/integrations/logs" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/integrations/test-oauth-grants` Test-only: connect, refresh, corrupt or reset the test_oauth_grant grant (OM_ENABLE_TEST_OAUTH_GRANTS) refresh configures the fake token endpoint outcome, then forces one refresh; result is ok or the Token Failure, and degraded is true when a still valid stored token was returned instead of a refreshed one. **Tags:** Integrations **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "action": "connect", "integrationId": "string" } ``` ### Responses **200** – connect: { reconnect, revisedAt }; refresh: { result, degraded }; corruptGrant: { corrupted }; reset: { ok } Content-Type: `application/json` ```json { "reconnect": true, "revisedAt": "string" } ``` **400** – Invalid request body, or the organization scope cannot be resolved (code organization_scope_required) Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Acting in another tenant, an explicitly empty organization scope, or no integrations.credentials.manage in the resolved organization Content-Type: `application/json` ```json { "error": "string" } ``` **404** – OM_ENABLE_TEST_OAUTH_GRANTS is off (production default), or the integration is not test_oauth_grant Content-Type: `application/json` ```json { "error": "string" } ``` **409** – connect: the grant service refused the Connect (code is the OAuth Connect Failure) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/integrations/test-oauth-grants" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"action\": \"connect\", \"integrationId\": \"string\" }" ``` ## GET `/mail_drafts/compose-options` Skrzynki i adres wgrywania załączników Skrzynki zespołu dostępne dla użytkownika (id, nazwa, adres, członkowie z nazwami, bez adresów e-mail), adres wgrywania załączników i to, czy użytkownik może wgrywać (allowed, denied, unavailable); zależą od aplikacji, która rejestruje port mailDraftComposeSupport. **Tags:** Szkice maili **Requires authentication.** ### Responses **200** – Opcje edytora Content-Type: `application/json` ```json { "channels": [ { "id": "00000000-0000-4000-8000-000000000000", "label": "string", "address": null, "memberUserIds": [ "00000000-0000-4000-8000-000000000000" ], "members": [ { "id": "00000000-0000-4000-8000-000000000000", "name": null } ] } ], "attachmentUpload": "allowed", "attachmentUploadUrl": null } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia mail_drafts.view Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mail_drafts/compose-options" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/mail_drafts/drafts` Lista szkiców Szkice skrzynek, których użytkownik jest członkiem. Filtry: assignee (id osoby albo none), dealId, status (lista po przecinku), channelId, origin; page, pageSize (do 100). **Tags:** Szkice maili **Requires authentication.** ### Responses **200** – Strona szkiców Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "channelId": "00000000-0000-4000-8000-000000000000", "status": "draft", "origin": "system", "assigneeUserId": null, "assigneeManual": true, "dealId": null, "to": [ "string" ], "cc": [ "string" ], "bcc": [ "string" ], "subject": "string", "bodyHtml": "string", "bodyText": "string", "quotedHtml": null, "version": 1, "stuck": true, "updatedAt": "string" } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia mail_drafts.view Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne filtry Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mail_drafts/drafts" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/mail_drafts/drafts` Nowy szkic Zakłada szkic człowieka w skrzynce, której użytkownik jest członkiem. HTML jest oczyszczany na serwerze, a bodyText wyliczany, gdy go brak. **Tags:** Szkice maili **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "channelId": "string", "assigneeUserId": null, "quotedHtml": null, "parentMessageId": null, "dealId": null, "personId": null } ``` ### Responses **201** – Szkic założony Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "channelId": "00000000-0000-4000-8000-000000000000", "status": "draft", "origin": "system", "assigneeUserId": null, "assigneeManual": true, "dealId": null, "to": [ "string" ], "cc": [ "string" ], "bcc": [ "string" ], "subject": "string", "bodyHtml": "string", "bodyText": "string", "quotedHtml": null, "version": 1, "stuck": true, "updatedAt": "string" } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia, dostępu do skrzynki albo do szansy Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mail_drafts/drafts" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"channelId\": \"string\", \"assigneeUserId\": null, \"quotedHtml\": null, \"parentMessageId\": null, \"dealId\": null, \"personId\": null }" ``` ## DELETE `/mail_drafts/drafts/{id}` Usunięcie szkicu (miękkie) **Tags:** Szkice maili **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Usunięto Content-Type: `application/json` ```json { "ok": true } ``` **404** – Nie znaleziono szkicu Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Szkic wysłany albo w wysyłce Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/mail_drafts/drafts/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/mail_drafts/drafts/{id}` Odczyt szkicu **Tags:** Szkice maili **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Szkic Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "status": "draft", "version": 1, "updatedAt": "string" } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia mail_drafts.view Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma takiego szkicu albo nie należy do skrzynki użytkownika Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mail_drafts/drafts/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/mail_drafts/drafts/{id}` Zmiana szkicu Wymaga expectedVersion. Zmiana treści podnosi wersję; zmiana szansy lub osoby nie. Niedozwolona dla szkicu wysłanego i będącego w wysyłce. **Tags:** Szkice maili **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "expectedVersion": 1, "quotedHtml": null, "parentMessageId": null, "dealId": null, "personId": null } ``` ### Responses **200** – Szkic po zmianie Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "status": "draft", "version": 1, "updatedAt": "string" } ``` **404** – Nie znaleziono szkicu Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Wersja nieaktualna albo szkic wysłany lub w wysyłce Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/mail_drafts/drafts/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"expectedVersion\": 1, \"quotedHtml\": null, \"parentMessageId\": null, \"dealId\": null, \"personId\": null }" ``` ## POST `/mail_drafts/drafts/{id}/assign` Przypisz szkic do osoby **Tags:** Szkice maili **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "assigneeUserId": null } ``` ### Responses **200** – Szkic po przypisaniu Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "assigneeUserId": null, "assigneeManual": true, "version": 1 } ``` **403** – Brak uprawnienia mail_drafts.assign Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie znaleziono szkicu Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Szkic już wysłany Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Osoba spoza skrzynki albo niepoprawne dane Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mail_drafts/drafts/:id/assign" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"assigneeUserId\": null }" ``` ## GET `/mail_drafts/drafts/{id}/attachments` Nazwy i rozmiary załączników szkicu **Tags:** Szkice maili **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Załączniki w kolejności ze szkicu Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "fileName": "string", "size": 1, "mimeType": "string" } ] } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia mail_drafts.view Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie znaleziono szkicu albo nie należy do skrzynki użytkownika Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mail_drafts/drafts/:id/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/mail_drafts/drafts/{id}/resolve-outcome` Oznacz szkic jako sprawdzony (wyszedł albo nie wyszedł) Dla szkicu ze znacznikiem „wynik nieznany”. sent=true przenosi go w stan wysłany, sent=false zdejmuje znacznik i zostawia stan failed. Wymaga mail_drafts.assign i członkostwa w skrzynce. **Tags:** Szkice maili **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "sent": true } ``` ### Responses **200** – Szkic po rozstrzygnięciu Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "status": "draft", "sendOutcomeUnknown": true, "version": 1 } ``` **403** – Brak uprawnienia mail_drafts.assign Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie znaleziono szkicu Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Wynik nie jest nieznany albo wysyłka jeszcze trwa Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mail_drafts/drafts/:id/resolve-outcome" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"sent\": true }" ``` ## POST `/mail_drafts/drafts/{id}/send` Wyślij szkic Wysyła szkic ze wspólnej skrzynki przez blokadę wyjścia. Wymaga mail_drafts.send, członkostwa w skrzynce i, gdy szkic ma szansę, prawa do jej odczytu. **Tags:** Szkice maili **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "expectedVersion": 1 } ``` ### Responses **200** – Szkic wysłany (status sent, sentMessageId) Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "status": "draft", "version": 1, "sentMessageId": null, "sentAt": null } ``` **403** – Brak uprawnienia albo dostępu do szansy Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie znaleziono szkicu Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Wysyłka trwa, szkic już wysłany albo wersja nieaktualna Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Nadawca odrzucił dane (np. za duże załączniki, brak odbiorcy, bramka wyjścia) Content-Type: `application/json` ```json { "error": "string" } ``` **502** – Wysyłka się nie powiodła, mail nie wyszedł; szkic w stanie failed Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Brak usługi wysyłki Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mail_drafts/drafts/:id/send" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"expectedVersion\": 1 }" ``` ## GET `/mcc/cards` Zlecenia i wersje kart szansy Stan zleceń (nowa, przekazana, przyjęta, cofnięta, wyprodukowana) z ostatnimi wersjami PDF. Wymaga mcc.items.view. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dealId | query | any | Required | ### Responses **200** – Zlecenia szansy Content-Type: `application/json` ```json { "orders": [ {} ], "zapro": { "enabled": true }, "countries": [ "string" ] } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia, organizacji albo klucz API zamiast użytkownika Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy albo karty w tej organizacji Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Karta ma blokady, jest zamrożona albo już w kolejce (`blockers`) Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/cards?dealId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/mcc/cards` Zleć kartę produkcyjną Sprawdza blokady karty, zakłada zlecenie grupy i kolejną wersję w kolejce. Wymaga mcc.items.manage. **Tags:** MCC **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "dealId": "00000000-0000-4000-8000-000000000000", "cardKey": "string", "shipDate": null, "productionCountry": null } ``` ### Responses **202** – Wersja karty w kolejce Content-Type: `application/json` ```json { "cardId": "00000000-0000-4000-8000-000000000000", "version": 1, "order": {} } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia, organizacji albo klucz API zamiast użytkownika Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy albo karty w tej organizacji Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Karta ma blokady, jest zamrożona albo już w kolejce (`blockers`) Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mcc/cards" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"dealId\": \"00000000-0000-4000-8000-000000000000\", \"cardKey\": \"string\", \"shipDate\": null, \"productionCountry\": null }" ``` ## GET `/mcc/cards/pdf` Pobierz PDF wersji karty Wymaga mcc.items.view. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | cardId | query | any | Required | ### Responses **200** – PDF karty Content-Type: `application/json` ```json "string" ``` **404** – Brak wersji albo PDF Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/cards/pdf?cardId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/mcc/cards/render` Wygeneruj kartę z kolejki Renderuje PDF najnowszej wersji karty w kolejce i zapisuje go w plikach szansy jako plik wewnętrzny. **Tags:** MCC **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "dealId": "00000000-0000-4000-8000-000000000000", "cardKey": "string" } ``` ### Responses **200** – Karta gotowa Content-Type: `application/json` ```json { "attachmentId": "00000000-0000-4000-8000-000000000000" } ``` **404** – Nie ma wersji w kolejce Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Karta nie może powstać (powód w komunikacie) Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Renderer niedostępny Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mcc/cards/render" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"dealId\": \"00000000-0000-4000-8000-000000000000\", \"cardKey\": \"string\" }" ``` ## POST `/mcc/cards/send` Przekaż kartę na produkcję Zmienia stan zlecenia na „przekazana”, nadaje stały token otwartego linku do PDF i zapisuje zdarzenie dla skutków w CRM. Wymaga mcc.items.manage. **Tags:** MCC **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "dealId": "00000000-0000-4000-8000-000000000000", "orderNum": 1 } ``` ### Responses **200** – Karta przekazana Content-Type: `application/json` ```json { "order": {} } ``` **404** – Brak zlecenia albo konto bez przekazania na produkcję Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Odmowa z listą blokad Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mcc/cards/send" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"dealId\": \"00000000-0000-4000-8000-000000000000\", \"orderNum\": 1 }" ``` ## GET `/mcc/grafik` Tablica „Kolejka grafików” Cztery kolumny z projektami (jeden projekt na kartę z wysłanym briefem). Wymaga mcc.grafik.view. **Tags:** MCC **Requires authentication.** ### Responses **200** – Tablica Content-Type: `application/json` ```json { "columns": [ { "id": "string", "name": "string", "jobs": [ {} ] } ] } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/grafik" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/mcc/grafik/{id}` Dane projektu Tytuł, karta, brief i pliki szansy. Wymaga mcc.grafik.view. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Dane projektu Content-Type: `application/json` ```json {} ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia (przypisuje tylko mcc.brief.manage) Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma takiego projektu Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/grafik/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/mcc/grafik/{id}` Przesuń projekt albo przypisz grafika Ruch na tablicy prowadzi proces szansy bez zadań. Wymaga mcc.grafik.manage; przypisanie tylko dla mcc.brief.manage. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "graphicUserId": null } ``` ### Responses **200** – Zapisano Content-Type: `application/json` ```json {} ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia (przypisuje tylko mcc.brief.manage) Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma takiego projektu Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/mcc/grafik/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"graphicUserId\": null }" ``` ## POST `/mcc/grafik/{id}/files` Wgraj plik projektu Plik trafia do plików szansy. Wymaga mcc.grafik.manage. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Plik zapisany Content-Type: `application/json` ```json {} ``` **404** – Brak projektu Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mcc/grafik/:id/files" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/mcc/grafik/deal` Karty szansy z briefem Karty, brief (zapisany albo podpowiedź z pozycji), projekt na tablicy i pliki szansy. Wymaga mcc.brief.manage. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dealId | query | any | Required | ### Responses **200** – Karty Content-Type: `application/json` ```json {} ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy albo karty Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Brief już wysłany Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane albo brief niekompletny Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/grafik/deal?dealId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/mcc/grafik/deal` Wybierz plik graficzny karty Jeden plik na kartę, z plików tej szansy; null zdejmuje wybór. **Tags:** MCC **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "dealId": "00000000-0000-4000-8000-000000000000", "cardKey": "string", "fileId": null } ``` ### Responses **200** – Plik wybrany Content-Type: `application/json` ```json {} ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy albo karty Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Brief już wysłany Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane albo brief niekompletny Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/mcc/grafik/deal" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"dealId\": \"00000000-0000-4000-8000-000000000000\", \"cardKey\": \"string\", \"fileId\": null }" ``` ## POST `/mcc/grafik/deal` Wyślij brief karty Wymaga kompletu pól. Zakłada projekt na tablicy, usuwa niewysłane szkice systemowe szansy, a po briefie ostatniej karty przesuwa szansę na „Projekt w przygotowaniu”. **Tags:** MCC **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "dealId": "00000000-0000-4000-8000-000000000000", "cardKey": "string" } ``` ### Responses **200** – Brief wysłany Content-Type: `application/json` ```json {} ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy albo karty Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Brief już wysłany Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane albo brief niekompletny Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mcc/grafik/deal" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"dealId\": \"00000000-0000-4000-8000-000000000000\", \"cardKey\": \"string\" }" ``` ## PUT `/mcc/grafik/deal` Zapisz brief karty Robocze wartości; niczego nie wysyła. Brief wysłany jest tylko do odczytu (409). **Tags:** MCC **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "dealId": "00000000-0000-4000-8000-000000000000", "cardKey": "string", "priority": null, "language": null, "expectedUpdatedAt": null } ``` ### Responses **200** – Brief zapisany Content-Type: `application/json` ```json {} ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy albo karty Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Brief już wysłany Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane albo brief niekompletny Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/mcc/grafik/deal" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"dealId\": \"00000000-0000-4000-8000-000000000000\", \"cardKey\": \"string\", \"priority\": null, \"language\": null, \"expectedUpdatedAt\": null }" ``` ## GET `/mcc/grafik/designers` Lista grafików organizacji Użytkownicy z rolą mcc_grafik (id i nazwa). Wymaga mcc.brief.manage. **Tags:** MCC **Requires authentication.** ### Responses **200** – Lista Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "name": "string" } ] } ``` **403** – Brak uprawnienia Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/grafik/designers" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/mcc/grafik/file` Pobierz plik szansy dla grafika Wymaga mcc.grafik.view; szansa pliku musi mieć projekt na tablicy. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required | ### Responses **200** – Zawartość pliku Content-Type: `application/json` ```json "string" ``` **404** – Brak pliku albo szansa bez projektu Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/grafik/file?id=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/mcc/items` Usuń pozycję Miękkie usunięcie; przelicza ceny grupy i wartość szansy. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | query | any | Required | | expectedUpdatedAt | query | any | Required | ### Responses **200** – Pozycja usunięta Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "view": { "deal": {}, "items": [ {} ], "services": [ {} ], "groups": [ {} ], "total": 1, "catalog": {}, "proposals": [ {} ], "cardsError": null } } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia, organizacji albo klucz API zamiast użytkownika Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy albo pozycji w tej organizacji Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Pozycję zmieniono w międzyczasie Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane pozycji Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/mcc/items?id=00000000-0000-4000-8000-000000000000&expectedUpdatedAt=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/mcc/items` Widok panelu pozycji szansy Pozycje, grupy (karty) z wyceną i blokadami karty, katalog ze zdjęciami i propozycje bramki do wczytania. Wymaga mcc.items.view. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dealId | query | any | Required | ### Responses **200** – Widok panelu Content-Type: `application/json` ```json { "deal": {}, "items": [ {} ], "services": [ {} ], "groups": [ {} ], "total": 1, "catalog": {}, "proposals": [ {} ], "cardsError": null } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia, organizacji albo klucz API zamiast użytkownika Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy albo pozycji w tej organizacji Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane pozycji Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/items?dealId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/mcc/items` Zmień pozycję Scala poprawkę z pozycją, waliduje całość, zatwierdza propozycję i przelicza ceny grupy oraz wartość szansy. expectedUpdatedAt jest wymagane i wykrywa równoczesną edycję (409, także przy dwóch zapisach naraz). **Tags:** MCC **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "expectedUpdatedAt": "string" } ``` ### Responses **200** – Pozycja zmieniona Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "view": { "deal": {}, "items": [ {} ], "services": [ {} ], "groups": [ {} ], "total": 1, "catalog": {}, "proposals": [ {} ], "cardsError": null } } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia, organizacji albo klucz API zamiast użytkownika Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy albo pozycji w tej organizacji Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Pozycję zmieniono w międzyczasie Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane pozycji Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/mcc/items" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"id\": \"00000000-0000-4000-8000-000000000000\", \"expectedUpdatedAt\": \"string\" }" ``` ## POST `/mcc/items` Dodaj pozycję Waliduje pozycję jak validateItemInput, liczy cenę z progu cennika dla grupy i przelicza wartość szansy. Wymaga mcc.items.manage. **Tags:** MCC **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "dealId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Pozycja dodana Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "view": { "deal": {}, "items": [ {} ], "services": [ {} ], "groups": [ {} ], "total": 1, "catalog": {}, "proposals": [ {} ], "cardsError": null } } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia, organizacji albo klucz API zamiast użytkownika Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy albo pozycji w tej organizacji Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane pozycji Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mcc/items" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"dealId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## POST `/mcc/items/proposals` Wczytaj propozycję z bramki do pozycji szansy Zamienia nieskonsumowaną propozycję pozycji (z maila) na pozycje do zatwierdzenia i przelicza wartość szansy. Wymaga mcc.items.manage. **Tags:** MCC **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "dealId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **200** – Liczba dodanych pozycji i nowy widok panelu Content-Type: `application/json` ```json { "created": 1, "view": {} } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia lub organizacji Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy albo propozycji Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Propozycja już wczytana albo należy do innej szansy Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mcc/items/proposals" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"dealId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## GET `/mcc/karta/krok` Pasek następnego kroku karty szansy Najważniejsza rzecz do zrobienia (braki następnego etapu, braki briefu, blokady i ostrzeżenia pozycji) oraz terminy wysyłki i wydarzenia. Blokady i ostrzeżenia pozycji tylko z mcc.items.view, braki briefu tylko z mcc.brief.manage. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | dealId | query | any | Required | ### Responses **200** – Krok i terminy Content-Type: `application/json` ```json { "krok": { "rodzaj": "blokada_etapu", "klucz": "string", "parametry": { "key": "string" }, "pola": [ "string" ] }, "terminy": null } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia, organizacji albo klucz API zamiast użytkownika Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma szansy w tej organizacji Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne zapytanie Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/karta/krok?dealId=00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/mcc/mail/attachments` Wgraj załącznik do maila Zapisuje plik w module attachments (partycja prywatna) i zachowuje oryginalną nazwę, także z polskimi znakami. Zwrócone id podaje się w attachmentIds trasy team-send. Wymaga uprawnienia mcc.mail.team_send. **Tags:** MCC **Requires authentication.** ### Responses **201** – Załącznik zapisany. Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "fileName": "string", "storedFileName": "string", "mimeType": "string", "size": 1 } ``` **400** – Plik wykonywalny albo z aktywną treścią Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia albo organizacji Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Plik za duży albo limit miejsca wyczerpany Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Brak pliku albo plik pusty Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mcc/mail/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/mcc/mail/deal` Wątki i treść maili powiązanych z szansą Wątki szansy z wiadomościami odebranymi i wysłanymi. Treść jest oczyszczona po stronie serwera i bez zdalnych zasobów (bez obrazków, arkuszy stylów i czcionek). Wątki spoza skrzynek, do których użytkownik nie należy, są pomijane. **Tags:** Poczta szansy **Requires authentication.** ### Responses **200** – Wątki szansy, od najnowszego Content-Type: `application/json` ```json { "threads": [ { "id": "00000000-0000-4000-8000-000000000000", "channelId": "00000000-0000-4000-8000-000000000000", "subject": "string", "lastAt": "string", "messages": [ { "id": "00000000-0000-4000-8000-000000000000", "direction": "inbound", "from": null, "to": [ "string" ], "at": "string", "subject": "string", "bodyHtml": "string", "removedImages": 1 } ], "reply": null } ] } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string", "code": "string" } ``` **403** – Brak uprawnień albo klucz API Content-Type: `application/json` ```json { "error": "string", "code": "string" } ``` **404** – Brak szansy albo konta MCC Content-Type: `application/json` ```json { "error": "string", "code": "string" } ``` **422** – Niepoprawne zapytanie Content-Type: `application/json` ```json { "error": "string", "code": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/mail/deal" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/mcc/mail/team-send` Wyślij mail ze wspólnej skrzynki zespołu Wysyła mail przez bramkę wyjścia ze wspólnego kanału, z załącznikami z modułu attachments. Wymaga uprawnienia mcc.mail.team_send i członkostwa w kanale. Ponowienie z tym samym idempotencyKey zwraca ten sam wynik i nie wysyła drugi raz. **Tags:** MCC **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "channelId": "00000000-0000-4000-8000-000000000000", "to": [ "string" ], "subject": "string", "html": "string", "text": "string", "idempotencyKey": "string" } ``` ### Responses **200** – Mail wysłany (lub wynik wcześniejszej wysyłki o tym kluczu). Content-Type: `application/json` ```json { "messageId": "00000000-0000-4000-8000-000000000000", "threadId": "00000000-0000-4000-8000-000000000000", "externalMessageId": "string", "rewrites": 1 } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia, organizacji albo członkostwa w kanale Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie znaleziono kanału albo załącznika Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Wysyłka o tym kluczu trwa albo klucz użyto z inną treścią Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Niepoprawne dane, za duże załączniki albo odmowa bramki wyjścia Content-Type: `application/json` ```json { "error": "string" } ``` **502** – Wysyłka się nie powiodła, mail nie wyszedł Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Nie da się sprawdzić skrzynki po poprzedniej próbie Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mcc/mail/team-send" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"channelId\": \"00000000-0000-4000-8000-000000000000\", \"to\": [ \"string\" ], \"subject\": \"string\", \"html\": \"string\", \"text\": \"string\", \"idempotencyKey\": \"string\" }" ``` ## GET `/mcc/payers/options` Firmy organizacji do listy wyboru Płatnika Wymaga customers.companies.view; zamiennik trasy OM wymagającej entities.definitions.view. **Tags:** MCC **Requires authentication.** ### Responses **200** – Opcje Content-Type: `application/json` ```json { "items": [ { "value": "string", "label": "string" } ] } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/payers/options" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/mcc/pub/cards/{token}` PDF karty po stałym tokenie Bez logowania. Zawsze 404 bez treści, gdy token jest zły, zlecenie nieprzekazane albo bez PDF. **Tags:** MCC ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | token | path | any | Required | ### Responses **200** – PDF karty Content-Type: `application/json` ```json "string" ``` **404** – Brak karty Content-Type: `application/json` **429** – Za dużo żądań Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/pub/cards/:token" \ -H "Accept: application/json" ``` ## GET `/mcc/widok/kontakty` Otwarte szanse, wartość, najbliższe zadanie, osoba kontaktowa albo firma i opiekun dla wielu rekordów Dla każdej firmy albo osoby z organizacji sesji: liczba i wartość otwartych szans, najbliższe otwarte zadanie (rekordu, jego otwartych szans, a przy firmie jej osób), osoba kontaktowa firmy albo firma osoby oraz nazwa i inicjały opiekuna. Rekordy spoza organizacji, usunięte i innego rodzaju są pomijane. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | rodzaj | query | any | Required. Rodzaj rekordów: firma albo osoba | | ids | query | any | Required. Identyfikatory rekordów (uuid) rozdzielone przecinkami, od 1 do 100 | ### Responses **200** – Dane rekordów po identyfikatorze Content-Type: `application/json` ```json { "items": { "key": { "otwarteSzanse": 1, "wartoscOtwartych": [ { "kwota": 1, "waluta": "string" } ], "zadanie": null, "osobaKontaktowa": null, "firma": null, "opiekun": null } } } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia, organizacji albo klucz API zamiast użytkownika Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Zły rodzaj, brak identyfikatorów, nie-uuid albo więcej niż 100 Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/widok/kontakty?rodzaj=firma&ids=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/mcc/widok/szanse` Najbliższe otwarte zadanie, data wysyłki i opiekun dla wielu szans Dla każdej szansy z organizacji sesji: najbliższe otwarte zadanie (tytuł, termin, stan w_terminie albo po_terminie), data wysyłki liczona jak na pasku karty szansy oraz nazwa i inicjały opiekuna. Szanse spoza organizacji i usunięte są pomijane. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | ids | query | any | Required. Identyfikatory szans (uuid) rozdzielone przecinkami, od 1 do 100 | ### Responses **200** – Dane szans po identyfikatorze Content-Type: `application/json` ```json { "items": { "key": { "zadanie": null, "wysylka": null, "opiekun": null } } } ``` **401** – Brak uwierzytelnienia Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Brak uprawnienia, organizacji albo klucz API zamiast użytkownika Content-Type: `application/json` ```json { "error": "string" } ``` **422** – Brak identyfikatorów, nie-uuid albo więcej niż 100 Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/widok/szanse?ids=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/mcc/zapro/cards` Pobierz karty produkcyjne Rekordy kart (jeden rekord = jedna karta produkcyjna) z linkiem do PDF. Klucz API z rolą mcc_zapro. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | state | query | any | Optional | ### Responses **200** – Karty Content-Type: `application/json` ```json { "cards": [ {} ], "truncated": true } ``` **400** – Zły parametr state Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Brak klucza API Content-Type: `application/json` **404** – Organizacja bez API Zapro Content-Type: `application/json` **429** – Za dużo żądań Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/zapro/cards" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/mcc/zapro/cards.csv` Pobierz karty produkcyjne jako CSV Te same rekordy co JSON. Klucz API z rolą mcc_zapro. **Tags:** MCC **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | state | query | any | Optional | ### Responses **200** – CSV Content-Type: `application/json` ```json "string" ``` **400** – Zły parametr state Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Brak klucza API Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/mcc/zapro/cards.csv" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/mcc/zapro/events` Przyjmij decyzję produkcji accepted wymaga orderNumber (1 do 40 znaków), returned wymaga reason (1 do 1000 znaków), produced niczego. Powtórka jest bezpieczna (200 duplicate). **Tags:** MCC **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "card": 1, "event": "accepted" } ``` ### Responses **200** – Przyjęte (albo duplikat) Content-Type: `application/json` ```json { "ok": true } ``` **400** – Zły kształt zdarzenia Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Nie ma takiej karty Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Zdarzenie spoza kolejności Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Ciało za duże Content-Type: `application/json` **415** – Nie application/json Content-Type: `application/json` **429** – Za dużo żądań Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/mcc/zapro/events" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"card\": 1, \"event\": \"accepted\" }" ``` ## GET `/messages` List messages **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | folder | query | any | Optional | | status | query | any | Optional | | type | query | any | Optional | | visibility | query | any | Optional | | sourceEntityType | query | any | Optional | | sourceEntityId | query | any | Optional | | externalEmail | query | any | Optional | | hasObjects | query | any | Optional | | hasAttachments | query | any | Optional | | hasActions | query | any | Optional | | senderId | query | any | Optional | | search | query | any | Optional | | since | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | ### Responses **200** – Message list Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "type": "string", "visibility": null, "sourceEntityType": null, "sourceEntityId": null, "externalEmail": null, "externalName": null, "subject": "string", "bodyPreview": "string", "senderUserId": "00000000-0000-4000-8000-000000000000", "senderName": null, "senderEmail": null, "priority": "string", "status": "string", "hasObjects": true, "objectCount": 1, "hasAttachments": true, "attachmentCount": 1, "recipientCount": 1, "hasActions": true, "actionTaken": null, "sentAt": null, "readAt": null, "threadId": null } ], "page": 1, "pageSize": 1, "total": 1, "totalPages": 1 } ``` **400** – Query parameters failed validation Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/messages?folder=inbox&page=1&pageSize=20" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/messages` Compose a message **Tags:** Messages **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "type": "default", "visibility": null, "recipients": [], "subject": "", "body": "", "bodyFormat": "text", "priority": "normal", "sendViaEmail": false, "isDraft": false } ``` ### Responses **201** – Message created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "threadId": null } ``` **400** – Compose payload failed validation Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Access denied, including a parentMessageId the caller cannot read Content-Type: `application/json` ```json { "error": "string" } ``` **404** – parentMessageId is unknown, deleted, or outside the caller organization Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/messages" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"type\": \"default\", \"visibility\": null, \"recipients\": [], \"subject\": \"\", \"body\": \"\", \"bodyFormat\": \"text\", \"priority\": \"normal\", \"sendViaEmail\": false, \"isDraft\": false }" ``` ## DELETE `/messages/{id}` Delete message for current sender/recipient context **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Message deleted Content-Type: `application/json` ```json { "ok": true } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Message was modified concurrently (optimistic lock conflict) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/messages/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/messages/{id}` Get message detail **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Message detail with actor-visible thread items only Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "updatedAt": null, "type": "string", "isDraft": true, "canEditDraft": true, "canArchive": true, "isArchived": true, "visibility": null, "sourceEntityType": null, "sourceEntityId": null, "externalEmail": null, "externalName": null, "typeDefinition": { "labelKey": "string", "icon": "string", "color": null, "allowReply": true, "allowForward": true, "ui": null }, "threadId": null, "parentMessageId": null, "senderUserId": "00000000-0000-4000-8000-000000000000", "senderName": null, "senderEmail": null, "subject": "string", "body": "string", "bodyFormat": "text", "priority": "string", "sentAt": null, "actionData": null, "actionTaken": null, "actionTakenAt": null, "actionTakenByUserId": null, "recipients": [ { "userId": "00000000-0000-4000-8000-000000000000", "type": "to", "status": "string", "readAt": null } ], "objects": [ { "id": "00000000-0000-4000-8000-000000000000", "entityModule": "string", "entityType": "string", "entityId": "00000000-0000-4000-8000-000000000000", "actionRequired": true, "actionType": null, "actionLabel": null, "snapshot": null, "preview": null } ], "thread": [ { "id": "00000000-0000-4000-8000-000000000000", "senderUserId": "00000000-0000-4000-8000-000000000000", "senderName": null, "senderEmail": null, "externalName": null, "externalEmail": null, "sourceEntityType": null, "body": "string", "sentAt": null } ], "isRead": true, "conversationArchived": true, "conversationAllUnread": true, "_channel": null, "_channelPayload": null, "_channelContact": null } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/messages/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/messages/{id}` Update draft message **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "visibility": null } ``` ### Responses **200** – Draft updated Content-Type: `application/json` ```json { "ok": true } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Only drafts can be edited, or the draft was modified concurrently (optimistic lock conflict) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/messages/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"visibility\": null }" ``` ## POST `/messages/{id}/actions/{actionId}` Execute message action **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | actionId | path | any | Required | ### Request Body Content-Type: `application/json` No example available for this content type. ### Responses **200** – Action executed Content-Type: `application/json` ```json { "ok": true, "actionId": "string" } ``` **403** – Access denied Content-Type: `application/json` **404** – Action not found Content-Type: `application/json` **409** – Action already taken, or the message was modified concurrently (optimistic lock conflict) Content-Type: `application/json` **410** – Action expired Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/messages/:id/actions/:actionId" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}/archive` Unarchive message **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Message unarchived Content-Type: `application/json` ```json { "ok": true } ``` **403** – Access denied or sender-only message cannot be unarchived Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/messages/:id/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/messages/{id}/archive` Archive message **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Message archived Content-Type: `application/json` ```json { "ok": true } ``` **403** – Access denied or sender-only message cannot be archived Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/messages/:id/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}/attachments` Unlink attachments from draft message **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Attachments unlinked Content-Type: `application/json` ```json { "ok": true } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Only draft messages can be edited Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/messages/:id/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## GET `/messages/{id}/attachments` List message attachments **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Attachments Content-Type: `application/json` ```json { "attachments": [ { "id": "00000000-0000-4000-8000-000000000000", "fileName": "string", "fileSize": 1, "mimeType": "string", "url": "string" } ] } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/messages/:id/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/messages/{id}/attachments` Link attachments to draft message **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "attachmentIds": [ "00000000-0000-4000-8000-000000000000" ] } ``` ### Responses **200** – Attachments linked Content-Type: `application/json` ```json { "ok": true } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Only draft messages can be edited Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/messages/:id/attachments" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"attachmentIds\": [ \"00000000-0000-4000-8000-000000000000\" ] }" ``` ## GET `/messages/{id}/confirmation` Read message confirmation status **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Confirmation status Content-Type: `application/json` ```json { "messageId": "00000000-0000-4000-8000-000000000000", "confirmed": true, "confirmedAt": null, "confirmedByUserId": null } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/messages/:id/confirmation" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}/conversation` Delete conversation for current actor **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Conversation deleted Content-Type: `application/json` ```json { "ok": true, "affectedCount": 1 } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/messages/:id/conversation" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}/conversation/archive` Unarchive conversation for current actor **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Conversation unarchived Content-Type: `application/json` ```json { "ok": true, "affectedCount": 1 } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/messages/:id/conversation/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/messages/{id}/conversation/archive` Archive conversation for current actor **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Conversation archived Content-Type: `application/json` ```json { "ok": true, "affectedCount": 1 } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/messages/:id/conversation/archive" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}/conversation/read` Mark entire conversation as unread for current actor **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Conversation marked unread Content-Type: `application/json` ```json { "ok": true, "affectedCount": 1 } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/messages/:id/conversation/read" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/messages/{id}/conversation/read` Mark entire conversation as read for current actor **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Conversation marked read Content-Type: `application/json` ```json { "ok": true, "affectedCount": 1 } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/messages/:id/conversation/read" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/messages/{id}/forward` Forward a message and optionally include attachments from the forwarded conversation slice **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "recipients": [ { "userId": "00000000-0000-4000-8000-000000000000", "type": "to" } ], "includeAttachments": true, "sendViaEmail": false } ``` ### Responses **201** – Message forwarded Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **403** – Access denied Content-Type: `application/json` **404** – Message not found Content-Type: `application/json` **409** – Forward not allowed for message type Content-Type: `application/json` **413** – Forward body exceeds maximum length Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/messages/:id/forward" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"recipients\": [ { \"userId\": \"00000000-0000-4000-8000-000000000000\", \"type\": \"to\" } ], \"includeAttachments\": true, \"sendViaEmail\": false }" ``` ## GET `/messages/{id}/forward-preview` Get forward preview for a message **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Forward preview generated Content-Type: `application/json` ```json { "subject": "string", "body": "string" } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` **413** – Forward body exceeds maximum length Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/messages/:id/forward-preview" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/messages/{id}/read` Mark message as unread **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Message marked unread Content-Type: `application/json` ```json { "ok": true } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/messages/:id/read" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/messages/{id}/read` Mark message as read **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Message marked read Content-Type: `application/json` ```json { "ok": true } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/messages/:id/read" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/messages/{id}/reply` Reply to message **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "body": "string", "bodyFormat": "text", "replyAll": false, "sendViaEmail": false } ``` ### Responses **201** – Reply created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **403** – Access denied Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Message not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – No recipients available for reply Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/messages/:id/reply" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"body\": \"string\", \"bodyFormat\": \"text\", \"replyAll\": false, \"sendViaEmail\": false }" ``` ## GET `/messages/object-types` List registered message object types for a message type **Tags:** Messages **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | messageType | query | any | Required | ### Responses **200** – Message object types Content-Type: `application/json` ```json { "items": [ { "module": "string", "entityType": "string", "labelKey": "string", "icon": "string", "actions": [ { "id": "string", "labelKey": "string" } ] } ] } ``` **400** – Invalid query Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/messages/object-types?messageType=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/messages/token/{token}` Access message via token **Tags:** Messages ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | token | path | any | Required | ### Responses **200** – Message detail via token Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000", "type": "string", "subject": "string", "body": "string", "bodyFormat": "text", "priority": "low", "senderUserId": "00000000-0000-4000-8000-000000000000", "sentAt": null, "actionData": null, "actionTaken": null, "actionTakenAt": null, "actionTakenByUserId": null, "objects": [ { "id": "00000000-0000-4000-8000-000000000000", "entityModule": "string", "entityType": "string", "entityId": "00000000-0000-4000-8000-000000000000", "actionRequired": true, "actionType": null, "actionLabel": null, "snapshot": null } ], "requiresAuth": true, "recipientUserId": "00000000-0000-4000-8000-000000000000" } ``` **404** – Invalid or expired link Content-Type: `application/json` **409** – Token usage exceeded Content-Type: `application/json` **410** – Token expired Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/messages/token/:token" \ -H "Accept: application/json" ``` ## GET `/messages/types` List registered message types **Tags:** Messages **Requires authentication.** ### Responses **200** – Message types Content-Type: `application/json` ```json { "items": [ { "type": "string", "module": "string", "labelKey": "string", "icon": "string", "color": null, "allowReply": true, "allowForward": true, "actionsExpireAfterHours": null, "ui": null } ] } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/messages/types" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/messages/unread-count` Get unread message count **Tags:** Messages **Requires authentication.** ### Responses **200** – Unread count Content-Type: `application/json` ```json { "unreadCount": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/messages/unread-count" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/notifications` List notifications Returns a paginated collection of notifications. **Tags:** Notifications **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | status | query | any | Optional | | type | query | any | Optional | | severity | query | any | Optional | | sourceEntityType | query | any | Optional | | sourceEntityId | query | any | Optional | | since | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated notifications Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "type": "string", "title": "string", "body": null, "titleKey": null, "bodyKey": null, "titleVariables": null, "bodyVariables": null, "icon": null, "severity": "string", "status": "string", "actions": [ { "id": "string", "label": "string" } ], "sourceModule": null, "sourceEntityType": null, "sourceEntityId": null, "linkHref": null, "createdAt": "string", "readAt": null, "actionTaken": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **403** – Request could not be resolved to a tenant scope (code: tenant_scope_required) Content-Type: `application/json` ```json { "error": "string", "code": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/notifications?page=1&pageSize=20" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/notifications` Create notification Creates a notification for a user. **Tags:** Notifications **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "type": "string", "severity": "info", "recipientUserId": "00000000-0000-4000-8000-000000000000" } ``` ### Responses **201** – Notification created Content-Type: `application/json` ```json { "id": "00000000-0000-4000-8000-000000000000" } ``` **400** – Invalid payload, or an action carries a `commandId` (code: notification_action_command_not_allowed) Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/notifications" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"type\": \"string\", \"severity\": \"info\", \"recipientUserId\": \"00000000-0000-4000-8000-000000000000\" }" ``` ## POST `/notifications/{id}/action` POST /notifications/{id}/action **Tags:** Notifications **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/notifications/:id/action" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/notifications/{id}/dismiss` PUT /notifications/{id}/dismiss **Tags:** Notifications **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/notifications/:id/dismiss" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/notifications/{id}/read` PUT /notifications/{id}/read **Tags:** Notifications **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/notifications/:id/read" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/notifications/{id}/restore` PUT /notifications/{id}/restore **Tags:** Notifications **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/notifications/:id/restore" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/notifications/admin/preferences` GET /notifications/admin/preferences **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/notifications/admin/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/notifications/admin/preferences` PUT /notifications/admin/preferences **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/notifications/admin/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/notifications/batch` POST /notifications/batch **Tags:** Notifications **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/notifications/batch" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/notifications/channels` GET /notifications/channels **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/notifications/channels" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/notifications/feature` POST /notifications/feature **Tags:** Notifications **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/notifications/feature" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/notifications/mark-all-read` PUT /notifications/mark-all-read **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/notifications/mark-all-read" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/notifications/preferences` GET /notifications/preferences **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/notifications/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/notifications/preferences` PUT /notifications/preferences **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/notifications/preferences" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/notifications/role` POST /notifications/role **Tags:** Notifications **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/notifications/role" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/notifications/settings` GET /notifications/settings **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/notifications/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/notifications/settings` POST /notifications/settings **Tags:** Notifications **Requires authentication.** ### Responses **201** – Success response Content-Type: `application/json` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/notifications/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/notifications/types` GET /notifications/types **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/notifications/types" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PATCH `/notifications/types` PATCH /notifications/types **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/notifications/types" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/notifications/types/{id}/channels/{channel}` DELETE /notifications/types/{id}/channels/{channel} **Tags:** Notifications **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | channel | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/notifications/types/:id/channels/:channel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/notifications/types/{id}/channels/{channel}` PUT /notifications/types/{id}/channels/{channel} **Tags:** Notifications **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | channel | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/notifications/types/:id/channels/:channel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/notifications/unread-count` GET /notifications/unread-count **Tags:** Notifications **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/notifications/unread-count" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/progress/active` GET /progress/active **Tags:** Progress **Requires authentication.** ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/progress/active" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/progress/jobs` List progressjobs Returns a paginated collection of progressjobs scoped to the authenticated tenant. **Tags:** Progress **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | status | query | any | Optional | | jobType | query | any | Optional | | parentJobId | query | any | Optional | | includeCompleted | query | any | Optional | | completedSince | query | any | Optional | | page | query | any | Optional | | pageSize | query | any | Optional | | search | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | | ids | query | any | Optional. Comma-separated list of record UUIDs to filter by (max 200). | ### Responses **200** – Paginated progressjobs Content-Type: `application/json` ```json { "items": [ { "id": "00000000-0000-4000-8000-000000000000", "jobType": "string", "name": "string", "description": null, "status": "string", "progressPercent": 1, "processedCount": 1, "totalCount": null, "etaSeconds": null, "cancellable": true, "startedAt": null, "finishedAt": null, "errorMessage": null, "createdAt": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": null } ], "total": 1, "totalPages": 1 } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/progress/jobs?page=1&pageSize=20" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/progress/jobs` Create progressjob Creates a new progress job for tracking a long-running operation. **Tags:** Progress **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "jobType": "string", "name": "string", "cancellable": false } ``` ### Responses **201** – ProgressJob created Content-Type: `application/json` ```json { "id": null } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/progress/jobs" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"jobType\": \"string\", \"name\": \"string\", \"cancellable\": false }" ``` ## DELETE `/progress/jobs/{id}` DELETE /progress/jobs/{id} **Tags:** Progress **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **204** – Success ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/progress/jobs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/progress/jobs/{id}` GET /progress/jobs/{id} **Tags:** Progress **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/progress/jobs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/progress/jobs/{id}` PUT /progress/jobs/{id} **Tags:** Progress **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/progress/jobs/:id" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/query_index/purge` Purge query index records Queues a purge job to remove indexed records for an entity type within the active scope. **Tags:** Query Index **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityType": "string" } ``` ### Responses **200** – Purge job accepted. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing entity type Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/query_index/purge" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityType\": \"string\" }" ``` ## POST `/query_index/reindex` Trigger query index rebuild Queues a reindex job for the specified entity type within the current tenant scope. **Tags:** Query Index **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "entityType": "string" } ``` ### Responses **200** – Reindex job accepted. Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing entity type Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/query_index/reindex" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"entityType\": \"string\" }" ``` ## GET `/query_index/status` Inspect query index coverage Returns entity counts comparing base tables with the query index along with the latest job status. **Tags:** Query Index **Requires authentication.** ### Responses **200** – Current query index status. Content-Type: `application/json` ```json { "items": [ { "entityId": "string", "label": "string", "baseCount": null, "indexCount": null, "vectorCount": null, "fulltextCount": null, "ok": true, "job": { "status": "idle", "startedAt": null, "finishedAt": null, "heartbeatAt": null, "processedCount": null, "totalCount": null, "scope": null }, "refreshedAt": null } ], "errors": [ { "id": "string", "source": "string", "handler": "string", "entityType": null, "recordId": null, "tenantId": null, "organizationId": null, "message": "string", "stack": null, "payload": null, "occurredAt": "string" } ], "logs": [ { "id": "string", "source": "string", "handler": "string", "level": "info", "entityType": null, "recordId": null, "tenantId": null, "organizationId": null, "message": "string", "details": null, "occurredAt": "string" } ] } ``` **400** – Tenant or organization context required Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Organization access denied Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/query_index/status" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/embeddings` Get embeddings configuration Returns current embedding provider and model configuration. **Tags:** Search **Requires authentication.** ### Responses **200** – Embeddings settings Content-Type: `application/json` ```json { "settings": { "openaiConfigured": true, "autoIndexingEnabled": true, "autoIndexingLocked": true, "lockReason": null, "embeddingConfig": null, "configuredProviders": [ "openai" ], "indexedDimension": null, "reindexRequired": true, "documentCount": null } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/search/embeddings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/search/embeddings` Update embeddings configuration Updates the embedding provider and model settings. **Tags:** Search **Requires authentication.** ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Updated settings Content-Type: `application/json` ```json { "settings": { "openaiConfigured": true, "autoIndexingEnabled": true, "autoIndexingLocked": true, "lockReason": null, "embeddingConfig": null, "configuredProviders": [ "openai" ], "indexedDimension": null, "reindexRequired": true, "documentCount": null } } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Auto-indexing disabled via environment Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Update failed Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Configuration service unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/search/embeddings" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## POST `/search/embeddings/reindex` Trigger vector reindex Starts a vector embedding reindex operation. **Tags:** Search **Requires authentication.** ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Reindex result Content-Type: `application/json` ```json { "ok": true } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Reindex already in progress Content-Type: `application/json` ```json { "error": "string", "lock": { "type": "fulltext", "action": "string", "startedAt": "string", "elapsedMinutes": 1, "processedCount": null, "totalCount": null } } ``` **500** – Reindex failed Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Search indexer unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/search/embeddings/reindex" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## POST `/search/embeddings/reindex/cancel` Cancel vector reindex Cancels an in-progress vector reindex operation. **Tags:** Search **Requires authentication.** ### Responses **200** – Cancel result Content-Type: `application/json` ```json { "ok": true, "jobsRemoved": 1 } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/search/embeddings/reindex/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## DELETE `/search/index` Purge vector index Purges entries from the vector search index. Requires confirmAll=true when purging all entities. **Tags:** Search **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Optional. Specific entity ID to purge (e.g., "customers:customer_person_profile", "catalog:catalog_product") | | confirmAll | query | any | Optional. Required when purging all entities | ### Responses **200** – Purge result Content-Type: `application/json` ```json { "ok": true } ``` **400** – Missing confirmAll parameter Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Purge failed Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Search indexer unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/search/index" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/index` List vector index entries Returns paginated list of entries in the vector search index. **Tags:** Search **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | entityId | query | any | Optional. Filter by entity ID (e.g., "customers:customer_person_profile", "catalog:catalog_product") | | limit | query | any | Optional. Maximum entries to return (default: 50, max: 200) | | offset | query | any | Optional. Offset for pagination (default: 0) | ### Responses **200** – Index entries Content-Type: `application/json` ```json { "entries": [ { "id": "string", "entityId": "string", "recordId": "string", "tenantId": "string", "organizationId": null } ], "limit": 1, "offset": 1 } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Failed to fetch index Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Vector strategy unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/search/index" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/search/reindex` Trigger fulltext reindex Starts a fulltext (Meilisearch) reindex operation. Can clear, recreate, or fully reindex. **Tags:** Search **Requires authentication.** ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Reindex result Content-Type: `application/json` ```json { "ok": true, "action": "clear", "entityId": null } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Reindex already in progress Content-Type: `application/json` ```json { "error": "string", "lock": { "type": "fulltext", "action": "string", "startedAt": "string", "elapsedMinutes": 1, "processedCount": null, "totalCount": null } } ``` **500** – Reindex failed Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Search service unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/search/reindex" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{}" ``` ## POST `/search/reindex/cancel` Cancel fulltext reindex Cancels an in-progress fulltext reindex operation. **Tags:** Search **Requires authentication.** ### Responses **200** – Cancel result Content-Type: `application/json` ```json { "ok": true, "jobsRemoved": 1 } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/search/reindex/cancel" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/search` Search across all indexed entities Performs a search using configured strategies (fulltext, vector, tokens). Use for search playground. Results are limited to the entity types the caller holds the declared view features for; superadmins are exempt. **Tags:** Search **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | q | query | any | Required. Search query (required) | | limit | query | any | Optional. Maximum results to return (default: 50, max: 100) | | strategies | query | any | Optional. Comma-separated strategies to use: fulltext, vector, tokens (e.g., "fulltext,vector") | | entityTypes | query | any | Optional. Comma-separated entity types to filter results (e.g., "customers:customer_person_profile,catalog:catalog_product,sales:sales_order") | ### Responses **200** – Search results Content-Type: `application/json` ```json { "results": [ { "entityId": "string", "recordId": "string", "score": 1, "source": "fulltext" } ], "strategiesUsed": [ "fulltext" ], "timing": 1, "query": "string", "limit": 1 } ``` **400** – Missing query parameter Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Search failed Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Search service unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/search/search?q=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/search/global` Global search (Cmd+K) Performs a global search using saved tenant strategies. Does NOT accept strategies from URL. **Tags:** Search **Requires authentication.** ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | q | query | any | Required. Search query (required) | | limit | query | any | Optional. Maximum results to return (default: 50, max: 100) | | entityTypes | query | any | Optional. Comma-separated entity types to filter results (e.g., "customers:customer_person_profile,catalog:catalog_product,sales:sales_order") | ### Responses **200** – Search results Content-Type: `application/json` ```json { "results": [ { "entityId": "string", "recordId": "string", "score": 1, "source": "fulltext" } ], "strategiesUsed": [ "fulltext" ], "strategiesEnabled": [ "fulltext" ], "timing": 1, "query": "string", "limit": 1 } ``` **400** – Missing query parameter Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Search failed Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Search service unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/search/search/global?q=string" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/settings` Get search settings and status Returns search module configuration, available strategies, and reindex lock status. **Tags:** Search **Requires authentication.** ### Responses **200** – Search settings Content-Type: `application/json` ```json { "settings": { "strategies": [ { "id": "string", "name": "string", "priority": 1, "available": true } ], "fulltextConfigured": true, "fulltextStats": null, "vectorConfigured": true, "tokensEnabled": true, "defaultStrategies": [ "string" ], "reindexLock": null, "fulltextReindexLock": null, "vectorReindexLock": null } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/search/settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/settings/fulltext` Get fulltext search configuration Returns Meilisearch configuration status and index statistics. **Tags:** Search **Requires authentication.** ### Responses **200** – Fulltext settings Content-Type: `application/json` ```json { "driver": null, "configured": true, "envVars": { "MEILISEARCH_HOST": { "set": true, "hint": "string" }, "MEILISEARCH_API_KEY": { "set": true, "hint": "string" } }, "optionalEnvVars": { "MEILISEARCH_INDEX_PREFIX": { "set": true, "hint": "string" }, "SEARCH_EXCLUDE_ENCRYPTED_FIELDS": { "set": true, "hint": "string" } } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/search/settings/fulltext" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/search/settings/global-search` Get global search strategies Returns the enabled strategies for Cmd+K global search. **Tags:** Search **Requires authentication.** ### Responses **200** – Global search settings Content-Type: `application/json` ```json { "enabledStrategies": [ "fulltext" ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/search/settings/global-search" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## POST `/search/settings/global-search` Update global search strategies Sets which strategies are enabled for Cmd+K global search. **Tags:** Search **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "enabledStrategies": [ "fulltext" ] } ``` ### Responses **200** – Updated settings Content-Type: `application/json` ```json { "ok": true, "enabledStrategies": [ "fulltext" ] } ``` **400** – Invalid request Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/search/settings/global-search" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"enabledStrategies\": [ \"fulltext\" ] }" ``` ## GET `/search/settings/vector-store` Get vector store configuration Returns vector store configuration status. **Tags:** Search **Requires authentication.** ### Responses **200** – Vector store settings Content-Type: `application/json` ```json { "currentDriver": "pgvector", "configured": true, "drivers": [ { "id": "pgvector", "name": "string", "configured": true, "implemented": true, "available": null, "unavailableReason": null, "envVars": [ { "name": "string", "set": true, "hint": "string" } ] } ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/search/settings/vector-store" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/version` Deployed Open Mercato version **Tags:** API Documentation ### Responses **200** – Success response Content-Type: `application/json` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/version" \ -H "Accept: application/json" ``` ## GET `/workflows/command-settings` List workflow-safe command candidates with tenant enablement Returns every command declared through registerWorkflowSafeCommands together with whether this tenant has switched it on. `configured: false` means the tenant has never saved the setting and the answers come from the grandfathered defaults. **Tags:** Workflows **Requires authentication.** ### Responses **200** – Catalogue with tenant enablement Content-Type: `application/json` ```json { "configured": true, "items": [ { "commandId": "string", "requiredFeatures": [ "string" ], "labelKey": null } ] } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/command-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/workflows/command-settings` Set which workflow-safe commands are enabled for the tenant Replaces the tenant's enabled set. Every submitted id must be present in the code-declared catalogue; an unknown id is rejected with 400 rather than stored. Stored ids whose declaring module is not loaded in this process are retained so a save can never silently untick them. **Tags:** Workflows **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "enabledCommandIds": [ "string" ] } ``` ### Responses **200** – Updated enablement Content-Type: `application/json` ```json { "configured": true, "items": [ { "commandId": "string", "requiredFeatures": [ "string" ], "labelKey": null } ], "ok": true } ``` **400** – Invalid payload or unknown command id Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Settings storage unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/workflows/command-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"enabledCommandIds\": [ \"string\" ] }" ``` ## GET `/workflows/commands` List commands allowlisted for UPDATE_ENTITY activities Returns the registered workflow-safe command catalogue consumed by the UPDATE_ENTITY command picker, each entry carrying whether the caller's tenant has enabled it. Entries with enabled:false, and commands outside the catalogue entirely, can still be authored but fail at runtime. **Tags:** Workflows ### Responses **200** – Allowlisted workflow-safe commands Content-Type: `application/json` ```json { "items": [ { "commandId": "string", "requiredFeatures": [ "string" ], "labelKey": null } ] } ``` **400** – Missing tenant context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/commands" \ -H "Accept: application/json" ``` ## GET `/workflows/definitions` List workflow definitions Get a list of workflow definitions with optional filters. Supports pagination and search. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | workflowId | query | any | Required | | enabled | query | any | Optional | | search | query | any | Optional | | limit | query | any | Optional | | offset | query | any | Optional | ### Responses **200** – List of workflow definitions with pagination Content-Type: `application/json` ```json { "data": [ { "id": "123e4567-e89b-12d3-a456-426614174000", "workflowId": "checkout-flow", "workflowName": "Checkout Flow", "description": "Complete checkout workflow for processing orders", "version": 1, "definition": { "steps": [ { "stepId": "start", "stepName": "Start", "stepType": "START" }, { "stepId": "validate-cart", "stepName": "Validate Cart", "stepType": "AUTOMATED" }, { "stepId": "end", "stepName": "End", "stepType": "END" } ], "transitions": [ { "transitionId": "start-to-validate", "fromStepId": "start", "toStepId": "validate-cart", "trigger": "auto" }, { "transitionId": "validate-to-end", "fromStepId": "validate-cart", "toStepId": "end", "trigger": "auto" } ] }, "enabled": true, "tenantId": "123e4567-e89b-12d3-a456-426614174001", "organizationId": "123e4567-e89b-12d3-a456-426614174002", "createdAt": "2025-12-08T10:00:00.000Z", "updatedAt": "2025-12-08T10:00:00.000Z" } ], "pagination": { "total": 1, "limit": 50, "offset": 0, "hasMore": false } } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/definitions?workflowId=string&limit=50&offset=0" \ -H "Accept: application/json" ``` ## POST `/workflows/definitions` Create workflow definition Create a new workflow definition. The definition must include at least START and END steps with at least one transition connecting them. **Tags:** Workflows ### Request Body Content-Type: `application/json` ```json { "workflowId": "checkout-flow", "workflowName": "Checkout Flow", "description": "Complete checkout workflow for processing orders", "version": 1, "definition": { "steps": [ { "stepId": "start", "stepName": "Start", "stepType": "START" }, { "stepId": "validate-cart", "stepName": "Validate Cart", "stepType": "AUTOMATED", "description": "Validate cart items and check inventory" }, { "stepId": "payment", "stepName": "Process Payment", "stepType": "AUTOMATED", "description": "Charge payment method", "retryPolicy": { "maxAttempts": 3, "backoffMs": 1000 } }, { "stepId": "end", "stepName": "End", "stepType": "END" } ], "transitions": [ { "transitionId": "start-to-validate", "fromStepId": "start", "toStepId": "validate-cart", "trigger": "auto" }, { "transitionId": "validate-to-payment", "fromStepId": "validate-cart", "toStepId": "payment", "trigger": "auto" }, { "transitionId": "payment-to-end", "fromStepId": "payment", "toStepId": "end", "trigger": "auto", "activities": [ { "activityName": "Send Order Confirmation", "activityType": "SEND_EMAIL", "config": { "to": "{{context.customerEmail}}", "subject": "Order Confirmation #{{context.orderId}}", "template": "order_confirmation" } } ] } ] }, "enabled": true } ``` ### Responses **201** – Workflow definition created successfully Content-Type: `application/json` ```json { "data": { "id": "123e4567-e89b-12d3-a456-426614174000", "workflowId": "checkout-flow", "workflowName": "Checkout Flow", "description": "Complete checkout workflow for processing orders", "version": 1, "definition": { "steps": [ { "stepId": "start", "stepName": "Start", "stepType": "START" }, { "stepId": "validate-cart", "stepName": "Validate Cart", "stepType": "AUTOMATED" }, { "stepId": "payment", "stepName": "Process Payment", "stepType": "AUTOMATED" }, { "stepId": "end", "stepName": "End", "stepType": "END" } ], "transitions": [ { "transitionId": "start-to-validate", "fromStepId": "start", "toStepId": "validate-cart", "trigger": "auto" }, { "transitionId": "validate-to-payment", "fromStepId": "validate-cart", "toStepId": "payment", "trigger": "auto" }, { "transitionId": "payment-to-end", "fromStepId": "payment", "toStepId": "end", "trigger": "auto" } ] }, "enabled": true, "tenantId": "123e4567-e89b-12d3-a456-426614174001", "organizationId": "123e4567-e89b-12d3-a456-426614174002", "createdAt": "2025-12-08T10:00:00.000Z", "updatedAt": "2025-12-08T10:00:00.000Z" }, "message": "Workflow definition created successfully" } ``` **400** – Validation error - invalid workflow structure Content-Type: `application/json` ```json { "error": "Validation failed", "details": [ { "path": [ "definition", "steps" ], "code": "custom", "message": "Workflow must have at least START and END steps" } ] } ``` **409** – Conflict - workflow with same ID and version already exists Content-Type: `application/json` ```json { "error": "Workflow definition with ID \"checkout-flow\" and version 1 already exists" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/definitions" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"workflowId\": \"string\", \"workflowName\": \"string\", \"description\": null, \"version\": 1, \"definition\": { \"steps\": [ { \"stepId\": \"string\", \"stepName\": \"string\", \"stepType\": \"START\" } ], \"transitions\": [ { \"transitionId\": \"string\", \"fromStepId\": \"string\", \"toStepId\": \"string\", \"trigger\": \"auto\", \"condition\": null, \"continueOnActivityFailure\": false, \"priority\": 0 } ] }, \"metadata\": null, \"enabled\": true, \"grantedFeatures\": null }" ``` ## DELETE `/workflows/definitions/{id}` Delete workflow definition Soft delete a workflow definition. Cannot be deleted if there are active workflow instances (RUNNING or WAITING status) using this definition. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Workflow definition deleted successfully Content-Type: `application/json` ```json { "message": "Workflow definition deleted successfully" } ``` **404** – Workflow definition not found Content-Type: `application/json` ```json { "error": "Workflow definition not found" } ``` **409** – Cannot delete - active workflow instances exist Content-Type: `application/json` ```json { "error": "Cannot delete workflow definition with 3 active instance(s)" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/workflows/definitions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" ``` ## GET `/workflows/definitions/{id}` Get workflow definition Get a single workflow definition by ID. Returns the complete workflow structure including steps and transitions (with embedded activities). **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required. UUID for DB definitions, or "code:" for code-based definitions | ### Responses **200** – Workflow definition found Content-Type: `application/json` ```json { "data": { "id": "123e4567-e89b-12d3-a456-426614174000", "workflowId": "checkout-flow", "workflowName": "Checkout Flow", "description": "Complete checkout workflow for processing orders", "version": 1, "definition": { "steps": [ { "stepId": "start", "stepName": "Start", "stepType": "START" }, { "stepId": "validate-cart", "stepName": "Validate Cart", "stepType": "AUTOMATED", "description": "Validate cart items and check inventory" }, { "stepId": "payment", "stepName": "Process Payment", "stepType": "AUTOMATED", "description": "Charge payment method", "retryPolicy": { "maxAttempts": 3, "backoffMs": 1000 } }, { "stepId": "end", "stepName": "End", "stepType": "END" } ], "transitions": [ { "transitionId": "start-to-validate", "fromStepId": "start", "toStepId": "validate-cart", "trigger": "auto" }, { "transitionId": "validate-to-payment", "fromStepId": "validate-cart", "toStepId": "payment", "trigger": "auto" }, { "transitionId": "payment-to-end", "fromStepId": "payment", "toStepId": "end", "trigger": "auto", "activities": [ { "activityName": "Send Order Confirmation", "activityType": "SEND_EMAIL", "config": { "to": "{{context.customerEmail}}", "subject": "Order Confirmation #{{context.orderId}}", "template": "order_confirmation" } } ] } ] }, "enabled": true, "tenantId": "123e4567-e89b-12d3-a456-426614174001", "organizationId": "123e4567-e89b-12d3-a456-426614174002", "createdAt": "2025-12-08T10:00:00.000Z", "updatedAt": "2025-12-08T10:00:00.000Z" } } ``` **404** – Workflow definition not found Content-Type: `application/json` ```json { "error": "Workflow definition not found" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/definitions/string" \ -H "Accept: application/json" ``` ## PUT `/workflows/definitions/{id}` Update workflow definition Update an existing workflow definition. Supports partial updates - only provided fields will be updated. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "definition": { "steps": [ { "stepId": "start", "stepName": "Start", "stepType": "START" }, { "stepId": "validate-cart", "stepName": "Validate Cart", "stepType": "AUTOMATED" }, { "stepId": "payment", "stepName": "Process Payment", "stepType": "AUTOMATED" }, { "stepId": "confirmation", "stepName": "Order Confirmation", "stepType": "AUTOMATED" }, { "stepId": "end", "stepName": "End", "stepType": "END" } ], "transitions": [ { "transitionId": "start-to-validate", "fromStepId": "start", "toStepId": "validate-cart", "trigger": "auto" }, { "transitionId": "validate-to-payment", "fromStepId": "validate-cart", "toStepId": "payment", "trigger": "auto" }, { "transitionId": "payment-to-confirmation", "fromStepId": "payment", "toStepId": "confirmation", "trigger": "auto" }, { "transitionId": "confirmation-to-end", "fromStepId": "confirmation", "toStepId": "end", "trigger": "auto" } ] }, "enabled": true } ``` ### Responses **200** – Workflow definition updated successfully Content-Type: `application/json` ```json { "data": { "id": "123e4567-e89b-12d3-a456-426614174000", "workflowId": "checkout-flow", "workflowName": "Checkout Flow", "description": "Complete checkout workflow for processing orders", "version": 1, "definition": { "steps": [ { "stepId": "start", "stepName": "Start", "stepType": "START" }, { "stepId": "validate-cart", "stepName": "Validate Cart", "stepType": "AUTOMATED" }, { "stepId": "payment", "stepName": "Process Payment", "stepType": "AUTOMATED" }, { "stepId": "confirmation", "stepName": "Order Confirmation", "stepType": "AUTOMATED" }, { "stepId": "end", "stepName": "End", "stepType": "END" } ], "transitions": [ { "transitionId": "start-to-validate", "fromStepId": "start", "toStepId": "validate-cart", "trigger": "auto" }, { "transitionId": "validate-to-payment", "fromStepId": "validate-cart", "toStepId": "payment", "trigger": "auto" }, { "transitionId": "payment-to-confirmation", "fromStepId": "payment", "toStepId": "confirmation", "trigger": "auto" }, { "transitionId": "confirmation-to-end", "fromStepId": "confirmation", "toStepId": "end", "trigger": "auto" } ] }, "enabled": true, "tenantId": "123e4567-e89b-12d3-a456-426614174001", "organizationId": "123e4567-e89b-12d3-a456-426614174002", "createdAt": "2025-12-08T10:00:00.000Z", "updatedAt": "2025-12-08T11:30:00.000Z" }, "message": "Workflow definition updated successfully" } ``` **400** – Validation error Content-Type: `application/json` ```json { "error": "Validation failed", "details": [ { "path": [ "definition" ], "code": "invalid_type", "message": "Invalid input: expected object, received string", "expected": "object", "got": "string" } ] } ``` **404** – Workflow definition not found Content-Type: `application/json` ```json { "error": "Workflow definition not found" } ``` **409** – Structural change refused while instances are still running (or optimistic-lock conflict). Publish a new version and apply the change there. Content-Type: `application/json` ```json { "error": "Structural changes require a new version while instances are still running", "code": "WORKFLOW_STRUCTURAL_EDIT_REQUIRES_NEW_VERSION", "definitionId": "123e4567-e89b-12d3-a456-426614174000", "activeInstanceCount": 3, "activeStatuses": [ "RUNNING", "PAUSED", "WAITING_FOR_ACTIVITIES", "FORKED", "COMPENSATING" ], "changes": [ { "kind": "transitionRetargeted", "id": "t_lz3k9_ab12cd34e" } ], "remedy": { "action": "createVersion", "method": "POST", "endpoint": "/api/workflows/definitions/123e4567-e89b-12d3-a456-426614174000/publish" } } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/workflows/definitions/00000000-0000-4000-8000-000000000000" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"description\": null, \"metadata\": null, \"effectiveFrom\": null, \"effectiveTo\": null, \"grantedFeatures\": null }" ``` ## GET `/workflows/definitions/{id}/callers` List sub-workflow callers and breaking mappings Returns parent definitions that invoke this workflow as a sub-workflow and the mappings its current port contract would break. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required. Workflow definition id | ### Responses **200** – Callers Content-Type: `application/json` ```json { "callers": [ { "workflowId": "order-flow", "version": 1, "stepId": "sub", "brokenMappings": [ "input:orderId" ] } ] } ``` **404** – Not found Content-Type: `application/json` ```json { "error": "Workflow definition not found" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/definitions/string/callers" \ -H "Accept: application/json" ``` ## GET `/workflows/definitions/{id}/context-schema` Get the per-step context ledger Computes what context paths are available at each step of the workflow definition, with type, presence (always/maybe), and producer source. Presence degrades to "maybe" at joins unless the entry arrives on every incoming route. Use ?stepId= to narrow the response to one step. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required. UUID for DB definitions, or "code:" for code-based definitions | | stepId | query | any | Optional. Narrow the response to this step (404 when the step does not exist) | ### Responses **200** – Per-step context ledger Content-Type: `application/json` ```json { "steps": { "approve": { "entries": [ { "path": "orderId", "type": "text", "presence": "always", "source": { "kind": "contextSchema", "label": "contextSchema.input" } }, { "path": "discount", "type": "number", "presence": "maybe", "source": { "kind": "userTask", "stepId": "review", "label": "userTask:review" } } ] } } } ``` **400** – Missing tenant context Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow definition or requested step not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/definitions/string/context-schema" \ -H "Accept: application/json" ``` ## POST `/workflows/definitions/{id}/customize` Customize code-based workflow definition Creates a DB override for a code-based workflow definition, seeded from the current code registry values. The id param must be of the form "code:". **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required. Must be of the form "code:" | ### Responses **200** – Workflow definition customized successfully Content-Type: `application/json` ```json { "data": { "id": "123e4567-e89b-12d3-a456-426614174000", "workflowId": "workflows.simple-approval", "workflowName": "Simple Approval Workflow", "source": "code_override" }, "message": "Workflow definition customized successfully" } ``` **400** – Not a code-based id Content-Type: `application/json` ```json { "error": "Customize is only supported for code-based workflow definitions" } ``` **404** – Code workflow not found Content-Type: `application/json` ```json { "error": "Workflow definition not found" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/definitions/string/customize" \ -H "Accept: application/json" ``` ## DELETE `/workflows/definitions/{id}/draft` Discard the current user's draft Deletes the authenticated user's draft for the workflow definition. Idempotent: discarding a non-existent draft succeeds. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required. Workflow definition UUID (server drafts exist only for saved definitions) | ### Responses **200** – Draft discarded (or no draft existed) Content-Type: `application/json` ```json { "message": "string" } ``` **400** – Invalid definition id Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X DELETE "https://pokaz.mcc.commercy.pl/api/workflows/definitions/string/draft" \ -H "Accept: application/json" ``` ## GET `/workflows/definitions/{id}/draft` Get the current user's draft Returns the authenticated user's autosaved draft for the workflow definition. Drafts are private to the user who saved them. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required. Workflow definition UUID (server drafts exist only for saved definitions) | ### Responses **200** – Draft found Content-Type: `application/json` ```json { "data": { "id": "string", "definitionId": null, "definition": { "steps": [ {} ], "transitions": [ {} ] }, "metadata": null, "baseUpdatedAt": null, "createdAt": null, "updatedAt": null } } ``` **400** – Invalid definition id (only saved definitions have server drafts) Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – No draft exists for this user and definition Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/definitions/string/draft" \ -H "Accept: application/json" ``` ## PUT `/workflows/definitions/{id}/draft` Save the current user's draft Creates or updates the authenticated user's draft for the workflow definition. The definition payload is validated shape-only (steps and transitions must be arrays of objects) so a mid-edit, structurally incomplete graph still saves; full validation runs when the draft is promoted via the definition PUT. Draft saves never participate in the definition's optimistic lock. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required. Workflow definition UUID (server drafts exist only for saved definitions) | ### Request Body Content-Type: `application/json` ```json { "definition": { "steps": [ { "stepId": "start", "stepName": "Start", "stepType": "START" } ], "transitions": [] }, "baseUpdatedAt": "2026-07-27T10:00:00.000Z" } ``` ### Responses **200** – Draft saved Content-Type: `application/json` ```json { "data": { "id": "string", "definitionId": null, "definition": { "steps": [ {} ], "transitions": [ {} ] }, "metadata": null, "baseUpdatedAt": null, "createdAt": null, "updatedAt": null }, "message": "string" } ``` **400** – Malformed draft payload or invalid definition id Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow definition not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/workflows/definitions/string/draft" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"definition\": { \"steps\": [ {} ], \"transitions\": [ {} ] }, \"metadata\": null, \"baseUpdatedAt\": null }" ``` ## POST `/workflows/definitions/{id}/publish` Publish a new workflow definition version Mints a frozen published version snapshotting the definition and its IO port contract. Returns affected sub-workflow callers; pass acknowledgeBreakingChanges=true to publish despite breaking changes. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required. Workflow definition id | ### Request Body Content-Type: `application/json` No example available for this content type. ### Responses **200** – Published Content-Type: `application/json` ```json { "data": { "id": "…", "workflowId": "verify-policy", "version": 2, "lifecycle": "published" }, "breakingChanges": [], "message": "Workflow definition published successfully" } ``` **404** – Not found Content-Type: `application/json` ```json { "error": "Workflow definition not found" } ``` **409** – Breaking changes not acknowledged Content-Type: `application/json` ```json { "error": "Publishing would break existing sub-workflow mappings", "breakingChanges": [ { "workflowId": "order-flow", "version": 1, "stepId": "sub", "brokenMappings": [ "input:orderId" ] } ] } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/definitions/string/publish" \ -H "Accept: application/json" ``` ## POST `/workflows/definitions/{id}/reset-to-code` Reset workflow definition to code version Deletes the DB override for a code-based workflow definition, reverting it to the original code registry version. Cannot be reset if there are active instances. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Workflow definition reset to code version Content-Type: `application/json` ```json { "data": { "id": "code:checkout-flow", "workflowId": "checkout-flow", "workflowName": "Checkout Flow", "description": "Code-defined checkout workflow", "version": 1, "source": "code", "isCodeBased": true }, "message": "Workflow definition reset to code version" } ``` **400** – Definition is not a code-based override Content-Type: `application/json` ```json { "error": "This workflow definition is not a code-based override and cannot be reset" } ``` **404** – Workflow definition not found Content-Type: `application/json` ```json { "error": "Workflow definition not found" } ``` **409** – Cannot reset - active workflow instances exist Content-Type: `application/json` ```json { "error": "Cannot reset workflow definition with 3 active instance(s)" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/definitions/00000000-0000-4000-8000-000000000000/reset-to-code" \ -H "Accept: application/json" ``` ## POST `/workflows/definitions/{id}/test-step` Dry-run one activity config with mock-first semantics Interpolates the supplied activity config against the sample context (plus a synthetic workflow scope and the server env allowlist) and runs the activity type's would-do mock. Never executes the real activity. Activity types that declare no mock or opt out with "refuse" respond 200 with a structured refusal the editor renders. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required. UUID for DB definitions, or "code:" for code-based definitions | ### Request Body Content-Type: `application/json` ```json { "stepId": "notify", "activityType": "SEND_EMAIL", "config": { "to": "{{context.customerEmail}}", "subject": "Order {{context.orderId}} approved" }, "context": { "customerEmail": "jane@example.com", "orderId": "ORD-42" } } ``` ### Responses **200** – Simulated mock output, or a structured refusal when the type cannot be simulated Content-Type: `application/json` ```json { "simulated": true, "activityType": "SEND_EMAIL", "output": { "sent": false, "simulated": true, "wouldSendTo": "jane@example.com", "subject": "Order ORD-42 approved" }, "interpolatedConfig": { "to": "jane@example.com", "subject": "Order ORD-42 approved" } } ``` **400** – Missing tenant context or malformed payload Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow definition or activity type not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/definitions/string/test-step" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"activityType\": \"string\", \"config\": {} }" ``` ## POST `/workflows/definitions/generate` Author a draft workflow definition from natural language Runs the propose-only workflows.workflow_author agent against this installation's activity, command, function and event catalogs and returns a draft definition plus the Problems-panel evaluation for it. Persists nothing: the draft is returned to the Studio for a human to apply, save and enable. Refusals ("unavailable" when no AI provider or agent registry is present, "failed" when the model call errored, "malformedResponse"/"schemaError" when the output is not a workflow definition) respond 200 with a structured body. **Tags:** Workflows ### Request Body Content-Type: `application/json` ```json { "prompt": "string" } ``` ### Responses **200** – The generated draft with its Problems-panel evaluation, or a structured refusal Content-Type: `application/json` ```json { "ok": true } ``` **400** – Invalid request body Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Generation failed unexpectedly Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/definitions/generate" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"prompt\": \"string\" }" ``` ## GET `/workflows/endpoints` List endpoints available to CALL_API activities Returns a trimmed projection of the OpenAPI surface (path, method, summary, tag, parameters, and declared request/response schemas) consumed by the CALL_API endpoint picker. Endpoints outside this catalog can still be authored as free text. Responses without a declared schema omit responseSchema so consumers degrade to unknown typing. **Tags:** Workflows ### Responses **200** – Endpoint catalog projected from the OpenAPI surface Content-Type: `application/json` ```json { "items": [ { "path": "string", "method": "string", "summary": "string", "tag": "string", "params": [ { "name": "string", "in": "path", "required": true, "type": "string" } ], "hasRequestSchema": true } ] } ``` **400** – Missing tenant context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/endpoints" \ -H "Accept: application/json" ``` ## GET `/workflows/events` List all workflow events Get a paginated list of all workflow events with filtering options **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | page | query | any | Optional | | pageSize | query | any | Optional | | eventType | query | any | Optional | | workflowInstanceId | query | any | Optional | | userId | query | any | Optional | | occurredAtFrom | query | any | Optional | | occurredAtTo | query | any | Optional | | sortField | query | any | Optional | | sortDir | query | any | Optional | ### Responses **200** – List of workflow events Content-Type: `application/json` ```json { "items": [ { "id": "string", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "stepInstanceId": null, "eventType": "string", "occurredAt": "string", "userId": null, "workflowInstance": null } ], "total": 1, "page": 1, "pageSize": 1, "totalPages": 1 } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/events?page=1&pageSize=50&sortField=occurredAt&sortDir=desc" \ -H "Accept: application/json" ``` ## GET `/workflows/events/{id}` Get workflow event by ID Get detailed information about a specific workflow event **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Workflow event details Content-Type: `application/json` ```json { "id": "string", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "stepInstanceId": null, "eventType": "string", "occurredAt": "string", "userId": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "workflowInstance": null } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow event not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/events/:id" \ -H "Accept: application/json" ``` ## GET `/workflows/functions` List registered workflow function descriptors for EXECUTE_FUNCTION activities Returns the registered workflow function descriptors consumed by the EXECUTE_FUNCTION function picker. Functions outside this list can still be authored but fail at runtime when no matching workflowFunction: DI registration exists. **Tags:** Workflows ### Responses **200** – Registered workflow function descriptors Content-Type: `application/json` ```json { "items": [ { "name": "string" } ] } ``` **400** – Missing tenant context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/functions" \ -H "Accept: application/json" ``` ## GET `/workflows/grantable-features` List grantable execution features Declared ACL feature ids/titles intersected with the calling user’s own current grants (wildcard-aware). Drives the definition editor’s execution-permissions picker; gated by workflows.definitions.grant_features. **Tags:** Workflows **Requires authentication.** ### Responses **200** – Grantable feature catalog Content-Type: `application/json` ```json { "items": [ { "id": "string", "title": "string", "module": "string" } ] } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Missing workflows.definitions.grant_features Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/grantable-features" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## GET `/workflows/instances` List workflow instances Get a list of workflow instances with optional filters. Supports pagination and filtering by status, workflowId, correlationKey, etc. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | workflowId | query | any | Optional | | status | query | any | Optional | | outcome | query | any | Optional. Filter by the run VERDICT, independently of status. Comma-separated for several (e.g. partial_failure,failure). An unknown value is a 400. | | correlationKey | query | any | Optional | | entityType | query | any | Optional | | entityId | query | any | Optional | | parentInstanceId | query | any | Optional. Return only direct sub-workflow children of this parent instance. | | hasParent | query | any | Optional. false = only top-level/standalone instances; true = only sub-workflow children. Ignored when parentInstanceId is set. | | attention | query | any | Optional. true = only instances parked by a failure-queue error directive; false = only instances without an attention marker. | | startedFrom | query | any | Optional. Lower bound on startedAt. A calendar day (YYYY-MM-DD) is taken from 00:00:00.000Z; a full ISO timestamp is taken verbatim. | | startedTo | query | any | Optional. Upper bound on startedAt, inclusive. A calendar day (YYYY-MM-DD) covers the whole day up to 23:59:59.999Z. | | limit | query | any | Optional | | offset | query | any | Optional | ### Responses **200** – List of workflow instances Content-Type: `application/json` ```json { "data": [ { "id": "00000000-0000-4000-8000-000000000000", "definitionId": "00000000-0000-4000-8000-000000000000", "workflowId": "string", "version": 1, "status": "RUNNING", "outcome": null, "currentStepId": "string", "correlationKey": null, "metadata": null, "startedAt": "string", "completedAt": null, "pausedAt": null, "cancelledAt": null, "errorMessage": null, "errorDetails": null, "pendingTransition": null, "retryCount": 1, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "deletedAt": null } ], "pagination": { "total": 1, "limit": 1, "offset": 1, "hasMore": true } } ``` **400** – Invalid date range or unknown outcome Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/instances?limit=50&offset=0" \ -H "Accept: application/json" ``` ## POST `/workflows/instances` Start workflow instance Start a new workflow instance from a workflow definition. The workflow will execute immediately. **Tags:** Workflows ### Request Body Content-Type: `application/json` ```json { "workflowId": "string" } ``` ### Responses **201** – Workflow started successfully Content-Type: `application/json` ```json { "data": { "instance": { "id": "00000000-0000-4000-8000-000000000000", "definitionId": "00000000-0000-4000-8000-000000000000", "workflowId": "string", "version": 1, "status": "RUNNING", "outcome": null, "currentStepId": "string", "correlationKey": null, "metadata": null, "startedAt": "string", "completedAt": null, "pausedAt": null, "cancelledAt": null, "errorMessage": null, "errorDetails": null, "pendingTransition": null, "retryCount": 1, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "deletedAt": null }, "execution": { "status": "RUNNING", "currentStep": "string", "message": "string" } }, "message": "string" } ``` **400** – Bad request - Validation failed or definition disabled/invalid Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden - Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow definition not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/instances" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"workflowId\": \"string\" }" ``` ## GET `/workflows/instances/{id}` Get workflow instance Get detailed information about a specific workflow instance including current state, context, and execution status. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Workflow instance details Content-Type: `application/json` ```json { "data": { "id": "00000000-0000-4000-8000-000000000000", "definitionId": "00000000-0000-4000-8000-000000000000", "workflowId": "string", "version": 1, "status": "RUNNING", "outcome": null, "currentStepId": "string", "correlationKey": null, "metadata": null, "startedAt": "string", "completedAt": null, "pausedAt": null, "cancelledAt": null, "errorMessage": null, "errorDetails": null, "pendingTransition": null, "retryCount": 1, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "deletedAt": null } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow instance not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/instances/:id" \ -H "Accept: application/json" ``` ## POST `/workflows/instances/{id}/advance` Manually advance workflow to next step Manually advance a workflow instance to the next step. Useful for manual progression, step-by-step testing, user-triggered transitions, and approval flows. Validates transitions and auto-progresses if possible. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Workflow advanced successfully Content-Type: `application/json` ```json { "data": { "instance": { "id": "00000000-0000-4000-8000-000000000000", "status": "string", "currentStepId": null, "previousStepId": null, "transitionFired": null } }, "message": "string" } ``` **400** – Invalid request, no valid transitions, or workflow already completed/cancelled/failed Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow instance not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/instances/:id/advance" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{}" ``` ## POST `/workflows/instances/{id}/cancel` Cancel workflow instance Cancel a running or paused workflow instance. The workflow will be marked as CANCELLED and will not execute further. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Workflow cancelled successfully Content-Type: `application/json` ```json { "data": { "id": "00000000-0000-4000-8000-000000000000", "definitionId": "00000000-0000-4000-8000-000000000000", "workflowId": "string", "version": 1, "status": "RUNNING", "outcome": null, "currentStepId": "string", "correlationKey": null, "metadata": null, "startedAt": "string", "completedAt": null, "pausedAt": null, "cancelledAt": null, "errorMessage": null, "errorDetails": null, "pendingTransition": null, "retryCount": 1, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "deletedAt": null }, "message": "string" } ``` **400** – Bad request - Workflow cannot be cancelled in current status Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden - Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow instance not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/instances/:id/cancel" \ -H "Accept: application/json" ``` ## PATCH `/workflows/instances/{id}/context` Merge a context patch and wake condition waiters Shallow-merges a partial context patch into a RUNNING/PAUSED/FORKED workflow instance, then re-evaluates every WAIT_FOR_CONDITION waiter in that instance and resumes the ones whose predicate now holds. Reserved engine keys are rejected. Requires the workflows.instances.update_context feature. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "context": {} } ``` ### Responses **200** – Context merged; woken lists the resumed step ids Content-Type: `application/json` ```json { "ok": true, "instanceId": "string", "woken": [ "string" ] } ``` **400** – Invalid body or reserved context key Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Instance not found in the caller scope Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Instance not updatable or stale version Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PATCH "https://pokaz.mcc.commercy.pl/api/workflows/instances/:id/context" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"context\": {} }" ``` ## GET `/workflows/instances/{id}/events` Get workflow instance events Get a chronological list of events for a workflow instance. Events track all state changes, transitions, and activities. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | eventType | query | any | Optional | | limit | query | any | Optional | | offset | query | any | Optional | ### Responses **200** – List of workflow events Content-Type: `application/json` ```json { "data": [ { "id": "string", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "stepInstanceId": null, "eventType": "string", "occurredAt": "string", "userId": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000" } ], "pagination": { "total": 1, "limit": 1, "offset": 1, "hasMore": true } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow instance not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/instances/:id/events?limit=100&offset=0" \ -H "Accept: application/json" ``` ## POST `/workflows/instances/{id}/rerun-step` Rerun a workflow instance from a step Replay a FAILED or PAUSED instance from one of its executed steps, optionally with an edited context patch. The previous attempt keeps its terminal step-instance row; the replay gets a fresh one, and the rerun is audited as a STEP_RERUN workflow event. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "stepId": "string" } ``` ### Responses **200** – Rerun started Content-Type: `application/json` ```json { "data": { "instance": { "id": "00000000-0000-4000-8000-000000000000", "definitionId": "00000000-0000-4000-8000-000000000000", "workflowId": "string", "version": 1, "status": "RUNNING", "outcome": null, "currentStepId": "string", "correlationKey": null, "metadata": null, "startedAt": "string", "completedAt": null, "pausedAt": null, "cancelledAt": null, "errorMessage": null, "errorDetails": null, "pendingTransition": null, "retryCount": 1, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "deletedAt": null }, "editedContextDiff": {} }, "message": "string" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow instance not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – The step cannot be rerun (still parked, changed type, or the instance is not rerunnable) Content-Type: `application/json` ```json { "error": "string", "code": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/instances/:id/rerun-step" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"stepId\": \"string\" }" ``` ## POST `/workflows/instances/{id}/retry` Retry failed workflow instance Retry a failed workflow instance from its current step. The workflow will be reset to RUNNING status and execution will continue. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Workflow retry initiated successfully Content-Type: `application/json` ```json { "data": { "instance": { "id": "00000000-0000-4000-8000-000000000000", "definitionId": "00000000-0000-4000-8000-000000000000", "workflowId": "string", "version": 1, "status": "RUNNING", "outcome": null, "currentStepId": "string", "correlationKey": null, "metadata": null, "startedAt": "string", "completedAt": null, "pausedAt": null, "cancelledAt": null, "errorMessage": null, "errorDetails": null, "pendingTransition": null, "retryCount": 1, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "deletedAt": null }, "execution": { "status": "RUNNING", "currentStep": "string", "events": [ { "eventType": "string", "occurredAt": "string" } ], "executionTime": 1 } }, "message": "string" } ``` **400** – Bad request - Workflow cannot be retried in its current status or with its current outcome, or execution error Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Forbidden - Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow instance not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/instances/:id/retry" \ -H "Accept: application/json" ``` ## POST `/workflows/instances/{id}/signal` Send signal to specific workflow Sends a signal to a specific workflow instance waiting for a signal. The workflow must be in PAUSED status and waiting for the specified signal. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "signalName": "string" } ``` ### Responses **200** – Signal sent successfully Content-Type: `application/json` ```json { "success": true, "message": "string" } ``` **400** – Invalid request body or signal name mismatch Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Instance or definition not found Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Workflow not paused or not waiting for signal Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error or transition failed Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/instances/:id/signal" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"signalName\": \"string\" }" ``` ## POST `/workflows/instances/{id}/step-through` Continue one step, or stop stepping Releases exactly the step the instance is currently parked on and resumes execution, or clears step-through so the run finishes on its own. To abort the run, use the cancel endpoint. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "action": "continue" } ``` ### Responses **200** – The run advanced Content-Type: `application/json` ```json { "data": { "instanceId": "string", "status": "string", "currentStep": "string", "stepThrough": null } } ``` **400** – Not a step-through run, or malformed payload Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow instance not found Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/instances/00000000-0000-4000-8000-000000000000/step-through" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"action\": \"continue\" }" ``` ## GET `/workflows/instances/{id}/steps` Get workflow instance step executions List the step executions recorded for a workflow instance, including per-step input, output, error payload, duration and attempt count. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | limit | query | any | Optional | | offset | query | any | Optional | ### Responses **200** – List of step executions Content-Type: `application/json` ```json { "data": [ { "id": "00000000-0000-4000-8000-000000000000", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "branchInstanceId": null, "stepId": "string", "stepName": "string", "stepType": "string", "status": "string", "inputData": null, "outputData": null, "errorData": null, "enteredAt": null, "exitedAt": null, "executionTimeMs": null, "retryCount": 1 } ], "pagination": { "total": 1, "limit": 1, "offset": 1, "hasMore": true } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow instance not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/instances/:id/steps?limit=100&offset=0" \ -H "Accept: application/json" ``` ## GET `/workflows/instances/{id}/would-do` Get a dry run's "Would do" report List every side effect a dry run suppressed, in execution order: simulated activities with their would-do output, activity types that refused simulation and stopped the run, user tasks that were not raised, and business rules whose action arm was withheld. A real (non-dry) run answers with an empty report. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | | limit | query | any | Optional | | offset | query | any | Optional | ### Responses **200** – The would-do report Content-Type: `application/json` ```json { "isDryRun": true, "entries": [ { "id": "string", "kind": "activity", "severity": "error", "stepId": null, "occurredAt": "string", "subject": "string", "detail": {} } ], "stoppedByRefusal": true, "pagination": { "total": 1, "limit": 1, "offset": 1, "hasMore": true } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Workflow instance not found Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/instances/:id/would-do" \ -H "Accept: application/json" ``` ## POST `/workflows/instances/bulk-replay` Bulk retry or cancel workflow instances Queue a bulk retry or cancel over the failure queue. Work runs in a queue worker and reports through the progress module; the response returns the progress job id immediately. **Tags:** Workflows **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "action": "retry", "ids": [ "00000000-0000-4000-8000-000000000000" ] } ``` ### Responses **202** – Bulk replay queued Content-Type: `application/json` ```json { "ok": true, "progressJobId": null, "message": "string" } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "ok": true, "progressJobId": null, "message": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "ok": true, "progressJobId": null, "message": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "ok": true, "progressJobId": null, "message": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "ok": true, "progressJobId": null, "message": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/instances/bulk-replay" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"action\": \"retry\", \"ids\": [ \"00000000-0000-4000-8000-000000000000\" ] }" ``` ## GET `/workflows/instances/failure-queue` List the workflow failure queue Triage list of instances parked by a failure-queue error directive together with FAILED instances, plus normalized error groups so a batch of similar failures reads as one row. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | workflowId | query | any | Optional | | errorGroup | query | any | Optional. Narrow the list to one normalized error group key. | | limit | query | any | Optional | | offset | query | any | Optional | ### Responses **200** – Failure queue Content-Type: `application/json` ```json { "data": [ { "id": "00000000-0000-4000-8000-000000000000", "definitionId": "00000000-0000-4000-8000-000000000000", "workflowId": "string", "version": 1, "status": "RUNNING", "outcome": null, "currentStepId": "string", "correlationKey": null, "metadata": null, "startedAt": "string", "completedAt": null, "pausedAt": null, "cancelledAt": null, "errorMessage": null, "errorDetails": null, "pendingTransition": null, "retryCount": 1, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "deletedAt": null } ], "groups": [ { "key": "string", "label": "string", "count": 1, "workflowIds": [ "string" ], "instanceIds": [ "00000000-0000-4000-8000-000000000000" ] } ], "grouping": { "scannedCount": 1, "scanLimit": 1, "truncated": true }, "pagination": { "total": 1, "limit": 1, "offset": 1, "hasMore": true } } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/instances/failure-queue?limit=50&offset=0" \ -H "Accept: application/json" ``` ## POST `/workflows/instances/validate-start` Validate if workflow can be started Evaluates pre-conditions defined on the START step and returns validation errors with localized messages if any fail. Returns canStart: true/false with details. **Tags:** Workflows ### Request Body Content-Type: `application/json` ```json { "workflowId": "string" } ``` ### Responses **200** – Validation result (canStart, errors, validatedRules) Content-Type: `application/json` ```json { "canStart": true, "workflowId": "string" } ``` **400** – Invalid request body or missing context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/instances/validate-start" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"workflowId\": \"string\" }" ``` ## GET `/workflows/metrics/definitions` Read per-definition workflow operational KPIs Batch KPI read for the named workflow ids over a sliding window: runs started, terminal runs by outcome, success rate, run-duration p50/p95 and task SLA hit-rate. Dry runs are excluded from every figure. Served from the precomputed rollup when one is fresh, recomputed live otherwise; each item reports which. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | window | query | any | Optional. Sliding window length. | | workflowIds | query | any | Required. Comma-separated logical workflow ids, at most 50 per request. | ### Responses **200** – Per-definition metrics Content-Type: `application/json` ```json { "data": [ { "workflowId": "string", "window": "24h", "windowStart": "string", "windowEnd": "string", "computedAt": "string", "source": "rollup", "metrics": { "runsStarted": 1, "runsTerminal": 1, "runsCompleted": 1, "runsFailed": 1, "runsCancelled": 1, "successRate": null, "durationSampleCount": 1, "avgDurationMs": null, "p50DurationMs": null, "p95DurationMs": null, "tasksWithDeadline": 1, "tasksMetDeadline": 1, "taskSlaHitRate": null } } ] } ``` **400** – Invalid query or missing tenant context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/metrics/definitions?window=7d&workflowIds=string" \ -H "Accept: application/json" ``` ## GET `/workflows/portal/tasks` List the portal principal's tasks Returns the customer-assigned tasks this portal principal may see. A portal admin additionally sees their company members' tasks but may not act on them. Tasks with no entity bindings are never portal-visible. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | status | query | any | Optional. Filter by status (comma-separated for multiple) | | page | query | any | Optional. Page number | | pageSize | query | any | Optional. Rows per page (max 100) | ### Responses **200** – Portal task list Content-Type: `application/json` ```json { "ok": true, "tasks": [ { "id": "00000000-0000-4000-8000-000000000000", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "stepInstanceId": "00000000-0000-4000-8000-000000000000", "branchInstanceId": null, "taskName": "string", "description": null, "status": "PENDING", "formSchema": null, "formData": null, "assignedTo": null, "assigneeKind": "user", "assignedToRoles": null, "entityTypes": null, "claimedBy": null, "claimedAt": null, "dueDate": null, "escalatedAt": null, "escalatedTo": null, "completedBy": null, "completedAt": null, "comments": null, "reassignedBy": null, "reassignedAt": null, "reassignReason": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "kind": "user_task", "proposalId": null, "priority": null, "entityBindings": null } ], "pagination": { "page": 1, "pageSize": 1, "total": 1, "totalPages": 1 } } ``` **401** – Authentication required Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions or no company association Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/portal/tasks?page=1&pageSize=25" \ -H "Accept: application/json" ``` ## GET `/workflows/portal/tasks/{id}` Read one portal task Returns a single customer-assigned task the portal principal owns. Every refusal — foreign tenant, another customer, an unbound task, a nonexistent id — is the same 404. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Portal task Content-Type: `application/json` ```json { "ok": true, "task": { "id": "00000000-0000-4000-8000-000000000000", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "stepInstanceId": "00000000-0000-4000-8000-000000000000", "branchInstanceId": null, "taskName": "string", "description": null, "status": "PENDING", "formSchema": null, "formData": null, "assignedTo": null, "assigneeKind": "user", "assignedToRoles": null, "entityTypes": null, "claimedBy": null, "claimedAt": null, "dueDate": null, "escalatedAt": null, "escalatedTo": null, "completedBy": null, "completedAt": null, "comments": null, "reassignedBy": null, "reassignedAt": null, "reassignReason": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "kind": "user_task", "proposalId": null, "priority": null, "entityBindings": null }, "decisions": [ { "id": "string", "label": "string", "transitionId": "string" } ], "formKey": null, "canComplete": true } ``` **401** – Authentication required Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions or no company association Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Task not found Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/portal/tasks/:id" \ -H "Accept: application/json" ``` ## POST `/workflows/portal/tasks/{id}/complete` Complete a portal task Completes a customer-assigned task and resumes the workflow. Only the assignee may complete; a portal admin who can read a company member's task is refused. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "formData": {} } ``` ### Responses **200** – Task completed Content-Type: `application/json` ```json { "ok": true, "task": null } ``` **400** – Invalid request body or form data Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **401** – Authentication required Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **403** – Insufficient permissions or no company association Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **404** – Task not found or not actionable by this principal Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "ok": false, "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/portal/tasks/:id/complete" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"formData\": {} }" ``` ## GET `/workflows/rule-usage` List workflows referencing a business rule Returns the workflow definitions whose START pre-conditions or transition pre/post-conditions reference the given business rule. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | ruleId | query | any | Required | ### Responses **200** – Usage references Content-Type: `application/json` ```json { "ruleId": "ORDER_ABOVE_LIMIT", "workflowCount": 1, "references": [ { "workflowId": "order-approval", "version": 2, "kind": "transitionPreCondition", "locationId": "e_start_review" } ] } ``` **400** – Invalid query parameters Content-Type: `application/json` ```json { "error": "Invalid query parameters" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "Unauthorized" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/rule-usage?ruleId=string" \ -H "Accept: application/json" ``` ## POST `/workflows/signals` Send signal to workflows by correlation key Sends a signal to all workflow instances waiting for the specified signal that match the correlation key. Returns the count of workflows that received the signal. **Tags:** Workflows ### Request Body Content-Type: `application/json` ```json { "correlationKey": "string", "signalName": "string" } ``` ### Responses **200** – Signal sent to matching workflows Content-Type: `application/json` ```json { "success": true, "message": "string", "count": 1 } ``` **400** – Missing tenant or organization context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/signals" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"correlationKey\": \"string\", \"signalName\": \"string\" }" ``` ## GET `/workflows/task-settings` Get tenant task-permission settings Returns whether the business-context task-permission model (spec §6.4) is enabled for the tenant. Defaults to true. **Tags:** Workflows **Requires authentication.** ### Responses **200** – Current settings Content-Type: `application/json` ```json { "taskPermissionsBusinessContext": true } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/task-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " ``` ## PUT `/workflows/task-settings` Update tenant task-permission settings Sets the tenant-scoped opt-out. Setting it to false restores the pre-6.4 READ filter on the task list, task detail and work inbox; it never affects claiming, completing, tenant/organization scoping or the portal task routes. **Tags:** Workflows **Requires authentication.** ### Request Body Content-Type: `application/json` ```json { "taskPermissionsBusinessContext": true } ``` ### Responses **200** – Updated settings Content-Type: `application/json` ```json { "taskPermissionsBusinessContext": true, "ok": true } ``` **400** – Invalid payload Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Missing authentication Content-Type: `application/json` ```json { "error": "string" } ``` **503** – Settings storage unavailable Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X PUT "https://pokaz.mcc.commercy.pl/api/workflows/task-settings" \ -H "Accept: application/json" \ -H "authorization: Bearer " \ -H "Content-Type: application/json" \ -d "{ \"taskPermissionsBusinessContext\": true }" ``` ## GET `/workflows/tasks` List user tasks Returns paginated list of user tasks with optional filtering by status, assignee, workflow instance, overdue, and myTasks flags. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | status | query | any | Optional. Filter by status (comma-separated for multiple: PENDING,IN_PROGRESS,COMPLETED,CANCELLED,ESCALATED) | | assignedTo | query | any | Optional. Filter by assigned user ID | | workflowInstanceId | query | any | Optional. Filter by workflow instance ID | | overdue | query | any | Optional. Filter overdue tasks (true/false) | | myTasks | query | any | Optional. Show only tasks assigned to or claimable by current user | | limit | query | any | Optional. Number of results (max 100) | | offset | query | any | Optional. Pagination offset | ### Responses **200** – User tasks list with pagination Content-Type: `application/json` ```json { "data": [ { "id": "00000000-0000-4000-8000-000000000000", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "stepInstanceId": "00000000-0000-4000-8000-000000000000", "branchInstanceId": null, "taskName": "string", "description": null, "status": "PENDING", "formSchema": null, "formData": null, "assignedTo": null, "assigneeKind": "user", "assignedToRoles": null, "entityTypes": null, "claimedBy": null, "claimedAt": null, "dueDate": null, "escalatedAt": null, "escalatedTo": null, "completedBy": null, "completedAt": null, "comments": null, "reassignedBy": null, "reassignedAt": null, "reassignReason": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "kind": "user_task", "proposalId": null, "priority": null, "entityBindings": null } ], "pagination": { "total": 1, "limit": 1, "offset": 1, "hasMore": true } } ``` **400** – Invalid query parameters or missing tenant context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/tasks?limit=50&offset=0" \ -H "Accept: application/json" ``` ## GET `/workflows/tasks/{id}` Get task details Returns complete details of a user task by ID. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – User task details Content-Type: `application/json` ```json { "data": { "id": "00000000-0000-4000-8000-000000000000", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "stepInstanceId": "00000000-0000-4000-8000-000000000000", "branchInstanceId": null, "taskName": "string", "description": null, "status": "PENDING", "formSchema": null, "formData": null, "assignedTo": null, "assigneeKind": "user", "assignedToRoles": null, "entityTypes": null, "claimedBy": null, "claimedAt": null, "dueDate": null, "escalatedAt": null, "escalatedTo": null, "completedBy": null, "completedAt": null, "comments": null, "reassignedBy": null, "reassignedAt": null, "reassignReason": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "kind": "user_task", "proposalId": null, "priority": null, "entityBindings": null, "stepId": null, "decisions": [ { "id": "string", "label": "string", "transitionId": "string" } ], "canComplete": true, "canClaim": true, "canRelease": true, "canReassign": true, "actBlockedReason": null } } ``` **400** – Missing tenant or organization context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – The task is bound to an entity type the caller may not view. Returned only to callers holding workflows.tasks.view_all (or a superadmin), who already see the row in a list view; everyone else receives the generic 404. Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Task not found, or not visible to the caller Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/tasks/:id" \ -H "Accept: application/json" ``` ## POST `/workflows/tasks/{id}/claim` Claim a task from role queue Allows a user to claim a task assigned to their role(s). Once claimed, the task moves to IN_PROGRESS status and is assigned to the claiming user. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Task claimed successfully Content-Type: `application/json` ```json { "data": { "id": "00000000-0000-4000-8000-000000000000", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "stepInstanceId": "00000000-0000-4000-8000-000000000000", "branchInstanceId": null, "taskName": "string", "description": null, "status": "PENDING", "formSchema": null, "formData": null, "assignedTo": null, "assigneeKind": "user", "assignedToRoles": null, "entityTypes": null, "claimedBy": null, "claimedAt": null, "dueDate": null, "escalatedAt": null, "escalatedTo": null, "completedBy": null, "completedAt": null, "comments": null, "reassignedBy": null, "reassignedAt": null, "reassignReason": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string" }, "message": "string" } ``` **400** – Missing tenant or organization context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – The task is visible to the caller but is not theirs to act on — it has no assignee and no role queue, so it must be reassigned first (§6.4: administration widens seeing, never acting). Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Task not found, or not visible to the caller Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Task already claimed Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/tasks/:id/claim" \ -H "Accept: application/json" ``` ## POST `/workflows/tasks/{id}/complete` Complete a task with form data Validates form data against task schema, updates task with completion data, merges form data into workflow context, and resumes workflow execution. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json { "formData": {} } ``` ### Responses **200** – Task completed successfully Content-Type: `application/json` ```json { "data": { "id": "00000000-0000-4000-8000-000000000000", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "stepInstanceId": "00000000-0000-4000-8000-000000000000", "branchInstanceId": null, "taskName": "string", "description": null, "status": "PENDING", "formSchema": null, "formData": null, "assignedTo": null, "assigneeKind": "user", "assignedToRoles": null, "entityTypes": null, "claimedBy": null, "claimedAt": null, "dueDate": null, "escalatedAt": null, "escalatedTo": null, "completedBy": null, "completedAt": null, "comments": null, "reassignedBy": null, "reassignedAt": null, "reassignReason": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string" }, "message": "string" } ``` **400** – Invalid request body, validation failed, or missing context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – The task is visible to the caller but is not theirs to act on — it has no assignee and no role queue, so it must be reassigned first (§6.4: administration widens seeing, never acting). Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Task not found, or not visible to the caller Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Task already completed, assigned to another user, or its workflow run is no longer active (`code: WORKFLOW_NOT_ACTIVE` — the run is completed, failed, cancelled, compensating or compensated) Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/tasks/:id/complete" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{ \"formData\": {} }" ``` ## POST `/workflows/tasks/{id}/reassign` Move a task to another assignee or role queue Records who moved the task, when, and why (`reassignedBy` / `reassignedAt` / `reassignReason`) and logs a `USER_TASK_REASSIGNED` workflow event. Requires `workflows.tasks.reassign`. An in-flight claim is released and an IN_PROGRESS task returns to PENDING; the status vocabulary is unchanged. Honours the optimistic-lock header `x-om-ext-optimistic-lock-expected-updated-at`. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Request Body Content-Type: `application/json` ```json {} ``` ### Responses **200** – Task reassigned successfully Content-Type: `application/json` ```json { "data": { "id": "00000000-0000-4000-8000-000000000000", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "stepInstanceId": "00000000-0000-4000-8000-000000000000", "branchInstanceId": null, "taskName": "string", "description": null, "status": "PENDING", "formSchema": null, "formData": null, "assignedTo": null, "assigneeKind": "user", "assignedToRoles": null, "entityTypes": null, "claimedBy": null, "claimedAt": null, "dueDate": null, "escalatedAt": null, "escalatedTo": null, "completedBy": null, "completedAt": null, "comments": null, "reassignedBy": null, "reassignedAt": null, "reassignReason": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string", "kind": "user_task", "proposalId": null, "priority": null, "entityBindings": null }, "message": "string" } ``` **400** – Missing tenant/organization context, or a body naming neither an assignee nor a role queue Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Visible to the caller but refused by the entity gate, with the blocking entity type named Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Task not found, or not visible to the caller Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Task is in a terminal status, or the record changed since it was loaded (optimistic lock) Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/tasks/:id/reassign" \ -H "Accept: application/json" \ -H "Content-Type: application/json" \ -d "{}" ``` ## POST `/workflows/tasks/{id}/unclaim` Release a claimed task back to its role queue Clears the caller's claim and returns the task to PENDING so another holder of the queued role can pick it up. Refused when the task is claimed by somebody else or is no longer in progress. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | id | path | any | Required | ### Responses **200** – Task released successfully Content-Type: `application/json` ```json { "data": { "id": "00000000-0000-4000-8000-000000000000", "workflowInstanceId": "00000000-0000-4000-8000-000000000000", "stepInstanceId": "00000000-0000-4000-8000-000000000000", "branchInstanceId": null, "taskName": "string", "description": null, "status": "PENDING", "formSchema": null, "formData": null, "assignedTo": null, "assigneeKind": "user", "assignedToRoles": null, "entityTypes": null, "claimedBy": null, "claimedAt": null, "dueDate": null, "escalatedAt": null, "escalatedTo": null, "completedBy": null, "completedAt": null, "comments": null, "reassignedBy": null, "reassignedAt": null, "reassignReason": null, "tenantId": "00000000-0000-4000-8000-000000000000", "organizationId": "00000000-0000-4000-8000-000000000000", "createdAt": "string", "updatedAt": "string" }, "message": "string" } ``` **400** – Missing tenant or organization context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – The task is visible to the caller but is not theirs to act on — it has no assignee and no role queue, so it must be reassigned first (§6.4: administration widens seeing, never acting). Content-Type: `application/json` ```json { "error": "string" } ``` **404** – Task not found, not visible to the caller, or not claimed Content-Type: `application/json` ```json { "error": "string" } ``` **409** – Task claimed by another user Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/tasks/:id/unclaim" \ -H "Accept: application/json" ``` ## GET `/workflows/templates` List seeded workflow templates Returns the shipped workflow template gallery: metadata (id, i18n name/description keys, category, icon) plus the complete workflow definition each template seeds. **Tags:** Workflows ### Responses **200** – Available workflow templates Content-Type: `application/json` ```json { "items": [ { "id": "string", "nameKey": "string", "descriptionKey": "string", "category": "string", "icon": "string", "definition": { "steps": [ { "stepId": "string", "stepName": "string", "stepType": "START" } ], "transitions": [ { "transitionId": "string", "fromStepId": "string", "toStepId": "string", "trigger": "auto", "condition": null, "continueOnActivityFailure": false, "priority": 0 } ] } } ] } ``` **400** – Missing tenant context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **403** – Insufficient permissions Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/templates" \ -H "Accept: application/json" ``` ## GET `/workflows/work-inbox` List work items across every registered source Merges every registered work-inbox source (workflow user tasks, plus any module that registers a provider) into one queue, filtered by kind/module/entity type/role/priority/status/overdue and ordered by priority, then due date, then age. **Tags:** Workflows ### Parameters | Name | Location | Type | Description | | --- | --- | --- | --- | | kind | query | any | Optional. Filter by source kind (comma-separated) | | module | query | any | Optional. Filter by owning module id (comma-separated) | | entityType | query | any | Optional. Filter by bound entity type (comma-separated) | | role | query | any | Optional. Filter by queued role (comma-separated) | | priority | query | any | Optional. Filter by priority (comma-separated: extreme,high,medium,low) | | status | query | any | Optional. Filter by status (comma-separated) | | overdue | query | any | Optional. Only items past their due date | | myWork | query | any | Optional. Only items assigned to, claimed by, or queued to a role of the caller | | assignedTo | query | any | Optional. Filter by assignee | | workflowInstanceId | query | any | Optional. Filter by workflow instance | | limit | query | any | Optional. Number of results (max 100) | | offset | query | any | Optional. Pagination offset | ### Responses **200** – Merged work items with pagination Content-Type: `application/json` ```json { "data": [ { "id": "string", "kind": "string", "moduleId": "string", "title": "string", "description": null, "status": "string", "priority": null, "dueDate": null, "overdue": true, "createdAt": "string", "updatedAt": "string", "assignedTo": null, "assignedToRoles": null, "claimedBy": null, "entityTypes": [ "string" ], "entityBindings": [ { "entityType": "string", "entityId": "string", "label": null } ], "detailHref": null, "actions": [ { "id": "string", "labelKey": "string", "endpoint": "string", "appliesTo": "claimable" } ] } ], "pagination": { "total": 1, "limit": 1, "offset": 1, "hasMore": true }, "meta": { "kinds": [ "string" ], "degradedKinds": [ "string" ] } } ``` **400** – Missing tenant context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X GET "https://pokaz.mcc.commercy.pl/api/workflows/work-inbox?limit=50&offset=0" \ -H "Accept: application/json" ``` ## POST `/workflows/work-inbox/next` Claim the top claimable item from the work inbox Walks the caller's claimable queue in inbox order and claims the first item it wins. The claim is a conditional update, so concurrent callers never receive the same item — a caller that loses the race moves on to the next candidate. Returns null data when nothing is claimable. **Tags:** Workflows ### Responses **200** – The claimed item, or null when nothing was claimable Content-Type: `application/json` ```json { "data": null, "message": "string" } ``` **400** – Missing tenant or organization context Content-Type: `application/json` ```json { "error": "string" } ``` **401** – Unauthorized Content-Type: `application/json` ```json { "error": "string" } ``` **500** – Internal server error Content-Type: `application/json` ```json { "error": "string" } ``` ### Example ```bash curl -X POST "https://pokaz.mcc.commercy.pl/api/workflows/work-inbox/next" \ -H "Accept: application/json" ```