{"openapi":"3.1.0","info":{"title":"WMS API","version":"1.0.0","description":"Every method is `POST /api/rpc` with a JSON-RPC 2.0 request body. The path key `/api/rpc#` only keeps the operations apart in this file.\n\n**Errors are not standard JSON-RPC.** A failed call returns `{ \"id\", \"error\": { \"message\", \"data\": { \"req_uuid\", \"detail\" } } }` with no `jsonrpc` key and no numeric code.\n\nGenerated from openrpc.json (932 methods). Example idempotency key: `7f1c2d4e-5a6b-4c8d-9e0f-1a2b3c4d5e6f`."},"servers":[{"url":"https://your-wms.example.com","description":"Your WMS installation"}],"tags":[{"name":"enterprise"},{"name":"master_data"},{"name":"inbound"},{"name":"inventory"},{"name":"outbound"},{"name":"tasks"},{"name":"reporting"},{"name":"rf"},{"name":"integration"}],"paths":{"/api/rpc#create_project":{"post":{"operationId":"create_project","summary":"Create a project","description":"Create a project\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN, MANAGER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n- The result is returned as is. It is not wrapped in a `data` object.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"UNIQUE_VIOLATION or INVALID_DATA","when":"The code already exists, or a value breaks a rule."}],"x-quark-module":"project","x-quark-operation":"create","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"create_project"},"params":{"type":"object","properties":{}}}},"example":{"jsonrpc":"2.0","id":1,"method":"create_project"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object"}}},"example":{"jsonrpc":"2.0","id":1,"result":{}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#list_projects":{"post":{"operationId":"list_projects","summary":"List projects (filtered)","description":"List projects (filtered)\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- The result is returned as is. It is not wrapped in a `data` object.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."}],"x-quark-module":"project","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"list_projects"},"params":{"type":"object","properties":{}}}},"example":{"jsonrpc":"2.0","id":1,"method":"list_projects"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object"}}},"example":{"jsonrpc":"2.0","id":1,"result":{}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#update_project":{"post":{"operationId":"update_project","summary":"Update a project","description":"Update a project\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN, MANAGER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n- The result is returned as is. It is not wrapped in a `data` object.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"INVALID_DATA","when":"A value breaks a rule."}],"x-quark-module":"project","x-quark-operation":"update","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"update_project"},"params":{"type":"object","properties":{}}}},"example":{"jsonrpc":"2.0","id":1,"method":"update_project"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object"}}},"example":{"jsonrpc":"2.0","id":1,"result":{}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#delete_project":{"post":{"operationId":"delete_project","summary":"Delete a project","description":"Delete a project\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN, MANAGER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n- The result is returned as is. It is not wrapped in a `data` object.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"DEPENDENT_DATA_EXIST","when":"Other rows still use this row."}],"x-quark-module":"project","x-quark-operation":"delete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"delete_project"},"params":{"type":"object","properties":{}}}},"example":{"jsonrpc":"2.0","id":1,"method":"delete_project"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object"}}},"example":{"jsonrpc":"2.0","id":1,"result":{}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#me":{"post":{"operationId":"me","summary":"Get current user info","description":"Get current user info\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, SUPERVISOR, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- You must log in. The method skips the permission check, so every logged-in user can call it.\n- This method only reads. It changes nothing and needs no idempotency key.\n- A tenant extension cannot replace this method.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","SUPERVISOR","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."}],"x-quark-module":"user","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"me"},"params":{"type":"object","properties":{}}}},"example":{"jsonrpc":"2.0","id":1,"method":"me"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"default":null,"description":"When the account was created — the AUDIT block's \"Created\" field.\n\n`add_when` is NOT NULL on both `enterprise.user` and tenant-manager's `user`, so this is `Option` to tolerate a projection that did not select it, not because a created account can lack a creation time.\n\nAdded late, and the reason is worth keeping: migration 317 put \"Created\" on the detail form reading `add_when`, but this struct — the only thing the `is_rpc` BIO's `get_user` path can return — never carried the column, so the field rendered permanently blank. The form was right; the projection was short.","type":["string","null"]},"api_access":{"type":"boolean"},"date_format":{"type":"string"},"email":{"type":"string"},"employee_id":{"type":["string","null"]},"failed_login_attempts":{"format":"int32","type":"integer"},"full_name":{"type":["string","null"]},"id":{"format":"int64","type":"integer"},"last_failed_login_at":{"default":null,"type":["string","null"]},"last_login_at":{"default":null,"type":["string","null"]},"locale":{"type":"string"},"mode":{"type":"string"},"password_age_days":{"description":"\"Password age\" for the AUDIT block — derived from `pwd_changed_at`, in whole days. **Not a database column**: `#[field(skip)]` keeps it out of the SELECT projection (`sea_column_refs`), and `#[sqlx(default)]` keeps `derive(FromRow)` from trying to read a `password_age_days` column that doesn't exist. Populated by `UserBy::finish_computed_fields`, which every `UserBmc` fetch path calls — see there. `None` whenever `pwd_changed_at` is `None`; never a misleading `0`.","format":"int64","type":["integer","null"]},"pwd_changed_at":{"default":null,"type":["string","null"]},"rf_login":{"type":"boolean"},"status":{"$ref":"#/components/schemas/UserStatus"},"timezone":{"type":"string"},"typ":{"$ref":"#/components/schemas/UserTyp"},"username":{"type":"string"}},"required":["api_access","date_format","email","failed_login_attempts","id","locale","mode","rf_login","status","timezone","typ","username"],"title":"UserInfo","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"api_access":false,"date_format":"","email":"","failed_login_attempts":1,"id":1,"locale":"","mode":"","rf_login":false,"status":"Active","timezone":"","typ":"User","username":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#create_user":{"post":{"operationId":"create_user","summary":"Create a new user — CRUD.","description":"Create a new user — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"RF_ERROR (other return codes)","when":"A business rule refused the command. Read `detail.message`, `detail.return_code` and `detail.class`."}],"x-quark-module":"user","x-quark-operation":"execute","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"create_user"},"params":{"type":"object","properties":{"data":{"properties":{"date_format":{"type":"string"},"email":{"type":"string"},"employee_id":{"type":["string","null"]},"full_name":{"description":"What an admin can meaningfully set when creating an account through the Users screen. Deliberately does NOT include the AUDIT-block columns (`last_login_at`, `failed_login_attempts`, `last_failed_login_at`, `pwd_changed_at`) — those are server-owned facts nobody sets at creation time either; see `UserForUpdate`'s doc comment for the full reasoning.","type":["string","null"]},"locale":{"type":"string"},"mode":{"type":"string"},"pwd_clear":{"description":"`pwd` is what the Users screen's field is called (form 171), as on [`UserForUpdate::pwd_clear`].","type":"string"},"status":{"anyOf":[{"$ref":"#/components/schemas/UserStatus"},{"type":"null"}],"description":"`None` leaves the column's DB default (`Active`) in place. An admin can still pick `Invited` explicitly for an account that hasn't set a password yet."},"timezone":{"type":"string"},"typ":{"anyOf":[{"$ref":"#/components/schemas/UserTyp"},{"type":"null"}],"description":"The New form's Type dropdown. `None` leaves the column default (`User`). Anything else is decided by a superuser only — see [`UserBmc::ensure_may_set_typ`]."},"username":{"type":"string"}},"required":["date_format","email","locale","mode","pwd_clear","timezone","username"],"title":"UserForCreate","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"create_user","params":{"data":{"date_format":"","email":"","locale":"","mode":"","pwd_clear":"","timezone":"","username":""}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"default":null,"description":"When the account was created — the AUDIT block's \"Created\" field.\n\n`add_when` is NOT NULL on both `enterprise.user` and tenant-manager's `user`, so this is `Option` to tolerate a projection that did not select it, not because a created account can lack a creation time.\n\nAdded late, and the reason is worth keeping: migration 317 put \"Created\" on the detail form reading `add_when`, but this struct — the only thing the `is_rpc` BIO's `get_user` path can return — never carried the column, so the field rendered permanently blank. The form was right; the projection was short.","type":["string","null"]},"api_access":{"type":"boolean"},"date_format":{"type":"string"},"email":{"type":"string"},"employee_id":{"type":["string","null"]},"failed_login_attempts":{"format":"int32","type":"integer"},"full_name":{"type":["string","null"]},"id":{"format":"int64","type":"integer"},"last_failed_login_at":{"default":null,"type":["string","null"]},"last_login_at":{"default":null,"type":["string","null"]},"locale":{"type":"string"},"mode":{"type":"string"},"password_age_days":{"description":"\"Password age\" for the AUDIT block — derived from `pwd_changed_at`, in whole days. **Not a database column**: `#[field(skip)]` keeps it out of the SELECT projection (`sea_column_refs`), and `#[sqlx(default)]` keeps `derive(FromRow)` from trying to read a `password_age_days` column that doesn't exist. Populated by `UserBy::finish_computed_fields`, which every `UserBmc` fetch path calls — see there. `None` whenever `pwd_changed_at` is `None`; never a misleading `0`.","format":"int64","type":["integer","null"]},"pwd_changed_at":{"default":null,"type":["string","null"]},"rf_login":{"type":"boolean"},"status":{"$ref":"#/components/schemas/UserStatus"},"timezone":{"type":"string"},"typ":{"$ref":"#/components/schemas/UserTyp"},"username":{"type":"string"}},"required":["api_access","date_format","email","failed_login_attempts","id","locale","mode","rf_login","status","timezone","typ","username"],"title":"UserInfo","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"api_access":false,"date_format":"","email":"","failed_login_attempts":1,"id":1,"locale":"","mode":"","rf_login":false,"status":"Active","timezone":"","typ":"User","username":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#get_user":{"post":{"operationId":"get_user","summary":"Get a user by ID — CRUD.","description":"Get a user by ID — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, SUPERVISOR. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","SUPERVISOR"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."}],"x-quark-module":"user","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"get_user"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"get_user","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"default":null,"description":"When the account was created — the AUDIT block's \"Created\" field.\n\n`add_when` is NOT NULL on both `enterprise.user` and tenant-manager's `user`, so this is `Option` to tolerate a projection that did not select it, not because a created account can lack a creation time.\n\nAdded late, and the reason is worth keeping: migration 317 put \"Created\" on the detail form reading `add_when`, but this struct — the only thing the `is_rpc` BIO's `get_user` path can return — never carried the column, so the field rendered permanently blank. The form was right; the projection was short.","type":["string","null"]},"api_access":{"type":"boolean"},"date_format":{"type":"string"},"email":{"type":"string"},"employee_id":{"type":["string","null"]},"failed_login_attempts":{"format":"int32","type":"integer"},"full_name":{"type":["string","null"]},"id":{"format":"int64","type":"integer"},"last_failed_login_at":{"default":null,"type":["string","null"]},"last_login_at":{"default":null,"type":["string","null"]},"locale":{"type":"string"},"mode":{"type":"string"},"password_age_days":{"description":"\"Password age\" for the AUDIT block — derived from `pwd_changed_at`, in whole days. **Not a database column**: `#[field(skip)]` keeps it out of the SELECT projection (`sea_column_refs`), and `#[sqlx(default)]` keeps `derive(FromRow)` from trying to read a `password_age_days` column that doesn't exist. Populated by `UserBy::finish_computed_fields`, which every `UserBmc` fetch path calls — see there. `None` whenever `pwd_changed_at` is `None`; never a misleading `0`.","format":"int64","type":["integer","null"]},"pwd_changed_at":{"default":null,"type":["string","null"]},"rf_login":{"type":"boolean"},"status":{"$ref":"#/components/schemas/UserStatus"},"timezone":{"type":"string"},"typ":{"$ref":"#/components/schemas/UserTyp"},"username":{"type":"string"}},"required":["api_access","date_format","email","failed_login_attempts","id","locale","mode","rf_login","status","timezone","typ","username"],"title":"UserInfo","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"api_access":false,"date_format":"","email":"","failed_login_attempts":1,"id":1,"locale":"","mode":"","rf_login":false,"status":"Active","timezone":"","typ":"User","username":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#list_user":{"post":{"operationId":"list_user","summary":"List user — CRUD.","description":"List user — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, SUPERVISOR. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","SUPERVISOR"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"user","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"list_user"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"list_user"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"items":{"$ref":"#/components/schemas/UserInfo"},"title":"Array_of_UserInfo","type":"array"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":[{"api_access":false,"date_format":"","email":"","failed_login_attempts":1,"id":1,"locale":"","mode":"","rf_login":false,"status":"Active","timezone":"","typ":"User","username":""}]}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#count_user":{"post":{"operationId":"count_user","summary":"Count user — CRUD.","description":"Count user — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, SUPERVISOR. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","SUPERVISOR"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"user","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"count_user"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"count_user"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"format":"int64","title":"int64","type":"integer"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":1}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#update_user":{"post":{"operationId":"update_user","summary":"Update an account through the guarded security model; audit facts are read-only.","description":"Update an account through the guarded security model; audit facts are read-only.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"RF_ERROR (other return codes)","when":"A business rule refused the command. Read `detail.message`, `detail.return_code` and `detail.class`."}],"x-quark-module":"user","x-quark-operation":"execute","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"update_user"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"},"data":{"additionalProperties":false,"description":"Security-owned user patch. Login/audit facts are absent by construction; nullable profile fields retain explicit keep/clear/set semantics.","properties":{"api_access":{"type":"boolean"},"date_format":{"type":"string"},"email":{"type":"string"},"employee_id":{"type":["string","null"]},"full_name":{"type":["string","null"]},"locale":{"type":"string"},"mode":{"type":"string"},"pwd_clear":{"type":"string"},"rf_login":{"type":"boolean"},"status":{"description":"Mirror of the `user_status` PostgreSQL enum (`enterprise` migration 044, tenant-manager migration 005).","oneOf":[{"enum":["Active","Locked","Disabled"],"type":"string"},{"description":"The account exists but its owner has not set a password yet. Allowed through: without a password there is nothing to sign in with, and once one is set the account is in use.","enum":["Invited"],"type":"string"}]},"timezone":{"type":"string"},"typ":{"description":"Mirror of the `enterprise.user_typ` PostgreSQL enum (migration 021).\n\nLifting `user.typ` from a stringly-typed column to a real enum gets us: - DB-level whitelist (insert/update of an unknown variant fails). - Compile-time exhaustive matching at every read site (was previously ad-hoc `matches!(s.as_str(), \"Admin\" | \"Sys\")` in `role_resolver`/`tx_helper`/`admin_rbac`).","enum":["User","Admin","Sys","Agent"],"type":"string"},"username":{"type":"string"}},"title":"UserUpdateApi","type":"object"}},"required":["id","data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"update_user","params":{"id":1,"data":{"api_access":false,"date_format":"","email":""}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"default":null,"description":"When the account was created — the AUDIT block's \"Created\" field.\n\n`add_when` is NOT NULL on both `enterprise.user` and tenant-manager's `user`, so this is `Option` to tolerate a projection that did not select it, not because a created account can lack a creation time.\n\nAdded late, and the reason is worth keeping: migration 317 put \"Created\" on the detail form reading `add_when`, but this struct — the only thing the `is_rpc` BIO's `get_user` path can return — never carried the column, so the field rendered permanently blank. The form was right; the projection was short.","type":["string","null"]},"api_access":{"type":"boolean"},"date_format":{"type":"string"},"email":{"type":"string"},"employee_id":{"type":["string","null"]},"failed_login_attempts":{"format":"int32","type":"integer"},"full_name":{"type":["string","null"]},"id":{"format":"int64","type":"integer"},"last_failed_login_at":{"default":null,"type":["string","null"]},"last_login_at":{"default":null,"type":["string","null"]},"locale":{"type":"string"},"mode":{"type":"string"},"password_age_days":{"description":"\"Password age\" for the AUDIT block — derived from `pwd_changed_at`, in whole days. **Not a database column**: `#[field(skip)]` keeps it out of the SELECT projection (`sea_column_refs`), and `#[sqlx(default)]` keeps `derive(FromRow)` from trying to read a `password_age_days` column that doesn't exist. Populated by `UserBy::finish_computed_fields`, which every `UserBmc` fetch path calls — see there. `None` whenever `pwd_changed_at` is `None`; never a misleading `0`.","format":"int64","type":["integer","null"]},"pwd_changed_at":{"default":null,"type":["string","null"]},"rf_login":{"type":"boolean"},"status":{"$ref":"#/components/schemas/UserStatus"},"timezone":{"type":"string"},"typ":{"$ref":"#/components/schemas/UserTyp"},"username":{"type":"string"}},"required":["api_access","date_format","email","failed_login_attempts","id","locale","mode","rf_login","status","timezone","typ","username"],"title":"UserInfo","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"api_access":false,"date_format":"","email":"","failed_login_attempts":1,"id":1,"locale":"","mode":"","rf_login":false,"status":"Active","timezone":"","typ":"User","username":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#delete_user":{"post":{"operationId":"delete_user","summary":"Delete a user by ID — CRUD.","description":"Delete a user by ID — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"RF_ERROR (other return codes)","when":"A business rule refused the command. Read `detail.message`, `detail.return_code` and `detail.class`."}],"x-quark-module":"user","x-quark-operation":"execute","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"delete_user"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"delete_user","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"default":null,"description":"When the account was created — the AUDIT block's \"Created\" field.\n\n`add_when` is NOT NULL on both `enterprise.user` and tenant-manager's `user`, so this is `Option` to tolerate a projection that did not select it, not because a created account can lack a creation time.\n\nAdded late, and the reason is worth keeping: migration 317 put \"Created\" on the detail form reading `add_when`, but this struct — the only thing the `is_rpc` BIO's `get_user` path can return — never carried the column, so the field rendered permanently blank. The form was right; the projection was short.","type":["string","null"]},"api_access":{"type":"boolean"},"date_format":{"type":"string"},"email":{"type":"string"},"employee_id":{"type":["string","null"]},"failed_login_attempts":{"format":"int32","type":"integer"},"full_name":{"type":["string","null"]},"id":{"format":"int64","type":"integer"},"last_failed_login_at":{"default":null,"type":["string","null"]},"last_login_at":{"default":null,"type":["string","null"]},"locale":{"type":"string"},"mode":{"type":"string"},"password_age_days":{"description":"\"Password age\" for the AUDIT block — derived from `pwd_changed_at`, in whole days. **Not a database column**: `#[field(skip)]` keeps it out of the SELECT projection (`sea_column_refs`), and `#[sqlx(default)]` keeps `derive(FromRow)` from trying to read a `password_age_days` column that doesn't exist. Populated by `UserBy::finish_computed_fields`, which every `UserBmc` fetch path calls — see there. `None` whenever `pwd_changed_at` is `None`; never a misleading `0`.","format":"int64","type":["integer","null"]},"pwd_changed_at":{"default":null,"type":["string","null"]},"rf_login":{"type":"boolean"},"status":{"$ref":"#/components/schemas/UserStatus"},"timezone":{"type":"string"},"typ":{"$ref":"#/components/schemas/UserTyp"},"username":{"type":"string"}},"required":["api_access","date_format","email","failed_login_attempts","id","locale","mode","rf_login","status","timezone","typ","username"],"title":"UserInfo","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"api_access":false,"date_format":"","email":"","failed_login_attempts":1,"id":1,"locale":"","mode":"","rf_login":false,"status":"Active","timezone":"","typ":"User","username":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#delete_many_user":{"post":{"operationId":"delete_many_user","summary":"Delete multiple user by IDs — CRUD.","description":"Delete multiple user by IDs — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"RF_ERROR (other return codes)","when":"A business rule refused the command. Read `detail.message`, `detail.return_code` and `detail.class`."}],"x-quark-module":"user","x-quark-operation":"execute","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"delete_many_user"},"params":{"type":"object","properties":{"ids":{"items":{"format":"int64","type":"integer"},"type":"array","description":"Record IDs"}},"required":["ids"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"delete_many_user","params":{"ids":[1]}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"format":"uint64","minimum":0,"title":"uint64","type":"integer"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":1}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#create_system_settings":{"post":{"operationId":"create_system_settings","summary":"Create a new system_settings — CRUD.","description":"Create a new system_settings — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN, MANAGER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"UNIQUE_VIOLATION or INVALID_DATA","when":"The code already exists, or a value breaks a rule."}],"x-quark-module":"sys_settings","x-quark-operation":"create","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"create_system_settings"},"params":{"type":"object","properties":{"data":{"properties":{"config_key":{"type":"string"},"config_value":{"type":"string"},"default_value":{"type":"string"},"description":{"type":["string","null"]},"editable":{"type":"boolean"}},"required":["config_key","config_value","default_value","editable"],"title":"SystemSettingsForCreate","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"create_system_settings","params":{"data":{"config_key":"","config_value":"","default_value":"","editable":false}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"config_key":{"type":"string"},"config_value":{"type":"string"},"default_value":{"type":"string"},"description":{"type":["string","null"]},"editable":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"}},"required":["add_when","add_who","config_key","config_value","default_value","editable","id","mod_when","mod_who"],"title":"SystemSettings","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"config_key":"","config_value":"","default_value":"","editable":false,"id":1,"mod_when":"","mod_who":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#get_system_settings":{"post":{"operationId":"get_system_settings","summary":"Get a system_settings by ID — CRUD.","description":"Get a system_settings by ID — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."}],"x-quark-module":"sys_settings","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"get_system_settings"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"get_system_settings","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"config_key":{"type":"string"},"config_value":{"type":"string"},"default_value":{"type":"string"},"description":{"type":["string","null"]},"editable":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"}},"required":["add_when","add_who","config_key","config_value","default_value","editable","id","mod_when","mod_who"],"title":"SystemSettings","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"config_key":"","config_value":"","default_value":"","editable":false,"id":1,"mod_when":"","mod_who":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#list_system_settings":{"post":{"operationId":"list_system_settings","summary":"List system_settings — CRUD.","description":"List system_settings — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"sys_settings","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"list_system_settings"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"list_system_settings"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"items":{"$ref":"#/components/schemas/SystemSettings"},"title":"Array_of_SystemSettings","type":"array"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":[{"add_when":"","add_who":1,"config_key":"","config_value":"","default_value":"","editable":false,"id":1,"mod_when":"","mod_who":1}]}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#update_system_settings":{"post":{"operationId":"update_system_settings","summary":"Update the value of an editable system setting; metadata is immutable.","description":"Update the value of an editable system setting; metadata is immutable.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN, MANAGER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"INVALID_DATA","when":"A value breaks a rule."}],"x-quark-module":"sys_settings","x-quark-operation":"update","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"update_system_settings"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"},"data":{"additionalProperties":false,"description":"Only the current value is operator-owned. Key/default/description and the editable bit are deployment metadata.","properties":{"config_value":{"type":"string"}},"title":"SystemSettingsUpdateApi","type":"object"}},"required":["id","data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"update_system_settings","params":{"id":1,"data":{"config_value":""}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"config_key":{"type":"string"},"config_value":{"type":"string"},"default_value":{"type":"string"},"description":{"type":["string","null"]},"editable":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"}},"required":["add_when","add_who","config_key","config_value","default_value","editable","id","mod_when","mod_who"],"title":"SystemSettings","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"config_key":"","config_value":"","default_value":"","editable":false,"id":1,"mod_when":"","mod_who":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#delete_system_settings":{"post":{"operationId":"delete_system_settings","summary":"Delete a system_settings by ID — CRUD.","description":"Delete a system_settings by ID — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN, MANAGER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"DEPENDENT_DATA_EXIST","when":"Other rows still use this row."}],"x-quark-module":"sys_settings","x-quark-operation":"delete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"delete_system_settings"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"delete_system_settings","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"config_key":{"type":"string"},"config_value":{"type":"string"},"default_value":{"type":"string"},"description":{"type":["string","null"]},"editable":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"}},"required":["add_when","add_who","config_key","config_value","default_value","editable","id","mod_when","mod_who"],"title":"SystemSettings","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"config_key":"","config_value":"","default_value":"","editable":false,"id":1,"mod_when":"","mod_who":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#warehouse_admin_list":{"post":{"operationId":"warehouse_admin_list","summary":"List warehouse definitions and actual schema readiness in Enterprise administration.","description":"List warehouse definitions and actual schema readiness in Enterprise administration.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- A tenant extension cannot replace this method.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"warehouse","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"warehouse_admin_list"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"warehouse_admin_list"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"items":{"$ref":"#/components/schemas/WarehouseAdminRow"},"title":"Array_of_WarehouseAdminRow","type":"array"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":[{"code":"","id":1,"is_active":false,"length_uom":"","name":"","readiness":"ready","readiness_label":"","readiness_reason":"","schema_name":"","volume_uom":"","weight_uom":""}]}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#warehouse_admin_get":{"post":{"operationId":"warehouse_admin_get","summary":"Read one warehouse definition and schema readiness in Enterprise administration.","description":"Read one warehouse definition and schema readiness in Enterprise administration.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- A tenant extension cannot replace this method.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."}],"x-quark-module":"warehouse","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"warehouse_admin_get"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"warehouse_admin_get","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"code":{"type":"string"},"id":{"format":"int64","type":"integer"},"is_active":{"type":"boolean"},"length_uom":{"type":"string"},"name":{"type":"string"},"readiness":{"$ref":"#/components/schemas/WarehouseReadiness"},"readiness_label":{"type":"string"},"readiness_reason":{"type":"string"},"schema_name":{"type":"string"},"volume_uom":{"type":"string"},"weight_uom":{"type":"string"}},"required":["code","id","is_active","length_uom","name","readiness","readiness_label","readiness_reason","schema_name","volume_uom","weight_uom"],"title":"WarehouseAdminRow","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"code":"","id":1,"is_active":false,"length_uom":"","name":"","readiness":"ready","readiness_label":"","readiness_reason":"","schema_name":"","volume_uom":"","weight_uom":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#warehouse_admin_create":{"post":{"operationId":"warehouse_admin_create","summary":"Create an inactive warehouse and provision its complete application schema.","description":"Create an inactive warehouse and provision its complete application schema.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n- A tenant extension cannot replace this method.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"UNIQUE_VIOLATION or INVALID_DATA","when":"The code already exists, or a value breaks a rule."}],"x-quark-module":"warehouse","x-quark-operation":"create","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"warehouse_admin_create"},"params":{"type":"object","properties":{"data":{"additionalProperties":false,"properties":{"code":{"type":"string"},"is_active":{"description":"Accepted for compatibility with generic forms, but always forced false.","type":["boolean","null"]},"length_uom":{"type":"string"},"name":{"type":"string"},"schema_name":{"type":"string"},"volume_uom":{"type":"string"},"weight_uom":{"type":"string"}},"required":["code","length_uom","name","schema_name","volume_uom","weight_uom"],"title":"WarehouseAdminCreate","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"warehouse_admin_create","params":{"data":{"code":"","length_uom":"","name":"","schema_name":"","volume_uom":"","weight_uom":""}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"code":{"type":"string"},"id":{"format":"int64","type":"integer"},"is_active":{"type":"boolean"},"length_uom":{"type":"string"},"name":{"type":"string"},"readiness":{"$ref":"#/components/schemas/WarehouseReadiness"},"readiness_label":{"type":"string"},"readiness_reason":{"type":"string"},"schema_name":{"type":"string"},"volume_uom":{"type":"string"},"weight_uom":{"type":"string"}},"required":["code","id","is_active","length_uom","name","readiness","readiness_label","readiness_reason","schema_name","volume_uom","weight_uom"],"title":"WarehouseAdminRow","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"code":"","id":1,"is_active":false,"length_uom":"","name":"","readiness":"ready","readiness_label":"","readiness_reason":"","schema_name":"","volume_uom":"","weight_uom":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#warehouse_admin_update":{"post":{"operationId":"warehouse_admin_update","summary":"Rename or change warehouse activity; activation requires current schema migrations.","description":"Rename or change warehouse activity; activation requires current schema migrations.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n- A tenant extension cannot replace this method.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"INVALID_DATA","when":"A value breaks a rule."}],"x-quark-module":"warehouse","x-quark-operation":"update","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"warehouse_admin_update"},"params":{"type":"object","properties":{"data":{"additionalProperties":false,"description":"Strict flat command input: generic UI commands carry every operand in data. Unknown identity/unit fields and explicit nulls cannot silently become no-ops.","properties":{"id":{"format":"int64","type":"integer"},"is_active":{"type":"boolean"},"name":{"type":"string"}},"required":["id"],"title":"WarehouseAdminUpdateApi","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"warehouse_admin_update","params":{"data":{"id":1}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"code":{"type":"string"},"id":{"format":"int64","type":"integer"},"is_active":{"type":"boolean"},"length_uom":{"type":"string"},"name":{"type":"string"},"readiness":{"$ref":"#/components/schemas/WarehouseReadiness"},"readiness_label":{"type":"string"},"readiness_reason":{"type":"string"},"schema_name":{"type":"string"},"volume_uom":{"type":"string"},"weight_uom":{"type":"string"}},"required":["code","id","is_active","length_uom","name","readiness","readiness_label","readiness_reason","schema_name","volume_uom","weight_uom"],"title":"WarehouseAdminRow","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"code":"","id":1,"is_active":false,"length_uom":"","name":"","readiness":"ready","readiness_label":"","readiness_reason":"","schema_name":"","volume_uom":"","weight_uom":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#list_user_warehouses":{"post":{"operationId":"list_user_warehouses","summary":"List warehouses accessible by a user (user_id optional → caller's Ctx.user_id by default)","description":"List warehouses accessible by a user (user_id optional → caller's Ctx.user_id by default)\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- You must log in. The method skips the permission check, so every logged-in user can call it.\n- This method only reads. It changes nothing and needs no idempotency key.\n- A tenant extension cannot replace this method.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."}],"x-quark-module":"warehouse","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"list_user_warehouses"},"params":{"type":"object","properties":{"data":{"properties":{"q":{"default":null,"description":"Reserved for future substring filter (rf-go's F2 picker convention sends `q`). Currently ignored — the per-user warehouse set is typically tiny so filtering doesn't earn its weight yet. Accepted so the F2 picker call deserializes cleanly.","type":["string","null"]},"user_id":{"description":"Target user_id. When omitted, falls back to the authenticated `Ctx.user_id()` — convenient for caller-self lookups (e.g. WHSEL's F2 picker, which can only send `{q: …}` per rf-go's lookupValues convention and has no way to thread an explicit user_id from screen state).","format":"int64","type":["integer","null"]}},"title":"ParamsListUserWarehouses","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"list_user_warehouses","params":{"data":{"q":"","user_id":1}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"items":{"$ref":"#/components/schemas/UserWarehouseWithDetails"},"title":"Array_of_UserWarehouseWithDetails","type":"array"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":[{"is_default":false,"role_code":"","role_id":1,"schema_name":"","user_warehouse_id":1,"warehouse_code":"","warehouse_id":1,"warehouse_name":""}]}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#get_warehouse_defaults":{"post":{"operationId":"get_warehouse_defaults","summary":"Get defaults for the active warehouse","description":"Get defaults for the active warehouse\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."}],"x-quark-module":"warehouse","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"get_warehouse_defaults"},"params":{"type":"object","properties":{}}}},"example":{"jsonrpc":"2.0","id":1,"method":"get_warehouse_defaults"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"anyOf":[{"$ref":"#/components/schemas/WarehouseDefaults"},{"type":"null"}],"title":"Nullable_WarehouseDefaults"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#warehouse_settings_list":{"post":{"operationId":"warehouse_settings_list","summary":"List the active warehouse with the rules its settings screen sets (one row; an id filter rereads it).","description":"List the active warehouse with the rules its settings screen sets (one row; an id filter rereads it).\n\n**Category:** `query`. Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, SUPERVISOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":true,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","SUPERVISOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"warehouse","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"warehouse_settings_list"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"warehouse_settings_list"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"items":{"$ref":"#/components/schemas/WarehouseSettingsRow"},"title":"Array_of_WarehouseSettingsRow","type":"array"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":[{"code":"","id":1,"name":"","shared_tote_allows_mixed_owners":false,"station_route_abandoned_after_minutes":1}]}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#warehouse_set_shared_tote_mixed_owners":{"post":{"operationId":"warehouse_set_shared_tote_mixed_owners","summary":"Set whether goods of several owners may share one station route's tote in the active warehouse.","description":"Set whether goods of several owners may share one station route's tote in the active warehouse.\n\n**Category:** `stateless_command`. Changes data. Requires `meta.idempotency_key`. No version check.\n\n**Default roles:** ADMIN, MANAGER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- Send `meta.idempotency_key`. If you send the same call again with the same key and the same data, you get the first answer back and nothing runs twice.\n- There is no version check.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"stateless_command","x-quark-category-declared":true,"x-quark-requires-idempotency":true,"x-quark-default-roles":["ADMIN","MANAGER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"RF_ERROR, return_code 42","when":"The idempotency key was used before with different data. Make a new key."},{"http":"400","error":"RF_ERROR, return_code 44","when":"The first call with this key is still running. Send the same call again."},{"http":"400","error":"RF_ERROR (other return codes)","when":"A business rule refused the command. Read `detail.message`, `detail.return_code` and `detail.class`."}],"x-quark-module":"warehouse","x-quark-operation":"execute","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"warehouse_set_shared_tote_mixed_owners"},"params":{"type":"object","properties":{"meta":{"properties":{"acknowledged_overrides":{"items":{"oneOf":[{"description":"Bare override code (receipt / dimensionless).","type":"integer"},{"description":"Move override pair (dimension code + hold-code subject).","properties":{"code":{"type":"integer"},"subject":{"type":"string"}},"required":["code"],"type":"object"}]},"type":"array"},"expected_version":{"format":"int64","type":"integer"},"idempotency_key":{"format":"uuid","type":"string"}},"type":"object","description":"Control-plane envelope (idempotency_key, expected_version, acknowledged_overrides — bare integer codes for receipt, or {code, subject} override pairs for move). Optional fields per ADR-058 D-3 semantic gating."},"data":{"description":"Wire command: the value the person chose for the caller's warehouse.","properties":{"allows_mixed_owners":{"description":"`true` — owners may share a tote; `false` — one owner per tote.","type":"boolean"},"idempotency_key":{"default":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"}},"required":["allows_mixed_owners"],"title":"SetSharedToteMixedOwners","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"warehouse_set_shared_tote_mixed_owners","params":{"meta":{"idempotency_key":"7f1c2d4e-5a6b-4c8d-9e0f-1a2b3c4d5e6f"},"data":{"allows_mixed_owners":false}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"description":"The caller's warehouse as the warehouse settings screen shows it: who it is and the rules the screen sets. One row — the screen never lists or writes another warehouse (plan R2). `Deserialize` because a command's output is stored for its replay.","properties":{"code":{"type":"string"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"},"shared_tote_allows_mixed_owners":{"description":"May goods of several owners lie in one station route's shared tote at once? Switching it off changes nothing already deposited: the next deposit of another owner is refused.","type":"boolean"},"station_route_abandoned_after_minutes":{"description":"Minutes with no activity on a station route — no stop under a live lease, no route or stop change — before the supervisor's board calls it abandoned and the supervisor's door finishes its totes.","format":"int32","type":"integer"}},"required":["code","id","name","shared_tote_allows_mixed_owners","station_route_abandoned_after_minutes"],"title":"WarehouseSettingsRow","type":"object"},"meta":{"type":"object","properties":{"idempotency_replayed":{"type":"boolean"}}}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"meta":{"idempotency_replayed":false},"data":{"code":"","id":1,"name":"","shared_tote_allows_mixed_owners":false,"station_route_abandoned_after_minutes":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#warehouse_set_station_route_abandoned_after":{"post":{"operationId":"warehouse_set_station_route_abandoned_after","summary":"Set after how many minutes with no activity a station route counts as abandoned in the active warehouse.","description":"Set after how many minutes with no activity a station route counts as abandoned in the active warehouse.\n\n**Category:** `stateless_command`. Changes data. Requires `meta.idempotency_key`. No version check.\n\n**Default roles:** ADMIN, MANAGER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- Send `meta.idempotency_key`. If you send the same call again with the same key and the same data, you get the first answer back and nothing runs twice.\n- There is no version check.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"stateless_command","x-quark-category-declared":true,"x-quark-requires-idempotency":true,"x-quark-default-roles":["ADMIN","MANAGER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"RF_ERROR, return_code 42","when":"The idempotency key was used before with different data. Make a new key."},{"http":"400","error":"RF_ERROR, return_code 44","when":"The first call with this key is still running. Send the same call again."},{"http":"400","error":"RF_ERROR (other return codes)","when":"A business rule refused the command. Read `detail.message`, `detail.return_code` and `detail.class`."}],"x-quark-module":"warehouse","x-quark-operation":"execute","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"warehouse_set_station_route_abandoned_after"},"params":{"type":"object","properties":{"meta":{"properties":{"acknowledged_overrides":{"items":{"oneOf":[{"description":"Bare override code (receipt / dimensionless).","type":"integer"},{"description":"Move override pair (dimension code + hold-code subject).","properties":{"code":{"type":"integer"},"subject":{"type":"string"}},"required":["code"],"type":"object"}]},"type":"array"},"expected_version":{"format":"int64","type":"integer"},"idempotency_key":{"format":"uuid","type":"string"}},"type":"object","description":"Control-plane envelope (idempotency_key, expected_version, acknowledged_overrides — bare integer codes for receipt, or {code, subject} override pairs for move). Optional fields per ADR-058 D-3 semantic gating."},"data":{"description":"Wire command: the number of minutes the person typed for the caller's warehouse.","properties":{"idempotency_key":{"default":"00000000-0000-0000-0000-000000000000","format":"uuid","type":"string"},"minutes":{"description":"Minutes with no activity on a station route before it counts as abandoned; at least 1.","format":"int64","type":"integer"}},"required":["minutes"],"title":"SetStationRouteAbandonedAfter","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"warehouse_set_station_route_abandoned_after","params":{"meta":{"idempotency_key":"7f1c2d4e-5a6b-4c8d-9e0f-1a2b3c4d5e6f"},"data":{"minutes":1}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"description":"The caller's warehouse as the warehouse settings screen shows it: who it is and the rules the screen sets. One row — the screen never lists or writes another warehouse (plan R2). `Deserialize` because a command's output is stored for its replay.","properties":{"code":{"type":"string"},"id":{"format":"int64","type":"integer"},"name":{"type":"string"},"shared_tote_allows_mixed_owners":{"description":"May goods of several owners lie in one station route's shared tote at once? Switching it off changes nothing already deposited: the next deposit of another owner is refused.","type":"boolean"},"station_route_abandoned_after_minutes":{"description":"Minutes with no activity on a station route — no stop under a live lease, no route or stop change — before the supervisor's board calls it abandoned and the supervisor's door finishes its totes.","format":"int32","type":"integer"}},"required":["code","id","name","shared_tote_allows_mixed_owners","station_route_abandoned_after_minutes"],"title":"WarehouseSettingsRow","type":"object"},"meta":{"type":"object","properties":{"idempotency_replayed":{"type":"boolean"}}}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"meta":{"idempotency_replayed":false},"data":{"code":"","id":1,"name":"","shared_tote_allows_mixed_owners":false,"station_route_abandoned_after_minutes":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#create_role":{"post":{"operationId":"create_role","summary":"Create a new role — CRUD.","description":"Create a new role — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"UNIQUE_VIOLATION or INVALID_DATA","when":"The code already exists, or a value breaks a rule."}],"x-quark-module":"role","x-quark-operation":"create","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"create_role"},"params":{"type":"object","properties":{"data":{"properties":{"code":{"type":"string"},"description":{"type":["string","null"]},"is_active":{"type":["boolean","null"]},"name":{"type":"string"}},"required":["code","name"],"title":"RoleForCreate","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"create_role","params":{"data":{"code":"","name":""}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"code":{"type":"string"},"description":{"type":["string","null"]},"id":{"format":"int64","type":"integer"},"is_active":{"type":"boolean"},"is_system":{"type":"boolean"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"name":{"type":"string"}},"required":["add_when","add_who","code","id","is_active","is_system","mod_when","mod_who","name"],"title":"Role","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"code":"","id":1,"is_active":false,"is_system":false,"mod_when":"","mod_who":1,"name":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#get_role":{"post":{"operationId":"get_role","summary":"Get a role by ID — CRUD.","description":"Get a role by ID — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."}],"x-quark-module":"role","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"get_role"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"get_role","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"code":{"type":"string"},"description":{"type":["string","null"]},"id":{"format":"int64","type":"integer"},"is_active":{"type":"boolean"},"is_system":{"type":"boolean"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"name":{"type":"string"}},"required":["add_when","add_who","code","id","is_active","is_system","mod_when","mod_who","name"],"title":"Role","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"code":"","id":1,"is_active":false,"is_system":false,"mod_when":"","mod_who":1,"name":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#list_role":{"post":{"operationId":"list_role","summary":"List role — CRUD.","description":"List role — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"role","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"list_role"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"list_role"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"items":{"$ref":"#/components/schemas/Role"},"title":"Array_of_Role","type":"array"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":[{"add_when":"","add_who":1,"code":"","id":1,"is_active":false,"is_system":false,"mod_when":"","mod_who":1,"name":""}]}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#update_role":{"post":{"operationId":"update_role","summary":"Update mutable role fields; code is immutable and null is explicit.","description":"Update mutable role fields; code is immutable and null is explicit.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"INVALID_DATA","when":"A value breaks a rule."}],"x-quark-module":"role","x-quark-operation":"update","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"update_role"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"},"data":{"additionalProperties":false,"description":"A role code is stable permission identity. Operators may rename, describe, disable or re-enable the role without moving that identity.","properties":{"description":{"type":["string","null"]},"is_active":{"type":"boolean"},"name":{"type":"string"}},"title":"RoleUpdateApi","type":"object"}},"required":["id","data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"update_role","params":{"id":1,"data":{"description":"","is_active":false,"name":""}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"code":{"type":"string"},"description":{"type":["string","null"]},"id":{"format":"int64","type":"integer"},"is_active":{"type":"boolean"},"is_system":{"type":"boolean"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"name":{"type":"string"}},"required":["add_when","add_who","code","id","is_active","is_system","mod_when","mod_who","name"],"title":"Role","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"code":"","id":1,"is_active":false,"is_system":false,"mod_when":"","mod_who":1,"name":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#delete_role":{"post":{"operationId":"delete_role","summary":"Delete a role by ID — CRUD.","description":"Delete a role by ID — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"DEPENDENT_DATA_EXIST","when":"Other rows still use this row."}],"x-quark-module":"role","x-quark-operation":"delete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"delete_role"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"delete_role","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"code":{"type":"string"},"description":{"type":["string","null"]},"id":{"format":"int64","type":"integer"},"is_active":{"type":"boolean"},"is_system":{"type":"boolean"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"name":{"type":"string"}},"required":["add_when","add_who","code","id","is_active","is_system","mod_when","mod_who","name"],"title":"Role","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"code":"","id":1,"is_active":false,"is_system":false,"mod_when":"","mod_who":1,"name":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#delete_many_role":{"post":{"operationId":"delete_many_role","summary":"Delete multiple role by IDs — CRUD.","description":"Delete multiple role by IDs — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"DEPENDENT_DATA_EXIST","when":"Other rows still use this row."}],"x-quark-module":"role","x-quark-operation":"delete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"delete_many_role"},"params":{"type":"object","properties":{"ids":{"items":{"format":"int64","type":"integer"},"type":"array","description":"Record IDs"}},"required":["ids"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"delete_many_role","params":{"ids":[1]}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"format":"uint64","minimum":0,"title":"uint64","type":"integer"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":1}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#count_role":{"post":{"operationId":"count_role","summary":"Count role — CRUD.","description":"Count role — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"role","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"count_role"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"count_role"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"format":"int64","title":"int64","type":"integer"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":1}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#create_role_permission":{"post":{"operationId":"create_role_permission","summary":"Create a new role_permission — CRUD.","description":"Create a new role_permission — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"UNIQUE_VIOLATION or INVALID_DATA","when":"The code already exists, or a value breaks a rule."}],"x-quark-module":"role","x-quark-operation":"create","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"create_role_permission"},"params":{"type":"object","properties":{"data":{"properties":{"can_delete":{"type":["boolean","null"]},"can_execute":{"type":["boolean","null"]},"can_read":{"type":["boolean","null"]},"can_write":{"type":["boolean","null"]},"resource_code":{"type":"string"},"resource_type":{"type":"string"},"role_id":{"format":"int64","type":"integer"}},"required":["resource_code","resource_type","role_id"],"title":"RolePermissionForCreate","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"create_role_permission","params":{"data":{"resource_code":"","resource_type":"","role_id":1}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"can_delete":{"type":"boolean"},"can_execute":{"type":"boolean"},"can_read":{"type":"boolean"},"can_write":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"resource_code":{"type":"string"},"resource_type":{"type":"string"},"role_id":{"format":"int64","type":"integer"}},"required":["add_when","add_who","can_delete","can_execute","can_read","can_write","id","mod_when","mod_who","resource_code","resource_type","role_id"],"title":"RolePermission","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"can_delete":false,"can_execute":false,"can_read":false,"can_write":false,"id":1,"mod_when":"","mod_who":1,"resource_code":"","resource_type":"","role_id":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#get_role_permission":{"post":{"operationId":"get_role_permission","summary":"Get a role_permission by ID — CRUD.","description":"Get a role_permission by ID — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."}],"x-quark-module":"role","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"get_role_permission"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"get_role_permission","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"can_delete":{"type":"boolean"},"can_execute":{"type":"boolean"},"can_read":{"type":"boolean"},"can_write":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"resource_code":{"type":"string"},"resource_type":{"type":"string"},"role_id":{"format":"int64","type":"integer"}},"required":["add_when","add_who","can_delete","can_execute","can_read","can_write","id","mod_when","mod_who","resource_code","resource_type","role_id"],"title":"RolePermission","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"can_delete":false,"can_execute":false,"can_read":false,"can_write":false,"id":1,"mod_when":"","mod_who":1,"resource_code":"","resource_type":"","role_id":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#list_role_permission":{"post":{"operationId":"list_role_permission","summary":"List role_permission — CRUD.","description":"List role_permission — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"role","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"list_role_permission"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"list_role_permission"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"items":{"$ref":"#/components/schemas/RolePermission"},"title":"Array_of_RolePermission","type":"array"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":[{"add_when":"","add_who":1,"can_delete":false,"can_execute":false,"can_read":false,"can_write":false,"id":1,"mod_when":"","mod_who":1,"resource_code":"","resource_type":"","role_id":1}]}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#update_role_permission":{"post":{"operationId":"update_role_permission","summary":"Update role-permission grants; null and identity changes are rejected.","description":"Update role-permission grants; null and identity changes are rejected.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"INVALID_DATA","when":"A value breaks a rule."}],"x-quark-module":"role","x-quark-operation":"update","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"update_role_permission"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"},"data":{"additionalProperties":false,"description":"Strict wire patch for the mutable cells of one permission row. The row's role/resource identity is immutable; moving a permission means delete + create, while the four grants may be independently changed.","properties":{"can_delete":{"type":"boolean"},"can_execute":{"type":"boolean"},"can_read":{"type":"boolean"},"can_write":{"type":"boolean"}},"title":"RolePermissionUpdateApi","type":"object"}},"required":["id","data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"update_role_permission","params":{"id":1,"data":{"can_delete":false,"can_execute":false,"can_read":false}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"can_delete":{"type":"boolean"},"can_execute":{"type":"boolean"},"can_read":{"type":"boolean"},"can_write":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"resource_code":{"type":"string"},"resource_type":{"type":"string"},"role_id":{"format":"int64","type":"integer"}},"required":["add_when","add_who","can_delete","can_execute","can_read","can_write","id","mod_when","mod_who","resource_code","resource_type","role_id"],"title":"RolePermission","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"can_delete":false,"can_execute":false,"can_read":false,"can_write":false,"id":1,"mod_when":"","mod_who":1,"resource_code":"","resource_type":"","role_id":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#delete_role_permission":{"post":{"operationId":"delete_role_permission","summary":"Delete a role_permission by ID — CRUD.","description":"Delete a role_permission by ID — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"DEPENDENT_DATA_EXIST","when":"Other rows still use this row."}],"x-quark-module":"role","x-quark-operation":"delete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"delete_role_permission"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"delete_role_permission","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"can_delete":{"type":"boolean"},"can_execute":{"type":"boolean"},"can_read":{"type":"boolean"},"can_write":{"type":"boolean"},"id":{"format":"int64","type":"integer"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"resource_code":{"type":"string"},"resource_type":{"type":"string"},"role_id":{"format":"int64","type":"integer"}},"required":["add_when","add_who","can_delete","can_execute","can_read","can_write","id","mod_when","mod_who","resource_code","resource_type","role_id"],"title":"RolePermission","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"can_delete":false,"can_execute":false,"can_read":false,"can_write":false,"id":1,"mod_when":"","mod_who":1,"resource_code":"","resource_type":"","role_id":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#delete_many_role_permission":{"post":{"operationId":"delete_many_role_permission","summary":"Delete multiple role_permission by IDs — CRUD.","description":"Delete multiple role_permission by IDs — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"DEPENDENT_DATA_EXIST","when":"Other rows still use this row."}],"x-quark-module":"role","x-quark-operation":"delete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"delete_many_role_permission"},"params":{"type":"object","properties":{"ids":{"items":{"format":"int64","type":"integer"},"type":"array","description":"Record IDs"}},"required":["ids"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"delete_many_role_permission","params":{"ids":[1]}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"format":"uint64","minimum":0,"title":"uint64","type":"integer"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":1}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#count_role_permission":{"post":{"operationId":"count_role_permission","summary":"Count role_permission — CRUD.","description":"Count role_permission — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"role","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"count_role_permission"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"count_role_permission"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"format":"int64","title":"int64","type":"integer"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":1}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#supervisor_override_grant":{"post":{"operationId":"supervisor_override_grant","summary":"Mint a supervisor override grant for the pairs a refused command reported. The grant binds OPERATOR + PAIRS + the authenticated authorizer, is single-use and expires in minutes. A move passes its id as move_execute's ctx.override_grant_id; receipt_close, receipt_receive_against_asn and receipt_receive_case_level_line take it as override_grant_id (meta or data). Receipt pairs are bound to what they decide: a close (71) to one receipt, {code, subject: \"receipt:\"}; a shortage or excess (28/27) to one line, {code, subject: \"receipt:/line:\"} — a grant for one line is refused on any other. Authority is checked PER PAIR: a move pair needs an override role (SUPERVISOR/MANAGER/ADMIN); a receipt pair needs the capability its code names (71 receipt.override_close_discrepancy, 28 receipt.override_qty_shortage, 27 receipt.override_qty_excess — SUPERVISOR only), so an ADMIN or MANAGER cannot authorize a receipt override. A caller who holds every pair's authority mints seamlessly with no credentials; anyone else must supply username + password, verified through the same path as /api/login, and that person is held to the same per-pair rule. Supplying credentials always authenticates THEM, even if the caller could have minted seamlessly. The recorded authorizer is whoever the SERVER authenticated here; it is never taken from the command request. A count-freeze pair ({code: 87, subject: \"count:\"}), which a Hard inventory count's freeze reports in context.pairs, needs an override role like a move pair AND a reason: the reason is recorded on the grant and written onto the count as the mark that stock moved underneath it, so the counter knows the number is in doubt. Such a grant is refused without one. move_execute, inventory_adjustment_post (override_grant_id) and pick_commit (count_freeze_grant_id) redeem it.","description":"Mint a supervisor override grant for the pairs a refused command reported. The grant binds OPERATOR + PAIRS + the authenticated authorizer, is single-use and expires in minutes. A move passes its id as move_execute's ctx.override_grant_id; receipt_close, receipt_receive_against_asn and receipt_receive_case_level_line take it as override_grant_id (meta or data). Receipt pairs are bound to what they decide: a close (71) to one receipt, {code, subject: \"receipt:\"}; a shortage or excess (28/27) to one line, {code, subject: \"receipt:/line:\"} — a grant for one line is refused on any other. Authority is checked PER PAIR: a move pair needs an override role (SUPERVISOR/MANAGER/ADMIN); a receipt pair needs the capability its code names (71 receipt.override_close_discrepancy, 28 receipt.override_qty_shortage, 27 receipt.override_qty_excess — SUPERVISOR only), so an ADMIN or MANAGER cannot authorize a receipt override. A caller who holds every pair's authority mints seamlessly with no credentials; anyone else must supply username + password, verified through the same path as /api/login, and that person is held to the same per-pair rule. Supplying credentials always authenticates THEM, even if the caller could have minted seamlessly. The recorded authorizer is whoever the SERVER authenticated here; it is never taken from the command request. A count-freeze pair ({code: 87, subject: \"count:\"}), which a Hard inventory count's freeze reports in context.pairs, needs an override role like a move pair AND a reason: the reason is recorded on the grant and written onto the count as the mark that stock moved underneath it, so the counter knows the number is in doubt. Such a grant is refused without one. move_execute, inventory_adjustment_post (override_grant_id) and pick_commit (count_freeze_grant_id) redeem it.\n\n**Category:** `stateless_command`. Changes data. Requires `meta.idempotency_key`. No version check.\n\n**Default roles:** ADMIN, MANAGER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- Send `meta.idempotency_key`. If you send the same call again with the same key and the same data, you get the first answer back and nothing runs twice.\n- There is no version check.\n- This method can ask for a supervisor override. Send the codes the operator accepted in `acknowledged_overrides`. See 04-command-types-and-concurrency.md and 05-errors.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"stateless_command","x-quark-category-declared":true,"x-quark-requires-idempotency":true,"x-quark-default-roles":["ADMIN","MANAGER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"RF_ERROR, return_code 42","when":"The idempotency key was used before with different data. Make a new key."},{"http":"400","error":"RF_ERROR, return_code 44","when":"The first call with this key is still running. Send the same call again."},{"http":"400","error":"RF_ERROR (other return codes)","when":"A business rule refused the command. Read `detail.message`, `detail.return_code` and `detail.class`."}],"x-quark-module":"override_grant","x-quark-operation":"execute","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"supervisor_override_grant"},"params":{"type":"object","properties":{"meta":{"properties":{"acknowledged_overrides":{"items":{"oneOf":[{"description":"Bare override code (receipt / dimensionless).","type":"integer"},{"description":"Move override pair (dimension code + hold-code subject).","properties":{"code":{"type":"integer"},"subject":{"type":"string"}},"required":["code"],"type":"object"}]},"type":"array"},"expected_version":{"format":"int64","type":"integer"},"idempotency_key":{"format":"uuid","type":"string"}},"type":"object","description":"Control-plane envelope (idempotency_key, expected_version, acknowledged_overrides — bare integer codes for receipt, or {code, subject} override pairs for move). Optional fields per ADR-058 D-3 semantic gating."},"data":{"properties":{"pairs":{"description":"The pairs this grant authorizes. For a move: exactly what the refused move reported in `error.data.detail.context.pairs`. For a receipt override, likewise what the refused receipt command reported there: `{\"code\": 71, \"subject\": \"receipt:\"}` for a close — bound to that receipt — and `{\"code\": <28|27>, \"subject\": \"receipt:/line:\"}` for a shortage or excess — bound to that one line.","items":{"$ref":"#/components/schemas/AckToken"},"type":"array"},"password":{"default":null,"type":["string","null"]},"reason":{"default":null,"description":"Why the authorizer is allowing it. REQUIRED for a count-freeze pair (`{\"code\": 87, \"subject\": \"count:\"}`): the owner asked for that reason to be recorded, and it is written onto the count as the mark that stock moved underneath it. Optional for every other pair, which says what it overrode in its own subject.","type":["string","null"]},"username":{"default":null,"description":"Required only when the caller cannot authorize every pair themselves.","type":["string","null"]}},"required":["pairs"],"title":"GrantParams","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"supervisor_override_grant","params":{"meta":{"idempotency_key":"7f1c2d4e-5a6b-4c8d-9e0f-1a2b3c4d5e6f"},"data":{"pairs":[{"code":1,"subject":""}]}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"expires_at":{"description":"RFC 3339 in UTC.","format":"date-time","type":"string"},"grant_id":{"format":"uuid","type":"string"}},"required":["expires_at","grant_id"],"title":"GrantResult","type":"object"},"meta":{"type":"object","properties":{"idempotency_replayed":{"type":"boolean"}}}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"meta":{"idempotency_replayed":false},"data":{"expires_at":"2026-01-01T00:00:00Z","grant_id":"7f1c2d4e-5a6b-4c8d-9e0f-1a2b3c4d5e6f"}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#create_user_warehouse":{"post":{"operationId":"create_user_warehouse","summary":"Create a new user_warehouse — CRUD.","description":"Create a new user_warehouse — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"UNIQUE_VIOLATION or INVALID_DATA","when":"The code already exists, or a value breaks a rule."}],"x-quark-module":"user_warehouse","x-quark-operation":"create","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"create_user_warehouse"},"params":{"type":"object","properties":{"data":{"properties":{"is_default":{"type":["boolean","null"]},"role_id":{"format":"int64","type":"integer"},"user_id":{"format":"int64","type":"integer"},"warehouse_id":{"format":"int64","type":"integer"}},"required":["role_id","user_id","warehouse_id"],"title":"UserWarehouseForCreate","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"create_user_warehouse","params":{"data":{"role_id":1,"user_id":1,"warehouse_id":1}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"is_default":{"type":"boolean"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"role_id":{"format":"int64","type":"integer"},"user_id":{"format":"int64","type":"integer"},"warehouse_id":{"format":"int64","type":"integer"}},"required":["add_when","add_who","id","is_default","mod_when","mod_who","role_id","user_id","warehouse_id"],"title":"UserWarehouse","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"id":1,"is_default":false,"mod_when":"","mod_who":1,"role_id":1,"user_id":1,"warehouse_id":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#get_user_warehouse":{"post":{"operationId":"get_user_warehouse","summary":"Get a user_warehouse by ID — CRUD.","description":"Get a user_warehouse by ID — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."}],"x-quark-module":"user_warehouse","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"get_user_warehouse"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"get_user_warehouse","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"is_default":{"type":"boolean"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"role_id":{"format":"int64","type":"integer"},"user_id":{"format":"int64","type":"integer"},"warehouse_id":{"format":"int64","type":"integer"}},"required":["add_when","add_who","id","is_default","mod_when","mod_who","role_id","user_id","warehouse_id"],"title":"UserWarehouse","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"id":1,"is_default":false,"mod_when":"","mod_who":1,"role_id":1,"user_id":1,"warehouse_id":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#list_user_warehouse":{"post":{"operationId":"list_user_warehouse","summary":"List user_warehouse — CRUD.","description":"List user_warehouse — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"user_warehouse","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"list_user_warehouse"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"list_user_warehouse"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"items":{"$ref":"#/components/schemas/UserWarehouse"},"title":"Array_of_UserWarehouse","type":"array"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":[{"add_when":"","add_who":1,"id":1,"is_default":false,"mod_when":"","mod_who":1,"role_id":1,"user_id":1,"warehouse_id":1}]}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#update_user_warehouse":{"post":{"operationId":"update_user_warehouse","summary":"Update an assignment's role/default marker; null and identity changes are rejected.","description":"Update an assignment's role/default marker; null and identity changes are rejected.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"INVALID_DATA","when":"A value breaks a rule."}],"x-quark-module":"user_warehouse","x-quark-operation":"update","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"update_user_warehouse"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"},"data":{"additionalProperties":false,"description":"A warehouse assignment keeps its `(user_id, warehouse_id)` identity. Only its role and default marker are editable; both columns are NOT NULL.","properties":{"is_default":{"type":"boolean"},"role_id":{"format":"int64","type":"integer"}},"title":"UserWarehouseUpdateApi","type":"object"}},"required":["id","data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"update_user_warehouse","params":{"id":1,"data":{"is_default":false,"role_id":1}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"is_default":{"type":"boolean"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"role_id":{"format":"int64","type":"integer"},"user_id":{"format":"int64","type":"integer"},"warehouse_id":{"format":"int64","type":"integer"}},"required":["add_when","add_who","id","is_default","mod_when","mod_who","role_id","user_id","warehouse_id"],"title":"UserWarehouse","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"id":1,"is_default":false,"mod_when":"","mod_who":1,"role_id":1,"user_id":1,"warehouse_id":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#delete_user_warehouse":{"post":{"operationId":"delete_user_warehouse","summary":"Delete a user_warehouse by ID — CRUD.","description":"Delete a user_warehouse by ID — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"DEPENDENT_DATA_EXIST","when":"Other rows still use this row."}],"x-quark-module":"user_warehouse","x-quark-operation":"delete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"delete_user_warehouse"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"delete_user_warehouse","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"id":{"format":"int64","type":"integer"},"is_default":{"type":"boolean"},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"role_id":{"format":"int64","type":"integer"},"user_id":{"format":"int64","type":"integer"},"warehouse_id":{"format":"int64","type":"integer"}},"required":["add_when","add_who","id","is_default","mod_when","mod_who","role_id","user_id","warehouse_id"],"title":"UserWarehouse","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"id":1,"is_default":false,"mod_when":"","mod_who":1,"role_id":1,"user_id":1,"warehouse_id":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#delete_many_user_warehouse":{"post":{"operationId":"delete_many_user_warehouse","summary":"Delete multiple user_warehouse by IDs — CRUD.","description":"Delete multiple user_warehouse by IDs — CRUD.\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."},{"http":"400","error":"DEPENDENT_DATA_EXIST","when":"Other rows still use this row."}],"x-quark-module":"user_warehouse","x-quark-operation":"delete","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"delete_many_user_warehouse"},"params":{"type":"object","properties":{"ids":{"items":{"format":"int64","type":"integer"},"type":"array","description":"Record IDs"}},"required":["ids"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"delete_many_user_warehouse","params":{"ids":[1]}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"format":"uint64","minimum":0,"title":"uint64","type":"integer"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":1}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#count_user_warehouse":{"post":{"operationId":"count_user_warehouse","summary":"Count user_warehouse — CRUD.","description":"Count user_warehouse — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"user_warehouse","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"count_user_warehouse"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"count_user_warehouse"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"format":"int64","title":"int64","type":"integer"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":1}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#generate_user_api_key":{"post":{"operationId":"generate_user_api_key","summary":"Generate API key for user; returns plaintext exactly once","description":"Generate API key for user; returns plaintext exactly once\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"RF_ERROR (other return codes)","when":"A business rule refused the command. Read `detail.message`, `detail.return_code` and `detail.class`."}],"x-quark-module":"user_api_key","x-quark-operation":"execute","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"generate_user_api_key"},"params":{"type":"object","properties":{"data":{"properties":{"expires_at":{"type":["string","null"]},"name":{"type":"string"},"user_id":{"format":"int64","type":"integer"}},"required":["name","user_id"],"title":"GenerateApiKeyParams","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"generate_user_api_key","params":{"data":{"name":"","user_id":1}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"expires_at":{"type":["string","null"]},"id":{"format":"int64","type":"integer"},"key_prefix":{"type":"string"},"plaintext_key":{"type":"string"}},"required":["id","key_prefix","plaintext_key"],"title":"GenerateApiKeyResult","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"id":1,"key_prefix":"","plaintext_key":""}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#revoke_user_api_key":{"post":{"operationId":"revoke_user_api_key","summary":"Revoke an API key for its parent user; retries preserve the first revoke time","description":"Revoke an API key for its parent user; retries preserve the first revoke time\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"RF_ERROR (other return codes)","when":"A business rule refused the command. Read `detail.message`, `detail.return_code` and `detail.class`."}],"x-quark-module":"user_api_key","x-quark-operation":"execute","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"revoke_user_api_key"},"params":{"type":"object","properties":{"data":{"properties":{"id":{"format":"int64","type":"integer"},"user_id":{"description":"The user card whose API-key list the caller is acting on. Requiring both identities prevents a stale/tampered row id from revoking a key that belongs to a different user.","format":"int64","type":"integer"}},"required":["id","user_id"],"title":"RevokeApiKeyParams","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"revoke_user_api_key","params":{"data":{"id":1,"user_id":1}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"title":"AnyValue"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":null}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#get_user_api_key":{"post":{"operationId":"get_user_api_key","summary":"Get a user_api_key by ID — CRUD.","description":"Get a user_api_key by ID — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."}],"x-quark-module":"user_api_key","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"get_user_api_key"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"get_user_api_key","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"add_when":{"type":"string"},"add_who":{"format":"int64","type":"integer"},"expires_at":{"default":null,"type":["string","null"]},"id":{"format":"int64","type":"integer"},"key_hash":{"description":"argon2id PHC hash of the full plaintext key. **Never leaves the process.** `#[serde(skip_serializing)]` keeps it out of every RPC response (`list_user_api_key` / `get_user_api_key`). The field is still populated by `FromRow` because `ApiKeyStore::validate` reads it directly from the table — just not via this DTO. See ADR-022 (mutation audit events).","type":"string","writeOnly":true},"key_prefix":{"type":"string"},"last_used_at":{"default":null,"type":["string","null"]},"mod_when":{"type":"string"},"mod_who":{"format":"int64","type":"integer"},"name":{"type":"string"},"revoked_at":{"default":null,"type":["string","null"]},"user_id":{"format":"int64","type":"integer"}},"required":["add_when","add_who","id","key_hash","key_prefix","mod_when","mod_who","name","user_id"],"title":"UserApiKey","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"add_when":"","add_who":1,"id":1,"key_hash":"","key_prefix":"","mod_when":"","mod_who":1,"name":"","user_id":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#list_user_api_key":{"post":{"operationId":"list_user_api_key","summary":"List user_api_key — CRUD.","description":"List user_api_key — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"user_api_key","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"list_user_api_key"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"list_user_api_key"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"items":{"$ref":"#/components/schemas/UserApiKey"},"title":"Array_of_UserApiKey","type":"array"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":[{"add_when":"","add_who":1,"id":1,"key_hash":"","key_prefix":"","mod_when":"","mod_who":1,"name":"","user_id":1}]}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#count_user_api_key":{"post":{"operationId":"count_user_api_key","summary":"Count user_api_key — CRUD.","description":"Count user_api_key — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"user_api_key","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"count_user_api_key"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"count_user_api_key"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"format":"int64","title":"int64","type":"integer"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":1}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#get_audit_log":{"post":{"operationId":"get_audit_log","summary":"Get a audit_log by ID — CRUD.","description":"Get a audit_log by ID — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"ENTITY_NOT_FOUND","when":"No row has this id."}],"x-quark-module":"audit_log","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"get_audit_log"},"params":{"type":"object","properties":{"id":{"format":"int64","type":"integer","description":"Record ID"}},"required":["id"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"get_audit_log","params":{"id":1}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"description":"Read-only audit log entry — **selected from `enterprise.audit_log_view`** (see ADR-025), not the raw `audit_log` table. The view LEFT JOINs user / role / warehouse / target entities so the Audit Log grid can render human labels (`username`, `role_code`, `warehouse_code`, `target_label`) instead of opaque numeric ids.\n\nInserts still go via `wms_lib_auth::authorization::audit::log_event` which writes directly to `enterprise.audit_log` with raw SQL — BMC is read-only for audit.","properties":{"detail":true,"event_kind":{"type":"string"},"event_time":{"type":"string"},"id":{"format":"int64","type":"integer"},"required_bit":{"type":["string","null"]},"resource_code":{"type":["string","null"]},"resource_label":{"description":"Alias of `resource_code` until the resource_catalog lands (ADR-025 §D4).","type":["string","null"]},"resource_type":{"type":["string","null"]},"role_code":{"description":"Resolved via LEFT JOIN on `enterprise.role`.","type":["string","null"]},"role_id":{"format":"int64","type":["integer","null"]},"target_extra":{"type":["string","null"]},"target_id":{"description":"Extracted from `detail->'target_pk'` (JSON — scalar for single-PK tables, array for composite). Grid renders the raw JSON."},"target_label":{"description":"Human label for the target row (`r.code`, `u.username`, …) joined from the six RBAC entity types (ADR-025 §D2). NULL for unknown / composite-PK targets — the UI renders em-dash.","type":["string","null"]},"target_type":{"description":"Extracted from `detail->>'target_table'` — which entity was mutated.","type":["string","null"]},"user_id":{"format":"int64","type":["integer","null"]},"username":{"description":"Resolved via LEFT JOIN on `enterprise.\"user\"`. NULL if user deleted.","type":["string","null"]},"warehouse_code":{"description":"Resolved via LEFT JOIN on `enterprise.warehouse`.","type":["string","null"]},"warehouse_id":{"format":"int64","type":["integer","null"]},"warehouse_name":{"description":"Resolved via LEFT JOIN on `enterprise.warehouse`.","type":["string","null"]}},"required":["event_kind","event_time","id"],"title":"AuditLog","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"event_kind":"","event_time":"","id":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#list_audit_log":{"post":{"operationId":"list_audit_log","summary":"List audit_log — CRUD.","description":"List audit_log — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"audit_log","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"list_audit_log"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"list_audit_log"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"items":{"$ref":"#/components/schemas/AuditLog"},"title":"Array_of_AuditLog","type":"array"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":[{"event_kind":"","event_time":"","id":1}]}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#count_audit_log":{"post":{"operationId":"count_audit_log","summary":"Count audit_log — CRUD.","description":"Count audit_log — CRUD.\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"audit_log","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"count_audit_log"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"count_audit_log"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"format":"int64","title":"int64","type":"integer"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":1}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#list_audit_event_kinds":{"post":{"operationId":"list_audit_event_kinds","summary":"Distinct event_kind values from enterprise.audit_log_view (set-filter feed).","description":"Distinct event_kind values from enterprise.audit_log_view (set-filter feed).\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN, MANAGER, OPERATOR, VIEWER. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN","MANAGER","OPERATOR","VIEWER"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."}],"x-quark-module":"audit_log","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"list_audit_event_kinds"},"params":{"type":"object","properties":{}}}},"example":{"jsonrpc":"2.0","id":1,"method":"list_audit_event_kinds"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"items":{"type":"string"},"title":"Array_of_String","type":"array"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":[""]}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#batch_update_role_permissions":{"post":{"operationId":"batch_update_role_permissions","summary":"Batch-update role_permission cells (Permission Matrix save)","description":"Batch-update role_permission cells (Permission Matrix save)\n\n**Category:** `not_declared` (inferred). The catalog gives no command type for this write method. Send an idempotency key to be safe.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- The catalog gives no command type for this method. It does not say whether an idempotency key or a version is needed.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"not_declared","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"400","error":"RF_ERROR (other return codes)","when":"A business rule refused the command. Read `detail.message`, `detail.return_code` and `detail.class`."}],"x-quark-module":"role_permission","x-quark-operation":"execute","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"batch_update_role_permissions"},"params":{"type":"object","properties":{"data":{"properties":{"changes":{"items":{"$ref":"#/components/schemas/PermissionChange"},"type":"array"}},"required":["changes"],"title":"BatchUpdateParams","type":"object"}},"required":["data"]}}},"example":{"jsonrpc":"2.0","id":1,"method":"batch_update_role_permissions","params":{"data":{"changes":[{"can_delete":false,"can_execute":false,"can_read":false,"can_write":false,"resource_code":"","resource_type":"","role_id":1}]}}}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"properties":{"duration_ms":{"format":"uint128","minimum":0,"type":"integer"},"updated_count":{"format":"uint","minimum":0,"type":"integer"}},"required":["duration_ms","updated_count"],"title":"BatchUpdateResult","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"duration_ms":1,"updated_count":1}}}}}},"default":{"description":"Error (HTTP 400, 401, 403, 500 or 503). Not a JSON-RPC 2.0 error object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}}}},"/api/rpc#list_role_permissions_tree":{"post":{"operationId":"list_role_permissions_tree","summary":"Tree view of role_permission rows grouped by resource_type (AG Grid SSRM).","description":"Tree view of role_permission rows grouped by resource_type (AG Grid SSRM).\n\n**Category:** `query` (inferred). Reads data. No idempotency key, no version.\n\n**Default roles:** ADMIN. An administrator can change the grants.\n\n\n\n**Notes**\n\n- This method only reads. It changes nothing and needs no idempotency key.\n- In `filters`, a plain value means equals. An object such as `{\"$gt\": 5}` uses an operator. See 03-request-and-response-format.md.\n\n_Errors are not standard JSON-RPC 2.0 error objects. See the `Error` response._","tags":["enterprise"],"x-quark-category":"query","x-quark-category-declared":false,"x-quark-requires-idempotency":false,"x-quark-default-roles":["ADMIN"],"x-quark-versioned-entities":[],"x-quark-errors":[{"http":"400","error":"RPC_PARAMS_INVALID","when":"A parameter is missing or has the wrong type."},{"http":"401","error":"NO_AUTH","when":"No valid cookie, API key or service token."},{"http":"403","error":"RBAC_FORBIDDEN / RBAC_NO_ROLE","when":"Your role may not call this method, or you have no role in the warehouse."},{"http":"400 / 403","error":"WAREHOUSE_REQUIRED, WAREHOUSE_NOT_AVAILABLE, WAREHOUSE_SELECTOR_INVALID","when":"The `X-Warehouse-Id` header is missing, wrong or not yours."},{"http":"500","error":"SERVICE_ERROR","when":"`list_options.limit` is above 5000 (the code maps this refusal to the general error)."}],"x-quark-module":"role_permission","x-quark-operation":"read","requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","method","params"],"properties":{"jsonrpc":{"const":"2.0"},"id":{"description":"Any JSON value. Returned in the answer.","type":["integer","string"]},"method":{"const":"list_role_permissions_tree"},"params":{"type":"object","properties":{"filters":{"items":{"type":"object"},"type":"array","description":"Filter criteria"},"list_options":{"properties":{"limit":{"type":"integer"},"offset":{"type":"integer"}},"type":"object","description":"Pagination/sorting"}}}}},"example":{"jsonrpc":"2.0","id":1,"method":"list_role_permissions_tree"}}}},"responses":{"200":{"description":"Success. A failed business rule can also answer HTTP 200 with an error body (APPLICATION_RETURN): always check for `error`.","content":{"application/json":{"schema":{"type":"object","required":["jsonrpc","id","result"],"properties":{"jsonrpc":{"const":"2.0"},"id":{},"result":{"type":"object","properties":{"data":{"description":"RPC response envelope. The framework's tree action expects a top-level `items` array.","properties":{"items":{"items":{"$ref":"#/components/schemas/RolePermissionTreeRow"},"type":"array"}},"required":["items"],"title":"RolePermissionTreeResponse","type":"object"}}}}},"example":{"jsonrpc":"2.0","id":1,"result":{"data":{"items":[{"can_delete":false,"can_execute":false,"can_read":false,"can_write":false,"hierarchyLevel":1,"hierarchyPath":[""],"id":1,"is_admin_only":false,"label":"