{"schemaVersion":"1.0","sourceCommit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca","sourceVisibility":"private","article":{"id":"api-client-mansoq-web-src-lib-capabilities-api-ts","title":"Api client API reference · mansoq-web","summary":"1 client route/call declarations with path parameters, named payload/response types and source references. Exact server acceptance and permissions require the matched backend contract.","module":"IT & integrations","roles":["IT administrator","Developer","Integration engineer"],"facilities":["All configured facility types"],"kind":"reference","minutes":3,"prerequisites":["Use the API contract from the installed deployment and an authorized synthetic test environment.","Confirm facility/organization scope, action permissions and optional app enablement.","This reference is static source evidence; complete payload, authorization, failure and end-to-end review remains recorded as pending."],"steps":[],"sections":[{"title":"Client contract scope","body":"These 1 declarations come from **repositories/platform/mansoq-web/src/lib/capabilities/api.ts**. Client types and noAuth flags describe the caller; they do not authorize a server action. Dynamic paths and missing backend matches are retained as review work, not repaired into invented endpoints."},{"title":"Operation map","body":"| Client method | HTTP method | Path pattern | Resolution |\n| --- | --- | --- | --- |\n| capabilityApi.manifest | GET | `/api/v1/tenant/capabilities/` | literal |"},{"title":"capabilityApi.manifest","body":"**GET /api/v1/tenant/capabilities/**. typed route object; literal. no exact statically resolved backend match in scanned contracts.\n\n**response type:** `CapabilityManifest`. client-side declaration; not proof of accepted server payload.\n\n**CapabilityManifest declared fields:**\n\n| Field | Type | Required | Description |\n| --- | --- | --- | --- |\n| registryVersion | number | true | — |\n| accessMode | \"full\" \\| \"read_only\" \\| \"none\" | true | — |\n| capabilities | CapabilityManifestEntry[] | true | — |\n| integrationsPending | string[] | true | — |\n\n**Operational limitation:** request validation, permission checks, error statuses and irreversible side effects belong to the server implementation. An unmatched or computed client route requires contract review before use."}],"troubleshooting":[{"problem":"A declared route is unavailable or a request is rejected","solution":"Compare the installed revision, actual API schema, optional plugin mount, HTTP-method restrictions and recorded validation/permission evidence. Do not bypass a refusal or send a production transaction to test documentation."}],"sources":[{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":13,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"}],"related":["it-api-contract","it-api-auth","security-rcm-roles"],"verification":"Static API contract — behavior review pending","version":"f6e9f05f76d4","apiReferenceIds":["frontend-operation-44e78c407407d8089e"]},"backend":{"resources":[],"operations":[],"methodEvidence":[],"schemas":[],"frameworkSettings":[]},"frontend":{"operations":[{"id":"frontend-operation-44e78c407407d8089e","repository":"repositories/platform/mansoq-web","apiModule":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","operationKey":"capabilityApi.manifest","method":"GET","path":"/api/v1/tenant/capabilities/","resolution":"literal","originOmitted":false,"source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":29,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"description":"","pathParameters":[],"declaredQueryParameters":[],"request":null,"response":{"type":"CapabilityManifest","schemaIds":["repositories/platform/mansoq-web/src/lib/capabilities/api.ts#CapabilityManifest"],"source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":32,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"reviewStatus":"client-side declaration; not proof of accepted server payload"},"query":null,"clientNoAuth":null,"contractKind":"typed route object","reviewStatus":"client contract extracted; runtime behavior and authorization review pending","backendOperationIds":[],"sourceFamily":"primary frontend","backendMatchStatus":"no exact statically resolved backend match in scanned contracts"}],"schemas":[{"id":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts#CapabilityManifest","name":"CapabilityManifest","kind":"InterfaceDeclaration","description":"","source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":13,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"typeParameters":[],"fields":[{"name":"registryVersion","type":"number","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":14,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]},{"name":"accessMode","type":"\"full\" | \"read_only\" | \"none\"","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":15,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]},{"name":"capabilities","type":"CapabilityManifestEntry[]","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":16,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":["repositories/platform/mansoq-web/src/lib/capabilities/api.ts#CapabilityManifestEntry"]},{"name":"integrationsPending","type":"string[]","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":17,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]}],"baseSchemaIds":[],"reviewStatus":"declared TypeScript fields extracted; server payload/validation review pending","baseTypes":[]},{"id":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts#CapabilityManifestEntry","name":"CapabilityManifestEntry","kind":"InterfaceDeclaration","description":"","source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":6,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"typeParameters":[],"fields":[{"name":"key","type":"string","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":7,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]},{"name":"entitled","type":"boolean","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":8,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]},{"name":"state","type":"CapabilityState","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":9,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":["repositories/platform/mansoq-web/src/lib/capabilities/api.ts#CapabilityState"]},{"name":"surfaces","type":"string[]","required":true,"readOnly":false,"hasInitializer":false,"description":"","source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":10,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"schemaIds":[]}],"baseSchemaIds":[],"reviewStatus":"declared TypeScript fields extracted; server payload/validation review pending","baseTypes":[]},{"id":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts#CapabilityState","name":"CapabilityState","kind":"TypeAliasDeclaration","description":"","source":{"path":"repositories/platform/mansoq-web/src/lib/capabilities/api.ts","line":3,"commit":"f6e9f05f76d443b26ebd2369f67d3c3bd52257ca"},"typeParameters":[],"fields":[],"baseSchemaIds":[],"reviewStatus":"declared TypeScript fields extracted; server payload/validation review pending","expression":"\"available\" | \"integration_pending\" | \"read_only\" | \"unavailable\""}]},"services":{"operations":[]},"boundaries":[]}