Give a lost report to a team, an officer on it, or both, and tell them.
Give a lost report to a team, an officer on it, or both, and tell them.
⌘I
{"docsConfig":{"theme":"almond","$schema":"https://mintlify.com/docs.json","name":"Asset Infinity","colors":{"primary":"#ec6952","light":"#ec6952","dark":"#c64732"},"logo":{"light":"https://mintcdn.com/assetinfinity/w2FOWpON9FCQXe__/logo/light.png?fit=max\u0026auto=format\u0026n=w2FOWpON9FCQXe__\u0026q=85\u0026s=c14e1c3e885f59c704e87db541e12345","dark":"https://mintcdn.com/assetinfinity/w2FOWpON9FCQXe__/logo/dark.png?fit=max\u0026auto=format\u0026n=w2FOWpON9FCQXe__\u0026q=85\u0026s=70858988002f8192362370c6e557cdc3"},"favicon":"https://mintcdn.com/assetinfinity/w2FOWpON9FCQXe__/favicon.png?fit=max\u0026auto=format\u0026n=w2FOWpON9FCQXe__\u0026q=85\u0026s=35520ffab1d50def4b447cb89b22b469","navbar":{"links":[{"href":"mailto:support@assetinfinity.com","label":"Support"}],"primary":{"type":"button","label":"Get Started Free","href":"https://www.assetinfinity.com"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/asset-infinity"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"assetinfinity","hasAudioNarration":false,"actualSubdomain":"assetinfinity","customDomains":["docs.assetinfinity.ai"],"gitSource":{"type":"github","owner":"asset-infinity","repo":"asset-infinity-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"latestBuiltDeploymentHistoryId":"6aeb4d92b434e7d02a3b2fe6","collectionId":"c0935c9c-bd9a-4c5c-a987-eac3838e08af","liveDeploymentHistoryId":"6aeb4d92b434e7d02a3b2fe6","schemaVersion":"v3"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6aeb68e74c41472c0b9b2ff8","clientVersion":"0.0.4054","searchFilterCounts":[{"language":"default","tag":"Complete API","count":2120},{"language":"default","tag":"Every endpoint","count":2120},{"language":"default","tag":"User Guide","count":107},{"language":"default","tag":"Procurement","count":82},{"language":"default","tag":"IT assets","count":75},{"language":"default","tag":"Finance","count":71},{"language":"default","tag":"Bookings","count":66},{"language":"default","tag":"Work lifecycle","count":64},{"language":"default","tag":"Administration","count":63},{"language":"default","tag":"API Reference","count":59}],"searchSettings":{"showContentSnippets":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"privacy":{"consentBanner":{"enabled":true}},"googleFontsInlined":true},"customCss":[],"page":{"pagePath":"api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them","slug":"/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them","pageMetadata":{"title":"Give a lost report to a team, an officer on it, or both, and tell them.","description":"Give a lost report to a team, an officer on it, or both, and tell them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assign_lost_report","href":"/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Give a lost report to a team, an officer on it, or both, and tell them.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Give a lost report to a team, an officer on it, or both, and tell them.","description":"Give a lost report to a team, an officer on it, or both, and tell them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assign_lost_report","href":"/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"subdomain":"assetinfinity","siteName":"Asset Infinity","title":"Give a lost report to a team, an officer on it, or both, and tell them. - Asset Infinity","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-04T17:19:58.844Z","originalFileLocation":"api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Give a lost report to a team, an officer on it, or both, and tell them.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Asset Infinity\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/assetinfinity/XNTZ96UIzuJW4E8-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/assetinfinity/XNTZ96UIzuJW4E8-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/assetinfinity/XNTZ96UIzuJW4E8-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/assetinfinity/XNTZ96UIzuJW4E8-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/assetinfinity/XNTZ96UIzuJW4E8-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/assetinfinity/XNTZ96UIzuJW4E8-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/assetinfinity/XNTZ96UIzuJW4E8-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/assetinfinity/XNTZ96UIzuJW4E8-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/assetinfinity/XNTZ96UIzuJW4E8-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Give a lost report to a team, an officer on it, or both, and tell them. - Asset Infinity\">\u003cmeta data-mint-head property=\"og:description\" content=\"Give a lost report to a team, an officer on it, or both, and tell them.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Asset Infinity\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.assetinfinity.ai/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://assetinfinity.mintlify.app/_mintlify/api/og/v2?division=Lost+and+found\u0026amp;title=Give+a+lost+report+to+a+team%2C+an+officer+on+it%2C+or+both%2C+and+tell+them.\u0026amp;description=Give+a+lost+report+to+a+team%2C+an+officer+on+it%2C+or+both%2C+and+tell+them.\u0026amp;theme=8978f52c6929a3182dbed8b9\u0026amp;signature=20fe79201bfaddb89f924f232c81aae7894c7e0088fd645217326f4a71909898\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Give a lost report to a team, an officer on it, or both, and tell them. - Asset Infinity\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Give a lost report to a team, an officer on it, or both, and tell them.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://assetinfinity.mintlify.app/_mintlify/api/og/v2?division=Lost+and+found\u0026amp;title=Give+a+lost+report+to+a+team%2C+an+officer+on+it%2C+or+both%2C+and+tell+them.\u0026amp;description=Give+a+lost+report+to+a+team%2C+an+officer+on+it%2C+or+both%2C+and+tell+them.\u0026amp;theme=8978f52c6929a3182dbed8b9\u0026amp;signature=20fe79201bfaddb89f924f232c81aae7894c7e0088fd645217326f4a71909898\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/assetinfinity/XNTZ96UIzuJW4E8-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Asset Infinity\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#ec6952\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.assetinfinity.ai/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.assetinfinity.ai/#organization\",\"name\":\"Asset Infinity\",\"url\":\"https://docs.assetinfinity.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/assetinfinity/w2FOWpON9FCQXe__/logo/light.png?fit=max\u0026auto=format\u0026n=w2FOWpON9FCQXe__\u0026q=85\u0026s=c14e1c3e885f59c704e87db541e12345\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.assetinfinity.ai#website\",\"name\":\"Asset Infinity\",\"url\":\"https://docs.assetinfinity.ai\",\"publisher\":{\"@id\":\"https://docs.assetinfinity.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.assetinfinity.ai/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them#webpage\",\"url\":\"https://docs.assetinfinity.ai/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them\",\"name\":\"Give a lost report to a team, an officer on it, or both, and tell them.\",\"description\":\"Give a lost report to a team, an officer on it, or both, and tell them.\",\"dateModified\":\"2026-11-04T17:19:58.844Z\",\"isPartOf\":{\"@id\":\"https://docs.assetinfinity.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.assetinfinity.ai/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.assetinfinity.ai/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Every endpoint\",\"item\":\"https://docs.assetinfinity.ai/api-reference/checklists/every-round-a-maintenance-schedule-has-generated-including-the-rounds-activity-merge-skipped\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Lost and found\",\"item\":\"https://docs.assetinfinity.ai/api-reference/lost-and-found/property-handed-in-where-it-is-kept-how-long-it-has-been-there-who-took-it-away-and-what-they-proved-and-what-a%E2%80%A6\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Give a lost report to a team, an officer on it, or both, and tell them.\",\"item\":\"https://docs.assetinfinity.ai/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.assetinfinity.ai/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them#apireference\",\"headline\":\"Give a lost report to a team, an officer on it, or both, and tell them.\",\"name\":\"Give a lost report to a team, an officer on it, or both, and tell them.\",\"description\":\"Give a lost report to a team, an officer on it, or both, and tell them.\",\"url\":\"https://docs.assetinfinity.ai/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them\",\"mainEntityOfPage\":{\"@id\":\"https://docs.assetinfinity.ai/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them#webpage\"},\"dateModified\":\"2026-11-04T17:19:58.844Z\",\"publisher\":{\"@id\":\"https://docs.assetinfinity.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.assetinfinity.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Asset Infinity\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Asset Infinity","nav":{"global":null,"tabs":[{"tab":"User Guide","pages":[{"title":"User Guide","href":"/introduction"}]},{"tab":"Administration","pages":[{"title":"Administration","href":"/setup/overview"}]},{"tab":"API Reference","icon":"code","pages":[{"title":"API Reference","href":"/api-reference/introduction"}]},{"tab":"Complete API","icon":"list","groups":[{"group":"Every endpoint","pages":[{"group":"Checklists","pages":[{"title":"Every round a maintenance schedule has generated, including the rounds activity merge skipped.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /activity_creation_summary","href":"/api-reference/checklists/every-round-a-maintenance-schedule-has-generated-including-the-rounds-activity-merge-skipped"},{"title":"The maintenance plans one asset is on, however it got there.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_maintenance_plans","href":"/api-reference/checklists/the-maintenance-plans-one-asset-is-on-however-it-got-there"},{"title":"Maintenance occurrences that are due, with the plan and asset behind each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenance_due","href":"/api-reference/checklists/maintenance-occurrences-that-are-due-with-the-plan-and-asset-behind-each"},{"title":"What a plan needs, in the same shape the readiness engine reads for a job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenance_plan_requirements","href":"/api-reference/checklists/what-a-plan-needs-in-the-same-shape-the-readiness-engine-reads-for-a-job"},{"title":"A plan's scope in one list: named assets, asset categories, asset types, and the places whose rounds are against the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenance_plan_scope","href":"/api-reference/checklists/a-plans-scope-in-one-list:-named-assets-asset-categories-asset-types-and-the-places-whose-rounds-are-against-the…"},{"title":"What a plan's checklist is made of, in order: the templates it was built from and the runs of steps somebody typed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenance_plan_task_blocks","href":"/api-reference/checklists/what-a-plans-checklist-is-made-of-in-order:-the-templates-it-was-built-from-and-the-runs-of-steps-somebody-typed"},{"title":"The steps of a template version, in order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /task_template_items","href":"/api-reference/checklists/the-steps-of-a-template-version-in-order"},{"title":"The checklist library a maintenance plan can be built from, with enough about each one to choose between two similar…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /task_templates","href":"/api-reference/checklists/the-checklist-library-a-maintenance-plan-can-be-built-from-with-enough-about-each-one-to-choose-between-two-similar…"}]},{"group":"API keys","pages":[{"title":"Every key this organisation has issued — its prefix, its scopes, its state and what it has been used for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api_keys","href":"/api-reference/api-keys/every-key-this-organisation-has-issued-—-its-prefix-its-scopes-its-state-and-what-it-has-been-used-for"},{"title":"Normalise a key's scope list, refusing a code that matches no permission and a code the account does not hold.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/check_key_scopes","href":"/api-reference/api-keys/normalise-a-keys-scope-list-refusing-a-code-that-matches-no-permission-and-a-code-the-account-does-not-hold"},{"title":"Issue a key for a service account and return it once.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_api_key","href":"/api-reference/api-keys/issue-a-key-for-a-service-account-and-return-it-once"},{"title":"Create a machine identity and the account row that carries its roles.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_service_account","href":"/api-reference/api-keys/create-a-machine-identity-and-the-account-row-that-carries-its-roles"},{"title":"Trade an api key for a session token of at most fifteen minutes, and send that token as `Authorization: Bearer` on…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/exchange_api_key","href":"/api-reference/api-keys/trade-an-api-key-for-a-session-token-of-at-most-fifteen-minutes-and-send-that-token-as-`authorization:-bearer`-on…"},{"title":"Refuse a caller authenticated by an api key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_a_person","href":"/api-reference/api-keys/refuse-a-caller-authenticated-by-an-api-key"},{"title":"End a key, with a reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revoke_api_key","href":"/api-reference/api-keys/end-a-key-with-a-reason"},{"title":"Issue a successor with the same name, scopes and account, and give the predecessor a grace window to be replaced in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rotate_api_key","href":"/api-reference/api-keys/issue-a-successor-with-the-same-name-scopes-and-account-and-give-the-predecessor-a-grace-window-to-be-replaced-in"},{"title":"Stop or restart a machine identity.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_service_account_active","href":"/api-reference/api-keys/stop-or-restart-a-machine-identity"},{"title":"Allow or stop this machine identity acting as a named person.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_service_account_may_act_for_people","href":"/api-reference/api-keys/allow-or-stop-this-machine-identity-acting-as-a-named-person"},{"title":"This organisation's machine identities, with the roles a key issued against each would resolve through and how many…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /service_accounts","href":"/api-reference/api-keys/this-organisations-machine-identities-with-the-roles-a-key-issued-against-each-would-resolve-through-and-how-many…"}]},{"group":"Workflows","pages":[{"title":"Who may decide in whose name, between which dates, and whether that is in force today.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /approval_delegation_settings","href":"/api-reference/workflows/who-may-decide-in-whose-name-between-which-dates-and-whether-that-is-in-force-today"},{"title":"The lines of a held request, with everybody's standing verdict on each and the caller's own.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /approval_items","href":"/api-reference/workflows/the-lines-of-a-held-request-with-everybodys-standing-verdict-on-each-and-the-callers-own"},{"title":"Steps somebody has asked the caller to look at before they are signed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_acknowledgements","href":"/api-reference/workflows/steps-somebody-has-asked-the-caller-to-look-at-before-they-are-signed"},{"title":"Everything waiting on the caller to decide, and how long it has been waiting. may_revise and may_rollback say whether…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_approvals","href":"/api-reference/workflows/everything-waiting-on-the-caller-to-decide-and-how-long-it-has-been-waiting-may_revise-and-may_rollback-say-whether…"},{"title":"Whose authority the signed-in person may use today, and until when.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_delegations","href":"/api-reference/workflows/whose-authority-the-signed-in-person-may-use-today-and-until-when"},{"title":"Everybody who could be asked to look at this step, which is everybody who could see the request.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/acknowledgement_candidates","href":"/api-reference/workflows/everybody-who-could-be-asked-to-look-at-this-step-which-is-everybody-who-could-see-the-request"},{"title":"Change a field on a held request at a level configured to change it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/amend_request_field","href":"/api-reference/workflows/change-a-field-on-a-held-request-at-a-level-configured-to-change-it"},{"title":"Acknowledge an approval step, or decline it — which turns the request down.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/answer_acknowledgement","href":"/api-reference/workflows/acknowledge-an-approval-step-or-decline-it-—-which-turns-the-request-down"},{"title":"Acknowledge or decline many approval steps in one call.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_answer_acknowledgements","href":"/api-reference/workflows/acknowledge-or-decline-many-approval-steps-in-one-call"},{"title":"Approve or reject many held steps in one call, each against the authority its own step names.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_decide_tasks","href":"/api-reference/workflows/approve-or-reject-many-held-steps-in-one-call-each-against-the-authority-its-own-step-names"},{"title":"Send many held steps' requests back to whoever raised each of them, for them to correct, in one call, with one note…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_send_for_revision","href":"/api-reference/workflows/send-many-held-steps-requests-back-to-whoever-raised-each-of-them-for-them-to-correct-in-one-call-with-one-note…"},{"title":"Roll many held steps back to the level before each of them in one call, with one note that goes with every one, in your…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_send_tasks_back","href":"/api-reference/workflows/roll-many-held-steps-back-to-the-level-before-each-of-them-in-one-call-with-one-note-that-goes-with-every-one-in-your…"},{"title":"Withdraw many of your own undecided requests in one call.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_withdraw_requests","href":"/api-reference/workflows/withdraw-many-of-your-own-undecided-requests-in-one-call"},{"title":"Take back an unanswered request for an acknowledgement, releasing the step.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_acknowledgement","href":"/api-reference/workflows/take-back-an-unanswered-request-for-an-acknowledgement-releasing-the-step"},{"title":"Approve, cut, reject or send back one line of a request you are being asked to sign.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decide_approval_item","href":"/api-reference/workflows/approve-cut-reject-or-send-back-one-line-of-a-request-you-are-being-asked-to-sign"},{"title":"Decide the approval step an emailed decision link is for, as the person it was sent to and under their own authority…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decide_by_approval_link","href":"/api-reference/workflows/decide-the-approval-step-an-emailed-decision-link-is-for-as-the-person-it-was-sent-to-and-under-their-own-authority…"},{"title":"Approve or reject one step of a held request, against the authority the step itself names.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decide_task","href":"/api-reference/workflows/approve-or-reject-one-step-of-a-held-request-against-the-authority-the-step-itself-names"},{"title":"Who the caller could forward this approval step to: everybody who could see the request, less the caller, whoever…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/forward_candidates","href":"/api-reference/workflows/who-the-caller-could-forward-this-approval-step-to:-everybody-who-could-see-the-request-less-the-caller-whoever…"},{"title":"Hand the caller's own place on an approval step to somebody they name, with a reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/forward_task","href":"/api-reference/workflows/hand-the-callers-own-place-on-an-approval-step-to-somebody-they-name-with-a-reason"},{"title":"Read the approval step an emailed decision link is for: what it asks, who asked, and which of approve, forward, send…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/open_approval_link","href":"/api-reference/workflows/read-the-approval-step-an-emailed-decision-link-is-for:-what-it-asks-who-asked-and-which-of-approve-forward-send…"},{"title":"Ask people to look at an approval step before it is signed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_acknowledgement","href":"/api-reference/workflows/ask-people-to-look-at-an-approval-step-before-it-is-signed"},{"title":"Send a request that was sent back to you for revision to its approvers again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resubmit_request","href":"/api-reference/workflows/send-a-request-that-was-sent-back-to-you-for-revision-to-its-approvers-again"},{"title":"Correct the form of a request that was sent back to you for revision: its values, whole, and its custom answers where…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revise_request_values","href":"/api-reference/workflows/correct-the-form-of-a-request-that-was-sent-back-to-you-for-revision:-its-values-whole-and-its-custom-answers-where…"},{"title":"Send one step's request back to whoever raised it, for them to correct, with what needs changing — in your own name, or…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/send_for_revision","href":"/api-reference/workflows/send-one-steps-request-back-to-whoever-raised-it-for-them-to-correct-with-what-needs-changing-—-in-your-own-name-or…"},{"title":"Roll one step of a held request back to the level before it — the nearest steps behind it in the chain that approved…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/send_task_back","href":"/api-reference/workflows/roll-one-step-of-a-held-request-back-to-the-level-before-it-—-the-nearest-steps-behind-it-in-the-chain-that-approved…"},{"title":"Withdraw your own request for approval before anybody has decided it, or one that has been sent back to you for…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/withdraw_request","href":"/api-reference/workflows/withdraw-your-own-request-for-approval-before-anybody-has-decided-it-or-one-that-has-been-sent-back-to-you-for…"},{"title":"Tenant-wide counts of what is running, with its initiator for revision, stuck, late or failed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/workflow_health","href":"/api-reference/workflows/tenant-wide-counts-of-what-is-running-with-its-initiator-for-revision-stuck-late-or-failed"},{"title":"What a held call is asking for, argument by argument, for a request that has no form behind it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/workflow_request_asked","href":"/api-reference/workflows/what-a-held-call-is-asking-for-argument-by-argument-for-a-request-that-has-no-form-behind-it"},{"title":"The fields a request changes, each with what it was and what it becomes — compared live while the request waits, and as…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/workflow_request_changes","href":"/api-reference/workflows/the-fields-a-request-changes-each-with-what-it-was-and-what-it-becomes-—-compared-live-while-the-request-waits-and-as…"},{"title":"The organisation's own fields on a request to create a record, with the answers and files the requester gave.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/workflow_request_custom_fields","href":"/api-reference/workflows/the-organisations-own-fields-on-a-request-to-create-a-record-with-the-answers-and-files-the-requester-gave"},{"title":"Every field of the record a held request is about, and the ones it would change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/workflow_request_facts","href":"/api-reference/workflows/every-field-of-the-record-a-held-request-is-about-and-the-ones-it-would-change"},{"title":"What a request that was sent back to you for revision holds, as the values it was raised with rather than as the words…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/workflow_request_revision","href":"/api-reference/workflows/what-a-request-that-was-sent-back-to-you-for-revision-holds-as-the-values-it-was-raised-with-rather-than-as-the-words…"},{"title":"The record a held request is about — which register, and which row of it — so the record's custom fields and files can…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/workflow_request_subject","href":"/api-reference/workflows/the-record-a-held-request-is-about-—-which-register-and-which-row-of-it-—-so-the-records-custom-fields-and-files-can…"},{"title":"Every level of every SLA extension asked for on a work order: who asked and when, how the level stands, who approved it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_sla_extension_approvals","href":"/api-reference/workflows/every-level-of-every-sla-extension-asked-for-on-a-work-order:-who-asked-and-when-how-the-level-stands-who-approved-it…"},{"title":"Who an approver has asked to look at a step before signing it, and what they answered.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_acknowledgements","href":"/api-reference/workflows/who-an-approver-has-asked-to-look-at-a-step-before-signing-it-and-what-they-answered"},{"title":"Every field a level changed on a request it was approving, with the step and the person, and every field its initiator…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_field_changes","href":"/api-reference/workflows/every-field-a-level-changed-on-a-request-it-was-approving-with-the-step-and-the-person-and-every-field-its-initiator…"},{"title":"Every level of a held request in order, including those still to come, and who signs each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_request_levels","href":"/api-reference/workflows/every-level-of-a-held-request-in-order-including-those-still-to-come-and-who-signs-each"},{"title":"Every time a request was rolled back, sent to its initiator for revision, or resubmitted by them: the step, who acted…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_request_returns","href":"/api-reference/workflows/every-time-a-request-was-rolled-back-sent-to-its-initiator-for-revision-or-resubmitted-by-them:-the-step-who-acted…"},{"title":"The steps of a held request, who each waits for, and whether it waits for the caller.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_request_steps","href":"/api-reference/workflows/the-steps-of-a-held-request-who-each-waits-for-and-whether-it-waits-for-the-caller"},{"title":"Held actions: what was asked for, who asked, and where it has got to. display_status is the status to show (PENDING…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_requests","href":"/api-reference/workflows/held-actions:-what-was-asked-for-who-asked-and-where-it-has-got-to-display_status-is-the-status-to-show-pending…"},{"title":"The fields a level asks about on one open step, and whether the request answers them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_step_fields","href":"/api-reference/workflows/the-fields-a-level-asks-about-on-one-open-step-and-whether-the-request-answers-them"},{"title":"Configured approval workflows, with the published version, when it runs, and what it has held.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflows","href":"/api-reference/workflows/configured-approval-workflows-with-the-published-version-when-it-runs-and-what-it-has-held"}]},{"group":"Finance","pages":[{"title":"A block of assets, year by year: what it opened at, what went in at each rate, what came out, and what it closed at.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_blocks","href":"/api-reference/finance/a-block-of-assets-year-by-year:-what-it-opened-at-what-went-in-at-each-rate-what-came-out-and-what-it-closed-at"},{"title":"The finance-side classification of the fleet, with how much of it is filed under each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_classes","href":"/api-reference/finance/the-finance-side-classification-of-the-fleet-with-how-much-of-it-is-filed-under-each"},{"title":"Add to asset classes: The finance-side classification of the fleet, with how much of it is filed under each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /asset_classes","href":"/api-reference/finance/add-to-asset-classes:-the-finance-side-classification-of-the-fleet-with-how-much-of-it-is-filed-under-each"},{"title":"Remove rows from asset classes: The finance-side classification of the fleet, with how much of it is filed under each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /asset_classes","href":"/api-reference/finance/remove-rows-from-asset-classes:-the-finance-side-classification-of-the-fleet-with-how-much-of-it-is-filed-under-each"},{"title":"Change rows in asset classes: The finance-side classification of the fleet, with how much of it is filed under each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /asset_classes","href":"/api-reference/finance/change-rows-in-asset-classes:-the-finance-side-classification-of-the-fleet-with-how-much-of-it-is-filed-under-each"},{"title":"What an asset has cost, event by event, with the rate each figure was frozen at.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_cost_events","href":"/api-reference/finance/what-an-asset-has-cost-event-by-event-with-the-rate-each-figure-was-frozen-at"},{"title":"Asset cost events with every field of the records each row points at: asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_cost_events_expanded","href":"/api-reference/finance/asset-cost-events-with-every-field-of-the-records-each-row-points-at:-asset"},{"title":"The fixed asset register: one row per asset per book, with its carrying amount.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_depreciation","href":"/api-reference/finance/the-fixed-asset-register:-one-row-per-asset-per-book-with-its-carrying-amount"},{"title":"What has left, what was received, and whether the plant's own register has caught up.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_disposals","href":"/api-reference/finance/what-has-left-what-was-received-and-whether-the-plants-own-register-has-caught-up"},{"title":"Which policy each book applies to which class, from when, and which of them is in force today.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /book_policy_rules","href":"/api-reference/finance/which-policy-each-book-applies-to-which-class-from-when-and-which-of-them-is-in-force-today"},{"title":"Where each piece of a project's cost came from, back to the invoice line and the vendor.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capital_project_costs","href":"/api-reference/finance/where-each-piece-of-a-projects-cost-came-from-back-to-the-invoice-line-and-the-vendor"},{"title":"Cost accumulating before there is an asset to carry it, and whether it should have been capitalised by now.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capital_projects","href":"/api-reference/finance/cost-accumulating-before-there-is-an-asset-to-carry-it-and-whether-it-should-have-been-capitalised-by-now"},{"title":"Assets whose status says they have left, in the books still carrying them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /carried_after_disposal","href":"/api-reference/finance/assets-whose-status-says-they-have-left-in-the-books-still-carrying-them"},{"title":"Which asset class each book starts an asset in, read from the maintenance category it is filed under.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /category_class_defaults","href":"/api-reference/finance/which-asset-class-each-book-starts-an-asset-in-read-from-the-maintenance-category-it-is-filed-under"},{"title":"Every accounting book, with what it carries, how far it has been posted, and whether it is configured well enough to…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /depreciation_books","href":"/api-reference/finance/every-accounting-book-with-what-it-carries-how-far-it-has-been-posted-and-whether-it-is-configured-well-enough-to…"},{"title":"What a pack is made of, in the words a person checking it against the statute needs: every book, class and policy it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /depreciation_pack_contents","href":"/api-reference/finance/what-a-pack-is-made-of-in-the-words-a-person-checking-it-against-the-statute-needs:-every-book-class-and-policy-it…"},{"title":"The country packs this product ships, against each of this tenant's companies: what each would create, which one…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /depreciation_packs","href":"/api-reference/finance/the-country-packs-this-product-ships-against-each-of-this-tenants-companies:-what-each-would-create-which-one…"},{"title":"The named rule sets a book resolves: method, life or rate, residual, and how a part period is charged.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /depreciation_policies","href":"/api-reference/finance/the-named-rule-sets-a-book-resolves:-method-life-or-rate-residual-and-how-a-part-period-is-charged"},{"title":"The enrolments a run considered and could not charge, with the reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /depreciation_run_exceptions","href":"/api-reference/finance/the-enrolments-a-run-considered-and-could-not-charge-with-the-reason"},{"title":"One asset's charge for one period, with every input that produced it — so the figure can be taken apart without anybody…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /depreciation_run_lines","href":"/api-reference/finance/one-assets-charge-for-one-period-with-every-input-that-produced-it-—-so-the-figure-can-be-taken-apart-without-anybody…"},{"title":"Every run: what it charged, who calculated it, who posted it, and what it reverses.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /depreciation_runs","href":"/api-reference/finance/every-run:-what-it-charged-who-calculated-it-who-posted-it-and-what-it-reverses"},{"title":"What each book made of a disposal.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /disposal_results","href":"/api-reference/finance/what-each-book-made-of-a-disposal"},{"title":"Every change of estimate: what it was, what it became, from which period, and why.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /enrolment_revisions","href":"/api-reference/finance/every-change-of-estimate:-what-it-was-what-it-became-from-which-period-and-why"},{"title":"A calendar's periods and what each one is: open, closed, or locked.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /fiscal_periods","href":"/api-reference/finance/a-calendars-periods-and-what-each-one-is:-open-closed-or-locked"},{"title":"The account codes a journal may carry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /gl_accounts","href":"/api-reference/finance/the-account-codes-a-journal-may-carry"},{"title":"The journals waiting to go to the ledger, and the ones already handed over.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /journal_batches","href":"/api-reference/finance/the-journals-waiting-to-go-to-the-ledger-and-the-ones-already-handed-over"},{"title":"The entry itself: an account, a cost centre, a side and an amount.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /journal_lines","href":"/api-reference/finance/the-entry-itself:-an-account-a-cost-centre-a-side-and-an-amount"},{"title":"A cutover file, staged and checked line by line before anybody agrees to believe it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /opening_balances","href":"/api-reference/finance/a-cutover-file-staged-and-checked-line-by-line-before-anybody-agrees-to-believe-it"},{"title":"Where each book's depreciation lands: one account debited, one credited, by class.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /posting_rules","href":"/api-reference/finance/where-each-books-depreciation-lands:-one-account-debited-one-credited-by-class"},{"title":"This tenant's own copies of the statutory schedules, with what each one sums to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rate_tables","href":"/api-reference/finance/this-tenants-own-copies-of-the-statutory-schedules-with-what-each-one-sums-to"},{"title":"Add to rate tables: This tenant's own copies of the statutory schedules, with what each one sums to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rate_tables","href":"/api-reference/finance/add-to-rate-tables:-this-tenants-own-copies-of-the-statutory-schedules-with-what-each-one-sums-to"},{"title":"Remove rows from rate tables: This tenant's own copies of the statutory schedules, with what each one sums to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /rate_tables","href":"/api-reference/finance/remove-rows-from-rate-tables:-this-tenants-own-copies-of-the-statutory-schedules-with-what-each-one-sums-to"},{"title":"Change rows in rate tables: This tenant's own copies of the statutory schedules, with what each one sums to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /rate_tables","href":"/api-reference/finance/change-rows-in-rate-tables:-this-tenants-own-copies-of-the-statutory-schedules-with-what-each-one-sums-to"},{"title":"Add cost to a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_project_cost","href":"/api-reference/finance/add-cost-to-a-project"},{"title":"Capitalise every ready cutover line.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/apply_opening_balances","href":"/api-reference/finance/capitalise-every-ready-cutover-line"},{"title":"What a machine and its components are worth together, per book.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_component_rollup","href":"/api-reference/finance/what-a-machine-and-its-components-are-worth-together-per-book"},{"title":"What one machine is worth, in every book that has an opinion about it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_depreciation_summary","href":"/api-reference/finance/what-one-machine-is-worth-in-every-book-that-has-an-opinion-about-it"},{"title":"What a single Dispose action can do to this asset right now: the subledger half, the state model half, and the reason…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_disposal_plan","href":"/api-reference/finance/what-a-single-dispose-action-can-do-to-this-asset-right-now:-the-subledger-half-the-state-model-half-and-the-reason…"},{"title":"What a Dispose action can do to each of these assets right now: the subledger half, the state model half, and the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_disposal_plans","href":"/api-reference/finance/what-a-dispose-action-can-do-to-each-of-these-assets-right-now:-the-subledger-half-the-state-model-half-and-the…"},{"title":"Build the journal for a disposal whose accounts were not mapped when it happened.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/build_disposal_journal","href":"/api-reference/finance/build-the-journal-for-a-disposal-whose-accounts-were-not-mapped-when-it-happened"},{"title":"Record many machines leaving, one outcome row each, with what was received for each one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_dispose_assets","href":"/api-reference/finance/record-many-machines-leaving-one-outcome-row-each-with-what-was-received-for-each-one"},{"title":"Work out one book's depreciation for one period.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/calculate_depreciation","href":"/api-reference/finance/work-out-one-books-depreciation-for-one-period"},{"title":"Put an asset into a book at a cost from a date, freezing the rate it will be carried at.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capitalise_asset","href":"/api-reference/finance/put-an-asset-into-a-book-at-a-cost-from-a-date-freezing-the-rate-it-will-be-carried-at"},{"title":"Depreciate a right-of-use asset over its lease term.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capitalise_lease","href":"/api-reference/finance/depreciate-a-right-of-use-asset-over-its-lease-term"},{"title":"Turn an accumulated project into assets.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capitalise_project","href":"/api-reference/finance/turn-an-accumulated-project-into-assets"},{"title":"Close a period, or lock it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/close_fiscal_period","href":"/api-reference/finance/close-a-period-or-lock-it"},{"title":"Open a capital project: cost accumulating before there is an asset to carry it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_capital_project","href":"/api-reference/finance/open-a-capital-project:-cost-accumulating-before-there-is-an-asset-to-carry-it"},{"title":"Delete every period of a financial year, if all of it is open and none of it has a run against it — posted or draft.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_fiscal_year","href":"/api-reference/finance/delete-every-period-of-a-financial-year-if-all-of-it-is-open-and-none-of-it-has-a-run-against-it-—-posted-or-draft"},{"title":"Discard a staged cutover.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/discard_opening_balances","href":"/api-reference/finance/discard-a-staged-cutover"},{"title":"Record a machine leaving, with a gain or loss per book that carried it and a reduction of the block for one that did…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispose_asset","href":"/api-reference/finance/record-a-machine-leaving-with-a-gain-or-loss-per-book-that-carried-it-and-a-reduction-of-the-block-for-one-that-did…"},{"title":"The journal, and the record that it was handed over.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/export_journal_batch","href":"/api-reference/finance/the-journal-and-the-record-that-it-was-handed-over"},{"title":"Write an asset down to its recoverable amount, taking the revaluation reserve first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/impair_asset","href":"/api-reference/finance/write-an-asset-down-to-its-recoverable-amount-taking-the-revaluation-reserve-first"},{"title":"Set a company up from a shipped country pack: its calendars, books, classes, policies and rules.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/install_depreciation_pack","href":"/api-reference/finance/set-a-company-up-from-a-shipped-country-pack:-its-calendars-books-classes-policies-and-rules"},{"title":"Copy a shipped statutory schedule into this tenant.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/install_rate_table","href":"/api-reference/finance/copy-a-shipped-statutory-schedule-into-this-tenant"},{"title":"Post a draft run.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/post_depreciation_run","href":"/api-reference/finance/post-a-draft-run"},{"title":"Hand a journal to the ledger through the outbox.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_journal_batch","href":"/api-reference/finance/hand-a-journal-to-the-ledger-through-the-outbox"},{"title":"Revalue an asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revalue_asset","href":"/api-reference/finance/revalue-an-asset"},{"title":"Reverse a posted run with an opposite entry and reopen its period.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reverse_depreciation_run","href":"/api-reference/finance/reverse-a-posted-run-with-an-opposite-entry-and-reopen-its-period"},{"title":"Change a useful life, residual or class from the current period forward, with the reason on the record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revise_depreciation","href":"/api-reference/finance/change-a-useful-life-residual-or-class-from-the-current-period-forward-with-the-reason-on-the-record"},{"title":"Load a cutover file against a book and check every line.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/stage_opening_balances","href":"/api-reference/finance/load-a-cutover-file-against-a-book-and-check-every-line"},{"title":"Enrolments whose accumulated depreciation disagrees with their own ledger.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unreconciled_depreciation","href":"/api-reference/finance/enrolments-whose-accumulated-depreciation-disagrees-with-their-own-ledger"},{"title":"The statutory schedules this product ships, and whether this tenant has installed each one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /shipped_rate_sets","href":"/api-reference/finance/the-statutory-schedules-this-product-ships-and-whether-this-tenant-has-installed-each-one"},{"title":"Add to shipped rate sets: The statutory schedules this product ships, and whether this tenant has installed each one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /shipped_rate_sets","href":"/api-reference/finance/add-to-shipped-rate-sets:-the-statutory-schedules-this-product-ships-and-whether-this-tenant-has-installed-each-one"},{"title":"Remove rows from shipped rate sets: The statutory schedules this product ships, and whether this tenant has installed each one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /shipped_rate_sets","href":"/api-reference/finance/remove-rows-from-shipped-rate-sets:-the-statutory-schedules-this-product-ships-and-whether-this-tenant-has-installed-each-one"},{"title":"Change rows in shipped rate sets: The statutory schedules this product ships, and whether this tenant has installed each one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /shipped_rate_sets","href":"/api-reference/finance/change-rows-in-shipped-rate-sets:-the-statutory-schedules-this-product-ships-and-whether-this-tenant-has-installed-each-one"}]},{"group":"Assets","pages":[{"title":"An asset's parts list with available stock per line, so the screen answers \"can we do this\".","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_bom","href":"/api-reference/assets/an-assets-parts-list-with-available-stock-per-line-so-the-screen-answers-\"can-we-do-this\""},{"title":"Contracts covering each asset today.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_contracts","href":"/api-reference/assets/contracts-covering-each-asset-today"},{"title":"What has been spent on an asset, against what a new one would cost and against the hours it has run — the two figures…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_cost_to_keep","href":"/api-reference/assets/what-has-been-spent-on-an-asset-against-what-a-new-one-would-cost-and-against-the-hours-it-has-run-—-the-two-figures…"},{"title":"The site as one tree.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_hierarchy","href":"/api-reference/assets/the-site-as-one-tree"},{"title":"Meters with their latest reading, the one before it, and the resulting rate per day.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_meters","href":"/api-reference/assets/meters-with-their-latest-reading-the-one-before-it-and-the-resulting-rate-per-day"},{"title":"The asset hierarchy with depth, ancestor path and per-node counts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_tree","href":"/api-reference/assets/the-asset-hierarchy-with-depth-ancestor-path-and-per-node-counts"},{"title":"Asset register with resolved category, status, site and custom fields.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /assets","href":"/api-reference/assets/asset-register-with-resolved-category-status-site-and-custom-fields"},{"title":"Assets with every field of the records each row points at: business unit, company, custodian, department, location…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /assets_expanded","href":"/api-reference/assets/assets-with-every-field-of-the-records-each-row-points-at:-business-unit-company-custodian-department-location…"},{"title":"Every correction made to a meter reading: which reading, what it said before and after, who corrected it, when, and why…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /meter_reading_corrections","href":"/api-reference/assets/every-correction-made-to-a-meter-reading:-which-reading-what-it-said-before-and-after-who-corrected-it-when-and-why…"},{"title":"The reading history behind api.asset_meters.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /meter_readings","href":"/api-reference/assets/the-reading-history-behind-apiasset_meters"},{"title":"Every asset a clone would create, with the number it would take and the taken ones it stepped over to get there.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_clone_preview","href":"/api-reference/assets/every-asset-a-clone-would-create-with-the-number-it-would-take-and-the-taken-ones-it-stepped-over-to-get-there"},{"title":"The asset register as it stood at the end of a day in the organisation's timezone: each asset that existed then, with…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assets_as_on","href":"/api-reference/assets/the-asset-register-as-it-stood-at-the-end-of-a-day-in-the-organisations-timezone:-each-asset-that-existed-then-with…"},{"title":"Set the custodian on one asset, dating the custody and optionally saying when it is due back.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assign_asset","href":"/api-reference/assets/set-the-custodian-on-one-asset-dating-the-custody-and-optionally-saying-when-it-is-due-back"},{"title":"Copy one asset n times, through api.clone_assets, and report the numbers it minted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clone_asset","href":"/api-reference/assets/copy-one-asset-n-times-through-apiclone_assets-and-report-the-numbers-it-minted"},{"title":"Create numbered copies of one asset or of a selection, with the parts, meters, plans, files and custom field answers…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clone_assets","href":"/api-reference/assets/create-numbered-copies-of-one-asset-or-of-a-selection-with-the-parts-meters-plans-files-and-custom-field-answers…"},{"title":"Add one asset to the register, with the same numbering, rules, reference checks and approval gate as the Assets screen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_asset","href":"/api-reference/assets/add-one-asset-to-the-register-with-the-same-numbering-rules-reference-checks-and-approval-gate-as-the-assets-screen"},{"title":"Set fields on one asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_asset","href":"/api-reference/assets/set-fields-on-one-asset"}]},{"group":"Lookups","pages":[{"title":"Asset categories with how many assets carry each and how many are under each, for scope pickers and filters.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_categories","href":"/api-reference/lookups/asset-categories-with-how-many-assets-carry-each-and-how-many-are-under-each-for-scope-pickers-and-filters"},{"title":"The meter types a usage trigger can be built on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_meter_types","href":"/api-reference/lookups/the-meter-types-a-usage-trigger-can-be-built-on"},{"title":"The certification catalogue: what each authorises, how long it lasts, who holds it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /certifications","href":"/api-reference/lookups/the-certification-catalogue:-what-each-authorises-how-long-it-lasts-who-holds-it"},{"title":"The failure taxonomy this organisation classifies breakdowns with, for the picker that asks what failed when a job is…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /failure_modes","href":"/api-reference/lookups/the-failure-taxonomy-this-organisation-classifies-breakdowns-with-for-the-picker-that-asks-what-failed-when-a-job-is…"},{"title":"Add to failure modes: The failure taxonomy this organisation classifies breakdowns with, for the picker that asks what failed when a job is…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /failure_modes","href":"/api-reference/lookups/add-to-failure-modes:-the-failure-taxonomy-this-organisation-classifies-breakdowns-with-for-the-picker-that-asks-what-failed-when-a-job-is…"},{"title":"Remove rows from failure modes: The failure taxonomy this organisation classifies breakdowns with, for the picker that asks what failed when a job is…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /failure_modes","href":"/api-reference/lookups/remove-rows-from-failure-modes:-the-failure-taxonomy-this-organisation-classifies-breakdowns-with-for-the-picker-that-asks-what-failed-when-a-job-is…"},{"title":"Change rows in failure modes: The failure taxonomy this organisation classifies breakdowns with, for the picker that asks what failed when a job is…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /failure_modes","href":"/api-reference/lookups/change-rows-in-failure-modes:-the-failure-taxonomy-this-organisation-classifies-breakdowns-with-for-the-picker-that-asks-what-failed-when-a-job-is…"},{"title":"The part catalogue with total availability. api.inventory_available is stock per warehouse.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parts","href":"/api-reference/lookups/the-part-catalogue-with-total-availability-apiinventory_available-is-stock-per-warehouse"},{"title":"Parts with every field of the records each row points at: manufacturer.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /parts_expanded","href":"/api-reference/lookups/parts-with-every-field-of-the-records-each-row-points-at:-manufacturer"},{"title":"Sites the caller can see, with the company and business unit above each, and the country the site is in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sites","href":"/api-reference/lookups/sites-the-caller-can-see-with-the-company-and-business-unit-above-each-and-the-country-the-site-is-in"},{"title":"Skills, with how many workers hold each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /skills","href":"/api-reference/lookups/skills-with-how-many-workers-hold-each"},{"title":"Add to skills: Skills, with how many workers hold each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /skills","href":"/api-reference/lookups/add-to-skills:-skills-with-how-many-workers-hold-each"},{"title":"Remove rows from skills: Skills, with how many workers hold each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /skills","href":"/api-reference/lookups/remove-rows-from-skills:-skills-with-how-many-workers-hold-each"},{"title":"Change rows in skills: Skills, with how many workers hold each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /skills","href":"/api-reference/lookups/change-rows-in-skills:-skills-with-how-many-workers-hold-each"},{"title":"Reference units.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /units_of_measure","href":"/api-reference/lookups/reference-units"},{"title":"Add to units of measure: Reference units.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /units_of_measure","href":"/api-reference/lookups/add-to-units-of-measure:-reference-units"},{"title":"Remove rows from units of measure: Reference units.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /units_of_measure","href":"/api-reference/lookups/remove-rows-from-units-of-measure:-reference-units"},{"title":"Change rows in units of measure: Reference units.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /units_of_measure","href":"/api-reference/lookups/change-rows-in-units-of-measure:-reference-units"},{"title":"Vendors, with how many contracts each holds.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendors","href":"/api-reference/lookups/vendors-with-how-many-contracts-each-holds"},{"title":"Priorities with their rank and promised times.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_priorities","href":"/api-reference/lookups/priorities-with-their-rank-and-promised-times"},{"title":"Add to work order priorities: Priorities with their rank and promised times.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /work_order_priorities","href":"/api-reference/lookups/add-to-work-order-priorities:-priorities-with-their-rank-and-promised-times"},{"title":"Remove rows from work order priorities: Priorities with their rank and promised times.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /work_order_priorities","href":"/api-reference/lookups/remove-rows-from-work-order-priorities:-priorities-with-their-rank-and-promised-times"},{"title":"Change rows in work order priorities: Priorities with their rank and promised times.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /work_order_priorities","href":"/api-reference/lookups/change-rows-in-work-order-priorities:-priorities-with-their-rank-and-promised-times"},{"title":"The priority rules that fill in a new job's priority, in the shape earlier versions of the field app read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_priority_rules","href":"/api-reference/lookups/the-priority-rules-that-fill-in-a-new-jobs-priority-in-the-shape-earlier-versions-of-the-field-app-read"},{"title":"Resolution codes, for the picker that records how a job was put right.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_resolution_codes","href":"/api-reference/lookups/resolution-codes-for-the-picker-that-records-how-a-job-was-put-right"},{"title":"Add to work order resolution codes: Resolution codes, for the picker that records how a job was put right.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /work_order_resolution_codes","href":"/api-reference/lookups/add-to-work-order-resolution-codes:-resolution-codes-for-the-picker-that-records-how-a-job-was-put-right"},{"title":"Remove rows from work order resolution codes: Resolution codes, for the picker that records how a job was put right.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /work_order_resolution_codes","href":"/api-reference/lookups/remove-rows-from-work-order-resolution-codes:-resolution-codes-for-the-picker-that-records-how-a-job-was-put-right"},{"title":"Change rows in work order resolution codes: Resolution codes, for the picker that records how a job was put right.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /work_order_resolution_codes","href":"/api-reference/lookups/change-rows-in-work-order-resolution-codes:-resolution-codes-for-the-picker-that-records-how-a-job-was-put-right"},{"title":"Why a job needed longer than it was promised, for the picker on Ask for more time.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_sla_extension_reasons","href":"/api-reference/lookups/why-a-job-needed-longer-than-it-was-promised-for-the-picker-on-ask-for-more-time"},{"title":"Add to work order sla extension reasons: Why a job needed longer than it was promised, for the picker on Ask for more time.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /work_order_sla_extension_reasons","href":"/api-reference/lookups/add-to-work-order-sla-extension-reasons:-why-a-job-needed-longer-than-it-was-promised-for-the-picker-on-ask-for-more-time"},{"title":"Remove rows from work order sla extension reasons: Why a job needed longer than it was promised, for the picker on Ask for more time.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /work_order_sla_extension_reasons","href":"/api-reference/lookups/remove-rows-from-work-order-sla-extension-reasons:-why-a-job-needed-longer-than-it-was-promised-for-the-picker-on-ask-for-more-time"},{"title":"Change rows in work order sla extension reasons: Why a job needed longer than it was promised, for the picker on Ask for more time.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /work_order_sla_extension_reasons","href":"/api-reference/lookups/change-rows-in-work-order-sla-extension-reasons:-why-a-job-needed-longer-than-it-was-promised-for-the-picker-on-ask-for-more-time"},{"title":"The priority rules: for jobs at a site, against an asset category, of a work order type — an empty one meaning any…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_sla_targets","href":"/api-reference/lookups/the-priority-rules:-for-jobs-at-a-site-against-an-asset-category-of-a-work-order-type-—-an-empty-one-meaning-any…"},{"title":"The work order states this tenant has, with their semantics and how many jobs are in each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_statuses","href":"/api-reference/lookups/the-work-order-states-this-tenant-has-with-their-semantics-and-how-many-jobs-are-in-each"},{"title":"Work order types.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_types","href":"/api-reference/lookups/work-order-types"}]},{"group":"Asset configuration","pages":[{"title":"The asset classification as a tree, with everything that leans on each node.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_category_settings","href":"/api-reference/asset-configuration/the-asset-classification-as-a-tree-with-everything-that-leans-on-each-node"},{"title":"The asset conditions in rank order, best first, with how many assets are in each and how many verification answers have…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_condition_settings","href":"/api-reference/asset-configuration/the-asset-conditions-in-rank-order-best-first-with-how-many-assets-are-in-each-and-how-many-verification-answers-have…"},{"title":"Add to asset condition settings: The asset conditions in rank order, best first, with how many assets are in each and how many verification answers have…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /asset_condition_settings","href":"/api-reference/asset-configuration/add-to-asset-condition-settings:-the-asset-conditions-in-rank-order-best-first-with-how-many-assets-are-in-each-and-how-many-verification-answers-have…"},{"title":"Remove rows from asset condition settings: The asset conditions in rank order, best first, with how many assets are in each and how many verification answers have…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /asset_condition_settings","href":"/api-reference/asset-configuration/remove-rows-from-asset-condition-settings:-the-asset-conditions-in-rank-order-best-first-with-how-many-assets-are-in-each-and-how-many-verification-answers-have…"},{"title":"Change rows in asset condition settings: The asset conditions in rank order, best first, with how many assets are in each and how many verification answers have…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /asset_condition_settings","href":"/api-reference/asset-configuration/change-rows-in-asset-condition-settings:-the-asset-conditions-in-rank-order-best-first-with-how-many-assets-are-in-each-and-how-many-verification-answers-have…"},{"title":"Asset models with their manufacturer, expected life, and how many are in service.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_model_settings","href":"/api-reference/asset-configuration/asset-models-with-their-manufacturer-expected-life-and-how-many-are-in-service"},{"title":"The ways one asset can relate to another, and how many pairs use each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_relationship_type_settings","href":"/api-reference/asset-configuration/the-ways-one-asset-can-relate-to-another-and-how-many-pairs-use-each"},{"title":"Add to asset relationship type settings: The ways one asset can relate to another, and how many pairs use each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /asset_relationship_type_settings","href":"/api-reference/asset-configuration/add-to-asset-relationship-type-settings:-the-ways-one-asset-can-relate-to-another-and-how-many-pairs-use-each"},{"title":"Remove rows from asset relationship type settings: The ways one asset can relate to another, and how many pairs use each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /asset_relationship_type_settings","href":"/api-reference/asset-configuration/remove-rows-from-asset-relationship-type-settings:-the-ways-one-asset-can-relate-to-another-and-how-many-pairs-use-each"},{"title":"Change rows in asset relationship type settings: The ways one asset can relate to another, and how many pairs use each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /asset_relationship_type_settings","href":"/api-reference/asset-configuration/change-rows-in-asset-relationship-type-settings:-the-ways-one-asset-can-relate-to-another-and-how-many-pairs-use-each"},{"title":"Asset types, the categories each is offered for, and how many assets carry it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_type_settings","href":"/api-reference/asset-configuration/asset-types-the-categories-each-is-offered-for-and-how-many-assets-carry-it"},{"title":"Add to asset type settings: Asset types, the categories each is offered for, and how many assets carry it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /asset_type_settings","href":"/api-reference/asset-configuration/add-to-asset-type-settings:-asset-types-the-categories-each-is-offered-for-and-how-many-assets-carry-it"},{"title":"Remove rows from asset type settings: Asset types, the categories each is offered for, and how many assets carry it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /asset_type_settings","href":"/api-reference/asset-configuration/remove-rows-from-asset-type-settings:-asset-types-the-categories-each-is-offered-for-and-how-many-assets-carry-it"},{"title":"Change rows in asset type settings: Asset types, the categories each is offered for, and how many assets carry it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /asset_type_settings","href":"/api-reference/asset-configuration/change-rows-in-asset-type-settings:-asset-types-the-categories-each-is-offered-for-and-how-many-assets-carry-it"},{"title":"The criticality scale with how many assets sit at each level.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /criticality_settings","href":"/api-reference/asset-configuration/the-criticality-scale-with-how-many-assets-sit-at-each-level"},{"title":"Add to criticality settings: The criticality scale with how many assets sit at each level.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /criticality_settings","href":"/api-reference/asset-configuration/add-to-criticality-settings:-the-criticality-scale-with-how-many-assets-sit-at-each-level"},{"title":"Remove rows from criticality settings: The criticality scale with how many assets sit at each level.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /criticality_settings","href":"/api-reference/asset-configuration/remove-rows-from-criticality-settings:-the-criticality-scale-with-how-many-assets-sit-at-each-level"},{"title":"Change rows in criticality settings: The criticality scale with how many assets sit at each level.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /criticality_settings","href":"/api-reference/asset-configuration/change-rows-in-criticality-settings:-the-criticality-scale-with-how-many-assets-sit-at-each-level"},{"title":"Manufacturers with the models and assets attributed to each, and who to contact for support.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /manufacturer_settings","href":"/api-reference/asset-configuration/manufacturers-with-the-models-and-assets-attributed-to-each-and-who-to-contact-for-support"},{"title":"Add to manufacturer settings: Manufacturers with the models and assets attributed to each, and who to contact for support.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /manufacturer_settings","href":"/api-reference/asset-configuration/add-to-manufacturer-settings:-manufacturers-with-the-models-and-assets-attributed-to-each-and-who-to-contact-for-support"},{"title":"Remove rows from manufacturer settings: Manufacturers with the models and assets attributed to each, and who to contact for support.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /manufacturer_settings","href":"/api-reference/asset-configuration/remove-rows-from-manufacturer-settings:-manufacturers-with-the-models-and-assets-attributed-to-each-and-who-to-contact-for-support"},{"title":"Change rows in manufacturer settings: Manufacturers with the models and assets attributed to each, and who to contact for support.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /manufacturer_settings","href":"/api-reference/asset-configuration/change-rows-in-manufacturer-settings:-manufacturers-with-the-models-and-assets-attributed-to-each-and-who-to-contact-for-support"},{"title":"Meter types with how many meters read them and how many maintenance triggers depend on them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /meter_type_settings","href":"/api-reference/asset-configuration/meter-types-with-how-many-meters-read-them-and-how-many-maintenance-triggers-depend-on-them"},{"title":"Say which asset categories a type is offered for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_asset_type_categories","href":"/api-reference/asset-configuration/say-which-asset-categories-a-type-is-offered-for"},{"title":"Say which sites an asset category exists at.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_category_sites","href":"/api-reference/asset-configuration/say-which-sites-an-asset-category-exists-at"}]},{"group":"Asset issue","pages":[{"title":"Every time an asset has been issued and taken back, against a booking or without one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_checkouts","href":"/api-reference/asset-issue/every-time-an-asset-has-been-issued-and-taken-back-against-a-booking-or-without-one"},{"title":"One asset as the issue form draws it: its status and the status it moves to when handed over and taken back, its…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_counter_status","href":"/api-reference/asset-issue/one-asset-as-the-issue-form-draws-it:-its-status-and-the-status-it-moves-to-when-handed-over-and-taken-back-its…"},{"title":"The checklist one asset owes going out (CHECK_OUT) or coming back (CHECK_IN) at the counter, with its questions; no row…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_checklist","href":"/api-reference/asset-issue/the-checklist-one-asset-owes-going-out-check_out-or-coming-back-check_in-at-the-counter-with-its-questions;-no-row…"},{"title":"Issue several assets at once without a booking, each to its taker until its Required Until, on its own rate card…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/issue_assets","href":"/api-reference/asset-issue/issue-several-assets-at-once-without-a-booking-each-to-its-taker-until-its-required-until-on-its-own-rate-card…"},{"title":"Take several assets back at once: each by its booking's own return where it went out on one, otherwise closing the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/return_assets","href":"/api-reference/asset-issue/take-several-assets-back-at-once:-each-by-its-bookings-own-return-where-it-went-out-on-one-otherwise-closing-the…"}]},{"group":"Asset components","pages":[{"title":"The fitted register with the assembly drawn on it: the row each component hangs off, how far down it sits, and the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_component_tree","href":"/api-reference/asset-components/the-fitted-register-with-the-assembly-drawn-on-it:-the-row-each-component-hangs-off-how-far-down-it-sits-and-the…"},{"title":"What is fitted to an asset and what came off it, with the job behind each and how long it lasted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_components","href":"/api-reference/asset-components/what-is-fitted-to-an-asset-and-what-came-off-it-with-the-job-behind-each-and-how-long-it-lasted"},{"title":"What is fitted to one asset, what is fitted to those, and so on down.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_components_under","href":"/api-reference/asset-components/what-is-fitted-to-one-asset-what-is-fitted-to-those-and-so-on-down"},{"title":"Re-parent a whole selection, one outcome row each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_reparent_assets","href":"/api-reference/asset-components/re-parent-a-whole-selection-one-outcome-row-each"},{"title":"Record a component as fitted to an asset, on a job where there is one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/fit_component","href":"/api-reference/asset-components/record-a-component-as-fitted-to-an-asset-on-a-job-where-there-is-one"},{"title":"Take a component off, on a job where there is one, and say what became of it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_component","href":"/api-reference/asset-components/take-a-component-off-on-a-job-where-there-is-one-and-say-what-became-of-it"},{"title":"Fit an asset to another assembly, or take it off the one it is on and stand it in a bay.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reparent_asset","href":"/api-reference/asset-components/fit-an-asset-to-another-assembly-or-take-it-off-the-one-it-is-on-and-stand-it-in-a-bay"},{"title":"Swap one component for another in one act, on the job it happened on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/replace_component","href":"/api-reference/asset-components/swap-one-component-for-another-in-one-act-on-the-job-it-happened-on"},{"title":"Retire, shelve or send for repair the unit a removal took off, reporting a refusal rather than raising it — the removal…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/settle_removed_component","href":"/api-reference/asset-components/retire-shelve-or-send-for-repair-the-unit-a-removal-took-off-reporting-a-refusal-rather-than-raising-it-—-the-removal…"},{"title":"The components one job fitted or removed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_components","href":"/api-reference/asset-components/the-components-one-job-fitted-or-removed"}]},{"group":"Asset lifecycle","pages":[{"title":"Why each asset left the register and to whom: the date, the reason, the buyer, the document and, for a sale, the price…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_disposal_records","href":"/api-reference/asset-lifecycle/why-each-asset-left-the-register-and-to-whom:-the-date-the-reason-the-buyer-the-document-and-for-a-sale-the-price…"},{"title":"Every report of an asset going missing, open or closed: when and where it was last seen, what happened, and how it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_loss_reports","href":"/api-reference/asset-lifecycle/every-report-of-an-asset-going-missing-open-or-closed:-when-and-where-it-was-last-seen-what-happened-and-how-it…"},{"title":"Where an asset has been.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_movements","href":"/api-reference/asset-lifecycle/where-an-asset-has-been"},{"title":"What state an asset has been in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_status_history","href":"/api-reference/asset-lifecycle/what-state-an-asset-has-been-in"},{"title":"Several assets moved as one consignment: where they all went, who took them on, and how many of them there were.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_transfer_batches","href":"/api-reference/asset-lifecycle/several-assets-moved-as-one-consignment:-where-they-all-went-who-took-them-on-and-how-many-of-them-there-were"},{"title":"An asset handed over: where it came from, who had it, and what state it came out in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_transfers","href":"/api-reference/asset-lifecycle/an-asset-handed-over:-where-it-came-from-who-had-it-and-what-state-it-came-out-in"},{"title":"Assets reported missing and not yet found, retired or disposed of, with their reports — and those whose report is…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /missing_assets","href":"/api-reference/asset-lifecycle/assets-reported-missing-and-not-yet-found-retired-or-disposed-of-with-their-reports-—-and-those-whose-report-is…"},{"title":"Assets that have left service, with when they left and who moved them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /retired_assets","href":"/api-reference/asset-lifecycle/assets-that-have-left-service-with-when-they-left-and-who-moved-them"},{"title":"Retired assets with every field of the records each row points at: business unit, company, custodian, location…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /retired_assets_expanded","href":"/api-reference/asset-lifecycle/retired-assets-with-every-field-of-the-records-each-row-points-at:-business-unit-company-custodian-location…"},{"title":"Periods an asset was unavailable.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_downtime","href":"/api-reference/asset-lifecycle/periods-an-asset-was-unavailable"},{"title":"Every asset lifecycle, with which status means missing in it, which status a found asset comes back in, and the moves…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_loss_lifecycles","href":"/api-reference/asset-lifecycle/every-asset-lifecycle-with-which-status-means-missing-in-it-which-status-a-found-asset-comes-back-in-and-the-moves…"},{"title":"The status a missing asset comes back in when it is marked found, and the others it may be given instead where the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_missing_found_choices","href":"/api-reference/asset-lifecycle/the-status-a-missing-asset-comes-back-in-when-it-is-marked-found-and-the-others-it-may-be-given-instead-where-the…"},{"title":"Take many assets out of the register to a closed status, one outcome row each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_close_assets","href":"/api-reference/asset-lifecycle/take-many-assets-out-of-the-register-to-a-closed-status-one-outcome-row-each"},{"title":"Remove many assets from the register, one outcome row each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_delete_assets","href":"/api-reference/asset-lifecycle/remove-many-assets-from-the-register-one-outcome-row-each"},{"title":"Report many assets missing at once, with one outcome row for each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_report_assets_missing","href":"/api-reference/asset-lifecycle/report-many-assets-missing-at-once-with-one-outcome-row-for-each"},{"title":"Transfer many assets the same way, one transfer row each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_transfer_assets","href":"/api-reference/asset-lifecycle/transfer-many-assets-the-same-way-one-transfer-row-each"},{"title":"Move many assets through their state model, one outcome row each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_transition_assets","href":"/api-reference/asset-lifecycle/move-many-assets-through-their-state-model-one-outcome-row-each"},{"title":"Set the same fields on many assets, through the generic record write.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_update_assets","href":"/api-reference/asset-lifecycle/set-the-same-fields-on-many-assets-through-the-generic-record-write"},{"title":"Dispose of part of each of several lines counted by quantity, each part in one transaction: split it off, then record…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispose_asset_parts","href":"/api-reference/asset-lifecycle/dispose-of-part-of-each-of-several-lines-counted-by-quantity-each-part-in-one-transaction:-split-it-off-then-record…"},{"title":"Walk an asset to a disposed state through whatever route its own model allows, in one transaction, and report every…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispose_asset_status","href":"/api-reference/asset-lifecycle/walk-an-asset-to-a-disposed-state-through-whatever-route-its-own-model-allows-in-one-transaction-and-report-every…"},{"title":"Mark a missing asset found: when, where and by whom, and the status it comes back in, which is the lifecycle's default…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/mark_asset_found","href":"/api-reference/asset-lifecycle/mark-a-missing-asset-found:-when-where-and-by-whom-and-the-status-it-comes-back-in-which-is-the-lifecycles-default…"},{"title":"Merge lines counted by quantity that are the same thing in the same place into one: the line kept takes the others'…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/merge_assets","href":"/api-reference/asset-lifecycle/merge-lines-counted-by-quantity-that-are-the-same-thing-in-the-same-place-into-one:-the-line-kept-takes-the-others…"},{"title":"Move an asset and record the move.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/move_asset","href":"/api-reference/asset-lifecycle/move-an-asset-and-record-the-move"},{"title":"How many people would lose sight of an asset or a location if it were moved to this site and place, and how many reach…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/move_audience","href":"/api-reference/asset-lifecycle/how-many-people-would-lose-sight-of-an-asset-or-a-location-if-it-were-moved-to-this-site-and-place-and-how-many-reach…"},{"title":"Add a Missing status to an asset lifecycle where it has none, and the moves into and out of it that the lifecycle does…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/prepare_asset_loss_lifecycle","href":"/api-reference/asset-lifecycle/add-a-missing-status-to-an-asset-lifecycle-where-it-has-none-and-the-moves-into-and-out-of-it-that-the-lifecycle-does…"},{"title":"Record why each of these assets left the register, and to whom: the date, the reason, the buyer (a customer or a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_asset_disposals","href":"/api-reference/asset-lifecycle/record-why-each-of-these-assets-left-the-register-and-to-whom:-the-date-the-reason-the-buyer-a-customer-or-a…"},{"title":"Record that somebody scanned an asset's label outside an audit: who, when, how and what the label said.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_asset_scan","href":"/api-reference/asset-lifecycle/record-that-somebody-scanned-an-assets-label-outside-an-audit:-who-when-how-and-what-the-label-said"},{"title":"Report an asset missing: when and where it was last seen (a site, a location at it, or both), what happened, and a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/report_asset_missing","href":"/api-reference/asset-lifecycle/report-an-asset-missing:-when-and-where-it-was-last-seen-a-site-a-location-at-it-or-both-what-happened-and-a…"},{"title":"Report the assets a verification round could not find as missing, each report naming its line, where it was expected…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/report_round_missing","href":"/api-reference/asset-lifecycle/report-the-assets-a-verification-round-could-not-find-as-missing-each-report-naming-its-line-where-it-was-expected…"},{"title":"Refuse a caller who may not move this asset into that status.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_asset_transition","href":"/api-reference/asset-lifecycle/refuse-a-caller-who-may-not-move-this-asset-into-that-status"},{"title":"Save which status a missing asset is moved to in one asset lifecycle, and which status a found one comes back in: the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_asset_loss_settings","href":"/api-reference/asset-lifecycle/save-which-status-a-missing-asset-is-moved-to-in-one-asset-lifecycle-and-which-status-a-found-one-comes-back-in:-the…"},{"title":"Take part of an asset counted by quantity — twelve of forty chairs — into an asset of its own, at the same place and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/split_asset","href":"/api-reference/asset-lifecycle/take-part-of-an-asset-counted-by-quantity-—-twelve-of-forty-chairs-—-into-an-asset-of-its-own-at-the-same-place-and…"},{"title":"Move an asset, hand it to a new custodian, restate its department and change its status in one act, and record that it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/transfer_asset","href":"/api-reference/asset-lifecycle/move-an-asset-hand-it-to-a-new-custodian-restate-its-department-and-change-its-status-in-one-act-and-record-that-it…"},{"title":"Move an asset through its own state model, recording the change.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/transition_asset","href":"/api-reference/asset-lifecycle/move-an-asset-through-its-own-state-model-recording-the-change"},{"title":"Change when and where a missing asset was last seen, what happened, and its reference.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_asset_missing_report","href":"/api-reference/asset-lifecycle/change-when-and-where-a-missing-asset-was-last-seen-what-happened-and-its-reference"},{"title":"Withdraw a report of an asset that was never really missing, putting it back in the status it had.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/withdraw_asset_missing_report","href":"/api-reference/asset-lifecycle/withdraw-a-report-of-an-asset-that-was-never-really-missing-putting-it-back-in-the-status-it-had"}]},{"group":"Verification","pages":[{"title":"What is stuck on an asset — QR, barcode, NFC, RFID, a plate.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_identifiers","href":"/api-reference/verification/what-is-stuck-on-an-asset-—-qr-barcode-nfc-rfid-a-plate"},{"title":"Pin an asset at the coordinate its count recorded, taking the most accurate matched scan .","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/accept_verification_coordinates","href":"/api-reference/verification/pin-an-asset-at-the-coordinate-its-count-recorded-taking-the-most-accurate-matched-scan-"},{"title":"Write what a verification found in one field to the asset, through the asset's ordinary edit with the round number as…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/accept_verification_field","href":"/api-reference/verification/write-what-a-verification-found-in-one-field-to-the-asset-through-the-assets-ordinary-edit-with-the-round-number-as…"},{"title":"Write every outstanding reading on a round to its asset, each as api.accept_verification_field would, reporting the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/accept_verification_fields","href":"/api-reference/verification/write-every-outstanding-reading-on-a-round-to-its-asset-each-as-apiaccept_verification_field-would-reporting-the…"},{"title":"Move an asset to where the count found it, recording the movement.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/accept_verification_location","href":"/api-reference/verification/move-an-asset-to-where-the-count-found-it-recording-the-movement"},{"title":"Put named assets on a draft round as MANUAL lines.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_verification_assets","href":"/api-reference/verification/put-named-assets-on-a-draft-round-as-manual-lines"},{"title":"Give an auditor a slice of a round — a site, a location, or the whole of it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assign_verification","href":"/api-reference/verification/give-an-auditor-a-slice-of-a-round-—-a-site-a-location-or-the-whole-of-it"},{"title":"Abandon a round, with a reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_verification_round","href":"/api-reference/verification/abandon-a-round-with-a-reason"},{"title":"Close a round.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/close_verification_round","href":"/api-reference/verification/close-a-round"},{"title":"Hand back a slice.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/complete_verification_assignment","href":"/api-reference/verification/hand-back-a-slice"},{"title":"Open rounds the caller is on, and open rounds nobody has been assigned to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/my_verifications","href":"/api-reference/verification/open-rounds-the-caller-is-on-and-open-rounds-nobody-has-been-assigned-to"},{"title":"How many assets a round's scope selects, where they are and how many lines each auditor on it would be given — and on a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_verification_scope","href":"/api-reference/verification/how-many-assets-a-rounds-scope-selects-where-they-are-and-how-many-lines-each-auditor-on-it-would-be-given-—-and-on-a…"},{"title":"Resolve a round's scope into its list, hand the lines to the auditors and tell them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_verification_round","href":"/api-reference/verification/resolve-a-rounds-scope-into-its-list-hand-the-lines-to-the-auditors-and-tell-them"},{"title":"Describe something found on a verification round that is not in the asset register: what it is, the label on it, where…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_unregistered_find","href":"/api-reference/verification/describe-something-found-on-a-verification-round-that-is-not-in-the-asset-register:-what-it-is-the-label-on-it-where…"},{"title":"Record what was found against one line, and file the scan that says so.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_verification","href":"/api-reference/verification/record-what-was-found-against-one-line-and-file-the-scan-that-says-so"},{"title":"Record what one checked field says on the asset itself: that the register is right, or what was found instead.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_verification_field","href":"/api-reference/verification/record-what-one-checked-field-says-on-the-asset-itself:-that-the-register-is-right-or-what-was-found-instead"},{"title":"What a scanner just read, resolved against a round: the line it belongs to, a new line for something unexpected, or an…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_verification_scan","href":"/api-reference/verification/what-a-scanner-just-read-resolved-against-a-round:-the-line-it-belongs-to-a-new-line-for-something-unexpected-or-an…"},{"title":"Add a find to the asset register.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/register_unregistered_find","href":"/api-reference/verification/add-a-find-to-the-asset-register"},{"title":"Turn down a find from a verification round instead of adding it to the register.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reject_unregistered_find","href":"/api-reference/verification/turn-down-a-find-from-a-verification-round-instead-of-adding-it-to-the-register"},{"title":"Remind an auditor of the lines still outstanding on their share of a running round.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remind_verification_auditor","href":"/api-reference/verification/remind-an-auditor-of-the-lines-still-outstanding-on-their-share-of-a-running-round"},{"title":"Take named assets back off a draft round.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_verification_assets","href":"/api-reference/verification/take-named-assets-back-off-a-draft-round"},{"title":"Add or change one scope rule on a draft round, and optionally send somebody to walk it: each site and location the rule…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_verification_scope_rule","href":"/api-reference/verification/add-or-change-one-scope-rule-on-a-draft-round-and-optionally-send-somebody-to-walk-it:-each-site-and-location-the-rule…"},{"title":"Send lines recorded as \"could not get to it\" back to be walked again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/send_back_verification_lines","href":"/api-reference/verification/send-lines-recorded-as-\"could-not-get-to-it\"-back-to-be-walked-again"},{"title":"Release an auditor's outstanding lines.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unassign_verification","href":"/api-reference/verification/release-an-auditors-outstanding-lines"},{"title":"Who a verification round may be handed to: active people who may record a count and can reach the named sites and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/verification_auditors","href":"/api-reference/verification/who-a-verification-round-may-be-handed-to:-active-people-who-may-record-a-count-and-can-reach-the-named-sites-and…"},{"title":"The asset fields a verification round may ask an auditor to read back: every field the asset form may set and every…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/verification_checkable_fields","href":"/api-reference/verification/the-asset-fields-a-verification-round-may-ask-an-auditor-to-read-back:-every-field-the-asset-form-may-set-and-every…"},{"title":"The fields one line of a verification round asks to be read back: what the register says now, and what the auditor has…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/verification_line_fields","href":"/api-reference/verification/the-fields-one-line-of-a-verification-round-asks-to-be-read-back:-what-the-register-says-now-and-what-the-auditor-has…"},{"title":"The whole round as a report: the counts, the exceptions, the checked fields found to differ from the register, what was…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/verification_report","href":"/api-reference/verification/the-whole-round-as-a-report:-the-counts-the-exceptions-the-checked-fields-found-to-differ-from-the-register-what-was…"},{"title":"Who is walking which slice of which round, and how much of it is left.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /verification_assignments","href":"/api-reference/verification/who-is-walking-which-slice-of-which-round-and-how-much-of-it-is-left"},{"title":"What a verification read back of each field it checks: what the register said when the auditor looked, what they found…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /verification_field_findings","href":"/api-reference/verification/what-a-verification-read-back-of-each-field-it-checks:-what-the-register-said-when-the-auditor-looked-what-they-found…"},{"title":"One asset in one round: what was expected, what was found, the last scan that said so, and the best fix any scan on it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /verification_lines","href":"/api-reference/verification/one-asset-in-one-round:-what-was-expected-what-was-found-the-last-scan-that-said-so-and-the-best-fix-any-scan-on-it…"},{"title":"Physical verification rounds, with where each stands and one word for it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /verification_rounds","href":"/api-reference/verification/physical-verification-rounds-with-where-each-stands-and-one-word-for-it"},{"title":"Every scan ever made against a line, including the ones that matched nothing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /verification_scans","href":"/api-reference/verification/every-scan-ever-made-against-a-line-including-the-ones-that-matched-nothing"},{"title":"What a round says should be looked at, with every id resolved to the name a person wrote.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /verification_scope_rules","href":"/api-reference/verification/what-a-round-says-should-be-looked-at-with-every-id-resolved-to-the-name-a-person-wrote"},{"title":"Things an auditor found on a verification round that are not in the asset register at all, each waiting for somebody…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /verification_unregistered_finds","href":"/api-reference/verification/things-an-auditor-found-on-a-verification-round-that-are-not-in-the-asset-register-at-all-each-waiting-for-somebody…"}]},{"group":"Map","pages":[{"title":"Assets with the coordinates they were pinned at, or inherit from their location or their site.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_map","href":"/api-reference/map/assets-with-the-coordinates-they-were-pinned-at-or-inherit-from-their-location-or-their-site"},{"title":"The tile URL, attribution, maximum zoom and place-search endpoint this tenant's maps use.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/map_configuration","href":"/api-reference/map/the-tile-url-attribution-maximum-zoom-and-place-search-endpoint-this-tenants-maps-use"},{"title":"Point this tenant's maps at a different tile server and place-search service.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_map_configuration","href":"/api-reference/map/point-this-tenants-maps-at-a-different-tile-server-and-place-search-service"}]},{"group":"Sensors and meters","pages":[{"title":"What a model expected, with the date it said so, so it can be graded afterwards.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_predictions","href":"/api-reference/sensors-and-meters/what-a-model-expected-with-the-date-it-said-so-so-it-can-be-graded-afterwards"},{"title":"Say somebody has seen an alert.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/acknowledge_alert","href":"/api-reference/sensors-and-meters/say-somebody-has-seen-an-alert"},{"title":"Record one sensor reading and return what it set off — alerts opened or cleared, and whether it fed a meter.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_sensor_reading","href":"/api-reference/sensors-and-meters/record-one-sensor-reading-and-return-what-it-set-off-—-alerts-opened-or-cleared-and-whether-it-fed-a-meter"},{"title":"A sensor's readings bucketed for a chart, with the min and max kept so a spike is not averaged away.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/sensor_series","href":"/api-reference/sensors-and-meters/a-sensors-readings-bucketed-for-a-chart-with-the-min-and-max-kept-so-a-spike-is-not-averaged-away"},{"title":"Threshold breaches — one per breach rather than one per reading, and how bad it got.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sensor_alerts","href":"/api-reference/sensors-and-meters/threshold-breaches-—-one-per-breach-rather-than-one-per-reading-and-how-bad-it-got"},{"title":"The limits a sensor is judged against, so a reading can be drawn beside the line it crossed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sensor_thresholds","href":"/api-reference/sensors-and-meters/the-limits-a-sensor-is-judged-against-so-a-reading-can-be-drawn-beside-the-line-it-crossed"},{"title":"Sensors with their latest reading, open alerts, and whether they feed a meter.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sensors","href":"/api-reference/sensors-and-meters/sensors-with-their-latest-reading-open-alerts-and-whether-they-feed-a-meter"}]},{"group":"Reliability","pages":[{"title":"MTBF, MTTR, availability, PM compliance, first-time fix and cost per asset per period.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_reliability","href":"/api-reference/reliability/mtbf-mttr-availability-pm-compliance-first-time-fix-and-cost-per-asset-per-period"},{"title":"What the reliability engine says should happen, with the figures behind each sentence.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reliability_recommendations","href":"/api-reference/reliability/what-the-reliability-engine-says-should-happen-with-the-figures-behind-each-sentence"},{"title":"Dismiss a reliability recommendation with a reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dismiss_reliability_recommendation","href":"/api-reference/reliability/dismiss-a-reliability-recommendation-with-a-reason"},{"title":"Recompute the last N months of reliability for the caller's tenant.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/refresh_reliability","href":"/api-reference/reliability/recompute-the-last-n-months-of-reliability-for-the-callers-tenant"},{"title":"The fleet ranked worst-first over a number of months.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reliability_bad_actors","href":"/api-reference/reliability/the-fleet-ranked-worst-first-over-a-number-of-months"},{"title":"Fleet MTBF, MTTR, availability, PM compliance, downtime and cost per month.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reliability_summary","href":"/api-reference/reliability/fleet-mtbf-mttr-availability-pm-compliance-downtime-and-cost-per-month"}]},{"group":"Warranty lookups","pages":[{"title":"Each line of cover an asset's manufacturer says it is under: the base warranty, an extension, an upgraded service…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_warranty_coverages","href":"/api-reference/warranty-lookups/each-line-of-cover-an-assets-manufacturer-says-it-is-under:-the-base-warranty-an-extension-an-upgraded-service…"},{"title":"Add to asset warranty coverages: Each line of cover an asset's manufacturer says it is under: the base warranty, an extension, an upgraded service…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /asset_warranty_coverages","href":"/api-reference/warranty-lookups/add-to-asset-warranty-coverages:-each-line-of-cover-an-assets-manufacturer-says-it-is-under:-the-base-warranty-an-extension-an-upgraded-service…"},{"title":"Remove rows from asset warranty coverages: Each line of cover an asset's manufacturer says it is under: the base warranty, an extension, an upgraded service…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /asset_warranty_coverages","href":"/api-reference/warranty-lookups/remove-rows-from-asset-warranty-coverages:-each-line-of-cover-an-assets-manufacturer-says-it-is-under:-the-base-warranty-an-extension-an-upgraded-service…"},{"title":"Change rows in asset warranty coverages: Each line of cover an asset's manufacturer says it is under: the base warranty, an extension, an upgraded service…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /asset_warranty_coverages","href":"/api-reference/warranty-lookups/change-rows-in-asset-warranty-coverages:-each-line-of-cover-an-assets-manufacturer-says-it-is-under:-the-base-warranty-an-extension-an-upgraded-service…"},{"title":"What each asset's manufacturer was last asked about its warranty and what it answered, beside the warranty date the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /asset_warranty_lookups","href":"/api-reference/warranty-lookups/what-each-assets-manufacturer-was-last-asked-about-its-warranty-and-what-it-answered-beside-the-warranty-date-the…"},{"title":"Ask the asset's manufacturer about its warranty now.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/check_asset_warranty","href":"/api-reference/warranty-lookups/ask-the-assets-manufacturer-about-its-warranty-now"},{"title":"Remove the organisation's connection to one manufacturer's warranty service, and its secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_warranty_connection","href":"/api-reference/warranty-lookups/remove-the-organisations-connection-to-one-manufacturers-warranty-service-and-its-secret"},{"title":"Set up or change the account the organisation asks one manufacturer's warranty service with: DELL, LENOVO, HP or APPLE…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_warranty_connection","href":"/api-reference/warranty-lookups/set-up-or-change-the-account-the-organisation-asks-one-manufacturers-warranty-service-with:-dell-lenovo-hp-or-apple…"},{"title":"The organisation's connections to manufacturers' warranty services: which maker, the client id, the last four…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /warranty_connections","href":"/api-reference/warranty-lookups/the-organisations-connections-to-manufacturers-warranty-services:-which-maker-the-client-id-the-last-four…"}]},{"group":"Workforce detail","pages":[{"title":"The suppliers a job can be sent to: name, number and whether they are the OEM.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /assignable_vendors","href":"/api-reference/workforce-detail/the-suppliers-a-job-can-be-sent-to:-name-number-and-whether-they-are-the-oem"},{"title":"The people a job can be given to, as the four facts that decide it: name, number, home site and whether they travel.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /assignable_workers","href":"/api-reference/workforce-detail/the-people-a-job-can-be-given-to-as-the-four-facts-that-decide-it:-name-number-home-site-and-whether-they-travel"},{"title":"Add to assignable workers: The people a job can be given to, as the four facts that decide it: name, number, home site and whether they travel.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /assignable_workers","href":"/api-reference/workforce-detail/add-to-assignable-workers:-the-people-a-job-can-be-given-to-as-the-four-facts-that-decide-it:-name-number-home-site-and-whether-they-travel"},{"title":"Remove rows from assignable workers: The people a job can be given to, as the four facts that decide it: name, number, home site and whether they travel.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /assignable_workers","href":"/api-reference/workforce-detail/remove-rows-from-assignable-workers:-the-people-a-job-can-be-given-to-as-the-four-facts-that-decide-it:-name-number-home-site-and-whether-they-travel"},{"title":"Change rows in assignable workers: The people a job can be given to, as the four facts that decide it: name, number, home site and whether they travel.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /assignable_workers","href":"/api-reference/workforce-detail/change-rows-in-assignable-workers:-the-people-a-job-can-be-given-to-as-the-four-facts-that-decide-it:-name-number-home-site-and-whether-they-travel"},{"title":"Depth of cover per skill.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /skill_coverage","href":"/api-reference/workforce-detail/depth-of-cover-per-skill"},{"title":"Teams with their current membership, for the assignment picker.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /teams","href":"/api-reference/workforce-detail/teams-with-their-current-membership-for-the-assignment-picker"},{"title":"The technician list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /technicians","href":"/api-reference/workforce-detail/the-technician-list"},{"title":"Work orders by assigned worker, open and closed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /worker_assignments","href":"/api-reference/workforce-detail/work-orders-by-assigned-worker-open-and-closed"},{"title":"Held certifications with expiry, what they authorise, and whether they have lapsed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /worker_certifications","href":"/api-reference/workforce-detail/held-certifications-with-expiry-what-they-authorise-and-whether-they-have-lapsed"},{"title":"The computed periods behind the Performance tab.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /worker_performance","href":"/api-reference/workforce-detail/the-computed-periods-behind-the-performance-tab"},{"title":"Shifts, availability windows and leave on one timeline.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /worker_schedule","href":"/api-reference/workforce-detail/shifts-availability-windows-and-leave-on-one-timeline"},{"title":"The skills matrix.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /worker_skills","href":"/api-reference/workforce-detail/the-skills-matrix"}]},{"group":"Files","pages":[{"title":"Files attached to a record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /attachments","href":"/api-reference/files/files-attached-to-a-record"},{"title":"Attach a file that already exists to another record, without moving its bytes again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/attach_existing_file","href":"/api-reference/files/attach-a-file-that-already-exists-to-another-record-without-moving-its-bytes-again"},{"title":"Ask whether this caller may read a file, and answer with where to read it from.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/authorize_download","href":"/api-reference/files/ask-whether-this-caller-may-read-a-file-and-answer-with-where-to-read-it-from"},{"title":"Ask whether this caller may attach a file here, and where it should go.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/authorize_upload","href":"/api-reference/files/ask-whether-this-caller-may-attach-a-file-here-and-where-it-should-go"},{"title":"Remove a file from the record it is attached to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/detach_file","href":"/api-reference/files/remove-a-file-from-the-record-it-is-attached-to"},{"title":"The largest file this deployment accepts, so a form can refuse one before it is sent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/file_limits","href":"/api-reference/files/the-largest-file-this-deployment-accepts-so-a-form-can-refuse-one-before-it-is-sent"},{"title":"Take back a photograph or a signature that answers a field on a record: the answer and the attachment go together…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_evidence_file","href":"/api-reference/files/take-back-a-photograph-or-a-signature-that-answers-a-field-on-a-record:-the-answer-and-the-attachment-go-together…"},{"title":"Announce an upload, get a storage key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_upload","href":"/api-reference/files/announce-an-upload-get-a-storage-key"},{"title":"Change what an attachment is called or which category it is filed under.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_attachment","href":"/api-reference/files/change-what-an-attachment-is-called-or-which-category-it-is-filed-under"}]},{"group":"Audit center","pages":[{"title":"The audit trail, one row per event, for reports and dashboard tiles: sign-ins and refusals, changes to who may do what…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /audit_events","href":"/api-reference/audit-center/the-audit-trail-one-row-per-event-for-reports-and-dashboard-tiles:-sign-ins-and-refusals-changes-to-who-may-do-what…"},{"title":"Effective-dated exchange rates, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /exchange_rates","href":"/api-reference/audit-center/effective-dated-exchange-rates-newest-first"},{"title":"The audit trail as rows to take away.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/audit_export","href":"/api-reference/audit-center/the-audit-trail-as-rows-to-take-away"},{"title":"Counts and the busiest actors and record types over a window, for the audit screen to open on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/audit_overview","href":"/api-reference/audit-center/counts-and-the-busiest-actors-and-record-types-over-a-window-for-the-audit-screen-to-open-on"},{"title":"Search the whole audit trail.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/audit_search","href":"/api-reference/audit-center/search-the-whole-audit-trail"},{"title":"Enter an exchange rate by hand, in force from a date onwards.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_exchange_rate","href":"/api-reference/audit-center/enter-an-exchange-rate-by-hand-in-force-from-a-date-onwards"},{"title":"Amounts recorded with no exchange rate to convert them, grouped by what is missing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unconverted_money","href":"/api-reference/audit-center/amounts-recorded-with-no-exchange-rate-to-convert-them-grouped-by-what-is-missing"}]},{"group":"Inventory configuration","pages":[{"title":"The storage tree inside a warehouse, and whether stock can be picked from each bin.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bin_settings","href":"/api-reference/inventory-configuration/the-storage-tree-inside-a-warehouse-and-whether-stock-can-be-picked-from-each-bin"},{"title":"Part categories as a tree, with the parts in each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /part_category_settings","href":"/api-reference/inventory-configuration/part-categories-as-a-tree-with-the-parts-in-each"},{"title":"Which stocked parts have a reorder policy.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reorder_coverage","href":"/api-reference/inventory-configuration/which-stocked-parts-have-a-reorder-policy"},{"title":"Stores with their bins, what is in them, and whether the ledger is allowed to go negative.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /warehouse_settings","href":"/api-reference/inventory-configuration/stores-with-their-bins-what-is-in-them-and-whether-the-ledger-is-allowed-to-go-negative"}]},{"group":"Real-time location","pages":[{"title":"Which asset each BLE tag was fitted to, from when until when, and who fitted and removed it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ble_tag_assignments","href":"/api-reference/real-time-location/which-asset-each-ble-tag-was-fitted-to-from-when-until-when-and-who-fitted-and-removed-it"},{"title":"BLE tags, the asset each is fitted to, the identity a handset can find it by, when a gateway or a handset last heard it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ble_tags","href":"/api-reference/real-time-location/ble-tags-the-asset-each-is-fitted-to-the-identity-a-handset-can-find-it-by-when-a-gateway-or-a-handset-last-heard-it…"},{"title":"Ready-made payload maps for BLE gateways from Minew (one for each of its JSON-LONG and JSON-Preparsed upload formats)…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reader_presets","href":"/api-reference/real-time-location/ready-made-payload-maps-for-ble-gateways-from-minew-one-for-each-of-its-json-long-and-json-preparsed-upload-formats…"},{"title":"Set a reader's payload map, payload format and tag format from a vendor preset, and give it antenna 1 at its own site…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/apply_reader_preset","href":"/api-reference/real-time-location/set-a-readers-payload-map-payload-format-and-tag-format-from-a-vendor-preset-and-give-it-antenna-1-at-its-own-site…"},{"title":"Remove a wall from a locating plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_rtls_wall","href":"/api-reference/real-time-location/remove-a-wall-from-a-locating-plan"},{"title":"Fit a BLE tag to an asset, closing whatever the tag and the asset were each carrying before.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/fit_ble_tag","href":"/api-reference/real-time-location/fit-a-ble-tag-to-an-asset-closing-whatever-the-tag-and-the-asset-were-each-carrying-before"},{"title":"Place a heard gateway at a point on a locating plan, move it, or unplace it with a null plan; optionally name it and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/place_gateway","href":"/api-reference/real-time-location/place-a-heard-gateway-at-a-point-on-a-locating-plan-move-it-or-unplace-it-with-a-null-plan;-optionally-name-it-and…"},{"title":"Record that the handset heard a BLE tag while looking for it: who, on which platform and when.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_ble_tag_heard","href":"/api-reference/real-time-location/record-that-the-handset-heard-a-ble-tag-while-looking-for-it:-who-on-which-platform-and-when"},{"title":"Register a BLE tag by its MAC address, optionally fitting it to an asset in the same step.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/register_ble_tag","href":"/api-reference/real-time-location/register-a-ble-tag-by-its-mac-address-optionally-fitting-it-to-an-asset-in-the-same-step"},{"title":"Refuses a locating plan outside the caller's organisation or at a site they cannot see.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rtls_require_plan","href":"/api-reference/real-time-location/refuses-a-locating-plan-outside-the-callers-organisation-or-at-a-site-they-cannot-see"},{"title":"How many months of indoor positions this organisation keeps, and the oldest one it still holds.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rtls_settings","href":"/api-reference/real-time-location/how-many-months-of-indoor-positions-this-organisation-keeps-and-the-oldest-one-it-still-holds"},{"title":"Draw a wall on a locating plan, or redraw one: a line of points, what it is made of, and whether a tag can pass through…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_rtls_wall","href":"/api-reference/real-time-location/draw-a-wall-on-a-locating-plan-or-redraw-one:-a-line-of-points-what-it-is-made-of-and-whether-a-tag-can-pass-through…"},{"title":"Set a floor plan's real size from two points on it and the distance between them, making it a plan tags can be located…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_floor_plan_scale","href":"/api-reference/real-time-location/set-a-floor-plans-real-size-from-two-points-on-it-and-the-distance-between-them-making-it-a-plan-tags-can-be-located…"},{"title":"Set how many months of indoor positions this organisation keeps, between 1 and 120.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_rtls_settings","href":"/api-reference/real-time-location/set-how-many-months-of-indoor-positions-this-organisation-keeps-between-1-and-120"},{"title":"Where an asset's BLE tags placed it between two moments, oldest first: the points, the drawing and the room, for…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/tag_trail","href":"/api-reference/real-time-location/where-an-assets-ble-tags-placed-it-between-two-moments-oldest-first:-the-points-the-drawing-and-the-room-for…"},{"title":"Take a BLE tag off the asset it is fitted to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unfit_ble_tag","href":"/api-reference/real-time-location/take-a-ble-tag-off-the-asset-it-is-fitted-to"},{"title":"BLE gateways the readers have heard, where each is placed on a locating plan, and whether it is still being heard.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rtls_gateways","href":"/api-reference/real-time-location/ble-gateways-the-readers-have-heard-where-each-is-placed-on-a-locating-plan-and-whether-it-is-still-being-heard"},{"title":"Floor plans set up for indoor location: their real size, how signal fades on them, and what setting them up still needs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rtls_plans","href":"/api-reference/real-time-location/floor-plans-set-up-for-indoor-location:-their-real-size-how-signal-fades-on-them-and-what-setting-them-up-still-needs"},{"title":"Walls drawn on locating plans, with the loss each costs a signal through it and its length once the plan has a scale.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rtls_walls","href":"/api-reference/real-time-location/walls-drawn-on-locating-plans-with-the-loss-each-costs-a-signal-through-it-and-its-length-once-the-plan-has-a-scale"},{"title":"Where each BLE tag is on a floor plan, how far out that may be, the room it is in, and whether it is still being heard.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tag_positions","href":"/api-reference/real-time-location/where-each-ble-tag-is-on-a-floor-plan-how-far-out-that-may-be-the-room-it-is-in-and-whether-it-is-still-being-heard"}]},{"group":"Bookings","pages":[{"title":"The five kinds of thing a booking can hold, and whether this organisation books each of them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bookable_kinds","href":"/api-reference/bookings/the-five-kinds-of-thing-a-booking-can-hold-and-whether-this-organisation-books-each-of-them"},{"title":"Everything the module can reserve, named the same way whichever register it came out of.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bookable_resources","href":"/api-reference/bookings/everything-the-module-can-reserve-named-the-same-way-whichever-register-it-came-out-of"},{"title":"The rules that keep assets out of bookings: a category with everything under it, a status, an asset type, a site, or…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_asset_exclusions","href":"/api-reference/bookings/the-rules-that-keep-assets-out-of-bookings:-a-category-with-everything-under-it-a-status-an-asset-type-a-site-or…"},{"title":"The assets a booking holds, with the reading each went out on and the issue a return is recorded against.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_asset_lines","href":"/api-reference/bookings/the-assets-a-booking-holds-with-the-reading-each-went-out-on-and-the-issue-a-return-is-recorded-against"},{"title":"The charge ledger, with the payer dimensions carried down from the booking — or, for an asset issued without one, from…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_charges","href":"/api-reference/bookings/the-charge-ledger-with-the-payer-dimensions-carried-down-from-the-booking-—-or-for-an-asset-issued-without-one-from…"},{"title":"Every answer given to a booking checklist at the counter, one row per question: the booking, the asset, whether it was…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_checklist_answers","href":"/api-reference/bookings/every-answer-given-to-a-booking-checklist-at-the-counter-one-row-per-question:-the-booking-the-asset-whether-it-was…"},{"title":"Every booked asset that has gone out, one row per hand-over, with the outcome of the checklist answered going out and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_checklist_custody","href":"/api-reference/bookings/every-booked-asset-that-has-gone-out-one-row-per-hand-over-with-the-outcome-of-the-checklist-answered-going-out-and…"},{"title":"Which checklist the counter answers as an asset goes out (CHECK_OUT) and as it comes back (CHECK_IN), narrowed by the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_checklist_rules","href":"/api-reference/bookings/which-checklist-the-counter-answers-as-an-asset-goes-out-check_out-and-as-it-comes-back-check_in-narrowed-by-the…"},{"title":"Refused reservations per resource per month.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_clash_summary","href":"/api-reference/bookings/refused-reservations-per-resource-per-month"},{"title":"Reservations that were refused for a clash: what was wanted, over what window, who was refused and which booking held…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_clashes","href":"/api-reference/bookings/reservations-that-were-refused-for-a-clash:-what-was-wanted-over-what-window-who-was-refused-and-which-booking-held…"},{"title":"When a booking nobody collects is written off, and when the people on a booking are reminded to collect it and to bring…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_collection_rules","href":"/api-reference/bookings/when-a-booking-nobody-collects-is-written-off-and-when-the-people-on-a-booking-are-reminded-to-collect-it-and-to-bring…"},{"title":"The rules that set how a booking line opens — billing cycle, chargeable behaviour and which rate cards are offered…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_defaults","href":"/api-reference/bookings/the-rules-that-set-how-a-booking-line-opens-—-billing-cycle-chargeable-behaviour-and-which-rate-cards-are-offered…"},{"title":"Everything a booking holds — assets, tools, parts, places and people — in one list, each with the window that line…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_lines","href":"/api-reference/bookings/everything-a-booking-holds-—-assets-tools-parts-places-and-people-—-in-one-list-each-with-the-window-that-line…"},{"title":"Every register a booking may be charged to, in one list keyed by the dimension that names it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_payers","href":"/api-reference/bookings/every-register-a-booking-may-be-charged-to-in-one-list-keyed-by-the-dimension-that-names-it"},{"title":"The project tasks a booking charged to a project is split across, each carrying an equal share of what the booking has…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_project_task_shares","href":"/api-reference/bookings/the-project-tasks-a-booking-charged-to-a-project-is-split-across-each-carrying-an-equal-share-of-what-the-booking-has…"},{"title":"Rate cards — one price each — with what each one prices resolved to a name, what it charges per, how much, and whether…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_rates","href":"/api-reference/bookings/rate-cards-—-one-price-each-—-with-what-each-one-prices-resolved-to-a-name-what-it-charges-per-how-much-and-whether…"},{"title":"Which payer dimensions each kind of booking may be charged to, and which one its form opens on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_type_charges","href":"/api-reference/bookings/which-payer-dimensions-each-kind-of-booking-may-be-charged-to-and-which-one-its-form-opens-on"},{"title":"Which kinds of thing each kind of booking may hold, and how many.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_type_resources","href":"/api-reference/bookings/which-kinds-of-thing-each-kind-of-booking-may-hold-and-how-many"},{"title":"The kinds of reservation a tenant has configured.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_types","href":"/api-reference/bookings/the-kinds-of-reservation-a-tenant-has-configured"},{"title":"Add to booking types: The kinds of reservation a tenant has configured.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /booking_types","href":"/api-reference/bookings/add-to-booking-types:-the-kinds-of-reservation-a-tenant-has-configured"},{"title":"Remove rows from booking types: The kinds of reservation a tenant has configured.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /booking_types","href":"/api-reference/bookings/remove-rows-from-booking-types:-the-kinds-of-reservation-a-tenant-has-configured"},{"title":"Change rows in booking types: The kinds of reservation a tenant has configured.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /booking_types","href":"/api-reference/bookings/change-rows-in-booking-types:-the-kinds-of-reservation-a-tenant-has-configured"},{"title":"Reservations with who pays resolved to a name, what is reserved counted and listed with the terms each line was…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bookings","href":"/api-reference/bookings/reservations-with-who-pays-resolved-to-a-name-what-is-reserved-counted-and-listed-with-the-terms-each-line-was…"},{"title":"The tasks of every project the caller can see, with the project's number, name and cost centre beside each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /project_tasks","href":"/api-reference/bookings/the-tasks-of-every-project-the-caller-can-see-with-the-projects-number-name-and-cost-centre-beside-each"},{"title":"The classes a booking calendar groups by — asset categories, tool types, bookable place types, worker types — in one…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /resource_groups","href":"/api-reference/bookings/the-classes-a-booking-calendar-groups-by-—-asset-categories-tool-types-bookable-place-types-worker-types-—-in-one…"},{"title":"Hold an asset for a window inside a booking: refusing a clash, refusing a turnaround, refusing a window maintenance…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_booking_asset","href":"/api-reference/bookings/hold-an-asset-for-a-window-inside-a-booking:-refusing-a-clash-refusing-a-turnaround-refusing-a-window-maintenance…"},{"title":"Hold a bookable place for a window inside a booking.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_booking_location","href":"/api-reference/bookings/hold-a-bookable-place-for-a-window-inside-a-booking"},{"title":"Claim a quantity of a part for a booking.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_booking_part","href":"/api-reference/bookings/claim-a-quantity-of-a-part-for-a-booking"},{"title":"Hold a tool for a window inside a booking that already exists, so an equipment hire carries the tools that go out with…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_booking_tool","href":"/api-reference/bookings/hold-a-tool-for-a-window-inside-a-booking-that-already-exists-so-an-equipment-hire-carries-the-tools-that-go-out-with…"},{"title":"Commit somebody to a booking.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_booking_worker","href":"/api-reference/bookings/commit-somebody-to-a-booking"},{"title":"The rate cards a booking line holding this resource at this site may be priced on, the resource's own default first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/applicable_booking_rates","href":"/api-reference/bookings/the-rate-cards-a-booking-line-holding-this-resource-at-this-site-may-be-priced-on-the-resources-own-default-first"},{"title":"The chargeable behaviour, rate cards offered and cost centre a new asset at this site, of this category, opens on: the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_booking_defaults","href":"/api-reference/bookings/the-chargeable-behaviour-rate-cards-offered-and-cost-centre-a-new-asset-at-this-site-of-this-category-opens-on:-the…"},{"title":"One class of bookable thing, machine by machine, day by day — what each is doing and who holds the ones that are held.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/availability_by_resource","href":"/api-reference/bookings/one-class-of-bookable-thing-machine-by-machine-day-by-day-—-what-each-is-doing-and-who-holds-the-ones-that-are-held"},{"title":"How many of each class of bookable thing are free, held or out on each day of a range, and on how many of those days…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/availability_calendar","href":"/api-reference/bookings/how-many-of-each-class-of-bookable-thing-are-free-held-or-out-on-each-day-of-a-range-and-on-how-many-of-those-days…"},{"title":"The individual resources behind one cell of the availability calendar, with who holds the ones that are held and why…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/availability_detail","href":"/api-reference/bookings/the-individual-resources-behind-one-cell-of-the-availability-calendar-with-who-holds-the-ones-that-are-held-and-why…"},{"title":"Which assets, tools, bookable places or people are free for a window — by the same rules the write path enforces, so…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/available_resources","href":"/api-reference/bookings/which-assets-tools-bookable-places-or-people-are-free-for-a-window-—-by-the-same-rules-the-write-path-enforces-so…"},{"title":"Raise a booking and hold one asset, place or person on it in a single call — so a refusal on the line leaves no header…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/book_resource","href":"/api-reference/bookings/raise-a-booking-and-hold-one-asset-place-or-person-on-it-in-a-single-call-—-so-a-refusal-on-the-line-leaves-no-header…"},{"title":"The cost centre of the person a booking is for, by code and name — or nothing when they have none.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/booked_for_cost_centre","href":"/api-reference/bookings/the-cost-centre-of-the-person-a-booking-is-for-by-code-and-name-—-or-nothing-when-they-have-none"},{"title":"The checklist one asset would answer going out (CHECK_OUT) and coming back (CHECK_IN) under the booking checklist rules…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/booking_checklist_for_asset","href":"/api-reference/bookings/the-checklist-one-asset-would-answer-going-out-check_out-and-coming-back-check_in-under-the-booking-checklist-rules…"},{"title":"The checklist each of these booked lines owes as it goes out (CHECK_OUT) or comes back (CHECK_IN), with the questions…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/booking_checklists","href":"/api-reference/bookings/the-checklist-each-of-these-booked-lines-owes-as-it-goes-out-check_out-or-comes-back-check_in-with-the-questions…"},{"title":"How many of this organisation's assets are never offered for booking, under its exclusions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/booking_excluded_asset_count","href":"/api-reference/bookings/how-many-of-this-organisations-assets-are-never-offered-for-booking-under-its-exclusions"},{"title":"The billing cycle and chargeable behaviour a new booking line holding this resource at this site opens on, and for an…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/booking_line_defaults","href":"/api-reference/bookings/the-billing-cycle-and-chargeable-behaviour-a-new-booking-line-holding-this-resource-at-this-site-opens-on-and-for-an…"},{"title":"Hold many assets on one reservation, reporting each by asset number.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_book_assets","href":"/api-reference/bookings/hold-many-assets-on-one-reservation-reporting-each-by-asset-number"},{"title":"Release a reservation and every line under it, and bank whatever the notice ladder says the notice was worth.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_booking","href":"/api-reference/bookings/release-a-reservation-and-every-line-under-it-and-bank-whatever-the-notice-ladder-says-the-notice-was-worth"},{"title":"Settle a booking: bank the final period and anything it ran over, then close it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/close_booking","href":"/api-reference/bookings/settle-a-booking:-bank-the-final-period-and-anything-it-ran-over-then-close-it"},{"title":"Commit a reservation and price what it is forecast to cost.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/confirm_booking","href":"/api-reference/bookings/commit-a-reservation-and-price-what-it-is-forecast-to-cost"},{"title":"Raise a reservation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_booking","href":"/api-reference/bookings/raise-a-reservation"},{"title":"Raise a booking and hold everything on it in one call — assets, tools, parts, places and people together.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_booking_with_lines","href":"/api-reference/bookings/raise-a-booking-and-hold-everything-on-it-in-one-call-—-assets-tools-parts-places-and-people-together"},{"title":"Raise one booking for each thing chosen, with who it is for, who pays, the site and the window shared.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_bookings_per_resource","href":"/api-reference/bookings/raise-one-booking-for-each-thing-chosen-with-who-it-is-for-who-pays-the-site-and-the-window-shared"},{"title":"Delete a booking made by mistake, with its lines, while it is still before check-out and nothing permanent names it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_booking","href":"/api-reference/bookings/delete-a-booking-made-by-mistake-with-its-lines-while-it-is-still-before-check-out-and-nothing-permanent-names-it"},{"title":"Keep a booking longer, at any point before it is over: the header, every line that ran to its end, the expected return…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/extend_booking","href":"/api-reference/bookings/keep-a-booking-longer-at-any-point-before-it-is-over:-the-header-every-line-that-ran-to-its-end-the-expected-return…"},{"title":"Keep the deposit, and bank it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/forfeit_booking_deposit","href":"/api-reference/bookings/keep-the-deposit-and-bank-it"},{"title":"Record money held against a booking.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/hold_booking_deposit","href":"/api-reference/bookings/record-money-held-against-a-booking"},{"title":"Hand an asset over against its line, taking the reading a metered hire is billed on, and move its status as its…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/issue_booking_asset","href":"/api-reference/bookings/hand-an-asset-over-against-its-line-taking-the-reading-a-metered-hire-is-billed-on-and-move-its-status-as-its…"},{"title":"Hand a booking's parts over: one ISSUE movement, the reservation drawn down by what left, and a charge priced off the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/issue_booking_part","href":"/api-reference/bookings/hand-a-bookings-parts-over:-one-issue-movement-the-reservation-drawn-down-by-what-left-and-a-charge-priced-off-the…"},{"title":"Record a reservation that was refused for a clash, re-deriving the clash rather than believing the caller.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_booking_clash","href":"/api-reference/bookings/record-a-reservation-that-was-refused-for-a-clash-re-deriving-the-clash-rather-than-believing-the-caller"},{"title":"Give the deposit back.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/release_booking_deposit","href":"/api-reference/bookings/give-the-deposit-back"},{"title":"Take an asset back: bank the metered usage once, raise the corrective job when it comes back damaged, and move its…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/return_booking_asset","href":"/api-reference/bookings/take-an-asset-back:-bank-the-metered-usage-once-raise-the-corrective-job-when-it-comes-back-damaged-and-move-its…"},{"title":"Take back a booking's unused parts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/return_booking_part","href":"/api-reference/bookings/take-back-a-bookings-unused-parts"},{"title":"Replace the rules that keep assets out of bookings.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_booking_asset_exclusions","href":"/api-reference/bookings/replace-the-rules-that-keep-assets-out-of-bookings"},{"title":"Replace the rules that choose the checklist answered as a booked asset goes out (CHECK_OUT) and comes back (CHECK_IN).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_booking_checklist_rules","href":"/api-reference/bookings/replace-the-rules-that-choose-the-checklist-answered-as-a-booked-asset-goes-out-check_out-and-comes-back-check_in"},{"title":"Change how one booking line is billed and whether it is charged, until the booking is settled.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_booking_line_terms","href":"/api-reference/bookings/change-how-one-booking-line-is-billed-and-whether-it-is-charged-until-the-booking-is-settled"},{"title":"Say which of assets, tools, parts, people and places this organisation books.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_booking_resource_kinds","href":"/api-reference/bookings/say-which-of-assets-tools-parts-people-and-places-this-organisation-books"},{"title":"Replace what a kind of booking may hold and who it may be charged to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_booking_type_rules","href":"/api-reference/bookings/replace-what-a-kind-of-booking-may-hold-and-who-it-may-be-charged-to"},{"title":"Change a booking that has not been handed over — its title, purpose, site, window, who it is for, who pays and what it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_booking","href":"/api-reference/bookings/change-a-booking-that-has-not-been-handed-over-—-its-title-purpose-site-window-who-it-is-for-who-pays-and-what-it…"},{"title":"Charges that could not be priced because no rate card matched.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /unpriced_charges","href":"/api-reference/bookings/charges-that-could-not-be-priced-because-no-rate-card-matched"}]},{"group":"Booking bills","pages":[{"title":"Bills: one per charge per payer, with their status, why one is invalid, and their way through the ERP.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_bills","href":"/api-reference/booking-bills/bills:-one-per-charge-per-payer-with-their-status-why-one-is-invalid-and-their-way-through-the-erp"},{"title":"Mark bills sent to the ERP closed there, with the ERP's reference.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/close_booking_bills","href":"/api-reference/booking-bills/mark-bills-sent-to-the-erp-closed-there-with-the-erps-reference"},{"title":"Mark bills the ERP refused: back to valid or invalid, with the ERP's reason kept.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/fail_booking_bills","href":"/api-reference/booking-bills/mark-bills-the-erp-refused:-back-to-valid-or-invalid-with-the-erps-reason-kept"},{"title":"Correct the rate card of a bill's charge and its split across project tasks by days.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resplit_booking_bill","href":"/api-reference/booking-bills/correct-the-rate-card-of-a-bills-charge-and-its-split-across-project-tasks-by-days"},{"title":"Bring waived bills back to pending validation, and check them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/restore_booking_bills","href":"/api-reference/booking-bills/bring-waived-bills-back-to-pending-validation-and-check-them"},{"title":"Check bills against their project and task now.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revalidate_booking_bills","href":"/api-reference/booking-bills/check-bills-against-their-project-and-task-now"},{"title":"Mark valid bills sent to the ERP.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/send_booking_bills","href":"/api-reference/booking-bills/mark-valid-bills-sent-to-the-erp"},{"title":"Waive bills not yet sent: closed, with a reason, billed to nobody.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/waive_booking_bills","href":"/api-reference/booking-bills/waive-bills-not-yet-sent:-closed-with-a-reason-billed-to-nobody"}]},{"group":"Booking hand over","pages":[{"title":"What was changed on a booking when it was handed over — a line's machine, rate card, billing or charging, who pays, how…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_changes","href":"/api-reference/booking-hand-over/what-was-changed-on-a-booking-when-it-was-handed-over-—-a-lines-machine-rate-card-billing-or-charging-who-pays-how…"},{"title":"Booked assets waiting to be handed over, with their status, category, cost centre, rate card, billing terms, the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /booking_hand_over_lines","href":"/api-reference/booking-hand-over/booked-assets-waiting-to-be-handed-over-with-their-status-category-cost-centre-rate-card-billing-terms-the…"},{"title":"The machines a booked line could be swapped for: same category and site, free for the line's window, not retired or out…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/booking_swap_candidates","href":"/api-reference/booking-hand-over/the-machines-a-booked-line-could-be-swapped-for:-same-category-and-site-free-for-the-lines-window-not-retired-or-out…"},{"title":"Hand over the booked assets of several bookings with the same payer at once, each scanned, with what is filed below…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/hand_over_bookings","href":"/api-reference/booking-hand-over/hand-over-the-booked-assets-of-several-bookings-with-the-same-payer-at-once-each-scanned-with-what-is-filed-below…"},{"title":"Put another machine of the same category at the same site on a booked line before it goes out.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/swap_booking_asset","href":"/api-reference/booking-hand-over/put-another-machine-of-the-same-category-at-the-same-site-on-a-booked-line-before-it-goes-out"}]},{"group":"Amendments","pages":[{"title":"Requests to change what a head is sanctioned for, and whether each would still fit.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /budget_amendments","href":"/api-reference/amendments/requests-to-change-what-a-head-is-sanctioned-for-and-whether-each-would-still-fit"},{"title":"Heads and projects over their money or past their date, with no request raised against them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /budget_overruns","href":"/api-reference/amendments/heads-and-projects-over-their-money-or-past-their-date-with-no-request-raised-against-them"},{"title":"Approvals to exceed a budget or a project, by cost, by time, or by both.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /overrun_requests","href":"/api-reference/amendments/approvals-to-exceed-a-budget-or-a-project-by-cost-by-time-or-by-both"},{"title":"Move an amendment's money, or send it for approval where a chain is configured.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/apply_amendment","href":"/api-reference/amendments/move-an-amendments-money-or-send-it-for-approval-where-a-chain-is-configured"},{"title":"Accept an overrun.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/approve_overrun","href":"/api-reference/amendments/accept-an-overrun"},{"title":"Raise a request to increase, decrease, transfer or rectify a budget head.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/raise_budget_amendment","href":"/api-reference/amendments/raise-a-request-to-increase-decrease-transfer-or-rectify-a-budget-head"},{"title":"Raise approval to exceed a head or a project.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/raise_overrun_request","href":"/api-reference/amendments/raise-approval-to-exceed-a-head-or-a-project"},{"title":"Turn down a budget amendment, with the reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reject_amendment","href":"/api-reference/amendments/turn-down-a-budget-amendment-with-the-reason"},{"title":"Turn down an overrun request, with the reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reject_overrun","href":"/api-reference/amendments/turn-down-an-overrun-request-with-the-reason"},{"title":"Correct an amendment nobody has decided: its amount, reason, target head and outside reference.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_budget_amendment","href":"/api-reference/amendments/correct-an-amendment-nobody-has-decided:-its-amount-reason-target-head-and-outside-reference"},{"title":"Correct an overrun request nobody has decided: its figures, its reasons and its outside reference.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_overrun_request","href":"/api-reference/amendments/correct-an-overrun-request-nobody-has-decided:-its-figures-its-reasons-and-its-outside-reference"},{"title":"Take back an amendment you raised, and stop the chain holding it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/withdraw_amendment","href":"/api-reference/amendments/take-back-an-amendment-you-raised-and-stop-the-chain-holding-it"}]},{"group":"Budgets","pages":[{"title":"Every movement against a budget head, commitments and actuals, newest arithmetic included.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /budget_entries","href":"/api-reference/budgets/every-movement-against-a-budget-head-commitments-and-actuals-newest-arithmetic-included"},{"title":"Budget heads with their position: sanctioned, released, committed, spent and left.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /budgets","href":"/api-reference/budgets/budget-heads-with-their-position:-sanctioned-released-committed-spent-and-left"},{"title":"The financial years a book or a budget runs on, with the company each belongs to, the year each continues and the year…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /fiscal_calendars","href":"/api-reference/budgets/the-financial-years-a-book-or-a-budget-runs-on-with-the-company-each-belongs-to-the-year-each-continues-and-the-year…"},{"title":"Maintenance cost per fiscal period against the OPEX budget for it — the executive cost trend and the line to draw it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenance_spend_against_budget","href":"/api-reference/budgets/maintenance-cost-per-fiscal-period-against-the-opex-budget-for-it-—-the-executive-cost-trend-and-the-line-to-draw-it…"},{"title":"Open a budget head for charging.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/activate_budget","href":"/api-reference/budgets/open-a-budget-head-for-charging"},{"title":"Would this amount fit in this head, and how does the head want an overspend handled.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/budget_check","href":"/api-reference/budgets/would-this-amount-fit-in-this-head-and-how-does-the-head-want-an-overspend-handled"},{"title":"Point one document at the budget head that funds it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/charge_to_budget","href":"/api-reference/budgets/point-one-document-at-the-budget-head-that-funds-it"},{"title":"Close a budget head.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/close_budget","href":"/api-reference/budgets/close-a-budget-head"},{"title":"Open a budget head for its fiscal calendar's year.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_budget","href":"/api-reference/budgets/open-a-budget-head-for-its-fiscal-calendars-year"},{"title":"Remove a budget head that has never been charged.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_budget","href":"/api-reference/budgets/remove-a-budget-head-that-has-never-been-charged"},{"title":"Record a budget movement by hand.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_budget_movement","href":"/api-reference/budgets/record-a-budget-movement-by-hand"},{"title":"Release money into a head, or take unspent money back.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/release_budget","href":"/api-reference/budgets/release-money-into-a-head-or-take-unspent-money-back"},{"title":"Change what a head is sanctioned for, refusing a cut below what is carved out or released.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_budget_sanction","href":"/api-reference/budgets/change-what-a-head-is-sanctioned-for-refusing-a-cut-below-what-is-carved-out-or-released"},{"title":"Edit a budget head's description and how it is enforced.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_budget","href":"/api-reference/budgets/edit-a-budget-heads-description-and-how-it-is-enforced"}]},{"group":"Bulk jobs","pages":[{"title":"One row per record in a bulk job the caller started.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bulk_job_items","href":"/api-reference/bulk-jobs/one-row-per-record-in-a-bulk-job-the-caller-started"},{"title":"Bulk actions the caller started over everything a filter matched, and how far each has got.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /bulk_jobs","href":"/api-reference/bulk-jobs/bulk-actions-the-caller-started-over-everything-a-filter-matched-and-how-far-each-has-got"},{"title":"Add to bulk jobs: Bulk actions the caller started over everything a filter matched, and how far each has got.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /bulk_jobs","href":"/api-reference/bulk-jobs/add-to-bulk-jobs:-bulk-actions-the-caller-started-over-everything-a-filter-matched-and-how-far-each-has-got"},{"title":"Remove rows from bulk jobs: Bulk actions the caller started over everything a filter matched, and how far each has got.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /bulk_jobs","href":"/api-reference/bulk-jobs/remove-rows-from-bulk-jobs:-bulk-actions-the-caller-started-over-everything-a-filter-matched-and-how-far-each-has-got"},{"title":"Change rows in bulk jobs: Bulk actions the caller started over everything a filter matched, and how far each has got.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /bulk_jobs","href":"/api-reference/bulk-jobs/change-rows-in-bulk-jobs:-bulk-actions-the-caller-started-over-everything-a-filter-matched-and-how-far-each-has-got"},{"title":"Stop a bulk job the caller started.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_bulk_job","href":"/api-reference/bulk-jobs/stop-a-bulk-job-the-caller-started"},{"title":"Run a bulk action over every record a register's filter matches, in the background.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/start_bulk_job","href":"/api-reference/bulk-jobs/run-a-bulk-action-over-every-record-a-registers-filter-matches-in-the-background"}]},{"group":"Capex plans","pages":[{"title":"The divisions and regions inside a company, for anything that has to name one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /business_units","href":"/api-reference/capex-plans/the-divisions-and-regions-inside-a-company-for-anything-that-has-to-name-one"},{"title":"The budget categories a capex proposal can be counted under: the active values of your organisation's list named…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_budget_categories","href":"/api-reference/capex-plans/the-budget-categories-a-capex-proposal-can-be-counted-under:-the-active-values-of-your-organisations-list-named…"},{"title":"Add to capex budget categories: The budget categories a capex proposal can be counted under: the active values of your organisation's list named…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /capex_budget_categories","href":"/api-reference/capex-plans/add-to-capex-budget-categories:-the-budget-categories-a-capex-proposal-can-be-counted-under:-the-active-values-of-your-organisations-list-named…"},{"title":"Remove rows from capex budget categories: The budget categories a capex proposal can be counted under: the active values of your organisation's list named…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /capex_budget_categories","href":"/api-reference/capex-plans/remove-rows-from-capex-budget-categories:-the-budget-categories-a-capex-proposal-can-be-counted-under:-the-active-values-of-your-organisations-list-named…"},{"title":"Change rows in capex budget categories: The budget categories a capex proposal can be counted under: the active values of your organisation's list named…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /capex_budget_categories","href":"/api-reference/capex-plans/change-rows-in-capex-budget-categories:-the-budget-categories-a-capex-proposal-can-be-counted-under:-the-active-values-of-your-organisations-list-named…"},{"title":"The calendars a capex plan can be stated in, without the books kept against them. takes_new_plans says whether a new…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_calendars","href":"/api-reference/capex-plans/the-calendars-a-capex-plan-can-be-stated-in-without-the-books-kept-against-them-takes_new_plans-says-whether-a-new…"},{"title":"The values a capex proposal's Category can be chosen from: the active values of your organisation's list named Category…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_category_master_values","href":"/api-reference/capex-plans/the-values-a-capex-proposals-category-can-be-chosen-from:-the-active-values-of-your-organisations-list-named-category…"},{"title":"Add to capex category master values: The values a capex proposal's Category can be chosen from: the active values of your organisation's list named Category…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /capex_category_master_values","href":"/api-reference/capex-plans/add-to-capex-category-master-values:-the-values-a-capex-proposals-category-can-be-chosen-from:-the-active-values-of-your-organisations-list-named-category…"},{"title":"Remove rows from capex category master values: The values a capex proposal's Category can be chosen from: the active values of your organisation's list named Category…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /capex_category_master_values","href":"/api-reference/capex-plans/remove-rows-from-capex-category-master-values:-the-values-a-capex-proposals-category-can-be-chosen-from:-the-active-values-of-your-organisations-list-named-category…"},{"title":"Change rows in capex category master values: The values a capex proposal's Category can be chosen from: the active values of your organisation's list named Category…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /capex_category_master_values","href":"/api-reference/capex-plans/change-rows-in-capex-category-master-values:-the-values-a-capex-proposals-category-can-be-chosen-from:-the-active-values-of-your-organisations-list-named-category…"},{"title":"A division's capex proposals for a financial year, across its unit plans and its own, counted and totalled by where…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_division_proposals","href":"/api-reference/capex-plans/a-divisions-capex-proposals-for-a-financial-year-across-its-unit-plans-and-its-own-counted-and-totalled-by-where…"},{"title":"Active users, with the address \"CC\" on a capex plan resolves to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_invite_candidates","href":"/api-reference/capex-plans/active-users-with-the-address-\"cc\"-on-a-capex-plan-resolves-to"},{"title":"Add to capex invite candidates: Active users, with the address \"CC\" on a capex plan resolves to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /capex_invite_candidates","href":"/api-reference/capex-plans/add-to-capex-invite-candidates:-active-users-with-the-address-\"cc\"-on-a-capex-plan-resolves-to"},{"title":"Remove rows from capex invite candidates: Active users, with the address \"CC\" on a capex plan resolves to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /capex_invite_candidates","href":"/api-reference/capex-plans/remove-rows-from-capex-invite-candidates:-active-users-with-the-address-\"cc\"-on-a-capex-plan-resolves-to"},{"title":"Change rows in capex invite candidates: Active users, with the address \"CC\" on a capex plan resolves to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /capex_invite_candidates","href":"/api-reference/capex-plans/change-rows-in-capex-invite-candidates:-active-users-with-the-address-\"cc\"-on-a-capex-plan-resolves-to"},{"title":"Why the money is being spent, for a form that has to offer the list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_natures","href":"/api-reference/capex-plans/why-the-money-is-being-spent-for-a-form-that-has-to-offer-the-list"},{"title":"The months a plan year is divided into — the columns of the phasing grid, and nothing else.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_periods","href":"/api-reference/capex-plans/the-months-a-plan-year-is-divided-into-—-the-columns-of-the-phasing-grid-and-nothing-else"},{"title":"The proposals in a plan, with what each was asked for, allowed, and phased to spend. scheme_value is…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_plan_lines","href":"/api-reference/capex-plans/the-proposals-in-a-plan-with-what-each-was-asked-for-allowed-and-phased-to-spend-scheme_value-is…"},{"title":"A plan's month-wise and outer-year phasing, one row per line, measure and period.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_plan_phasing","href":"/api-reference/capex-plans/a-plans-month-wise-and-outer-year-phasing-one-row-per-line-measure-and-period"},{"title":"Capex plans with what was asked for, what survived, and what is holding them up. awaiting_instance_id is the approval…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_plans","href":"/api-reference/capex-plans/capex-plans-with-what-was-asked-for-what-survived-and-what-is-holding-them-up-awaiting_instance_id-is-the-approval…"},{"title":"Correct a capex proposal that is waiting on you as its approver, before you sign it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/amend_capex_proposal","href":"/api-reference/capex-plans/correct-a-capex-proposal-that-is-waiting-on-you-as-its-approver-before-you-sign-it"},{"title":"Move a capex proposal's phasing between months as its approver, keeping each measure's total: changing the total is…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/amend_capex_proposal_phasing","href":"/api-reference/capex-plans/move-a-capex-proposals-phasing-between-months-as-its-approver-keeping-each-measures-total:-changing-the-total-is…"},{"title":"Delete several capex proposals at once, each exactly as delete_capex_plan_line deletes one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_delete_capex_plan_lines","href":"/api-reference/capex-plans/delete-several-capex-proposals-at-once-each-exactly-as-delete_capex_plan_line-deletes-one"},{"title":"Change several capex proposals at once, each exactly as save_capex_plan_line changes one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_save_capex_plan_lines","href":"/api-reference/capex-plans/change-several-capex-proposals-at-once-each-exactly-as-save_capex_plan_line-changes-one"},{"title":"What this plan fails right now, recomputed rather than remembered (FA_CPA_PA_12, _22, _23, _24).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capex_plan_exceptions","href":"/api-reference/capex-plans/what-this-plan-fails-right-now-recomputed-rather-than-remembered-fa_cpa_pa_12-_22-_23-_24"},{"title":"Whether your organisation is ready to approve capex proposals one at a time: whether a workflow for them has a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capex_proposal_switch_check","href":"/api-reference/capex-plans/whether-your-organisation-is-ready-to-approve-capex-proposals-one-at-a-time:-whether-a-workflow-for-them-has-a…"},{"title":"The category a proposal would be given at this value and quantity on this plan, worked out the way saving it works it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capex_scheme_category","href":"/api-reference/capex-plans/the-category-a-proposal-would-be-given-at-this-value-and-quantity-on-this-plan-worked-out-the-way-saving-it-works-it…"},{"title":"Open next year's plan with what this one did not finish.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/carry_forward_capex_plan","href":"/api-reference/capex-plans/open-next-years-plan-with-what-this-one-did-not-finish"},{"title":"Pull an approved unit plan's surviving proposals into a division plan (FA_CPA_PA_19, _21).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/consolidate_capex_plan","href":"/api-reference/capex-plans/pull-an-approved-unit-plans-surviving-proposals-into-a-division-plan-fa_cpa_pa_19-_21"},{"title":"Start a capex plan for a year.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_capex_plan","href":"/api-reference/capex-plans/start-a-capex-plan-for-a-year"},{"title":"Take a proposal off a plan while it is a draft, or while it is back with you for revision, which withdraws the request…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_capex_plan_line","href":"/api-reference/capex-plans/take-a-proposal-off-a-plan-while-it-is-a-draft-or-while-it-is-back-with-you-for-revision-which-withdraws-the-request…"},{"title":"Add proposals to a draft capex plan from a spreadsheet, or correct the ones it has: a row giving the Proposal ID of a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_capex_plan_lines","href":"/api-reference/capex-plans/add-proposals-to-a-draft-capex-plan-from-a-spreadsheet-or-correct-the-ones-it-has:-a-row-giving-the-proposal-id-of-a…"},{"title":"Add capex proposals to any plan, and correct proposals on any plan, from one spreadsheet. p_payload is {\"lines\"…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_capex_proposals","href":"/api-reference/capex-plans/add-capex-proposals-to-any-plan-and-correct-proposals-on-any-plan-from-one-spreadsheet-p_payload-is-\"lines\"…"},{"title":"Mark a capex proposal Flexible, or take the mark off, from the approval request it is an item of.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/mark_capex_scheme_flexible","href":"/api-reference/capex-plans/mark-a-capex-proposal-flexible-or-take-the-mark-off-from-the-approval-request-it-is-an-item-of"},{"title":"Open one budget head per finally approved proposal that has none, sanctioned and not yet released.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/open_capex_plan_budgets","href":"/api-reference/capex-plans/open-one-budget-head-per-finally-approved-proposal-that-has-none-sanctioned-and-not-yet-released"},{"title":"Turn down a submitted plan, with the reason, at the step of its approval that is waiting on you.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reject_capex_plan","href":"/api-reference/capex-plans/turn-down-a-submitted-plan-with-the-reason-at-the-step-of-its-approval-that-is-waiting-on-you"},{"title":"Announce a picture or PDF for a capex proposal's justification and get somewhere to put it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_capex_justification_upload","href":"/api-reference/capex-plans/announce-a-picture-or-pdf-for-a-capex-proposals-justification-and-get-somewhere-to-put-it"},{"title":"Announce a picture for a capex plan's description and get somewhere to put it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_capex_plan_description_upload","href":"/api-reference/capex-plans/announce-a-picture-for-a-capex-plans-description-and-get-somewhere-to-put-it"},{"title":"Add a proposal to a draft plan or change one (FA_CPA_PA_4).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_capex_plan_line","href":"/api-reference/capex-plans/add-a-proposal-to-a-draft-plan-or-change-one-fa_cpa_pa_4"},{"title":"Send a capex plan's stakeholder invite that is waiting for the plan's files, now.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/send_capex_plan_invite","href":"/api-reference/capex-plans/send-a-capex-plans-stakeholder-invite-that-is-waiting-for-the-plans-files-now"},{"title":"Replace one measure's month-wise and outer-year phasing for a proposal.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_capex_line_phasing","href":"/api-reference/capex-plans/replace-one-measures-month-wise-and-outer-year-phasing-for-a-proposal"},{"title":"Submit a plan for line-by-line approval, or approve it where no chain is configured.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_capex_plan","href":"/api-reference/capex-plans/submit-a-plan-for-line-by-line-approval-or-approve-it-where-no-chain-is-configured"},{"title":"Send a capex proposal into its approval workflow, or send it back after revision.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_capex_proposal","href":"/api-reference/capex-plans/send-a-capex-proposal-into-its-approval-workflow-or-send-it-back-after-revision"},{"title":"Send many capex proposals into their approval workflow in one call, each on its own, with one outcome for each: a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_capex_proposals","href":"/api-reference/capex-plans/send-many-capex-proposals-into-their-approval-workflow-in-one-call-each-on-its-own-with-one-outcome-for-each:-a…"},{"title":"Move your organisation to approving capex proposals one at a time, each in its own workflow, instead of approving whole…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/switch_capex_to_proposal_approval","href":"/api-reference/capex-plans/move-your-organisation-to-approving-capex-proposals-one-at-a-time-each-in-its-own-workflow-instead-of-approving-whole…"},{"title":"Change a draft plan's invite-cycle dates, audience and invite subject.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_capex_plan_dates","href":"/api-reference/capex-plans/change-a-draft-plans-invite-cycle-dates-audience-and-invite-subject"},{"title":"Take a submitted plan back to draft so it can be amended and resubmitted (FA_CPA_PA_15).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/withdraw_capex_plan","href":"/api-reference/capex-plans/take-a-submitted-plan-back-to-draft-so-it-can-be-amended-and-resubmitted-fa_cpa_pa_15"}]},{"group":"Root cause analysis","pages":[{"title":"Corrective and preventive actions, with whether each was done, checked, and found to work.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capa_actions","href":"/api-reference/root-cause-analysis/corrective-and-preventive-actions-with-whether-each-was-done-checked-and-found-to-work"},{"title":"Work orders classified as failures, with the taxonomy and whether this has happened before.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /failures","href":"/api-reference/root-cause-analysis/work-orders-classified-as-failures-with-the-taxonomy-and-whether-this-has-happened-before"},{"title":"Root-cause investigations — about an asset or about a place — with how many findings and how many actions are still…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rca_investigations","href":"/api-reference/root-cause-analysis/root-cause-investigations-—-about-an-asset-or-about-a-place-—-with-how-many-findings-and-how-many-actions-are-still…"},{"title":"Record what kind of failure a work order was.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/classify_failure","href":"/api-reference/root-cause-analysis/record-what-kind-of-failure-a-work-order-was"},{"title":"Conclude an investigation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/conclude_rca","href":"/api-reference/root-cause-analysis/conclude-an-investigation"},{"title":"Open a root-cause investigation into an asset or a place, closing the recommendation that asked for it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/open_rca","href":"/api-reference/root-cause-analysis/open-a-root-cause-investigation-into-an-asset-or-a-place-closing-the-recommendation-that-asked-for-it"},{"title":"One investigation's findings as a tree — a Five Whys chain, a fishbone, or a fault tree.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rca_findings","href":"/api-reference/root-cause-analysis/one-investigations-findings-as-a-tree-—-a-five-whys-chain-a-fishbone-or-a-fault-tree"},{"title":"Record whether an action actually worked, some time after it was verified.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/review_capa_effectiveness","href":"/api-reference/root-cause-analysis/record-whether-an-action-actually-worked-some-time-after-it-was-verified"},{"title":"Create or amend a corrective or preventive action against an investigation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_capa","href":"/api-reference/root-cause-analysis/create-or-amend-a-corrective-or-preventive-action-against-an-investigation"},{"title":"Add or amend one node of an investigation — a why, a bone, or a branch.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_rca_finding","href":"/api-reference/root-cause-analysis/add-or-amend-one-node-of-an-investigation-—-a-why-a-bone-or-a-branch"},{"title":"Record that an action was actually done, by the caller, now.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/verify_capa","href":"/api-reference/root-cause-analysis/record-that-an-action-was-actually-done-by-the-caller-now"}]},{"group":"Capex change logs","pages":[{"title":"Every change to a proposal's approval notes, a row per field, in the shape of capex_proposal_change_logs: changed_by…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_approval_note_change_logs","href":"/api-reference/capex-change-logs/every-change-to-a-proposals-approval-notes-a-row-per-field-in-the-shape-of-capex_proposal_change_logs:-changed_by…"},{"title":"Every change to an approved proposal's capitalization plan, a row per field, in the shape of…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_capitalization_change_logs","href":"/api-reference/capex-change-logs/every-change-to-an-approved-proposals-capitalization-plan-a-row-per-field-in-the-shape-of…"},{"title":"Every change to an approved proposal's planning on the consolidated capex plan, a row per field, in the shape of…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_consolidation_change_logs","href":"/api-reference/capex-change-logs/every-change-to-an-approved-proposals-planning-on-the-consolidated-capex-plan-a-row-per-field-in-the-shape-of…"},{"title":"Every change to a capex plan, a row per field, in the shape of capex_proposal_change_logs: changed_by, changed_at…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_plan_change_logs","href":"/api-reference/capex-change-logs/every-change-to-a-capex-plan-a-row-per-field-in-the-shape-of-capex_proposal_change_logs:-changed_by-changed_at…"},{"title":"Every change to a capex proposal, a row per field: who changed it (changed_by), when (changed_at), which field…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_proposal_change_logs","href":"/api-reference/capex-change-logs/every-change-to-a-capex-proposal-a-row-per-field:-who-changed-it-changed_by-when-changed_at-which-field…"},{"title":"Every change to a T\u0026C appraisal note, a row per field, in the shape of capex_proposal_change_logs: changed_by…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tnc_appraisal_note_change_logs","href":"/api-reference/capex-change-logs/every-change-to-a-t\u0026c-appraisal-note-a-row-per-field-in-the-shape-of-capex_proposal_change_logs:-changed_by…"}]},{"group":"Capex approval notes","pages":[{"title":"The capex approval notes: the papers a planned Project, Specified or Flexible capex proposal goes to the committee…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_approval_notes","href":"/api-reference/capex-approval-notes/the-capex-approval-notes:-the-papers-a-planned-project-specified-or-flexible-capex-proposal-goes-to-the-committee…"},{"title":"The policies a capex approval note can name as relevant to its subject matter: the values of your organisation's list…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_fixed_policies","href":"/api-reference/capex-approval-notes/the-policies-a-capex-approval-note-can-name-as-relevant-to-its-subject-matter:-the-values-of-your-organisations-list…"},{"title":"Add to capex fixed policies: The policies a capex approval note can name as relevant to its subject matter: the values of your organisation's list…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /capex_fixed_policies","href":"/api-reference/capex-approval-notes/add-to-capex-fixed-policies:-the-policies-a-capex-approval-note-can-name-as-relevant-to-its-subject-matter:-the-values-of-your-organisations-list…"},{"title":"Remove rows from capex fixed policies: The policies a capex approval note can name as relevant to its subject matter: the values of your organisation's list…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /capex_fixed_policies","href":"/api-reference/capex-approval-notes/remove-rows-from-capex-fixed-policies:-the-policies-a-capex-approval-note-can-name-as-relevant-to-its-subject-matter:-the-values-of-your-organisations-list…"},{"title":"Change rows in capex fixed policies: The policies a capex approval note can name as relevant to its subject matter: the values of your organisation's list…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /capex_fixed_policies","href":"/api-reference/capex-approval-notes/change-rows-in-capex-fixed-policies:-the-policies-a-capex-approval-note-can-name-as-relevant-to-its-subject-matter:-the-values-of-your-organisations-list…"},{"title":"Raise an approval note on a proposal's row on the consolidated plan (see capex_consolidated_lines, whose may_raise_note…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/raise_capex_approval_note","href":"/api-reference/capex-approval-notes/raise-an-approval-note-on-a-proposals-row-on-the-consolidated-plan-see-capex_consolidated_lines-whose-may_raise_note…"},{"title":"Announce a picture or PDF for one of a capex approval note's documents and get somewhere to put it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_capex_approval_note_upload","href":"/api-reference/capex-approval-notes/announce-a-picture-or-pdf-for-one-of-a-capex-approval-notes-documents-and-get-somewhere-to-put-it"},{"title":"Change a capex approval note.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_capex_approval_note","href":"/api-reference/capex-approval-notes/change-a-capex-approval-note"},{"title":"Send a capex approval note for approval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_capex_approval_note","href":"/api-reference/capex-approval-notes/send-a-capex-approval-note-for-approval"}]},{"group":"Capex consolidation","pages":[{"title":"The asset blocks a proposal on the consolidated capex plan can be put in: your organisation's asset categories. path…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_asset_blocks","href":"/api-reference/capex-consolidation/the-asset-blocks-a-proposal-on-the-consolidated-capex-plan-can-be-put-in:-your-organisations-asset-categories-path…"},{"title":"Add to capex asset blocks: The asset blocks a proposal on the consolidated capex plan can be put in: your organisation's asset categories. path…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /capex_asset_blocks","href":"/api-reference/capex-consolidation/add-to-capex-asset-blocks:-the-asset-blocks-a-proposal-on-the-consolidated-capex-plan-can-be-put-in:-your-organisations-asset-categories-path…"},{"title":"Remove rows from capex asset blocks: The asset blocks a proposal on the consolidated capex plan can be put in: your organisation's asset categories. path…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /capex_asset_blocks","href":"/api-reference/capex-consolidation/remove-rows-from-capex-asset-blocks:-the-asset-blocks-a-proposal-on-the-consolidated-capex-plan-can-be-put-in:-your-organisations-asset-categories-path…"},{"title":"Change rows in capex asset blocks: The asset blocks a proposal on the consolidated capex plan can be put in: your organisation's asset categories. path…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /capex_asset_blocks","href":"/api-reference/capex-consolidation/change-rows-in-capex-asset-blocks:-the-asset-blocks-a-proposal-on-the-consolidated-capex-plan-can-be-put-in:-your-organisations-asset-categories-path…"},{"title":"The consolidated capex plan: one row for each capex proposal approved for the consolidation plan, made when it was…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_consolidated_lines","href":"/api-reference/capex-consolidation/the-consolidated-capex-plan:-one-row-for-each-capex-proposal-approved-for-the-consolidation-plan-made-when-it-was…"},{"title":"The GST rates a proposal on the consolidated capex plan can be given: the values of your organisation's list named GST…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_gst_rates","href":"/api-reference/capex-consolidation/the-gst-rates-a-proposal-on-the-consolidated-capex-plan-can-be-given:-the-values-of-your-organisations-list-named-gst…"},{"title":"Add to capex gst rates: The GST rates a proposal on the consolidated capex plan can be given: the values of your organisation's list named GST…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /capex_gst_rates","href":"/api-reference/capex-consolidation/add-to-capex-gst-rates:-the-gst-rates-a-proposal-on-the-consolidated-capex-plan-can-be-given:-the-values-of-your-organisations-list-named-gst…"},{"title":"Remove rows from capex gst rates: The GST rates a proposal on the consolidated capex plan can be given: the values of your organisation's list named GST…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /capex_gst_rates","href":"/api-reference/capex-consolidation/remove-rows-from-capex-gst-rates:-the-gst-rates-a-proposal-on-the-consolidated-capex-plan-can-be-given:-the-values-of-your-organisations-list-named-gst…"},{"title":"Change rows in capex gst rates: The GST rates a proposal on the consolidated capex plan can be given: the values of your organisation's list named GST…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /capex_gst_rates","href":"/api-reference/capex-consolidation/change-rows-in-capex-gst-rates:-the-gst-rates-a-proposal-on-the-consolidated-capex-plan-can-be-given:-the-values-of-your-organisations-list-named-gst…"},{"title":"Change several proposals' rows on the consolidated capex plan at once, each exactly as save_capex_consolidated_line…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_save_capex_consolidated_lines","href":"/api-reference/capex-consolidation/change-several-proposals-rows-on-the-consolidated-capex-plan-at-once-each-exactly-as-save_capex_consolidated_line…"},{"title":"Change proposals' rows on the consolidated capex plan from a spreadsheet, row by row, or say what stops each one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_capex_consolidated_lines","href":"/api-reference/capex-consolidation/change-proposals-rows-on-the-consolidated-capex-plan-from-a-spreadsheet-row-by-row-or-say-what-stops-each-one"},{"title":"Change an approved proposal's row on the consolidated capex plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_capex_consolidated_line","href":"/api-reference/capex-consolidation/change-an-approved-proposals-row-on-the-consolidated-capex-plan"},{"title":"Send a proposal's row on the consolidated capex plan for approval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_capex_consolidated_line","href":"/api-reference/capex-consolidation/send-a-proposals-row-on-the-consolidated-capex-plan-for-approval"}]},{"group":"Capex capitalization","pages":[{"title":"The asset blocks a lot of a capex proposal's capitalization plan can land in: your organisation's asset categories.…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_capitalization_blocks","href":"/api-reference/capex-capitalization/the-asset-blocks-a-lot-of-a-capex-proposals-capitalization-plan-can-land-in:-your-organisations-asset-categories…"},{"title":"Add to capex capitalization blocks: The asset blocks a lot of a capex proposal's capitalization plan can land in: your organisation's asset categories.…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /capex_capitalization_blocks","href":"/api-reference/capex-capitalization/add-to-capex-capitalization-blocks:-the-asset-blocks-a-lot-of-a-capex-proposals-capitalization-plan-can-land-in:-your-organisations-asset-categories…"},{"title":"Remove rows from capex capitalization blocks: The asset blocks a lot of a capex proposal's capitalization plan can land in: your organisation's asset categories.…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /capex_capitalization_blocks","href":"/api-reference/capex-capitalization/remove-rows-from-capex-capitalization-blocks:-the-asset-blocks-a-lot-of-a-capex-proposals-capitalization-plan-can-land-in:-your-organisations-asset-categories…"},{"title":"Change rows in capex capitalization blocks: The asset blocks a lot of a capex proposal's capitalization plan can land in: your organisation's asset categories.…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /capex_capitalization_blocks","href":"/api-reference/capex-capitalization/change-rows-in-capex-capitalization-blocks:-the-asset-blocks-a-lot-of-a-capex-proposals-capitalization-plan-can-land-in:-your-organisations-asset-categories…"},{"title":"The lots a capex proposal's capitalization plan is capitalized in, each with its depreciation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_capitalization_lines","href":"/api-reference/capex-capitalization/the-lots-a-capex-proposals-capitalization-plan-is-capitalized-in-each-with-its-depreciation"},{"title":"The capitalization plan: one row for each approved capex proposal, made when it was approved, saying when its money…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_capitalization_plans","href":"/api-reference/capex-capitalization/the-capitalization-plan:-one-row-for-each-approved-capex-proposal-made-when-it-was-approved-saying-when-its-money…"},{"title":"The TNC asset types a Plant and Machinery lot of a capitalization plan can be given: the values of your organisation's…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /capex_tnc_asset_types","href":"/api-reference/capex-capitalization/the-tnc-asset-types-a-plant-and-machinery-lot-of-a-capitalization-plan-can-be-given:-the-values-of-your-organisations…"},{"title":"Add to capex tnc asset types: The TNC asset types a Plant and Machinery lot of a capitalization plan can be given: the values of your organisation's…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /capex_tnc_asset_types","href":"/api-reference/capex-capitalization/add-to-capex-tnc-asset-types:-the-tnc-asset-types-a-plant-and-machinery-lot-of-a-capitalization-plan-can-be-given:-the-values-of-your-organisations…"},{"title":"Remove rows from capex tnc asset types: The TNC asset types a Plant and Machinery lot of a capitalization plan can be given: the values of your organisation's…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /capex_tnc_asset_types","href":"/api-reference/capex-capitalization/remove-rows-from-capex-tnc-asset-types:-the-tnc-asset-types-a-plant-and-machinery-lot-of-a-capitalization-plan-can-be-given:-the-values-of-your-organisations…"},{"title":"Change rows in capex tnc asset types: The TNC asset types a Plant and Machinery lot of a capitalization plan can be given: the values of your organisation's…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /capex_tnc_asset_types","href":"/api-reference/capex-capitalization/change-rows-in-capex-tnc-asset-types:-the-tnc-asset-types-a-plant-and-machinery-lot-of-a-capitalization-plan-can-be-given:-the-values-of-your-organisations…"},{"title":"Take a lot off a capex proposal's capitalization plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_capex_capitalization_line","href":"/api-reference/capex-capitalization/take-a-lot-off-a-capex-proposals-capitalization-plan"},{"title":"Change capex proposals' capitalization plans and their lots from a spreadsheet, a proposal at a time, or say what stops…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_capex_capitalization","href":"/api-reference/capex-capitalization/change-capex-proposals-capitalization-plans-and-their-lots-from-a-spreadsheet-a-proposal-at-a-time-or-say-what-stops…"},{"title":"Add a lot to a capex proposal's capitalization plan, or change one (p_id, which must be a lot of that plan).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_capex_capitalization_line","href":"/api-reference/capex-capitalization/add-a-lot-to-a-capex-proposals-capitalization-plan-or-change-one-p_id-which-must-be-a-lot-of-that-plan"},{"title":"Change an approved proposal's capitalization plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_capex_capitalization_plan","href":"/api-reference/capex-capitalization/change-an-approved-proposals-capitalization-plan"},{"title":"Send a proposal's capitalization plan for approval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_capex_capitalization_plan","href":"/api-reference/capex-capitalization/send-a-proposals-capitalization-plan-for-approval"}]},{"group":"Catalogue","pages":[{"title":"The signed-in person's cart: each item, how many, and what it costs at today's agreed price.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog_cart","href":"/api-reference/catalogue/the-signed-in-persons-cart:-each-item-how-many-and-what-it-costs-at-todays-agreed-price"},{"title":"The shelves a catalogue is browsed by, with how many published items each one holds.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog_categories","href":"/api-reference/catalogue/the-shelves-a-catalogue-is-browsed-by-with-how-many-published-items-each-one-holds"},{"title":"Add to catalog categories: The shelves a catalogue is browsed by, with how many published items each one holds.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /catalog_categories","href":"/api-reference/catalogue/add-to-catalog-categories:-the-shelves-a-catalogue-is-browsed-by-with-how-many-published-items-each-one-holds"},{"title":"Remove rows from catalog categories: The shelves a catalogue is browsed by, with how many published items each one holds.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /catalog_categories","href":"/api-reference/catalogue/remove-rows-from-catalog-categories:-the-shelves-a-catalogue-is-browsed-by-with-how-many-published-items-each-one-holds"},{"title":"Change rows in catalog categories: The shelves a catalogue is browsed by, with how many published items each one holds.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /catalog_categories","href":"/api-reference/catalogue/change-rows-in-catalog-categories:-the-shelves-a-catalogue-is-browsed-by-with-how-many-published-items-each-one-holds"},{"title":"Every catalogue item, published or not: what it is, its agreed price and supplier, its limits, who it is for, and how…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /catalog_items","href":"/api-reference/catalogue/every-catalogue-item-published-or-not:-what-it-is-its-agreed-price-and-supplier-its-limits-who-it-is-for-and-how…"},{"title":"The catalogue items a person may ask for, for delivery at a site.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/catalog_browse","href":"/api-reference/catalogue/the-catalogue-items-a-person-may-ask-for-for-delivery-at-a-site"},{"title":"For each line of the signed-in person's cart, whether it can be asked for at a site and for whom, and if not, why…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/catalog_cart_check","href":"/api-reference/catalogue/for-each-line-of-the-signed-in-persons-cart-whether-it-can-be-asked-for-at-a-site-and-for-whom-and-if-not-why…"},{"title":"Empty the signed-in person's cart.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clear_catalog_cart","href":"/api-reference/catalogue/empty-the-signed-in-persons-cart"},{"title":"The requisitions the signed-in person raised, and those raised for them by somebody else.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/my_purchase_requests","href":"/api-reference/catalogue/the-requisitions-the-signed-in-person-raised-and-those-raised-for-them-by-somebody-else"},{"title":"Set how many of a catalogue item are in the signed-in person's cart; zero takes it out.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_catalog_cart_quantity","href":"/api-reference/catalogue/set-how-many-of-a-catalogue-item-are-in-the-signed-in-persons-cart;-zero-takes-it-out"},{"title":"Say which sites, departments and roles a catalogue item is for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_catalog_item_audiences","href":"/api-reference/catalogue/say-which-sites-departments-and-roles-a-catalogue-item-is-for"}]},{"group":"Workforce configuration","pages":[{"title":"Certifications with the skills they authorise, who holds them and what is lapsing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /certification_settings","href":"/api-reference/workforce-configuration/certifications-with-the-skills-they-authorise-who-holds-them-and-what-is-lapsing"},{"title":"Shift patterns with their working minutes net of breaks, and how many are rostered on each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /shift_settings","href":"/api-reference/workforce-configuration/shift-patterns-with-their-working-minutes-net-of-breaks-and-how-many-are-rostered-on-each"},{"title":"Skill categories with the skills grouped under each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /skill_category_settings","href":"/api-reference/workforce-configuration/skill-categories-with-the-skills-grouped-under-each"},{"title":"Add to skill category settings: Skill categories with the skills grouped under each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /skill_category_settings","href":"/api-reference/workforce-configuration/add-to-skill-category-settings:-skill-categories-with-the-skills-grouped-under-each"},{"title":"Remove rows from skill category settings: Skill categories with the skills grouped under each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /skill_category_settings","href":"/api-reference/workforce-configuration/remove-rows-from-skill-category-settings:-skill-categories-with-the-skills-grouped-under-each"},{"title":"Change rows in skill category settings: Skill categories with the skills grouped under each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /skill_category_settings","href":"/api-reference/workforce-configuration/change-rows-in-skill-category-settings:-skill-categories-with-the-skills-grouped-under-each"},{"title":"api.skill_coverage plus the configuration half.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /skill_settings","href":"/api-reference/workforce-configuration/apiskill_coverage-plus-the-configuration-half"},{"title":"Training courses with attendances, passes, and the certification a pass grants.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /training_course_settings","href":"/api-reference/workforce-configuration/training-courses-with-attendances-passes-and-the-certification-a-pass-grants"},{"title":"Worker types with how many people are of each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /worker_type_settings","href":"/api-reference/workforce-configuration/worker-types-with-how-many-people-are-of-each"},{"title":"Add to worker type settings: Worker types with how many people are of each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /worker_type_settings","href":"/api-reference/workforce-configuration/add-to-worker-type-settings:-worker-types-with-how-many-people-are-of-each"},{"title":"Remove rows from worker type settings: Worker types with how many people are of each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /worker_type_settings","href":"/api-reference/workforce-configuration/remove-rows-from-worker-type-settings:-worker-types-with-how-many-people-are-of-each"},{"title":"Change rows in worker type settings: Worker types with how many people are of each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /worker_type_settings","href":"/api-reference/workforce-configuration/change-rows-in-worker-type-settings:-worker-types-with-how-many-people-are-of-each"}]},{"group":"Channels","pages":[{"title":"The rooms this organisation posts notifications into.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /channel_destinations","href":"/api-reference/channels/the-rooms-this-organisation-posts-notifications-into"},{"title":"One row, always: this organisation's email sender, or the deployment's where it has none.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /email_channel","href":"/api-reference/channels/one-row-always:-this-organisations-email-sender-or-the-deployments-where-it-has-none"},{"title":"How this organisation's notifications leave the building, with the credential described rather than disclosed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notification_channels","href":"/api-reference/channels/how-this-organisations-notifications-leave-the-building-with-the-credential-described-rather-than-disclosed"},{"title":"Whether anybody in this organisation can be reached by push, and what the last test did .","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /push_channel","href":"/api-reference/channels/whether-anybody-in-this-organisation-can-be-reached-by-push-and-what-the-last-test-did-"},{"title":"Remove the relay password.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clear_channel_credential","href":"/api-reference/channels/remove-the-relay-password"},{"title":"Remove a room, and with it the subscriptions that posted into it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_channel_destination","href":"/api-reference/channels/remove-a-room-and-with-it-the-subscriptions-that-posted-into-it"},{"title":"Add or edit a room: a Teams URL (write-only) or a Telegram chat id (not a secret).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_channel_destination","href":"/api-reference/channels/add-or-edit-a-room:-a-teams-url-write-only-or-a-telegram-chat-id-not-a-secret"},{"title":"Send through your own relay, or ours.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_email_channel","href":"/api-reference/channels/send-through-your-own-relay-or-ours"},{"title":"Save this organisation's SMS provider and its monthly ceiling.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_sms_channel","href":"/api-reference/channels/save-this-organisations-sms-provider-and-its-monthly-ceiling"},{"title":"Turn this organisation's Teams channel on or off.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_teams_channel","href":"/api-reference/channels/turn-this-organisations-teams-channel-on-or-off"},{"title":"Turn this organisation's Telegram channel on or off.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_telegram_channel","href":"/api-reference/channels/turn-this-organisations-telegram-channel-on-or-off"},{"title":"Save this organisation's WhatsApp sender and the approved template its messages go out as.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_whatsapp_channel","href":"/api-reference/channels/save-this-organisations-whatsapp-sender-and-the-approved-template-its-messages-go-out-as"},{"title":"Ask the worker to send one test message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/send_channel_test","href":"/api-reference/channels/ask-the-worker-to-send-one-test-message"},{"title":"Store the relay password, encrypted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_channel_credential","href":"/api-reference/channels/store-the-relay-password-encrypted"},{"title":"This organisation's SMS provider, its sender id, and how much of its monthly ceiling is spent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sms_channel","href":"/api-reference/channels/this-organisations-sms-provider-its-sender-id-and-how-much-of-its-monthly-ceiling-is-spent"},{"title":"This organisation's Teams channel, and how many of its rooms are actually working.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /teams_channel","href":"/api-reference/channels/this-organisations-teams-channel-and-how-many-of-its-rooms-are-actually-working"},{"title":"This organisation's Telegram bot, and how many of its groups are actually working.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /telegram_channel","href":"/api-reference/channels/this-organisations-telegram-bot-and-how-many-of-its-groups-are-actually-working"},{"title":"This organisation's WhatsApp sender, the approved template every message goes out as, and how much of its monthly…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /whatsapp_channel","href":"/api-reference/channels/this-organisations-whatsapp-sender-the-approved-template-every-message-goes-out-as-and-how-much-of-its-monthly…"}]},{"group":"Energy","pages":[{"title":"What this organisation buys and meters, with the unit its readings are in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /commodities","href":"/api-reference/energy/what-this-organisation-buys-and-meters-with-the-unit-its-readings-are-in"},{"title":"Periods that used more than they should have, with the sentence, the figures behind it and the job it raised.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /consumption_anomalies","href":"/api-reference/energy/periods-that-used-more-than-they-should-have-with-the-sentence-the-figures-behind-it-and-the-job-it-raised"},{"title":"What consumption was expected to be, by which method, from how large a sample.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /consumption_baselines","href":"/api-reference/energy/what-consumption-was-expected-to-be-by-which-method-from-how-large-a-sample"},{"title":"The reading ledger: the register that was read and the consumption it was banked as, with the full location it was read…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /consumption_readings","href":"/api-reference/energy/the-reading-ledger:-the-register-that-was-read-and-the-consumption-it-was-banked-as-with-the-full-location-it-was-read…"},{"title":"Consumption totalled by period, with what it was expected to be beside it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /consumption_snapshots","href":"/api-reference/energy/consumption-totalled-by-period-with-what-it-was-expected-to-be-beside-it"},{"title":"A year of each supply point's consumption on one line: a column per month, the year's total and the whole of the year…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /consumption_years","href":"/api-reference/energy/a-year-of-each-supply-points-consumption-on-one-line:-a-column-per-month-the-years-total-and-the-whole-of-the-year…"},{"title":"What a unit of a commodity carries in carbon, effective-dated and with its source named — so a grid that decarbonises…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /emission_factors","href":"/api-reference/energy/what-a-unit-of-a-commodity-carries-in-carbon-effective-dated-and-with-its-source-named-—-so-a-grid-that-decarbonises…"},{"title":"Every correction made to an energy reading: which reading, what its register and consumption were before and after, who…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /energy_reading_change_log","href":"/api-reference/energy/every-correction-made-to-an-energy-reading:-which-reading-what-its-register-and-consumption-were-before-and-after-who…"},{"title":"Reductions somebody has committed to, with where each one stands: the allowance its baseline implies, what has been…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reduction_targets","href":"/api-reference/energy/reductions-somebody-has-committed-to-with-where-each-one-stands:-the-allowance-its-baseline-implies-what-has-been…"},{"title":"What one asset consumed and what it cost, by commodity.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/asset_energy_consumption","href":"/api-reference/energy/what-one-asset-consumed-and-what-it-cost-by-commodity"},{"title":"Correct the register (or, with no dial, the quantity) of a reading from the last thirty days, and return what it now…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/correct_energy_reading","href":"/api-reference/energy/correct-the-register-or-with-no-dial-the-quantity-of-a-reading-from-the-last-thirty-days-and-return-what-it-now…"},{"title":"Disagree with a finding, on the record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dismiss_energy_anomaly","href":"/api-reference/energy/disagree-with-a-finding-on-the-record"},{"title":"The last thirty days before today at the supply point's site, whether each still has no reading, and the readings…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/energy_backdate_days","href":"/api-reference/energy/the-last-thirty-days-before-today-at-the-supply-points-site-whether-each-still-has-no-reading-and-the-readings…"},{"title":"Whether a reading is from the last thirty days at its site and so can be corrected, what it says now, and the readings…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/energy_reading_correction","href":"/api-reference/energy/whether-a-reading-is-from-the-last-thirty-days-at-its-site-and-so-can-be-corrected-what-it-says-now-and-the-readings…"},{"title":"A supply point's consumption by period, with both expectations — its own history and its peers — on the same row…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/energy_series","href":"/api-reference/energy/a-supply-points-consumption-by-period-with-both-expectations-—-its-own-history-and-its-peers-—-on-the-same-row…"},{"title":"Record a reading for one of the last thirty days that has none, and return what it banked.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_backdated_energy_reading","href":"/api-reference/energy/record-a-reading-for-one-of-the-last-thirty-days-that-has-none-and-return-what-it-banked"},{"title":"Record one reading and return what it banked — the consumption, the cost, and whether it fed a meter.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_energy_reading","href":"/api-reference/energy/record-one-reading-and-return-what-it-banked-—-the-consumption-the-cost-and-whether-it-fed-a-meter"},{"title":"Set the expectation for one period by hand.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_energy_baseline","href":"/api-reference/energy/set-the-expectation-for-one-period-by-hand"},{"title":"Where each commodity is metered, with the latest period's consumption and whether it feeds a meter.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /supply_points","href":"/api-reference/energy/where-each-commodity-is-metered-with-the-latest-periods-consumption-and-whether-it-feeds-a-meter"},{"title":"The unit rates, effective-dated.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tariffs","href":"/api-reference/energy/the-unit-rates-effective-dated"},{"title":"Which sensor a site counts its degree days from, at what base temperature, and whether it is still reporting.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /weather_sources","href":"/api-reference/energy/which-sensor-a-site-counts-its-degree-days-from-at-what-base-temperature-and-whether-it-is-still-reporting"}]},{"group":"Contracts","pages":[{"title":"The contract's yes-or-no terms as readable lines: parts, labour, travel, who may do the work and what happens at the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contract_cover","href":"/api-reference/contracts/the-contracts-yes-or-no-terms-as-readable-lines:-parts-labour-travel-who-may-do-the-work-and-what-happens-at-the…"},{"title":"Named assets and covered asset classes on one list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contract_coverage","href":"/api-reference/contracts/named-assets-and-covered-asset-classes-on-one-list"},{"title":"What a contract charges, line by line, with the dates each price is good for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contract_pricing","href":"/api-reference/contracts/what-a-contract-charges-line-by-line-with-the-dates-each-price-is-good-for"},{"title":"Entitlements, exclusions, SLAs and services on one list. term_type says which clause it is.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contract_terms","href":"/api-reference/contracts/entitlements-exclusions-slas-and-services-on-one-list-term_type-says-which-clause-it-is"},{"title":"How much of a contract's value the claims against it have used, against what the agreement is worth.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contract_value_usage","href":"/api-reference/contracts/how-much-of-a-contracts-value-the-claims-against-it-have-used-against-what-the-agreement-is-worth"},{"title":"The visits a contract schedules, which are included in its price, and which are overdue.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contract_visits","href":"/api-reference/contracts/the-visits-a-contract-schedules-which-are-included-in-its-price-and-which-are-overdue"},{"title":"The contract register and detail header.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contracts","href":"/api-reference/contracts/the-contract-register-and-detail-header"},{"title":"Contracts with every field of the records each row points at: owner, site, vendor.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contracts_expanded","href":"/api-reference/contracts/contracts-with-every-field-of-the-records-each-row-points-at:-owner-site-vendor"},{"title":"Every coverage decision for a job, with is_current marking the one in force.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /entitlement_decisions","href":"/api-reference/contracts/every-coverage-decision-for-a-job-with-is_current-marking-the-one-in-force"},{"title":"Coverage decisions with the evidence that produced them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /entitlement_evaluations","href":"/api-reference/contracts/coverage-decisions-with-the-evidence-that-produced-them"},{"title":"The worker record behind the signed-in user, or NULL where they are not somebody on site.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/acting_worker","href":"/api-reference/contracts/the-worker-record-behind-the-signed-in-user-or-null-where-they-are-not-somebody-on-site"},{"title":"Record what the vendor answered a claim: agreed in full, agreed in part, or refused .","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decide_warranty_claim","href":"/api-reference/contracts/record-what-the-vendor-answered-a-claim:-agreed-in-full-agreed-in-part-or-refused-"},{"title":"Whether a contract or warranty covers this job, and on what basis.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/evaluate_entitlement","href":"/api-reference/contracts/whether-a-contract-or-warranty-covers-this-job-and-on-what-basis"},{"title":"Contracts inside their renewal window, and what lapses with each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/expiring_contracts","href":"/api-reference/contracts/contracts-inside-their-renewal-window-and-what-lapses-with-each"},{"title":"Raise a domain error with an HTTP status and a stable machine-readable error_code.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/fail","href":"/api-reference/contracts/raise-a-domain-error-with-an-http-status-and-a-stable-machine-readable-error_code"},{"title":"Open a warranty claim against a covered job, quoting the supplier's own account of the failure and the lines they…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/file_warranty_claim","href":"/api-reference/contracts/open-a-warranty-claim-against-a-covered-job-quoting-the-suppliers-own-account-of-the-failure-and-the-lines-they…"},{"title":"Create a supplier contact's portal login from the vendor record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/invite_vendor_contact","href":"/api-reference/contracts/create-a-supplier-contacts-portal-login-from-the-vendor-record"},{"title":"Overrule an entitlement decision, with the reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/override_entitlement","href":"/api-reference/contracts/overrule-an-entitlement-decision-with-the-reason"},{"title":"Rate the vendor who held a finished job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rate_vendor","href":"/api-reference/contracts/rate-the-vendor-who-held-a-finished-job"},{"title":"Re-derive whether a job can be done, after its requirements or stock moved.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/recalculate_readiness","href":"/api-reference/contracts/re-derive-whether-a-job-can-be-done-after-its-requirements-or-stock-moved"},{"title":"The id a previous call created for this (device, client_operation) pair, or NULL.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/replayed","href":"/api-reference/contracts/the-id-a-previous-call-created-for-this-device-client_operation-pair-or-null"},{"title":"Refuse a bulk call over more than 1000 records, which is as many as one response can report on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_bulk_size","href":"/api-reference/contracts/refuse-a-bulk-call-over-more-than-1000-records-which-is-as-many-as-one-response-can-report-on"},{"title":"Resolve a record id within the caller's own tenant, or refuse.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_own","href":"/api-reference/contracts/resolve-a-record-id-within-the-callers-own-tenant-or-refuse"},{"title":"Refuse unless the caller holds a permission.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_permission","href":"/api-reference/contracts/refuse-unless-the-caller-holds-a-permission"},{"title":"Refuse a caller whose access at this site and place is read-only.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_place_write","href":"/api-reference/contracts/refuse-a-caller-whose-access-at-this-site-and-place-is-read-only"},{"title":"Refuse a caller whose grant at this site is read-only.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_site_write","href":"/api-reference/contracts/refuse-a-caller-whose-grant-at-this-site-is-read-only"},{"title":"Refuse a caller whose grant at this job's site is read-only, or whose role's edit reach does not include this job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_work_order_write","href":"/api-reference/contracts/refuse-a-caller-whose-grant-at-this-jobs-site-is-read-only-or-whose-roles-edit-reach-does-not-include-this-job"},{"title":"Refuse a generic write to a record whose work order the caller may not change, walking the record's declared parents to…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_work_order_write_for","href":"/api-reference/contracts/refuse-a-generic-write-to-a-record-whose-work-order-the-caller-may-not-change-walking-the-records-declared-parents-to…"},{"title":"Record what has actually been received against an agreed claim, and when.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/settle_warranty_claim","href":"/api-reference/contracts/record-what-has-actually-been-received-against-an-agreed-claim-and-when"},{"title":"Send a claim to the vendor liable for it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_warranty_claim","href":"/api-reference/contracts/send-a-claim-to-the-vendor-liable-for-it"},{"title":"Who the session says you are: the user, the organisation, the roles and the site scope.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/whoami","href":"/api-reference/contracts/who-the-session-says-you-are:-the-user-the-organisation-the-roles-and-the-site-scope"},{"title":"Claims against contracts, with what is still outstanding and whose account of the failure they rest on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /warranty_claims","href":"/api-reference/contracts/claims-against-contracts-with-what-is-still-outstanding-and-whose-account-of-the-failure-they-rest-on"},{"title":"Work on assets a contract still covers, and what the cover extends to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /warranty_covered_work","href":"/api-reference/contracts/work-on-assets-a-contract-still-covers-and-what-the-cover-extends-to"}]},{"group":"Vendor and contract configuration","pages":[{"title":"Contract types.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /contract_type_settings","href":"/api-reference/vendor-and-contract-configuration/contract-types"},{"title":"Add to contract type settings: Contract types.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /contract_type_settings","href":"/api-reference/vendor-and-contract-configuration/add-to-contract-type-settings:-contract-types"},{"title":"Remove rows from contract type settings: Contract types.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /contract_type_settings","href":"/api-reference/vendor-and-contract-configuration/remove-rows-from-contract-type-settings:-contract-types"},{"title":"Change rows in contract type settings: Contract types.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /contract_type_settings","href":"/api-reference/vendor-and-contract-configuration/change-rows-in-contract-type-settings:-contract-types"},{"title":"Vendor categories as a tree, with the vendors and rate cards under each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_category_settings","href":"/api-reference/vendor-and-contract-configuration/vendor-categories-as-a-tree-with-the-vendors-and-rate-cards-under-each"},{"title":"Vendor types. is_oem is what warranty routing prefers when a job is covered.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_type_settings","href":"/api-reference/vendor-and-contract-configuration/vendor-types-is_oem-is-what-warranty-routing-prefers-when-a-job-is-covered"},{"title":"Add to vendor type settings: Vendor types. is_oem is what warranty routing prefers when a job is covered.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /vendor_type_settings","href":"/api-reference/vendor-and-contract-configuration/add-to-vendor-type-settings:-vendor-types-is_oem-is-what-warranty-routing-prefers-when-a-job-is-covered"},{"title":"Remove rows from vendor type settings: Vendor types. is_oem is what warranty routing prefers when a job is covered.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /vendor_type_settings","href":"/api-reference/vendor-and-contract-configuration/remove-rows-from-vendor-type-settings:-vendor-types-is_oem-is-what-warranty-routing-prefers-when-a-job-is-covered"},{"title":"Change rows in vendor type settings: Vendor types. is_oem is what warranty routing prefers when a job is covered.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /vendor_type_settings","href":"/api-reference/vendor-and-contract-configuration/change-rows-in-vendor-type-settings:-vendor-types-is_oem-is-what-warranty-routing-prefers-when-a-job-is-covered"}]},{"group":"Conversations","pages":[{"title":"The participant lines of a conversation: named people, addressed roles and addressed teams, with leavers kept.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /conversation_people","href":"/api-reference/conversations/the-participant-lines-of-a-conversation:-named-people-addressed-roles-and-addressed-teams-with-leavers-kept"},{"title":"The messages that reference a record, for the panel on that record's screen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discussed_in","href":"/api-reference/conversations/the-messages-that-reference-a-record-for-the-panel-on-that-records-screen"},{"title":"People, roles, teams and sites a conversation can be addressed to, as one list for one picker.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /message_recipients","href":"/api-reference/conversations/people-roles-teams-and-sites-a-conversation-can-be-addressed-to-as-one-list-for-one-picker"},{"title":"Every conversation and record discussion the caller is part of, with unread counts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_threads","href":"/api-reference/conversations/every-conversation-and-record-discussion-the-caller-is-part-of-with-unread-counts"},{"title":"Add people, roles or teams to a group conversation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_conversation_participants","href":"/api-reference/conversations/add-people-roles-or-teams-to-a-group-conversation"},{"title":"Invite a vendor's contact into a group conversation, creating their login if they have none.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/invite_to_conversation","href":"/api-reference/conversations/invite-a-vendors-contact-into-a-group-conversation-creating-their-login-if-they-have-none"},{"title":"Leave a conversation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/leave_conversation","href":"/api-reference/conversations/leave-a-conversation"},{"title":"Record that the caller has read a thread up to now.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/mark_thread_read","href":"/api-reference/conversations/record-that-the-caller-has-read-a-thread-up-to-now"},{"title":"Add or take back a reaction on a message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/react_to_message","href":"/api-reference/conversations/add-or-take-back-a-reaction-on-a-message"},{"title":"Search messages and record comments the caller can read, newest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/search_messages","href":"/api-reference/conversations/search-messages-and-record-comments-the-caller-can-read-newest-first"},{"title":"Send a message to a conversation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/send_message","href":"/api-reference/conversations/send-a-message-to-a-conversation"},{"title":"Start a group conversation, or open a site's channel.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/start_conversation","href":"/api-reference/conversations/start-a-group-conversation-or-open-a-sites-channel"},{"title":"Open the direct conversation with somebody, creating it the first time.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/start_direct_conversation","href":"/api-reference/conversations/open-the-direct-conversation-with-somebody-creating-it-the-first-time"},{"title":"Rename a conversation, archive it, or mute it for yourself.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_conversation","href":"/api-reference/conversations/rename-a-conversation-archive-it-or-mute-it-for-yourself"},{"title":"The messages on one thread — a conversation or a record — with references resolved for this reader, reactions, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /thread_messages","href":"/api-reference/conversations/the-messages-on-one-thread-—-a-conversation-or-a-record-—-with-references-resolved-for-this-reader-reactions-and…"}]},{"group":"Copilot","pages":[{"title":"The charts the copilot composed, as specs rather than as figures.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /copilot_charts","href":"/api-reference/copilot/the-charts-the-copilot-composed-as-specs-rather-than-as-figures"},{"title":"Add to copilot charts: The charts the copilot composed, as specs rather than as figures.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /copilot_charts","href":"/api-reference/copilot/add-to-copilot-charts:-the-charts-the-copilot-composed-as-specs-rather-than-as-figures"},{"title":"Remove rows from copilot charts: The charts the copilot composed, as specs rather than as figures.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /copilot_charts","href":"/api-reference/copilot/remove-rows-from-copilot-charts:-the-charts-the-copilot-composed-as-specs-rather-than-as-figures"},{"title":"Change rows in copilot charts: The charts the copilot composed, as specs rather than as figures.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /copilot_charts","href":"/api-reference/copilot/change-rows-in-copilot-charts:-the-charts-the-copilot-composed-as-specs-rather-than-as-figures"},{"title":"Copilot threads, scoped to whoever may reach the record each is about.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /copilot_conversations","href":"/api-reference/copilot/copilot-threads-scoped-to-whoever-may-reach-the-record-each-is-about"},{"title":"The turns, including the ones that failed or were declined — those are the useful rows.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /copilot_messages","href":"/api-reference/copilot/the-turns-including-the-ones-that-failed-or-were-declined-—-those-are-the-useful-rows"},{"title":"Whether this organisation agreed to the copilot, whose key it spends, and what is left of today's ceiling.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /copilot_settings","href":"/api-reference/copilot/whether-this-organisation-agreed-to-the-copilot-whose-key-it-spends-and-what-is-left-of-todays-ceiling"},{"title":"What the copilot proposed, what it rests on, and what somebody did about it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /copilot_suggestions","href":"/api-reference/copilot/what-the-copilot-proposed-what-it-rests-on-and-what-somebody-did-about-it"},{"title":"Add to copilot suggestions: What the copilot proposed, what it rests on, and what somebody did about it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /copilot_suggestions","href":"/api-reference/copilot/add-to-copilot-suggestions:-what-the-copilot-proposed-what-it-rests-on-and-what-somebody-did-about-it"},{"title":"Remove rows from copilot suggestions: What the copilot proposed, what it rests on, and what somebody did about it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /copilot_suggestions","href":"/api-reference/copilot/remove-rows-from-copilot-suggestions:-what-the-copilot-proposed-what-it-rests-on-and-what-somebody-did-about-it"},{"title":"Change rows in copilot suggestions: What the copilot proposed, what it rests on, and what somebody did about it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /copilot_suggestions","href":"/api-reference/copilot/change-rows-in-copilot-suggestions:-what-the-copilot-proposed-what-it-rests-on-and-what-somebody-did-about-it"},{"title":"Accept or reject a suggestion.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/act_on_copilot_suggestion","href":"/api-reference/copilot/accept-or-reject-a-suggestion"},{"title":"Ask the copilot about a record you can already open.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/ask_copilot","href":"/api-reference/copilot/ask-the-copilot-about-a-record-you-can-already-open"},{"title":"Remove this organisation's provider key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clear_ai_key","href":"/api-reference/copilot/remove-this-organisations-provider-key"},{"title":"Remove the speech key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clear_ai_voice_key","href":"/api-reference/copilot/remove-the-speech-key"},{"title":"Accept rate per capability, over decided suggestions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/copilot_accuracy","href":"/api-reference/copilot/accept-rate-per-capability-over-decided-suggestions"},{"title":"What a copilot chart's filter meant against the rows you can see: values read as something else, and values nothing…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/copilot_chart_grounding","href":"/api-reference/copilot/what-a-copilot-charts-filter-meant-against-the-rows-you-can-see:-values-read-as-something-else-and-values-nothing…"},{"title":"Exactly what left the building for one turn.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/copilot_context_sent","href":"/api-reference/copilot/exactly-what-left-the-building-for-one-turn"},{"title":"Read a form off a document or a sentence.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/extract_into_form","href":"/api-reference/copilot/read-a-form-off-a-document-or-a-sentence"},{"title":"Put a chart the copilot drew on a board, through the same setter a person building one uses.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/keep_copilot_chart","href":"/api-reference/copilot/put-a-chart-the-copilot-drew-on-a-board-through-the-same-setter-a-person-building-one-uses"},{"title":"Rate an answer.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rate_copilot_answer","href":"/api-reference/copilot/rate-an-answer"},{"title":"Run a chart the copilot composed, as the caller, so RLS decides what it counts and what its filter's values are checked…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_copilot_chart","href":"/api-reference/copilot/run-a-chart-the-copilot-composed-as-the-caller-so-rls-decides-what-it-counts-and-what-its-filters-values-are-checked…"},{"title":"Run a list the copilot composed, as the caller: its columns, at most 25 of the records your access reaches, and how…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_copilot_list","href":"/api-reference/copilot/run-a-list-the-copilot-composed-as-the-caller:-its-columns-at-most-25-of-the-records-your-access-reaches-and-how…"},{"title":"Agree to the copilot, or withdraw.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_copilot_settings","href":"/api-reference/copilot/agree-to-the-copilot-or-withdraw"},{"title":"Store this organisation's provider key, encrypted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_ai_key","href":"/api-reference/copilot/store-this-organisations-provider-key-encrypted"},{"title":"Store the OpenAI key used to transcribe speech.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_ai_voice_key","href":"/api-reference/copilot/store-the-openai-key-used-to-transcribe-speech"}]},{"group":"Sites, locations and the organisation","pages":[{"title":"Cost centres with the departments under each, which is what resolves a centre for costing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /cost_centre_settings","href":"/api-reference/sites-locations-and-the-organisation/cost-centres-with-the-departments-under-each-which-is-what-resolves-a-centre-for-costing"},{"title":"Departments with the people and assets attached to each, and the two people its assets answer to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /department_settings","href":"/api-reference/sites-locations-and-the-organisation/departments-with-the-people-and-assets-attached-to-each-and-the-two-people-its-assets-answer-to"},{"title":"Each company's GST registrations, one per GSTIN, with the state its first two digits name and how many sites send goods…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /gst_registrations","href":"/api-reference/sites-locations-and-the-organisation/each-companys-gst-registrations-one-per-gstin-with-the-state-its-first-two-digits-name-and-how-many-sites-send-goods…"},{"title":"The location tree with its materialised depth and path, and what sits in each branch.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /location_settings","href":"/api-reference/sites-locations-and-the-organisation/the-location-tree-with-its-materialised-depth-and-path-and-what-sits-in-each-branch"},{"title":"Location types with how many locations carry each and which sites describe themselves with it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /location_type_settings","href":"/api-reference/sites-locations-and-the-organisation/location-types-with-how-many-locations-carry-each-and-which-sites-describe-themselves-with-it"},{"title":"Companies and the business units under them — the spine sites and departments hang from.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /organisation_settings","href":"/api-reference/sites-locations-and-the-organisation/companies-and-the-business-units-under-them-—-the-spine-sites-and-departments-hang-from"},{"title":"Projects as a dimension work and cost are filed against — a shutdown, a capital installation, a job done for a customer.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /project_settings","href":"/api-reference/sites-locations-and-the-organisation/projects-as-a-dimension-work-and-cost-are-filed-against-—-a-shutdown-a-capital-installation-a-job-done-for-a-customer"},{"title":"A site's working week and its holidays on one list — both answer \"is the site open\".","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /site_calendar_settings","href":"/api-reference/sites-locations-and-the-organisation/a-sites-working-week-and-its-holidays-on-one-list-—-both-answer-\"is-the-site-open\""},{"title":"For every site, the GST registration goods leaving it go under and how that was decided: SITE (chosen on the site)…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /site_gst_registrations","href":"/api-reference/sites-locations-and-the-organisation/for-every-site-the-gst-registration-goods-leaving-it-go-under-and-how-that-was-decided:-site-chosen-on-the-site…"},{"title":"Sites with what stands on them, who answers for them, and whether their working week is configured at all.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /site_settings","href":"/api-reference/sites-locations-and-the-organisation/sites-with-what-stands-on-them-who-answers-for-them-and-whether-their-working-week-is-configured-at-all"},{"title":"Site settings with every field of the records each row points at: department.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /site_settings_expanded","href":"/api-reference/sites-locations-and-the-organisation/site-settings-with-every-field-of-the-records-each-row-points-at:-department"}]},{"group":"Currencies and locales","pages":[{"title":"Every currency, with the symbol and the number of decimal places an amount in it is written to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /currencies","href":"/api-reference/currencies-and-locales/every-currency-with-the-symbol-and-the-number-of-decimal-places-an-amount-in-it-is-written-to"},{"title":"Add to currencies: Every currency, with the symbol and the number of decimal places an amount in it is written to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /currencies","href":"/api-reference/currencies-and-locales/add-to-currencies:-every-currency-with-the-symbol-and-the-number-of-decimal-places-an-amount-in-it-is-written-to"},{"title":"Remove rows from currencies: Every currency, with the symbol and the number of decimal places an amount in it is written to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /currencies","href":"/api-reference/currencies-and-locales/remove-rows-from-currencies:-every-currency-with-the-symbol-and-the-number-of-decimal-places-an-amount-in-it-is-written-to"},{"title":"Change rows in currencies: Every currency, with the symbol and the number of decimal places an amount in it is written to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /currencies","href":"/api-reference/currencies-and-locales/change-rows-in-currencies:-every-currency-with-the-symbol-and-the-number-of-decimal-places-an-amount-in-it-is-written-to"},{"title":"The currency a cost recorded at each site is entered in, resolved site → company → organisation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /entry_currencies","href":"/api-reference/currencies-and-locales/the-currency-a-cost-recorded-at-each-site-is-entered-in-resolved-site-→-company-→-organisation"},{"title":"Refuse a non-translatable entity with a reason a person can act on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assert_translatable","href":"/api-reference/currencies-and-locales/refuse-a-non-translatable-entity-with-a-reason-a-person-can-act-on"},{"title":"Refuse a noun that is not on the renameable list, with a reason a person can act on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assert_vocabulary_term","href":"/api-reference/currencies-and-locales/refuse-a-noun-that-is-not-on-the-renameable-list-with-a-reason-a-person-can-act-on"},{"title":"One field's choices, with what each is called in one language.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/custom_field_option_translations","href":"/api-reference/currencies-and-locales/one-fields-choices-with-what-each-is-called-in-one-language"},{"title":"The fields this tenant added, with their wording in one language and the wording they were authored in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/custom_field_translation_fields","href":"/api-reference/currencies-and-locales/the-fields-this-tenant-added-with-their-wording-in-one-language-and-the-wording-they-were-authored-in"},{"title":"The tenant-configured lists that may be translated, named in the requested language.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/entity_translation_lists","href":"/api-reference/currencies-and-locales/the-tenant-configured-lists-that-may-be-translated-named-in-the-requested-language"},{"title":"Every row of one of this tenant's lists, with its name as written and as translated into one language.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/entity_translation_rows","href":"/api-reference/currencies-and-locales/every-row-of-one-of-this-tenants-lists-with-its-name-as-written-and-as-translated-into-one-language"},{"title":"One list's translated row names, for one language.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/entity_translations","href":"/api-reference/currencies-and-locales/one-lists-translated-row-names-for-one-language"},{"title":"The model's own field labels, hints and section headings in this reader's language, keyed by our English.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/model_words","href":"/api-reference/currencies-and-locales/the-models-own-field-labels-hints-and-section-headings-in-this-readers-language-keyed-by-our-english"},{"title":"The tenant's own list rows in this reader's language, keyed by row and column.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/own_words","href":"/api-reference/currencies-and-locales/the-tenants-own-list-rows-in-this-readers-language-keyed-by-row-and-column"},{"title":"The reader's language and the organisation's, for text that has no product translation behind it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reading_languages","href":"/api-reference/currencies-and-locales/the-readers-language-and-the-organisations-for-text-that-has-no-product-translation-behind-it"},{"title":"This tenant's rename pairs as the two arrays ref.rename_terms takes, in one row.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rename_arrays","href":"/api-reference/currencies-and-locales/this-tenants-rename-pairs-as-the-two-arrays-refrename_terms-takes-in-one-row"},{"title":"A language code to an id, or the caller's own language when given nothing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resolve_language","href":"/api-reference/currencies-and-locales/a-language-code-to-an-id-or-the-callers-own-language-when-given-nothing"},{"title":"What one of a field's choices is called in one language.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_custom_field_option_translation","href":"/api-reference/currencies-and-locales/what-one-of-a-fields-choices-is-called-in-one-language"},{"title":"One string of one of this tenant's own fields, in one language.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_custom_field_translation","href":"/api-reference/currencies-and-locales/one-string-of-one-of-this-tenants-own-fields-in-one-language"},{"title":"One row of one tenant-configured list, in one language.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_entity_translation","href":"/api-reference/currencies-and-locales/one-row-of-one-tenant-configured-list-in-one-language"},{"title":"This tenant's wording for one product string.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_translation_override","href":"/api-reference/currencies-and-locales/this-tenants-wording-for-one-product-string"},{"title":"This tenant's name for one object, singular and plural together.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_vocabulary_term","href":"/api-reference/currencies-and-locales/this-tenants-name-for-one-object-singular-and-plural-together"},{"title":"The language source_text is written in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/source_language","href":"/api-reference/currencies-and-locales/the-language-source_text-is-written-in"},{"title":"The whole resolved catalogue as one row, so a row limit cannot truncate what a client reads.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/translation_bundle","href":"/api-reference/currencies-and-locales/the-whole-resolved-catalogue-as-one-row-so-a-row-limit-cannot-truncate-what-a-client-reads"},{"title":"Every active string resolved for one language, renamed nouns applied, with the rung of the fallback ladder that…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/translation_catalogue","href":"/api-reference/currencies-and-locales/every-active-string-resolved-for-one-language-renamed-nouns-applied-with-the-rung-of-the-fallback-ladder-that…"},{"title":"One row per translatable string for one language: our English, our translation, this tenant's override, and what a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/translation_entries","href":"/api-reference/currencies-and-locales/one-row-per-translatable-string-for-one-language:-our-english-our-translation-this-tenants-override-and-what-a…"},{"title":"Per language: how many strings are translated, how many this tenant has overridden, and how many are still English.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/translation_languages","href":"/api-reference/currencies-and-locales/per-language:-how-many-strings-are-translated-how-many-this-tenant-has-overridden-and-how-many-are-still-english"},{"title":"The modules the product's strings are filed under, one row each, for narrowing the string editor to one of them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/translation_modules","href":"/api-reference/currencies-and-locales/the-modules-the-products-strings-are-filed-under-one-row-each-for-narrowing-the-string-editor-to-one-of-them"},{"title":"Every string a proposed rename would rewrite, before and after, before it is saved.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/vocabulary_impact","href":"/api-reference/currencies-and-locales/every-string-a-proposed-rename-would-rewrite-before-and-after-before-it-is-saved"},{"title":"This tenant's renamed nouns as substitution pairs, longest find first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/vocabulary_pairs","href":"/api-reference/currencies-and-locales/this-tenants-renamed-nouns-as-substitution-pairs-longest-find-first"},{"title":"The objects a tenant may rename, with our word, theirs, and how many strings a rename rewrites.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/vocabulary_terms","href":"/api-reference/currencies-and-locales/the-objects-a-tenant-may-rename-with-our-word-theirs-and-how-many-strings-a-rename-rewrites"},{"title":"The renameable objects in one language: our word, this tenant's, and whether they have renamed it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/vocabulary_words","href":"/api-reference/currencies-and-locales/the-renameable-objects-in-one-language:-our-word-this-tenants-and-whether-they-have-renamed-it"}]},{"group":"Custom fields","pages":[{"title":"When each of the tenant's own fields is shown, insisted on or frozen, as the rule rather than as the answer.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom_field_condition_settings","href":"/api-reference/custom-fields/when-each-of-the-tenants-own-fields-is-shown-insisted-on-or-frozen-as-the-rule-rather-than-as-the-answer"},{"title":"The record types whose forms and custom fields you may configure, with what may be done to each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom_field_entities","href":"/api-reference/custom-fields/the-record-types-whose-forms-and-custom-fields-you-may-configure-with-what-may-be-done-to-each"},{"title":"The choices a select field offers, in the order they are shown.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom_field_option_settings","href":"/api-reference/custom-fields/the-choices-a-select-field-offers-in-the-order-they-are-shown"},{"title":"The payload columns that decide which custom fields apply, per entity type.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom_field_scopes","href":"/api-reference/custom-fields/the-payload-columns-that-decide-which-custom-fields-apply-per-entity-type"},{"title":"The tenant's field definitions, with how many records have answered each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom_field_settings","href":"/api-reference/custom-fields/the-tenants-field-definitions-with-how-many-records-have-answered-each"},{"title":"When one of a record's own columns is asked, insisted on or frozen, as the rule rather than as the answer.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /record_field_condition_settings","href":"/api-reference/custom-fields/when-one-of-a-records-own-columns-is-asked-insisted-on-or-frozen-as-the-rule-rather-than-as-the-answer"},{"title":"Add to record field condition settings: When one of a record's own columns is asked, insisted on or frozen, as the rule rather than as the answer.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /record_field_condition_settings","href":"/api-reference/custom-fields/add-to-record-field-condition-settings:-when-one-of-a-records-own-columns-is-asked-insisted-on-or-frozen-as-the-rule-rather-than-as-the-answer"},{"title":"Remove rows from record field condition settings: When one of a record's own columns is asked, insisted on or frozen, as the rule rather than as the answer.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /record_field_condition_settings","href":"/api-reference/custom-fields/remove-rows-from-record-field-condition-settings:-when-one-of-a-records-own-columns-is-asked-insisted-on-or-frozen-as-the-rule-rather-than-as-the-answer"},{"title":"Change rows in record field condition settings: When one of a record's own columns is asked, insisted on or frozen, as the rule rather than as the answer.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /record_field_condition_settings","href":"/api-reference/custom-fields/change-rows-in-record-field-condition-settings:-when-one-of-a-records-own-columns-is-asked-insisted-on-or-frozen-as-the-rule-rather-than-as-the-answer"},{"title":"Define a new field of your own on a record type — `p_entity` such as `core.assets`, `core.locations` or `core.sites`…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_custom_field","href":"/api-reference/custom-fields/define-a-new-field-of-your-own-on-a-record-type-—-`p_entity`-such-as-`coreassets`-`corelocations`-or-`coresites`…"},{"title":"Add a choice to a select field, by the id `add_custom_field` returned.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_custom_field_option","href":"/api-reference/custom-fields/add-a-choice-to-a-select-field-by-the-id-`add_custom_field`-returned"},{"title":"The tenant's own fields for one record: what applies, what is answered, what may be chosen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/custom_fields","href":"/api-reference/custom-fields/the-tenants-own-fields-for-one-record:-what-applies-what-is-answered-what-may-be-chosen"},{"title":"Which required custom fields a record has not answered.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/missing_custom_fields","href":"/api-reference/custom-fields/which-required-custom-fields-a-record-has-not-answered"},{"title":"The tenant's own fields a create form should ask, for the scope its payload has chosen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/new_custom_fields","href":"/api-reference/custom-fields/the-tenants-own-fields-a-create-form-should-ask-for-the-scope-its-payload-has-chosen"},{"title":"Make a drafted field live on the forms it is bound to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_custom_field","href":"/api-reference/custom-fields/make-a-drafted-field-live-on-the-forms-it-is-bound-to"},{"title":"Remove a choice.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_custom_field_option","href":"/api-reference/custom-fields/remove-a-choice"},{"title":"Ask a retired field again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/restore_custom_field","href":"/api-reference/custom-fields/ask-a-retired-field-again"},{"title":"Stop asking a field without deleting what it has already collected.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/retire_custom_field","href":"/api-reference/custom-fields/stop-asking-a-field-without-deleting-what-it-has-already-collected"},{"title":"Answer one custom field on one record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_custom_field_value","href":"/api-reference/custom-fields/answer-one-custom-field-on-one-record"},{"title":"Change a field's label, hint, requiredness, or whether the form may answer it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_custom_field","href":"/api-reference/custom-fields/change-a-fields-label-hint-requiredness-or-whether-the-form-may-answer-it"},{"title":"Rename a choice, or change where it sits in the list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_custom_field_option","href":"/api-reference/custom-fields/rename-a-choice-or-change-where-it-sits-in-the-list"}]},{"group":"Form studio","pages":[{"title":"The tenant's field groups, with how many fields each holds and which model section it lands in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /custom_field_group_settings","href":"/api-reference/form-studio/the-tenants-field-groups-with-how-many-fields-each-holds-and-which-model-section-it-lands-in"},{"title":"The parts of a record beyond its form that an organisation turns on, and whether yours has each one on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /form_extras","href":"/api-reference/form-studio/the-parts-of-a-record-beyond-its-form-that-an-organisation-turns-on-and-whether-yours-has-each-one-on"},{"title":"The lists whose look your organisation may choose, and how each one is drawn.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /list_looks","href":"/api-reference/form-studio/the-lists-whose-look-your-organisation-may-choose-and-how-each-one-is-drawn"},{"title":"The notices a register's list draws above its rows, and whether this organisation has each one shown.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /list_notices","href":"/api-reference/form-studio/the-notices-a-registers-list-draws-above-its-rows-and-whether-this-organisation-has-each-one-shown"},{"title":"Add a group to a form, so its fields arrive under a heading rather than in a list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_custom_field_group","href":"/api-reference/form-studio/add-a-group-to-a-form-so-its-fields-arrive-under-a-heading-rather-than-in-a-list"},{"title":"The whole form as it is drawn: sections in order, each naming the fields and columns it holds.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/arrange_form","href":"/api-reference/form-studio/the-whole-form-as-it-is-drawn:-sections-in-order-each-naming-the-fields-and-columns-it-holds"},{"title":"Show a field on a particular register, or on one kind of record within it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bind_custom_field","href":"/api-reference/form-studio/show-a-field-on-a-particular-register-or-on-one-kind-of-record-within-it"},{"title":"Where one custom field applies, with each binding's scope named rather than left as an id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/custom_field_bindings","href":"/api-reference/form-studio/where-one-custom-field-applies-with-each-bindings-scope-named-rather-than-left-as-an-id"},{"title":"Which fields a condition reads, so a change to one can refresh the other.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/custom_field_condition_fields","href":"/api-reference/form-studio/which-fields-a-condition-reads-so-a-change-to-one-can-refresh-the-other"},{"title":"The conditions that decide whether a field is shown at all.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/custom_field_conditions","href":"/api-reference/form-studio/the-conditions-that-decide-whether-a-field-is-shown-at-all"},{"title":"Which roles are hidden from a field.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/custom_field_hidden_roles","href":"/api-reference/form-studio/which-roles-are-hidden-from-a-field"},{"title":"Who may see and who may answer each field.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/custom_field_permissions","href":"/api-reference/form-studio/who-may-see-and-who-may-answer-each-field"},{"title":"The rules a field's answer must satisfy.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/custom_field_validations","href":"/api-reference/form-studio/the-rules-a-fields-answer-must-satisfy"},{"title":"Move a field into a group, or out of one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/move_custom_field_to_group","href":"/api-reference/form-studio/move-a-field-into-a-group-or-out-of-one"},{"title":"Which of a record's own questions a new one is being asked, for the answers given so far.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/new_record_field_states","href":"/api-reference/form-studio/which-of-a-records-own-questions-a-new-one-is-being-asked-for-the-answers-given-so-far"},{"title":"The columns a new record's form should watch, because a condition it is asked under reads them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_field_condition_columns","href":"/api-reference/form-studio/the-columns-a-new-records-form-should-watch-because-a-condition-it-is-asked-under-reads-them"},{"title":"Which fields a condition on one of a record's own columns may name.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_field_condition_fields","href":"/api-reference/form-studio/which-fields-a-condition-on-one-of-a-records-own-columns-may-name"},{"title":"The conditions that decide when one of a record's own columns is asked, insisted on or frozen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_field_conditions","href":"/api-reference/form-studio/the-conditions-that-decide-when-one-of-a-records-own-columns-is-asked-insisted-on-or-frozen"},{"title":"The values a field of one of the model's forms may start on, as that form offers them: value is what the column holds…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_field_default_options","href":"/api-reference/form-studio/the-values-a-field-of-one-of-the-models-forms-may-start-on-as-that-form-offers-them:-value-is-what-the-column-holds…"},{"title":"Which roles are hidden from one of the model's own columns, on the form and the record detail view only.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_field_hidden_roles","href":"/api-reference/form-studio/which-roles-are-hidden-from-one-of-the-models-own-columns-on-the-form-and-the-record-detail-view-only"},{"title":"Which roles may answer one of the model's own columns.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_field_permissions","href":"/api-reference/form-studio/which-roles-may-answer-one-of-the-models-own-columns"},{"title":"Which of a record's own questions this record is being asked, and which of them it may skip.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_field_states","href":"/api-reference/form-studio/which-of-a-records-own-questions-this-record-is-being-asked-and-which-of-them-it-may-skip"},{"title":"Remove a condition, so the field is always shown.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_custom_field_condition","href":"/api-reference/form-studio/remove-a-condition-so-the-field-is-always-shown"},{"title":"Remove a group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_custom_field_group","href":"/api-reference/form-studio/remove-a-group"},{"title":"Remove a validation rule.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_custom_field_validation","href":"/api-reference/form-studio/remove-a-validation-rule"},{"title":"Remove a condition, so the column is asked the way the model and the layout already said.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_record_field_condition","href":"/api-reference/form-studio/remove-a-condition-so-the-column-is-asked-the-way-the-model-and-the-layout-already-said"},{"title":"Set the order groups appear in on the form.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reorder_custom_field_groups","href":"/api-reference/form-studio/set-the-order-groups-appear-in-on-the-form"},{"title":"Set the order fields appear in within their group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reorder_custom_fields","href":"/api-reference/form-studio/set-the-order-fields-appear-in-within-their-group"},{"title":"Put a record's form back the way it was drawn when the organisation was set up.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reset_form_layout","href":"/api-reference/form-studio/put-a-records-form-back-the-way-it-was-drawn-when-the-organisation-was-set-up"},{"title":"Make a field appear only when another field's answer says it should.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_custom_field_condition","href":"/api-reference/form-studio/make-a-field-appear-only-when-another-fields-answer-says-it-should"},{"title":"Hide one of the organisation's own fields from everyone, or show it again .","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_custom_field_hidden_from_everyone","href":"/api-reference/form-studio/hide-one-of-the-organisations-own-fields-from-everyone-or-show-it-again-"},{"title":"Hide or unhide one role from one field.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_custom_field_hidden_role","href":"/api-reference/form-studio/hide-or-unhide-one-role-from-one-field"},{"title":"Say which roles may read a field and which may write it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_custom_field_permission","href":"/api-reference/form-studio/say-which-roles-may-read-a-field-and-which-may-write-it"},{"title":"Add or replace a validation rule on a field.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_custom_field_validation","href":"/api-reference/form-studio/add-or-replace-a-validation-rule-on-a-field"},{"title":"Say which kinds of answer one of a form's controls offers — a crew, a technician or a supplier.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_form_control_options","href":"/api-reference/form-studio/say-which-kinds-of-answer-one-of-a-forms-controls-offers-—-a-crew-a-technician-or-a-supplier"},{"title":"Turn one of the parts of a record beyond its form on or off for your organisation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_form_extra_on","href":"/api-reference/form-studio/turn-one-of-the-parts-of-a-record-beyond-its-form-on-or-off-for-your-organisation"},{"title":"Choose how one of your organisation's lists is drawn: headings centred over their columns or not, a rule down every…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_list_look","href":"/api-reference/form-studio/choose-how-one-of-your-organisations-lists-is-drawn:-headings-centred-over-their-columns-or-not-a-rule-down-every…"},{"title":"Show or stop showing one of the notices a register's list draws above its rows.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_list_notice_shown","href":"/api-reference/form-studio/show-or-stop-showing-one-of-the-notices-a-registers-list-draws-above-its-rows"},{"title":"Ask for one of a record's own columns only when it matters, or insist on it only when it does.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_record_field_condition","href":"/api-reference/form-studio/ask-for-one-of-a-records-own-columns-only-when-it-matters-or-insist-on-it-only-when-it-does"},{"title":"Choose what a new record's form starts one of its dropdowns on, or clear it with no value.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_record_field_default","href":"/api-reference/form-studio/choose-what-a-new-records-form-starts-one-of-its-dropdowns-on-or-clear-it-with-no-value"},{"title":"Stop asking one of the model's own columns that the model leaves optional.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_record_field_hidden","href":"/api-reference/form-studio/stop-asking-one-of-the-models-own-columns-that-the-model-leaves-optional"},{"title":"Hide one of the model's own columns from everyone in the organisation, or show it again .","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_record_field_hidden_from_everyone","href":"/api-reference/form-studio/hide-one-of-the-models-own-columns-from-everyone-in-the-organisation-or-show-it-again-"},{"title":"Hide or unhide one role from one of the model's own columns .","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_record_field_hidden_role","href":"/api-reference/form-studio/hide-or-unhide-one-role-from-one-of-the-models-own-columns-"},{"title":"Say which roles may answer one of the model's own columns.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_record_field_permission","href":"/api-reference/form-studio/say-which-roles-may-answer-one-of-the-models-own-columns"},{"title":"Show one of the model's own columns without letting the form answer it .","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_record_field_read_only","href":"/api-reference/form-studio/show-one-of-the-models-own-columns-without-letting-the-form-answer-it-"},{"title":"Insist on one of the model's own columns that the model leaves optional.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_record_field_required","href":"/api-reference/form-studio/insist-on-one-of-the-models-own-columns-that-the-model-leaves-optional"},{"title":"Say that this field, on this form, is answered with the last level of the tree it points at.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_record_field_requires_leaf","href":"/api-reference/form-studio/say-that-this-field-on-this-form-is-answered-with-the-last-level-of-the-tree-it-points-at"},{"title":"Stop showing a field on a register.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unbind_custom_field","href":"/api-reference/form-studio/stop-showing-a-field-on-a-register"},{"title":"Rename a group or change how it is presented.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_custom_field_group","href":"/api-reference/form-studio/rename-a-group-or-change-how-it-is-presented"}]},{"group":"Vendors and contracts","pages":[{"title":"A customer's addresses: where they are billed, where their goods are delivered, and the GSTIN registered at each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /customer_sites","href":"/api-reference/vendors-and-contracts/a-customers-addresses:-where-they-are-billed-where-their-goods-are-delivered-and-the-gstin-registered-at-each"},{"title":"A vendor's addresses, one row each, with coordinates where they are known.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_addresses","href":"/api-reference/vendors-and-contracts/a-vendors-addresses-one-row-each-with-coordinates-where-they-are-known"},{"title":"Work orders by assigned vendor, open and closed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_assignments","href":"/api-reference/vendors-and-contracts/work-orders-by-assigned-vendor-open-and-closed"},{"title":"Vendor skills and certifications in one list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_capabilities","href":"/api-reference/vendors-and-contracts/vendor-skills-and-certifications-in-one-list"},{"title":"A vendor's insurances and certifications, with what has lapsed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_compliance","href":"/api-reference/vendors-and-contracts/a-vendors-insurances-and-certifications-with-what-has-lapsed"},{"title":"The people at a vendor, with the first to ring, the one to escalate to, and whether they have a login of their own.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_contacts","href":"/api-reference/vendors-and-contracts/the-people-at-a-vendor-with-the-first-to-ring-the-one-to-escalate-to-and-whether-they-have-a-login-of-their-own"},{"title":"The vendor list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_directory","href":"/api-reference/vendors-and-contracts/the-vendor-list"},{"title":"Vendor directory with whatever this tenant's own reference fields point at, resolved.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_directory_expanded","href":"/api-reference/vendors-and-contracts/vendor-directory-with-whatever-this-tenants-own-reference-fields-point-at-resolved"},{"title":"What a vendor supplies — their part number, price, lead time and minimum order, with what we hold of each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_parts","href":"/api-reference/vendors-and-contracts/what-a-vendor-supplies-—-their-part-number-price-lead-time-and-minimum-order-with-what-we-hold-of-each"},{"title":"Computed periods behind the vendor performance tab.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_performance","href":"/api-reference/vendors-and-contracts/computed-periods-behind-the-vendor-performance-tab"},{"title":"What a vendor charges — hourly, callout, travel, minimum hours and parts markup.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_rates","href":"/api-reference/vendors-and-contracts/what-a-vendor-charges-—-hourly-callout-travel-minimum-hours-and-parts-markup"},{"title":"How a vendor scored on the jobs they have done.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_ratings","href":"/api-reference/vendors-and-contracts/how-a-vendor-scored-on-the-jobs-they-have-done"},{"title":"What each vendor is engaged to do, as categories rather than prose.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_service_categories","href":"/api-reference/vendors-and-contracts/what-each-vendor-is-engaged-to-do-as-categories-rather-than-prose"},{"title":"Which of your sites a vendor covers, and what they have committed to each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_sites","href":"/api-reference/vendors-and-contracts/which-of-your-sites-a-vendor-covers-and-what-they-have-committed-to-each"},{"title":"What a vendor has committed to respond and resolve within, per priority.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_slas","href":"/api-reference/vendors-and-contracts/what-a-vendor-has-committed-to-respond-and-resolve-within-per-priority"}]},{"group":"Dashboards","pages":[{"title":"One scheduled render each: whose access answered it, how many widgets came back, and where the file went.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dashboard_deliveries","href":"/api-reference/dashboards/one-scheduled-render-each:-whose-access-answered-it-how-many-widgets-came-back-and-where-the-file-went"},{"title":"When a dashboard is sent, to whom, with which site, period and comparison frozen, and what would stop it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dashboard_schedules","href":"/api-reference/dashboards/when-a-dashboard-is-sent-to-whom-with-which-site-period-and-comparison-frozen-and-what-would-stop-it"},{"title":"The people and roles a RESTRICTED dashboard is shared with.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dashboard_shares","href":"/api-reference/dashboards/the-people-and-roles-a-restricted-dashboard-is-shared-with"},{"title":"The widgets on a board, including whether each one honours the board's site and period.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dashboard_widgets","href":"/api-reference/dashboards/the-widgets-on-a-board-including-whether-each-one-honours-the-boards-site-and-period"},{"title":"Dashboards the caller may open, less any that came with a module this tenant does not have.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /dashboards","href":"/api-reference/dashboards/dashboards-the-caller-may-open-less-any-that-came-with-a-module-this-tenant-does-not-have"},{"title":"Add to dashboards: Dashboards the caller may open, less any that came with a module this tenant does not have.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /dashboards","href":"/api-reference/dashboards/add-to-dashboards:-dashboards-the-caller-may-open-less-any-that-came-with-a-module-this-tenant-does-not-have"},{"title":"Remove rows from dashboards: Dashboards the caller may open, less any that came with a module this tenant does not have.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /dashboards","href":"/api-reference/dashboards/remove-rows-from-dashboards:-dashboards-the-caller-may-open-less-any-that-came-with-a-module-this-tenant-does-not-have"},{"title":"Change rows in dashboards: Dashboards the caller may open, less any that came with a module this tenant does not have.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /dashboards","href":"/api-reference/dashboards/change-rows-in-dashboards:-dashboards-the-caller-may-open-less-any-that-came-with-a-module-this-tenant-does-not-have"},{"title":"Remove a dashboard and stop its schedules.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_dashboard","href":"/api-reference/dashboards/remove-a-dashboard-and-stop-its-schedules"},{"title":"Stop sending a dashboard.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_dashboard_schedule","href":"/api-reference/dashboards/stop-sending-a-dashboard"},{"title":"Remove a widget from a board.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_dashboard_widget","href":"/api-reference/dashboards/remove-a-widget-from-a-board"},{"title":"Copy a dashboard and its widgets into a private one of the caller's own.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/duplicate_dashboard","href":"/api-reference/dashboards/copy-a-dashboard-and-its-widgets-into-a-private-one-of-the-callers-own"},{"title":"Record that a dashboard was opened, for the last-viewed column.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/note_dashboard_view","href":"/api-reference/dashboards/record-that-a-dashboard-was-opened-for-the-last-viewed-column"},{"title":"Draft, publish or retire a dashboard.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_dashboard","href":"/api-reference/dashboards/draft-publish-or-retire-a-dashboard"},{"title":"Set the reading order of a board's widgets in one statement.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reorder_dashboard_widgets","href":"/api-reference/dashboards/set-the-reading-order-of-a-boards-widgets-in-one-statement"},{"title":"Run one widget as the caller, so RLS decides what it counts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_widget","href":"/api-reference/dashboards/run-one-widget-as-the-caller-so-rls-decides-what-it-counts"},{"title":"Run one widget of a scheduled dashboard, refusing unless the session is the user the delivery names.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_widget_for_delivery","href":"/api-reference/dashboards/run-one-widget-of-a-scheduled-dashboard-refusing-unless-the-session-is-the-user-the-delivery-names"},{"title":"Run a TABLE or PIVOT tile as the caller and answer with the whole table — the same document a report's own screen reads…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_widget_grid","href":"/api-reference/dashboards/run-a-table-or-pivot-tile-as-the-caller-and-answer-with-the-whole-table-—-the-same-document-a-reports-own-screen-reads…"},{"title":"One table tile of a scheduled dashboard, run as the delivery's own user with the schedule's scope and comparison.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_widget_grid_for_delivery","href":"/api-reference/dashboards/one-table-tile-of-a-scheduled-dashboard-run-as-the-deliverys-own-user-with-the-schedules-scope-and-comparison"},{"title":"Create or amend a dashboard.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_dashboard","href":"/api-reference/dashboards/create-or-amend-a-dashboard"},{"title":"Create or amend a dashboard schedule, with the site, period and comparison the render will use frozen into it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_dashboard_schedule","href":"/api-reference/dashboards/create-or-amend-a-dashboard-schedule-with-the-site-period-and-comparison-the-render-will-use-frozen-into-it"},{"title":"Create or amend a widget.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_dashboard_widget","href":"/api-reference/dashboards/create-or-amend-a-widget"},{"title":"Copy one of Today's three boards into an editable dashboard, naming the tiles it cannot bring.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/seed_dashboard_from_board","href":"/api-reference/dashboards/copy-one-of-todays-three-boards-into-an-editable-dashboard-naming-the-tiles-it-cannot-bring"},{"title":"Set who a dashboard is for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/share_dashboard","href":"/api-reference/dashboards/set-who-a-dashboard-is-for"},{"title":"The rows behind one widget's figure, as the caller, for a peek at them without leaving the board.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/widget_rows","href":"/api-reference/dashboards/the-rows-behind-one-widgets-figure-as-the-caller-for-a-peek-at-them-without-leaving-the-board"}]},{"group":"Date reminders","pages":[{"title":"Reminders set on a date of an asset, a location or a person.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /date_reminders","href":"/api-reference/date-reminders/reminders-set-on-a-date-of-an-asset-a-location-or-a-person"},{"title":"The dates of one register a reminder may watch: its own date columns, then its custom fields of type DATE.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/date_reminder_fields","href":"/api-reference/date-reminders/the-dates-of-one-register-a-reminder-may-watch:-its-own-date-columns-then-its-custom-fields-of-type-date"},{"title":"Stop a date reminder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_date_reminder","href":"/api-reference/date-reminders/stop-a-date-reminder"},{"title":"The records one reminder covers that are inside their window today, with how many people would be told about each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_date_reminder","href":"/api-reference/date-reminders/the-records-one-reminder-covers-that-are-inside-their-window-today-with-how-many-people-would-be-told-about-each"},{"title":"Create or amend a date reminder with its dates, the people it tells and the records it covers.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_date_reminder","href":"/api-reference/date-reminders/create-or-amend-a-date-reminder-with-its-dates-the-people-it-tells-and-the-records-it-covers"}]},{"group":"Visitors","pages":[{"title":"When a signature is asked for, where the kind of device cannot say it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /device_authorisation_rules","href":"/api-reference/visitors/when-a-signature-is-asked-for-where-the-kind-of-device-cannot-say-it"},{"title":"What kinds of device the gate knows about, and which of them need a signature.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /device_categories","href":"/api-reference/visitors/what-kinds-of-device-the-gate-knows-about-and-which-of-them-need-a-signature"},{"title":"Add to device categories: What kinds of device the gate knows about, and which of them need a signature.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /device_categories","href":"/api-reference/visitors/add-to-device-categories:-what-kinds-of-device-the-gate-knows-about-and-which-of-them-need-a-signature"},{"title":"Remove rows from device categories: What kinds of device the gate knows about, and which of them need a signature.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /device_categories","href":"/api-reference/visitors/remove-rows-from-device-categories:-what-kinds-of-device-the-gate-knows-about-and-which-of-them-need-a-signature"},{"title":"Change rows in device categories: What kinds of device the gate knows about, and which of them need a signature.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /device_categories","href":"/api-reference/visitors/change-rows-in-device-categories:-what-kinds-of-device-the-gate-knows-about-and-which-of-them-need-a-signature"},{"title":"Every declared device, what was decided about it, and whether it is inside the fence.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /device_registrations","href":"/api-reference/visitors/every-declared-device-what-was-decided-about-it-and-whether-it-is-inside-the-fence"},{"title":"Every scan at every gate, with what the guard was told at the time.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /gate_events","href":"/api-reference/visitors/every-scan-at-every-gate-with-what-the-guard-was-told-at-the-time"},{"title":"Call a visit off, and withdraw the devices declared for it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_visit","href":"/api-reference/visitors/call-a-visit-off-and-withdraw-the-devices-declared-for-it"},{"title":"Authorise a declared device to enter, to leave, or both — or refuse it with a reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decide_device_registration","href":"/api-reference/visitors/authorise-a-declared-device-to-enter-to-leave-or-both-—-or-refuse-it-with-a-reason"},{"title":"Why this device does or does not need a signature: every rule in the order it was asked, whether it matched, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/explain_device_authorisation","href":"/api-reference/visitors/why-this-device-does-or-does-not-need-a-signature:-every-rule-in-the-order-it-was-asked-whether-it-matched-and…"},{"title":"Who and what is inside the fence right now, what is waiting on a signature, and today's exceptions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/gate_summary","href":"/api-reference/visitors/who-and-what-is-inside-the-fence-right-now-what-is-waiting-on-a-signature-and-todays-exceptions"},{"title":"Record what was presented at a gate and answer whether it may pass.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_gate_event","href":"/api-reference/visitors/record-what-was-presented-at-a-gate-and-answer-whether-it-may-pass"},{"title":"Take a device registration back, with a reason the gate will show.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/withdraw_device_registration","href":"/api-reference/visitors/take-a-device-registration-back-with-a-reason-the-gate-will-show"},{"title":"Who is expected, who is here, and who is still here after they said they would be gone.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /visits","href":"/api-reference/visitors/who-is-expected-who-is-here-and-who-is-still-here-after-they-said-they-would-be-gone"}]},{"group":"Sync","pages":[{"title":"The handsets registered to this tenant, and what each last did.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /devices","href":"/api-reference/sync/the-handsets-registered-to-this-tenant-and-what-each-last-did"},{"title":"The api functions a device may queue offline, so a client does not have to guess.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /offline_actions","href":"/api-reference/sync/the-api-functions-a-device-may-queue-offline-so-a-client-does-not-have-to-guess"},{"title":"The bundles a device downloads to work without a signal, and how current each is.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /offline_data_packs","href":"/api-reference/sync/the-bundles-a-device-downloads-to-work-without-a-signal-and-how-current-each-is"},{"title":"Add to offline data packs: The bundles a device downloads to work without a signal, and how current each is.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /offline_data_packs","href":"/api-reference/sync/add-to-offline-data-packs:-the-bundles-a-device-downloads-to-work-without-a-signal-and-how-current-each-is"},{"title":"Remove rows from offline data packs: The bundles a device downloads to work without a signal, and how current each is.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /offline_data_packs","href":"/api-reference/sync/remove-rows-from-offline-data-packs:-the-bundles-a-device-downloads-to-work-without-a-signal-and-how-current-each-is"},{"title":"Change rows in offline data packs: The bundles a device downloads to work without a signal, and how current each is.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /offline_data_packs","href":"/api-reference/sync/change-rows-in-offline-data-packs:-the-bundles-a-device-downloads-to-work-without-a-signal-and-how-current-each-is"},{"title":"The device confirms it has applied everything through a sequence.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/acknowledge_changes","href":"/api-reference/sync/the-device-confirms-it-has-applied-everything-through-a-sequence"},{"title":"The sequence number a new device's copy starts from.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/begin_hydration","href":"/api-reference/sync/the-sequence-number-a-new-devices-copy-starts-from"},{"title":"The device reporting that it destroyed its local copy.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/confirm_device_wipe","href":"/api-reference/sync/the-device-reporting-that-it-destroyed-its-local-copy"},{"title":"What is inside a data pack, so a technician can see what they will have offline.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/data_pack_contents","href":"/api-reference/sync/what-is-inside-a-data-pack-so-a-technician-can-see-what-they-will-have-offline"},{"title":"What this device should do with its local copy.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/device_orders","href":"/api-reference/sync/what-this-device-should-do-with-its-local-copy"},{"title":"Hand a device everything that has changed in a scope since it last acknowledged.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/pull_changes","href":"/api-reference/sync/hand-a-device-everything-that-has-changed-in-a-scope-since-it-last-acknowledged"},{"title":"Submit a whole offline batch in one call; the result reports each operation separately.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/push_operations","href":"/api-reference/sync/submit-a-whole-offline-batch-in-one-call;-the-result-reports-each-operation-separately"},{"title":"Rebuild a data pack so the next download carries current rows.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/refresh_data_pack","href":"/api-reference/sync/rebuild-a-data-pack-so-the-next-download-carries-current-rows"},{"title":"Register a handset and return what it needs to start syncing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/register_device","href":"/api-reference/sync/register-a-handset-and-return-what-it-needs-to-start-syncing"},{"title":"Settle a conflict between what a device recorded offline and what the server has.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resolve_sync_conflict","href":"/api-reference/sync/settle-a-conflict-between-what-a-device-recorded-offline-and-what-the-server-has"},{"title":"Stop a device syncing, and optionally order it wiped.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revoke_device","href":"/api-reference/sync/stop-a-device-syncing-and-optionally-order-it-wiped"},{"title":"Record the push token a handset has been issued, or withdraw it by passing NULL.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_push_token","href":"/api-reference/sync/record-the-push-token-a-handset-has-been-issued-or-withdraw-it-by-passing-null"},{"title":"How far each device has caught up, per scope.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/sync_status","href":"/api-reference/sync/how-far-each-device-has-caught-up-per-scope"},{"title":"One row per field somebody decided when merging a conflict, with both sides they decided between.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sync_conflict_decisions","href":"/api-reference/sync/one-row-per-field-somebody-decided-when-merging-a-conflict-with-both-sides-they-decided-between"},{"title":"Both sides of every collision. is_material marks the ones a person has to decide.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sync_conflicts","href":"/api-reference/sync/both-sides-of-every-collision-is_material-marks-the-ones-a-person-has-to-decide"},{"title":"What each device has still to send, and what has failed to apply.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sync_queue","href":"/api-reference/sync/what-each-device-has-still-to-send-and-what-has-failed-to-apply"}]},{"group":"IT assets","pages":[{"title":"Every device discovery knows, across every source that has reported it: whether it is linked to an asset, unreviewed or…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovered_devices","href":"/api-reference/it-assets/every-device-discovery-knows-across-every-source-that-has-reported-it:-whether-it-is-linked-to-an-asset-unreviewed-or…"},{"title":"The review: discovered devices a person has to decide about.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_candidates","href":"/api-reference/it-assets/the-review:-discovered-devices-a-person-has-to-decide-about"},{"title":"Which asset category a discovered device is filed under.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_category_rules","href":"/api-reference/it-assets/which-asset-category-a-discovered-device-is-filed-under"},{"title":"Add to discovery category rules: Which asset category a discovered device is filed under.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /discovery_category_rules","href":"/api-reference/it-assets/add-to-discovery-category-rules:-which-asset-category-a-discovered-device-is-filed-under"},{"title":"Remove rows from discovery category rules: Which asset category a discovered device is filed under.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /discovery_category_rules","href":"/api-reference/it-assets/remove-rows-from-discovery-category-rules:-which-asset-category-a-discovered-device-is-filed-under"},{"title":"Change rows in discovery category rules: Which asset category a discovered device is filed under.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /discovery_category_rules","href":"/api-reference/it-assets/change-rows-in-discovery-category-rules:-which-asset-category-a-discovered-device-is-filed-under"},{"title":"Where collectors find their scanning credentials, and which collectors may use each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_credential_refs","href":"/api-reference/it-assets/where-collectors-find-their-scanning-credentials-and-which-collectors-may-use-each"},{"title":"Add to discovery credential refs: Where collectors find their scanning credentials, and which collectors may use each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /discovery_credential_refs","href":"/api-reference/it-assets/add-to-discovery-credential-refs:-where-collectors-find-their-scanning-credentials-and-which-collectors-may-use-each"},{"title":"Remove rows from discovery credential refs: Where collectors find their scanning credentials, and which collectors may use each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /discovery_credential_refs","href":"/api-reference/it-assets/remove-rows-from-discovery-credential-refs:-where-collectors-find-their-scanning-credentials-and-which-collectors-may-use-each"},{"title":"Change rows in discovery credential refs: Where collectors find their scanning credentials, and which collectors may use each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /discovery_credential_refs","href":"/api-reference/it-assets/change-rows-in-discovery-credential-refs:-where-collectors-find-their-scanning-credentials-and-which-collectors-may-use-each"},{"title":"Everything discovery may keep about a device.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_device_attributes","href":"/api-reference/it-assets/everything-discovery-may-keep-about-a-device"},{"title":"Add to discovery device attributes: Everything discovery may keep about a device.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /discovery_device_attributes","href":"/api-reference/it-assets/add-to-discovery-device-attributes:-everything-discovery-may-keep-about-a-device"},{"title":"Remove rows from discovery device attributes: Everything discovery may keep about a device.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /discovery_device_attributes","href":"/api-reference/it-assets/remove-rows-from-discovery-device-attributes:-everything-discovery-may-keep-about-a-device"},{"title":"Change rows in discovery device attributes: Everything discovery may keep about a device.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /discovery_device_attributes","href":"/api-reference/it-assets/change-rows-in-discovery-device-attributes:-everything-discovery-may-keep-about-a-device"},{"title":"Enrolments: which installers may still admit machines, and how many each has.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_enrolments","href":"/api-reference/it-assets/enrolments:-which-installers-may-still-admit-machines-and-how-many-each-has"},{"title":"Add to discovery enrolments: Enrolments: which installers may still admit machines, and how many each has.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /discovery_enrolments","href":"/api-reference/it-assets/add-to-discovery-enrolments:-enrolments:-which-installers-may-still-admit-machines-and-how-many-each-has"},{"title":"Remove rows from discovery enrolments: Enrolments: which installers may still admit machines, and how many each has.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /discovery_enrolments","href":"/api-reference/it-assets/remove-rows-from-discovery-enrolments:-enrolments:-which-installers-may-still-admit-machines-and-how-many-each-has"},{"title":"Change rows in discovery enrolments: Enrolments: which installers may still admit machines, and how many each has.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /discovery_enrolments","href":"/api-reference/it-assets/change-rows-in-discovery-enrolments:-enrolments:-which-installers-may-still-admit-machines-and-how-many-each-has"},{"title":"What discovery found that somebody has to answer for — unknown, duplicate, stale, unmanaged, unauthorised and orphaned…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_exceptions","href":"/api-reference/it-assets/what-discovery-found-that-somebody-has-to-answer-for-—-unknown-duplicate-stale-unmanaged-unauthorised-and-orphaned…"},{"title":"How much agreement on each identifying attribute counts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_match_rules","href":"/api-reference/it-assets/how-much-agreement-on-each-identifying-attribute-counts"},{"title":"How sure a match must be before nobody is asked.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_reconciliation_settings","href":"/api-reference/it-assets/how-sure-a-match-must-be-before-nobody-is-asked"},{"title":"Add to discovery reconciliation settings: How sure a match must be before nobody is asked.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /discovery_reconciliation_settings","href":"/api-reference/it-assets/add-to-discovery-reconciliation-settings:-how-sure-a-match-must-be-before-nobody-is-asked"},{"title":"Remove rows from discovery reconciliation settings: How sure a match must be before nobody is asked.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /discovery_reconciliation_settings","href":"/api-reference/it-assets/remove-rows-from-discovery-reconciliation-settings:-how-sure-a-match-must-be-before-nobody-is-asked"},{"title":"Change rows in discovery reconciliation settings: How sure a match must be before nobody is asked.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /discovery_reconciliation_settings","href":"/api-reference/it-assets/change-rows-in-discovery-reconciliation-settings:-how-sure-a-match-must-be-before-nobody-is-asked"},{"title":"Who authorised which networks to be scanned, with which protocols, for which period, and whether that authority is in…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_scan_authorisations","href":"/api-reference/it-assets/who-authorised-which-networks-to-be-scanned-with-which-protocols-for-which-period-and-whether-that-authority-is-in…"},{"title":"Add to discovery scan authorisations: Who authorised which networks to be scanned, with which protocols, for which period, and whether that authority is in…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /discovery_scan_authorisations","href":"/api-reference/it-assets/add-to-discovery-scan-authorisations:-who-authorised-which-networks-to-be-scanned-with-which-protocols-for-which-period-and-whether-that-authority-is-in…"},{"title":"Remove rows from discovery scan authorisations: Who authorised which networks to be scanned, with which protocols, for which period, and whether that authority is in…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /discovery_scan_authorisations","href":"/api-reference/it-assets/remove-rows-from-discovery-scan-authorisations:-who-authorised-which-networks-to-be-scanned-with-which-protocols-for-which-period-and-whether-that-authority-is-in…"},{"title":"Change rows in discovery scan authorisations: Who authorised which networks to be scanned, with which protocols, for which period, and whether that authority is in…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /discovery_scan_authorisations","href":"/api-reference/it-assets/change-rows-in-discovery-scan-authorisations:-who-authorised-which-networks-to-be-scanned-with-which-protocols-for-which-period-and-whether-that-authority-is-in…"},{"title":"Every scan received: from which source, what kind, how the sweep went, what was dropped, and whether it has been…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_scan_documents","href":"/api-reference/it-assets/every-scan-received:-from-which-source-what-kind-how-the-sweep-went-what-was-dropped-and-whether-it-has-been…"},{"title":"Addresses no collector may scan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_scan_exclusions","href":"/api-reference/it-assets/addresses-no-collector-may-scan"},{"title":"Add to discovery scan exclusions: Addresses no collector may scan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /discovery_scan_exclusions","href":"/api-reference/it-assets/add-to-discovery-scan-exclusions:-addresses-no-collector-may-scan"},{"title":"Remove rows from discovery scan exclusions: Addresses no collector may scan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /discovery_scan_exclusions","href":"/api-reference/it-assets/remove-rows-from-discovery-scan-exclusions:-addresses-no-collector-may-scan"},{"title":"Change rows in discovery scan exclusions: Addresses no collector may scan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /discovery_scan_exclusions","href":"/api-reference/it-assets/change-rows-in-discovery-scan-exclusions:-addresses-no-collector-may-scan"},{"title":"When each collector sweeps which authorised ranges, and which inventories its connectors read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_scan_schedules","href":"/api-reference/it-assets/when-each-collector-sweeps-which-authorised-ranges-and-which-inventories-its-connectors-read"},{"title":"Add to discovery scan schedules: When each collector sweeps which authorised ranges, and which inventories its connectors read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /discovery_scan_schedules","href":"/api-reference/it-assets/add-to-discovery-scan-schedules:-when-each-collector-sweeps-which-authorised-ranges-and-which-inventories-its-connectors-read"},{"title":"Remove rows from discovery scan schedules: When each collector sweeps which authorised ranges, and which inventories its connectors read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /discovery_scan_schedules","href":"/api-reference/it-assets/remove-rows-from-discovery-scan-schedules:-when-each-collector-sweeps-which-authorised-ranges-and-which-inventories-its-connectors-read"},{"title":"Change rows in discovery scan schedules: When each collector sweeps which authorised ranges, and which inventories its connectors read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /discovery_scan_schedules","href":"/api-reference/it-assets/change-rows-in-discovery-scan-schedules:-when-each-collector-sweeps-which-authorised-ranges-and-which-inventories-its-connectors-read"},{"title":"What can report devices: agents, collectors and connectors.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_source_platforms","href":"/api-reference/it-assets/what-can-report-devices:-agents-collectors-and-connectors"},{"title":"Add to discovery source platforms: What can report devices: agents, collectors and connectors.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /discovery_source_platforms","href":"/api-reference/it-assets/add-to-discovery-source-platforms:-what-can-report-devices:-agents-collectors-and-connectors"},{"title":"Remove rows from discovery source platforms: What can report devices: agents, collectors and connectors.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /discovery_source_platforms","href":"/api-reference/it-assets/remove-rows-from-discovery-source-platforms:-what-can-report-devices:-agents-collectors-and-connectors"},{"title":"Change rows in discovery source platforms: What can report devices: agents, collectors and connectors.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /discovery_source_platforms","href":"/api-reference/it-assets/change-rows-in-discovery-source-platforms:-what-can-report-devices:-agents-collectors-and-connectors"},{"title":"Every agent, collector and connector, when each last reported, and whether it is overdue — not heard from in twice its…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /discovery_sources","href":"/api-reference/it-assets/every-agent-collector-and-connector-when-each-last-reported-and-whether-it-is-overdue-—-not-heard-from-in-twice-its…"},{"title":"Register a discovered device as a new asset and link the two.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/accept_itam_candidate","href":"/api-reference/it-assets/register-a-discovered-device-as-a-new-asset-and-link-the-two"},{"title":"Say an exception is being dealt with, and optionally hand it to somebody else.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/acknowledge_itam_exception","href":"/api-reference/it-assets/say-an-exception-is-being-dealt-with-and-optionally-hand-it-to-somebody-else"},{"title":"Resolve an exception, saying what was done.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/close_itam_exception","href":"/api-reference/it-assets/resolve-an-exception-saying-what-was-done"},{"title":"Create an enrolment and return the key an installer carries, once.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_itam_enrolment","href":"/api-reference/it-assets/create-an-enrolment-and-return-the-key-an-installer-carries-once"},{"title":"Create a collector or connector by hand — the datacentre's collector, the vCenter connector — rather than through an…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_itam_source","href":"/api-reference/it-assets/create-a-collector-or-connector-by-hand-—-the-datacentres-collector-the-vcenter-connector-—-rather-than-through-an…"},{"title":"Issue a key for one collector or connector, bound to it and able to post its scans and nothing else.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_itam_source_key","href":"/api-reference/it-assets/issue-a-key-for-one-collector-or-connector-bound-to-it-and-able-to-post-its-scans-and-nothing-else"},{"title":"Remove a category rule.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_itam_category_rule","href":"/api-reference/it-assets/remove-a-category-rule"},{"title":"Remove a credential reference, and take it out of every schedule that tried it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_itam_credential_ref","href":"/api-reference/it-assets/remove-a-credential-reference-and-take-it-out-of-every-schedule-that-tried-it"},{"title":"Remove a scan exclusion.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_itam_scan_exclusion","href":"/api-reference/it-assets/remove-a-scan-exclusion"},{"title":"Remove a scan schedule or a connector.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_itam_scan_schedule","href":"/api-reference/it-assets/remove-a-scan-schedule-or-a-connector"},{"title":"Dismiss a discovered device as NOT_OURS, PERSONAL_DEVICE, NOT_AN_ASSET or NOT_PERMITTED.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dismiss_itam_device","href":"/api-reference/it-assets/dismiss-a-discovered-device-as-not_ours-personal_device-not_an_asset-or-not_permitted"},{"title":"Called by an agent or collector, with a token exchanged from an enrolment key: become a discovery source and receive a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/enrol_itam_source","href":"/api-reference/it-assets/called-by-an-agent-or-collector-with-a-token-exchanged-from-an-enrolment-key:-become-a-discovery-source-and-receive-a…"},{"title":"Grant a drafted scan authorisation, putting your name to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/grant_itam_scan_authorisation","href":"/api-reference/it-assets/grant-a-drafted-scan-authorisation-putting-your-name-to-it"},{"title":"Discovery's coverage over the last p_days: devices discovered and how many are linked to assets, unreviewed or…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/itam_coverage","href":"/api-reference/it-assets/discoverys-coverage-over-the-last-p_days:-devices-discovered-and-how-many-are-linked-to-assets-unreviewed-or…"},{"title":"The software installed on a discovered device at a moment — now unless p_as_at says otherwise — as its sources reported…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/itam_device_software","href":"/api-reference/it-assets/the-software-installed-on-a-discovered-device-at-a-moment-—-now-unless-p_as_at-says-otherwise-—-as-its-sources-reported…"},{"title":"Called by an agent or collector with its own key: what to report and how often, which attributes are kept, and for a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/itam_source_config","href":"/api-reference/it-assets/called-by-an-agent-or-collector-with-its-own-key:-what-to-report-and-how-often-which-attributes-are-kept-and-for-a…"},{"title":"Decide that a discovered device is an asset already in the register.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/link_itam_candidate","href":"/api-reference/it-assets/decide-that-a-discovered-device-is-an-asset-already-in-the-register"},{"title":"Match waiting scans against the register now rather than at the next minute.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reconcile_itam_now","href":"/api-reference/it-assets/match-waiting-scans-against-the-register-now-rather-than-at-the-next-minute"},{"title":"Take back a dismissal and put the device in the review again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/restore_itam_device","href":"/api-reference/it-assets/take-back-a-dismissal-and-put-the-device-in-the-review-again"},{"title":"Stop an enrolment admitting machines, and revoke its key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revoke_itam_enrolment","href":"/api-reference/it-assets/stop-an-enrolment-admitting-machines-and-revoke-its-key"},{"title":"Revoke a scan authorisation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revoke_itam_scan_authorisation","href":"/api-reference/it-assets/revoke-a-scan-authorisation"},{"title":"Called by an agent or collector with its own key: issue a successor with the same scope and binding, and end the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rotate_own_itam_source_key","href":"/api-reference/it-assets/called-by-an-agent-or-collector-with-its-own-key:-issue-a-successor-with-the-same-scope-and-binding-and-end-the…"},{"title":"Say which asset category a discovered device is filed under, by its platform, device class or an operating system…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_itam_category_rule","href":"/api-reference/it-assets/say-which-asset-category-a-discovered-device-is-filed-under-by-its-platform-device-class-or-an-operating-system…"},{"title":"Have a collector read an inventory another system keeps, every so many minutes: AWS, AZURE or GCP instances, INTUNE…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_itam_connector_schedule","href":"/api-reference/it-assets/have-a-collector-read-an-inventory-another-system-keeps-every-so-many-minutes:-aws-azure-or-gcp-instances-intune…"},{"title":"Record where collectors find a scanning credential — the store (COLLECTOR_LOCAL, ENVIRONMENT, HASHICORP_VAULT…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_itam_credential_ref","href":"/api-reference/it-assets/record-where-collectors-find-a-scanning-credential-—-the-store-collector_local-environment-hashicorp_vault…"},{"title":"Set how much agreement on one identifying attribute counts toward matching a device to an asset, and whether…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_itam_match_rule","href":"/api-reference/it-assets/set-how-much-agreement-on-one-identifying-attribute-counts-toward-matching-a-device-to-an-asset-and-whether…"},{"title":"Set how sure a match must be to link a device without asking (auto_link_threshold), below which it is not proposed at…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_itam_reconciliation_settings","href":"/api-reference/it-assets/set-how-sure-a-match-must-be-to-link-a-device-without-asking-auto_link_threshold-below-which-it-is-not-proposed-at…"},{"title":"Draft an authorisation to scan network ranges (CIDR, no wider than a /16), with which protocols, for which period, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_itam_scan_authorisation","href":"/api-reference/it-assets/draft-an-authorisation-to-scan-network-ranges-cidr-no-wider-than-a-16-with-which-protocols-for-which-period-and…"},{"title":"Exclude an address or range from scanning — by one collector, or every collector when no source is named — until a time…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_itam_scan_exclusion","href":"/api-reference/it-assets/exclude-an-address-or-range-from-scanning-—-by-one-collector-or-every-collector-when-no-source-is-named-—-until-a-time…"},{"title":"Schedule a collector to sweep an authorisation's ranges every so many minutes, optionally in a daily window and on…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_itam_scan_schedule","href":"/api-reference/it-assets/schedule-a-collector-to-sweep-an-authorisations-ranges-every-so-many-minutes-optionally-in-a-daily-window-and-on…"},{"title":"Approve a pending source, suspend or restore one, or retire one for good.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_itam_source_status","href":"/api-reference/it-assets/approve-a-pending-source-suspend-or-restore-one-or-retire-one-for-good"},{"title":"Called by an agent, collector or connector with its own key: post one scan document (schema itam.scan/1) as that…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_itam_scan","href":"/api-reference/it-assets/called-by-an-agent-collector-or-connector-with-its-own-key:-post-one-scan-document-schema-itamscan1-as-that…"},{"title":"Undo a link between a discovered device and an asset, with a reason, and put the device back in the review.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unlink_itam_device","href":"/api-reference/it-assets/undo-a-link-between-a-discovered-device-and-an-asset-with-a-reason-and-put-the-device-back-in-the-review"}]},{"group":"Activity","pages":[{"title":"One record's activity feed — comments, curated events, the audit trail as a sentence — spanning every register until a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /document_activity_log","href":"/api-reference/activity/one-records-activity-feed-—-comments-curated-events-the-audit-trail-as-a-sentence-—-spanning-every-register-until-a…"},{"title":"The timeline for one record: comments, curated activity and the audit trail as sentences.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/activity","href":"/api-reference/activity/the-timeline-for-one-record:-comments-curated-activity-and-the-audit-trail-as-sentences"},{"title":"Add a comment to a record, optionally mentioning people who should see it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_comment","href":"/api-reference/activity/add-a-comment-to-a-record-optionally-mentioning-people-who-should-see-it"},{"title":"The audit trail, field by field, for a record or an actor.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/audit_trail","href":"/api-reference/activity/the-audit-trail-field-by-field-for-a-record-or-an-actor"},{"title":"Remove your own comment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_comment","href":"/api-reference/activity/remove-your-own-comment"},{"title":"Change your own comment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/edit_comment","href":"/api-reference/activity/change-your-own-comment"}]},{"group":"Document configuration","pages":[{"title":"Document categories as a tree.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /document_category_settings","href":"/api-reference/document-configuration/document-categories-as-a-tree"},{"title":"How long files are kept and what happens when the time is up.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /retention_policy_settings","href":"/api-reference/document-configuration/how-long-files-are-kept-and-what-happens-when-the-time-is-up"},{"title":"Add to retention policy settings: How long files are kept and what happens when the time is up.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /retention_policy_settings","href":"/api-reference/document-configuration/add-to-retention-policy-settings:-how-long-files-are-kept-and-what-happens-when-the-time-is-up"},{"title":"Remove rows from retention policy settings: How long files are kept and what happens when the time is up.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /retention_policy_settings","href":"/api-reference/document-configuration/remove-rows-from-retention-policy-settings:-how-long-files-are-kept-and-what-happens-when-the-time-is-up"},{"title":"Change rows in retention policy settings: How long files are kept and what happens when the time is up.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /retention_policy_settings","href":"/api-reference/document-configuration/change-rows-in-retention-policy-settings:-how-long-files-are-kept-and-what-happens-when-the-time-is-up"},{"title":"Tags with how often each has actually been applied — an unused tag is one nobody found.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tag_settings","href":"/api-reference/document-configuration/tags-with-how-often-each-has-actually-been-applied-—-an-unused-tag-is-one-nobody-found"},{"title":"Add to tag settings: Tags with how often each has actually been applied — an unused tag is one nobody found.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tag_settings","href":"/api-reference/document-configuration/add-to-tag-settings:-tags-with-how-often-each-has-actually-been-applied-—-an-unused-tag-is-one-nobody-found"},{"title":"Remove rows from tag settings: Tags with how often each has actually been applied — an unused tag is one nobody found.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /tag_settings","href":"/api-reference/document-configuration/remove-rows-from-tag-settings:-tags-with-how-often-each-has-actually-been-applied-—-an-unused-tag-is-one-nobody-found"},{"title":"Change rows in tag settings: Tags with how often each has actually been applied — an unused tag is one nobody found.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /tag_settings","href":"/api-reference/document-configuration/change-rows-in-tag-settings:-tags-with-how-often-each-has-actually-been-applied-—-an-unused-tag-is-one-nobody-found"}]},{"group":"Document folders","pages":[{"title":"The people and roles a restricted document folder is open to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /document_folder_audience","href":"/api-reference/document-folders/the-people-and-roles-a-restricted-document-folder-is-open-to"},{"title":"Hand-made document folders the caller may see, and what each holds.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /document_folders","href":"/api-reference/document-folders/hand-made-document-folders-the-caller-may-see-and-what-each-holds"},{"title":"Remove an empty document folder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_document_folder","href":"/api-reference/document-folders/remove-an-empty-document-folder"},{"title":"Put a document in a hand-made folder, or take it out.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/file_document_in_folder","href":"/api-reference/document-folders/put-a-document-in-a-hand-made-folder-or-take-it-out"},{"title":"Open a restricted document folder to a person or a role.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/grant_document_folder","href":"/api-reference/document-folders/open-a-restricted-document-folder-to-a-person-or-a-role"},{"title":"Close a restricted document folder to somebody it was open to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revoke_document_folder","href":"/api-reference/document-folders/close-a-restricted-document-folder-to-somebody-it-was-open-to"},{"title":"Create or amend a hand-made document folder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_document_folder","href":"/api-reference/document-folders/create-or-amend-a-hand-made-document-folder"}]},{"group":"Documents","pages":[{"title":"What each kind of document puts on the page, and how many have been produced from it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /document_templates","href":"/api-reference/documents/what-each-kind-of-document-puts-on-the-page-and-how-many-have-been-produced-from-it"},{"title":"Retire a template.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_document_template","href":"/api-reference/documents/retire-a-template"},{"title":"Every placeholder path that resolves for a register, with what it says for a real record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/document_bindings","href":"/api-reference/documents/every-placeholder-path-that-resolves-for-a-register-with-what-it-says-for-a-real-record"},{"title":"The registers a document can be produced for, each with the column that names a record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/document_entities","href":"/api-reference/documents/the-registers-a-document-can-be-produced-for-each-with-the-column-that-names-a-record"},{"title":"Records of one register the caller may see, for a template to be previewed against.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/document_preview_records","href":"/api-reference/documents/records-of-one-register-the-caller-may-see-for-a-template-to-be-previewed-against"},{"title":"Every document produced about one record, with what stopped the ones that failed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/document_renders","href":"/api-reference/documents/every-document-produced-about-one-record-with-what-stopped-the-ones-that-failed"},{"title":"The sources a table block on this register's document can list rows from — those with a key to the register, and those…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/document_table_sources","href":"/api-reference/documents/the-sources-a-table-block-on-this-registers-document-can-list-rows-from-—-those-with-a-key-to-the-register-and-those…"},{"title":"The published templates a record actually offers, once each one's visibility condition — its location, its category…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/document_templates_available","href":"/api-reference/documents/the-published-templates-a-record-actually-offers-once-each-ones-visibility-condition-—-its-location-its-category…"},{"title":"Make a template available to the product, or take it back.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_document_template","href":"/api-reference/documents/make-a-template-available-to-the-product-or-take-it-back"},{"title":"Ask for a document about a record, and get the render to watch.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_document","href":"/api-reference/documents/ask-for-a-document-about-a-record-and-get-the-render-to-watch"},{"title":"A template being edited, resolved against a record — the same structure the renderer is given.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resolve_document_draft","href":"/api-reference/documents/a-template-being-edited-resolved-against-a-record-—-the-same-structure-the-renderer-is-given"},{"title":"Create or amend a document template.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_document_template","href":"/api-reference/documents/create-or-amend-a-document-template"}]},{"group":"Document tree","pages":[{"title":"The browsable document library as a flat node/parent list, shaped for a tree control.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /document_tree","href":"/api-reference/document-tree/the-browsable-document-library-as-a-flat-nodeparent-list-shaped-for-a-tree-control"},{"title":"The documents and files sitting directly in one Browse-tree folder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/document_folder_contents","href":"/api-reference/document-tree/the-documents-and-files-sitting-directly-in-one-browse-tree-folder"},{"title":"Leaves matching a search, each with the folder it sits in, so the Browse tree can filter in place and reveal the branch…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/document_search","href":"/api-reference/document-tree/leaves-matching-a-search-each-with-the-folder-it-sits-in-so-the-browse-tree-can-filter-in-place-and-reveal-the-branch…"},{"title":"Move a document filing or a file attachment to another record in the Browse tree.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/refile_to_folder","href":"/api-reference/document-tree/move-a-document-filing-or-a-file-attachment-to-another-record-in-the-browse-tree"}]},{"group":"Document control","pages":[{"title":"The revision history behind a controlled document.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /document_versions","href":"/api-reference/document-control/the-revision-history-behind-a-controlled-document"},{"title":"The controlled document library. control_state is what the calendar says, status is what a person decided — they…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /documents","href":"/api-reference/document-control/the-controlled-document-library-control_state-is-what-the-calendar-says-status-is-what-a-person-decided-—-they…"},{"title":"Put a revision in force and supersede the one before it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/approve_document","href":"/api-reference/document-control/put-a-revision-in-force-and-supersede-the-one-before-it"},{"title":"Put a revision of a procedure in force and supersede the one before it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/approve_sop","href":"/api-reference/document-control/put-a-revision-of-a-procedure-in-force-and-supersede-the-one-before-it"},{"title":"Counts for the document library header: what has lapsed, what is about to, and what is waiting.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/document_control_summary","href":"/api-reference/document-control/counts-for-the-document-library-header:-what-has-lapsed-what-is-about-to-and-what-is-waiting"},{"title":"The records a controlled document is filed against, restricted to the ones the caller may see.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/document_links","href":"/api-reference/document-control/the-records-a-controlled-document-is-filed-against-restricted-to-the-ones-the-caller-may-see"},{"title":"The controlled documents filed against a record, including the ones its asset type, model or asset carries.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/documents_for_entity","href":"/api-reference/document-control/the-controlled-documents-filed-against-a-record-including-the-ones-its-asset-type-model-or-asset-carries"},{"title":"File a controlled document against a record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/link_document","href":"/api-reference/document-control/file-a-controlled-document-against-a-record"},{"title":"Create a document or open its next revision.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_document","href":"/api-reference/document-control/create-a-document-or-open-its-next-revision"},{"title":"Create a procedure or open its next revision.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_sop","href":"/api-reference/document-control/create-a-procedure-or-open-its-next-revision"},{"title":"Write or amend a task-level work instruction.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_work_instruction","href":"/api-reference/document-control/write-or-amend-a-task-level-work-instruction"},{"title":"Submit the open revision of a document for approval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_document","href":"/api-reference/document-control/submit-the-open-revision-of-a-document-for-approval"},{"title":"Submit the open revision of a procedure for approval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_sop","href":"/api-reference/document-control/submit-the-open-revision-of-a-procedure-for-approval"},{"title":"Remove a document from one record, leaving it filed against the others.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unlink_document","href":"/api-reference/document-control/remove-a-document-from-one-record-leaving-it-filed-against-the-others"},{"title":"Withdraw a document from use, with the reason on the record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/withdraw_document","href":"/api-reference/document-control/withdraw-a-document-from-use-with-the-reason-on-the-record"},{"title":"Withdraw a procedure from use, with the reason on the record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/withdraw_sop","href":"/api-reference/document-control/withdraw-a-procedure-from-use-with-the-reason-on-the-record"},{"title":"The revision history behind a procedure.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sop_versions","href":"/api-reference/document-control/the-revision-history-behind-a-procedure"},{"title":"Standard operating procedures with the steps of their current revision.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sops","href":"/api-reference/document-control/standard-operating-procedures-with-the-steps-of-their-current-revision"},{"title":"Task-level instructions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_instructions","href":"/api-reference/document-control/task-level-instructions"}]},{"group":"Admin","pages":[{"title":"Every administered entity, with what the calling user may do to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /entity_definitions","href":"/api-reference/admin/every-administered-entity-with-what-the-calling-user-may-do-to-it"},{"title":"The columns a form may ask for, generated from the model, with where the tenant arranged them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /entity_fields","href":"/api-reference/admin/the-columns-a-form-may-ask-for-generated-from-the-model-with-where-the-tenant-arranged-them"},{"title":"What a hand-written form asks that its table has no column for, with where the tenant put it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /entity_form_controls","href":"/api-reference/admin/what-a-hand-written-form-asks-that-its-table-has-no-column-for-with-where-the-tenant-put-it"},{"title":"Every record type, with what may be hung off it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /entity_types","href":"/api-reference/admin/every-record-type-with-what-may-be-hung-off-it"},{"title":"Which statuses this record may move to next, and what each would require.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/available_record_transitions","href":"/api-reference/admin/which-statuses-this-record-may-move-to-next-and-what-each-would-require"},{"title":"Create a new role as a copy of an existing one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clone_role","href":"/api-reference/admin/create-a-new-role-as-a-copy-of-an-existing-one"},{"title":"Create a row of an administered entity, with its custom field answers.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_record","href":"/api-reference/admin/create-a-row-of-an-administered-entity-with-its-custom-field-answers"},{"title":"Remove a row of an administered entity.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_record","href":"/api-reference/admin/remove-a-row-of-an-administered-entity"},{"title":"One row of an administered entity, as the form that edits it expects.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/get_record","href":"/api-reference/admin/one-row-of-an-administered-entity-as-the-form-that-edits-it-expects"},{"title":"id, label and code for a picker, for any entity — choosable is not the same as editable.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/list_options","href":"/api-reference/admin/id-label-and-code-for-a-picker-for-any-entity-—-choosable-is-not-the-same-as-editable"},{"title":"Rows of an administered entity, under the caller's own RLS.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/list_records","href":"/api-reference/admin/rows-of-an-administered-entity-under-the-callers-own-rls"},{"title":"Every field the model describes for one record, resolved and sectioned, for a screen to read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_facts","href":"/api-reference/admin/every-field-the-model-describes-for-one-record-resolved-and-sectioned-for-a-screen-to-read"},{"title":"The status a record is in, for a screen refreshing after a move.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_status","href":"/api-reference/admin/the-status-a-record-is-in-for-a-screen-refreshing-after-a-move"},{"title":"The values a chosen reference contributes to the rest of the form that chose it, in two groups.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reference_defaults","href":"/api-reference/admin/the-values-a-chosen-reference-contributes-to-the-rest-of-the-form-that-chose-it-in-two-groups"},{"title":"Put a hand-arranged list into the order somebody dragged it into.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reorder_records","href":"/api-reference/admin/put-a-hand-arranged-list-into-the-order-somebody-dragged-it-into"},{"title":"Grant and revoke a set of a role's permissions together.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_role_permissions","href":"/api-reference/admin/grant-and-revoke-a-set-of-a-roles-permissions-together"},{"title":"Move a record to another status, through its own state model.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/transition_record","href":"/api-reference/admin/move-a-record-to-another-status-through-its-own-state-model"},{"title":"Correct a row of an administered entity.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_record","href":"/api-reference/admin/correct-a-row-of-an-administered-entity"}]},{"group":"E-way bills","pages":[{"title":"Everyone an asset can be sold to — customers and suppliers in one list — with which register each comes from.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /eway_bill_buyers","href":"/api-reference/e-way-bills/everyone-an-asset-can-be-sold-to-—-customers-and-suppliers-in-one-list-—-with-which-register-each-comes-from"},{"title":"Every move between two sites and every sale, per site the goods left, with what it is worth, how much of it e-way bills…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /eway_bill_consignments","href":"/api-reference/e-way-bills/every-move-between-two-sites-and-every-sale-per-site-the-goods-left-with-what-it-is-worth-how-much-of-it-e-way-bills…"},{"title":"The assets on each e-way bill, with the HSN code, rate and value each was sent at and the tax it came to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /eway_bill_lines","href":"/api-reference/e-way-bills/the-assets-on-each-e-way-bill-with-the-hsn-code-rate-and-value-each-was-sent-at-and-the-tax-it-came-to"},{"title":"E-way bills: the consignment each one covers, both GSTINs, the document it travels on, the tax, the transport and, once…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /eway_bills","href":"/api-reference/e-way-bills/e-way-bills:-the-consignment-each-one-covers-both-gstins-the-document-it-travels-on-the-tax-the-transport-and-once…"},{"title":"What the e-way bills for a move that has happened — a bulk move's batch or one transfer — would say, one consignment…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/eway_bill_plan_for_move","href":"/api-reference/e-way-bills/what-the-e-way-bills-for-a-move-that-has-happened-—-a-bulk-moves-batch-or-one-transfer-—-would-say-one-consignment…"},{"title":"What the e-way bills for a recorded sale would say — one consignment per site the assets leave, billed and delivered…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/eway_bill_plan_for_sale","href":"/api-reference/e-way-bills/what-the-e-way-bills-for-a-recorded-sale-would-say-—-one-consignment-per-site-the-assets-leave-billed-and-delivered…"},{"title":"Prepare e-way bills for a move that has happened — a bulk move's batch or one transfer — one per site the goods left.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/prepare_eway_bills","href":"/api-reference/e-way-bills/prepare-e-way-bills-for-a-move-that-has-happened-—-a-bulk-moves-batch-or-one-transfer-—-one-per-site-the-goods-left"},{"title":"Prepare e-way bills for a recorded sale, one per site the assets leave.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/prepare_sale_eway_bills","href":"/api-reference/e-way-bills/prepare-e-way-bills-for-a-recorded-sale-one-per-site-the-assets-leave"}]},{"group":"E-way bill filing","pages":[{"title":"The connection this organisation files e-way bills through: its name, TEST or LIVE, the service's two addresses, the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /eway_bill_filing_account","href":"/api-reference/e-way-bill-filing/the-connection-this-organisation-files-e-way-bills-through:-its-name-test-or-live-the-services-two-addresses-the…"},{"title":"Each time the filing service was asked to generate, cancel or print an e-way bill: what was sent, what it answered, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /eway_bill_filings","href":"/api-reference/e-way-bill-filing/each-time-the-filing-service-was-asked-to-generate-cancel-or-print-an-e-way-bill:-what-was-sent-what-it-answered-and…"},{"title":"Ask the portal to cancel a generated e-way bill, within 24 hours of its generation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_eway_bill","href":"/api-reference/e-way-bill-filing/ask-the-portal-to-cancel-a-generated-e-way-bill-within-24-hours-of-its-generation"},{"title":"Correct the addresses or the transport on an e-way bill the portal has not generated: any of from_/to_/ship_to_…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/correct_eway_bill","href":"/api-reference/e-way-bill-filing/correct-the-addresses-or-the-transport-on-an-e-way-bill-the-portal-has-not-generated:-any-of-from_to_ship_to_…"},{"title":"One e-way bill and its lines in the field names a filing connection's templates use, for previewing what a template…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/eway_bill_filing_document","href":"/api-reference/e-way-bill-filing/one-e-way-bill-and-its-lines-in-the-field-names-a-filing-connections-templates-use-for-previewing-what-a-template…"},{"title":"File a draft e-way bill with the GST portal, or file again one the portal refused once it has been corrected.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/file_eway_bill","href":"/api-reference/e-way-bill-filing/file-a-draft-e-way-bill-with-the-gst-portal-or-file-again-one-the-portal-refused-once-it-has-been-corrected"},{"title":"Fetch the portal's print of a generated e-way bill again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/refetch_eway_bill_pdf","href":"/api-reference/e-way-bill-filing/fetch-the-portals-print-of-a-generated-e-way-bill-again"},{"title":"Set up or change the connection e-way bills are filed through: its name, the service's test and live addresses, the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_eway_bill_connection","href":"/api-reference/e-way-bill-filing/set-up-or-change-the-connection-e-way-bills-are-filed-through:-its-name-the-services-test-and-live-addresses-the…"}]},{"group":"Features","pages":[{"title":"Which modules this organisation has: what we offer, what they chose, and what the answer resolves to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /features","href":"/api-reference/features/which-modules-this-organisation-has:-what-we-offer-what-they-chose-and-what-the-answer-resolves-to"},{"title":"The modules this organisation has today that switching one off would take with it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/feature_impact","href":"/api-reference/features/the-modules-this-organisation-has-today-that-switching-one-off-would-take-with-it"},{"title":"Refuse unless the caller's organisation has a feature.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_feature","href":"/api-reference/features/refuse-unless-the-callers-organisation-has-a-feature"},{"title":"Switch a module on or off for this organisation, within what we offer it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_feature","href":"/api-reference/features/switch-a-module-on-or-off-for-this-organisation-within-what-we-offer-it"},{"title":"Try a module this organisation has not bought, free for 14 days.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/start_module_trial","href":"/api-reference/features/try-a-module-this-organisation-has-not-bought-free-for-14-days"}]},{"group":"Feeds","pages":[{"title":"A gateway's MQTT feed: how it is reached, whether it is reaching us, and whether what arrives is becoming readings.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /feeds","href":"/api-reference/feeds/a-gateways-mqtt-feed:-how-it-is-reached-whether-it-is-reaching-us-and-whether-what-arrives-is-becoming-readings"},{"title":"Give a device a feed: a broker to subscribe to, or (transport BROKER) a way to publish its messages to ours.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_feed","href":"/api-reference/feeds/give-a-device-a-feed:-a-broker-to-subscribe-to-or-transport-broker-a-way-to-publish-its-messages-to-ours"},{"title":"Issue a key for one sensor feed to use as its password at our MQTT broker.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_feed_key","href":"/api-reference/feeds/issue-a-key-for-one-sensor-feed-to-use-as-its-password-at-our-mqtt-broker"},{"title":"What a map makes of a message, through the same mapper ingest uses, and whether each code names a sensor.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_feed_mapping","href":"/api-reference/feeds/what-a-map-makes-of-a-message-through-the-same-mapper-ingest-uses-and-whether-each-code-names-a-sensor"},{"title":"Post a gateway's own messages for a feed that publishes to us, naming it by its device code; the feed's map reads them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_feed_messages","href":"/api-reference/feeds/post-a-gateways-own-messages-for-a-feed-that-publishes-to-us-naming-it-by-its-device-code;-the-feeds-map-reads-them"},{"title":"Record readings for several sensors at once, each named by its code, and say what happened to each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_sensor_readings","href":"/api-reference/feeds/record-readings-for-several-sensors-at-once-each-named-by-its-code-and-say-what-happened-to-each"},{"title":"Save which fields of a gateway's messages hold the sensor code, the value, the quality and the time.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_feed_mapping","href":"/api-reference/feeds/save-which-fields-of-a-gateways-messages-hold-the-sensor-code-the-value-the-quality-and-the-time"},{"title":"Set or clear a feed's broker password.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_feed_credential","href":"/api-reference/feeds/set-or-clear-a-feeds-broker-password"},{"title":"Feed messages to a feed by hand, to prove the whole path before any gateway is connected.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/simulate_feed_messages","href":"/api-reference/feeds/feed-messages-to-a-feed-by-hand-to-prove-the-whole-path-before-any-gateway-is-connected"}]},{"group":"FF\u0026E plans","pages":[{"title":"The sections an FF\u0026E plan is divided into, such as Rooms or IT.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ffe_areas","href":"/api-reference/ff\u0026e-plans/the-sections-an-ff\u0026e-plan-is-divided-into-such-as-rooms-or-it"},{"title":"Add to ffe areas: The sections an FF\u0026E plan is divided into, such as Rooms or IT.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /ffe_areas","href":"/api-reference/ff\u0026e-plans/add-to-ffe-areas:-the-sections-an-ff\u0026e-plan-is-divided-into-such-as-rooms-or-it"},{"title":"Remove rows from ffe areas: The sections an FF\u0026E plan is divided into, such as Rooms or IT.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /ffe_areas","href":"/api-reference/ff\u0026e-plans/remove-rows-from-ffe-areas:-the-sections-an-ff\u0026e-plan-is-divided-into-such-as-rooms-or-it"},{"title":"Change rows in ffe areas: The sections an FF\u0026E plan is divided into, such as Rooms or IT.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /ffe_areas","href":"/api-reference/ff\u0026e-plans/change-rows-in-ffe-areas:-the-sections-an-ff\u0026e-plan-is-divided-into-such-as-rooms-or-it"},{"title":"The calendars an FF\u0026E plan can be stated in, with the financial year each is for and the currency of the company each…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ffe_calendars","href":"/api-reference/ff\u0026e-plans/the-calendars-an-ff\u0026e-plan-can-be-stated-in-with-the-financial-year-each-is-for-and-the-currency-of-the-company-each…"},{"title":"The items on an FF\u0026E plan, each with its quantity, unit price and amount for Years 1 to 5 and the budget head its Year…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ffe_plan_lines","href":"/api-reference/ff\u0026e-plans/the-items-on-an-ff\u0026e-plan-each-with-its-quantity-unit-price-and-amount-for-years-1-to-5-and-the-budget-head-its-year…"},{"title":"FF\u0026E plans, one per hotel per round, with what each spends in Year 1 and over five years, where its reserve ends Year…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ffe_plans","href":"/api-reference/ff\u0026e-plans/ff\u0026e-plans-one-per-hotel-per-round-with-what-each-spends-in-year-1-and-over-five-years-where-its-reserve-ends-year…"},{"title":"What kind of goods an FF\u0026E line buys, per area: soft goods and case goods in the rooms, for example.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /ffe_product_types","href":"/api-reference/ff\u0026e-plans/what-kind-of-goods-an-ff\u0026e-line-buys-per-area:-soft-goods-and-case-goods-in-the-rooms-for-example"},{"title":"Start a hotel's five-year FF\u0026E plan, whose Year 1 is its fiscal calendar's year.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_ffe_plan","href":"/api-reference/ff\u0026e-plans/start-a-hotels-five-year-ff\u0026e-plan-whose-year-1-is-its-fiscal-calendars-year"},{"title":"Remove a draft FF\u0026E plan nobody has submitted, so the hotel can start the round again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_ffe_plan","href":"/api-reference/ff\u0026e-plans/remove-a-draft-ff\u0026e-plan-nobody-has-submitted-so-the-hotel-can-start-the-round-again"},{"title":"Take an item off a draft FF\u0026E plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_ffe_plan_line","href":"/api-reference/ff\u0026e-plans/take-an-item-off-a-draft-ff\u0026e-plan"},{"title":"What an FF\u0026E plan fails right now, recomputed on every call.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/ffe_plan_exceptions","href":"/api-reference/ff\u0026e-plans/what-an-ff\u0026e-plan-fails-right-now-recomputed-on-every-call"},{"title":"An FF\u0026E plan's reserve for Year 0 to Year 5: revenue, the agreed rate, the provision it earns, what is spent from the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/ffe_plan_reserve","href":"/api-reference/ff\u0026e-plans/an-ff\u0026e-plans-reserve-for-year-0-to-year-5:-revenue-the-agreed-rate-the-provision-it-earns-what-is-spent-from-the…"},{"title":"Bring a draft FF\u0026E plan into line with a workbook, by project number: matching items are updated, new ones added, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_ffe_plan","href":"/api-reference/ff\u0026e-plans/bring-a-draft-ff\u0026e-plan-into-line-with-a-workbook-by-project-number:-matching-items-are-updated-new-ones-added-and…"},{"title":"Open budget heads for an approved FF\u0026E plan's Year 1: a total for the plan, one branch for the reserve and one for the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/open_ffe_plan_budgets","href":"/api-reference/ff\u0026e-plans/open-budget-heads-for-an-approved-ff\u0026e-plans-year-1:-a-total-for-the-plan-one-branch-for-the-reserve-and-one-for-the…"},{"title":"Add an item to a draft FF\u0026E plan or change one. p_years is [{year_offset 1-5, quantity, unit_price}] and replaces the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_ffe_plan_line","href":"/api-reference/ff\u0026e-plans/add-an-item-to-a-draft-ff\u0026e-plan-or-change-one-p_years-is-[-]-and-replaces-the…"},{"title":"Set revenue and the FF\u0026E rate for any of a draft plan's six years.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_ffe_plan_years","href":"/api-reference/ff\u0026e-plans/set-revenue-and-the-ff\u0026e-rate-for-any-of-a-draft-plans-six-years"},{"title":"Submit an FF\u0026E plan for approval, or approve it where no approval chain is configured.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_ffe_plan","href":"/api-reference/ff\u0026e-plans/submit-an-ff\u0026e-plan-for-approval-or-approve-it-where-no-approval-chain-is-configured"},{"title":"Take a submitted FF\u0026E plan back to draft so it can be revised and resubmitted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/withdraw_ffe_plan","href":"/api-reference/ff\u0026e-plans/take-a-submitted-ff\u0026e-plan-back-to-draft-so-it-can-be-revised-and-resubmitted"}]},{"group":"Floor plans","pages":[{"title":"Marked areas with the state of what each points at.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /floor_plan_regions","href":"/api-reference/floor-plans/marked-areas-with-the-state-of-what-each-points-at"},{"title":"Remove a floor plan and the regions marked on it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_floor_plan","href":"/api-reference/floor-plans/remove-a-floor-plan-and-the-regions-marked-on-it"},{"title":"Remove one marked area from a floor plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_floor_plan_region","href":"/api-reference/floor-plans/remove-one-marked-area-from-a-floor-plan"},{"title":"Which signals colour a floor plan region urgent, and which merely worth watching.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/floor_plan_settings","href":"/api-reference/floor-plans/which-signals-colour-a-floor-plan-region-urgent-and-which-merely-worth-watching"},{"title":"Create or amend a floor plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_floor_plan","href":"/api-reference/floor-plans/create-or-amend-a-floor-plan"},{"title":"Mark an area on a plan, or move one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_floor_plan_region","href":"/api-reference/floor-plans/mark-an-area-on-a-plan-or-move-one"},{"title":"Decide which signals colour a floor plan region urgent and which watch.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_floor_plan_settings","href":"/api-reference/floor-plans/decide-which-signals-colour-a-floor-plan-region-urgent-and-which-watch"},{"title":"Floor plans with what each is of.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /site_floor_plans","href":"/api-reference/floor-plans/floor-plans-with-what-each-is-of"}]},{"group":"Lost and found","pages":[{"title":"Property handed in, where it is kept, how long it has been there, who took it away and what they proved, and what a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /found_items","href":"/api-reference/lost-and-found/property-handed-in-where-it-is-kept-how-long-it-has-been-there-who-took-it-away-and-what-they-proved-and-what-a…"},{"title":"Found items with every field of the records each row points at: found at, found by, matched report, site, stored at.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /found_items_expanded","href":"/api-reference/lost-and-found/found-items-with-every-field-of-the-records-each-row-points-at:-found-at-found-by-matched-report-site-stored-at"},{"title":"What kind of thing was lost or found, the broader kind it belongs to, how long its kind is held for, whether it is held…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lost_found_categories","href":"/api-reference/lost-and-found/what-kind-of-thing-was-lost-or-found-the-broader-kind-it-belongs-to-how-long-its-kind-is-held-for-whether-it-is-held…"},{"title":"Reports of lost property.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lost_item_reports","href":"/api-reference/lost-and-found/reports-of-lost-property"},{"title":"Lost item reports with every field of the records each row points at: location, owner, reported by, site.","description":"Lost item reports with every field of the records each row points at: location, owner, reported by, site.\n\nChoose this source when one report needs columns from more than one register. Every list, export and dashboard reads the base view instead, which costs none of these joins — and the planner does not remove them when the columns go unnamed, so the two are separate sources on purpose.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lost_item_reports_expanded","href":"/api-reference/lost-and-found/lost-item-reports-with-every-field-of-the-records-each-row-points-at:-location-owner-reported-by-site"},{"title":"Give a lost report to a team, an officer on it, or both, and tell them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assign_lost_report","href":"/api-reference/lost-and-found/give-a-lost-report-to-a-team-an-officer-on-it-or-both-and-tell-them"},{"title":"Close a lost report with a reason.","description":"Close a lost report with a reason. Refused while a found item is matched to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_lost_report","href":"/api-reference/lost-and-found/close-a-lost-report-with-a-reason"},{"title":"Record an investigation's outcome and ask a manager to approve proceeding on it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/conclude_lost_report_investigation","href":"/api-reference/lost-and-found/record-an-investigations-outcome-and-ask-a-manager-to-approve-proceeding-on-it"},{"title":"Approve or turn down a request to dispose of unclaimed property.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decide_found_item_disposal","href":"/api-reference/lost-and-found/approve-or-turn-down-a-request-to-dispose-of-unclaimed-property"},{"title":"Approve or send back an investigation outcome or a closure as never found.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decide_lost_report","href":"/api-reference/lost-and-found/approve-or-send-back-an-investigation-outcome-or-a-closure-as-never-found"},{"title":"Hold a found item because its ownership is disputed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispute_found_item","href":"/api-reference/lost-and-found/hold-a-found-item-because-its-ownership-is-disputed"},{"title":"Open lost reports at the same site, investigated or not, that a found item might answer, best first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/match_candidates_for_found","href":"/api-reference/lost-and-found/open-lost-reports-at-the-same-site-investigated-or-not-that-a-found-item-might-answer-best-first"},{"title":"Found property at the same site that might be what a lost report describes, best first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/match_candidates_for_lost","href":"/api-reference/lost-and-found/found-property-at-the-same-site-that-might-be-what-a-lost-report-describes-best-first"},{"title":"Link a found item to a lost report and tell the owner.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/match_found_item","href":"/api-reference/lost-and-found/link-a-found-item-to-a-lost-report-and-tell-the-owner"},{"title":"Record property being handed over, naming who took it, what they proved and the signature they gave.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/release_found_item","href":"/api-reference/lost-and-found/record-property-being-handed-over-naming-who-took-it-what-they-proved-and-the-signature-they-gave"},{"title":"Ask a manager to approve disposing of unclaimed property.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_found_item_disposal","href":"/api-reference/lost-and-found/ask-a-manager-to-approve-disposing-of-unclaimed-property"},{"title":"Ask a manager to approve closing an investigated lost report as never found.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_lost_report_unrecovered","href":"/api-reference/lost-and-found/ask-a-manager-to-approve-closing-an-investigated-lost-report-as-never-found"},{"title":"Settle a dispute over who owns a found item, so it can be handed over or disposed of.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/settle_found_item_dispute","href":"/api-reference/lost-and-found/settle-a-dispute-over-who-owns-a-found-item-so-it-can-be-handed-over-or-disposed-of"},{"title":"Start investigating a lost report.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/start_lost_report_investigation","href":"/api-reference/lost-and-found/start-investigating-a-lost-report"},{"title":"Put a found item in store.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/store_found_item","href":"/api-reference/lost-and-found/put-a-found-item-in-store"},{"title":"Break the link between a found item and a lost report, saying why.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unmatch_found_item","href":"/api-reference/lost-and-found/break-the-link-between-a-found-item-and-a-lost-report-saying-why"}]},{"group":"Trackers","pages":[{"title":"Areas drawn on the map for a site or one of its locations, as GeoJSON.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /geofences","href":"/api-reference/trackers/areas-drawn-on-the-map-for-a-site-or-one-of-its-locations-as-geojson"},{"title":"Register a GPS tracker by its IMEI, optionally fitted to an asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/register_tracker","href":"/api-reference/trackers/register-a-gps-tracker-by-its-imei-optionally-fitted-to-an-asset"},{"title":"Remove an area.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_geofence","href":"/api-reference/trackers/remove-an-area"},{"title":"Draw an area for a site, or one of its locations, as a GeoJSON Polygon or MultiPolygon.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_geofence","href":"/api-reference/trackers/draw-an-area-for-a-site-or-one-of-its-locations-as-a-geojson-polygon-or-multipolygon"},{"title":"Set how many months of GPS positions this organisation keeps, from 1 to 120.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_tracker_settings","href":"/api-reference/trackers/set-how-many-months-of-gps-positions-this-organisation-keeps-from-1-to-120"},{"title":"The server address and port to enter in a tracker's configuration, for each tracker family this deployment listens for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/tracker_connection","href":"/api-reference/trackers/the-server-address-and-port-to-enter-in-a-trackers-configuration-for-each-tracker-family-this-deployment-listens-for"},{"title":"Every record a tracker sent between two times, newest first, whether or not it had a GPS fix: the device's time and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/tracker_reports","href":"/api-reference/trackers/every-record-a-tracker-sent-between-two-times-newest-first-whether-or-not-it-had-a-gps-fix:-the-devices-time-and…"},{"title":"How many months of GPS positions this organisation keeps, and the time of the oldest one it still holds.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/tracker_settings","href":"/api-reference/trackers/how-many-months-of-gps-positions-this-organisation-keeps-and-the-time-of-the-oldest-one-it-still-holds"},{"title":"Where a tracker was between two times, as points in order, thinned evenly when there are more than the map can usefully…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/tracker_trail","href":"/api-reference/trackers/where-a-tracker-was-between-two-times-as-points-in-order-thinned-evenly-when-there-are-more-than-the-map-can-usefully…"},{"title":"A tracker's journeys between two times: each run of movement, split wherever it stood still for longer than the stop…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/tracker_trips","href":"/api-reference/trackers/a-trackers-journeys-between-two-times:-each-run-of-movement-split-wherever-it-stood-still-for-longer-than-the-stop…"},{"title":"GPS trackers, the asset each is fitted to, where it last was and whether it is still calling.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /trackers","href":"/api-reference/trackers/gps-trackers-the-asset-each-is-fitted-to-where-it-last-was-and-whether-it-is-still-calling"}]},{"group":"Single sign-on","pages":[{"title":"This organisation's identity providers, with certificate and mapping counts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /identity_providers","href":"/api-reference/single-sign-on/this-organisations-identity-providers-with-certificate-and-mapping-counts"},{"title":"The certificates each provider is trusted through — signing certificates on SAML, TLS authorities on LDAP.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /provider_certificates","href":"/api-reference/single-sign-on/the-certificates-each-provider-is-trusted-through-—-signing-certificates-on-saml-tls-authorities-on-ldap"},{"title":"Which IdP group grants which role.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /provider_role_mappings","href":"/api-reference/single-sign-on/which-idp-group-grants-which-role"},{"title":"Add or reactivate a signing certificate.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_provider_certificate","href":"/api-reference/single-sign-on/add-or-reactivate-a-signing-certificate"},{"title":"Whether this caller may search a directory connection for people and add them as users.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/authorize_directory_add","href":"/api-reference/single-sign-on/whether-this-caller-may-search-a-directory-connection-for-people-and-add-them-as-users"},{"title":"Whether this caller may have the sign-in service read identity provider metadata from a URL.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/authorize_metadata_read","href":"/api-reference/single-sign-on/whether-this-caller-may-have-the-sign-in-service-read-identity-provider-metadata-from-a-url"},{"title":"Whether this caller may have the broker try a connection.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/authorize_provider_test","href":"/api-reference/single-sign-on/whether-this-caller-may-have-the-broker-try-a-connection"},{"title":"Delete a provider and everything hanging off it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_identity_provider","href":"/api-reference/single-sign-on/delete-a-provider-and-everything-hanging-off-it"},{"title":"Remove a group mapping.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_provider_role_mapping","href":"/api-reference/single-sign-on/remove-a-group-mapping"},{"title":"Switch a certificate off, or delete it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/retire_provider_certificate","href":"/api-reference/single-sign-on/switch-a-certificate-off-or-delete-it"},{"title":"Create or update an identity provider.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_identity_provider","href":"/api-reference/single-sign-on/create-or-update-an-identity-provider"},{"title":"Map one IdP group to one role.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_provider_role_mapping","href":"/api-reference/single-sign-on/map-one-idp-group-to-one-role"},{"title":"Switch Windows sign-in on or off for an LDAP connection and store its keytab.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_windows_sign_in","href":"/api-reference/single-sign-on/switch-windows-sign-in-on-or-off-for-an-ldap-connection-and-store-its-keytab"},{"title":"How an address's domain signs in — password, providers, or both.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/sign_in_methods","href":"/api-reference/single-sign-on/how-an-addresss-domain-signs-in-—-password-providers-or-both"},{"title":"Where the sign-in screen at this host name should send a browser to sign in with Windows, or null where Windows sign-in…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/windows_sign_in","href":"/api-reference/single-sign-on/where-the-sign-in-screen-at-this-host-name-should-send-a-browser-to-sign-in-with-windows-or-null-where-windows-sign-in…"}]},{"group":"Import","pages":[{"title":"The staged rows of one import: what the file said, what was corrected, and the verdict on each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /import_rows","href":"/api-reference/import/the-staged-rows-of-one-import:-what-the-file-said-what-was-corrected-and-the-verdict-on-each"},{"title":"Add to import rows: The staged rows of one import: what the file said, what was corrected, and the verdict on each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /import_rows","href":"/api-reference/import/add-to-import-rows:-the-staged-rows-of-one-import:-what-the-file-said-what-was-corrected-and-the-verdict-on-each"},{"title":"Remove rows from import rows: The staged rows of one import: what the file said, what was corrected, and the verdict on each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /import_rows","href":"/api-reference/import/remove-rows-from-import-rows:-the-staged-rows-of-one-import:-what-the-file-said-what-was-corrected-and-the-verdict-on-each"},{"title":"Change rows in import rows: The staged rows of one import: what the file said, what was corrected, and the verdict on each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /import_rows","href":"/api-reference/import/change-rows-in-import-rows:-the-staged-rows-of-one-import:-what-the-file-said-what-was-corrected-and-the-verdict-on-each"},{"title":"One mapped column: where its value comes from, how the text becomes a value, and what happens when a name matches…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /import_template_fields","href":"/api-reference/import/one-mapped-column:-where-its-value-comes-from-how-the-text-becomes-a-value-and-what-happens-when-a-name-matches…"},{"title":"Saved column mappings, so the second file from a customer arrives already mapped.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /import_templates","href":"/api-reference/import/saved-column-mappings-so-the-second-file-from-a-customer-arrives-already-mapped"},{"title":"Add to import templates: Saved column mappings, so the second file from a customer arrives already mapped.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /import_templates","href":"/api-reference/import/add-to-import-templates:-saved-column-mappings-so-the-second-file-from-a-customer-arrives-already-mapped"},{"title":"Remove rows from import templates: Saved column mappings, so the second file from a customer arrives already mapped.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /import_templates","href":"/api-reference/import/remove-rows-from-import-templates:-saved-column-mappings-so-the-second-file-from-a-customer-arrives-already-mapped"},{"title":"Change rows in import templates: Saved column mappings, so the second file from a customer arrives already mapped.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /import_templates","href":"/api-reference/import/change-rows-in-import-templates:-saved-column-mappings-so-the-second-file-from-a-customer-arrives-already-mapped"},{"title":"Every import this organisation has run, with its counts and whether it can still be undone.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /imports","href":"/api-reference/import/every-import-this-organisation-has-run-with-its-counts-and-whether-it-can-still-be-undone"},{"title":"Add a sheet of the same workbook to an import, placed by its tab name or by the caller.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_import_sheet","href":"/api-reference/import/add-a-sheet-of-the-same-workbook-to-an-import-placed-by-its-tab-name-or-by-the-caller"},{"title":"Correct cells of a staged row before the import is committed: `p_row_id` is the row's id from `import_rows`, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/amend_import_row","href":"/api-reference/import/correct-cells-of-a-staged-row-before-the-import-is-committed:-`p_row_id`-is-the-rows-id-from-`import_rows`-and…"},{"title":"Map this file the way a saved mapping says, copying it so later edits stay local to this file.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/apply_import_template","href":"/api-reference/import/map-this-file-the-way-a-saved-mapping-says-copying-it-so-later-edits-stay-local-to-this-file"},{"title":"Run the statuses a committed file stated, through the entity's own transition function .","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/apply_import_transitions","href":"/api-reference/import/run-the-statuses-a-committed-file-stated-through-the-entitys-own-transition-function-"},{"title":"Attach an uploaded file to an import and queue the parse.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/attach_import_file","href":"/api-reference/import/attach-an-uploaded-file-to-an-import-and-queue-the-parse"},{"title":"Write a validated import into the records, inline when it is small and through the worker when it is not.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/commit_import","href":"/api-reference/import/write-a-validated-import-into-the-records-inline-when-it-is-small-and-through-the-worker-when-it-is-not"},{"title":"Write a whole workbook into the records, sheet by sheet in the model's dependency order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/commit_import_bundle","href":"/api-reference/import/write-a-whole-workbook-into-the-records-sheet-by-sheet-in-the-models-dependency-order"},{"title":"Apply one chunk of a validated import, as the person who asked for it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/commit_import_chunk","href":"/api-reference/import/apply-one-chunk-of-a-validated-import-as-the-person-who-asked-for-it"},{"title":"Answer one value an import names and the tenant does not have, as `import_unresolved` lists them: `p_decision` is MAP…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decide_import_lookup","href":"/api-reference/import/answer-one-value-an-import-names-and-the-tenant-does-not-have-as-`import_unresolved`-lists-them:-`p_decision`-is-map…"},{"title":"Stop offering a saved mapping.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/forget_import_template","href":"/api-reference/import/stop-offering-a-saved-mapping"},{"title":"What each source column appears to contain, and which field it probably means.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_columns","href":"/api-reference/import/what-each-source-column-appears-to-contain-and-which-field-it-probably-means"},{"title":"The tenant's own fields a file may be mapped into, with a reason against the ones it may not, and a DROPDOWN/RADIO…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_custom_fields","href":"/api-reference/import/the-tenants-own-fields-a-file-may-be-mapped-into-with-a-reason-against-the-ones-it-may-not-and-a-dropdownradio…"},{"title":"The files added beside an import's spreadsheet, and the file names its cells give that nothing has been added under yet.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_files","href":"/api-reference/import/the-files-added-beside-an-imports-spreadsheet-and-the-file-names-its-cells-give-that-nothing-has-been-added-under-yet"},{"title":"The columns a record of this entity is unique on, in the model's own field order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_natural_keys","href":"/api-reference/import/the-columns-a-record-of-this-entity-is-unique-on-in-the-models-own-field-order"},{"title":"What is wrong with an import, one line per reason, with the first few row numbers.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_problems","href":"/api-reference/import/what-is-wrong-with-an-import-one-line-per-reason-with-the-first-few-row-numbers"},{"title":"A workbook's sheets in commit order, with what each one will do.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_sheets","href":"/api-reference/import/a-workbooks-sheets-in-commit-order-with-what-each-one-will-do"},{"title":"The saved mappings that fit this file, scored by how many of its headers they know.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_template_matches","href":"/api-reference/import/the-saved-mappings-that-fit-this-file-scored-by-how-many-of-its-headers-they-know"},{"title":"Whether a requested starter template has been written yet.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_template_status","href":"/api-reference/import/whether-a-requested-starter-template-has-been-written-yet"},{"title":"What the Status column of a committed batch would do: one line per distinct value, how many rows state it, and whether…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_transitions","href":"/api-reference/import/what-the-status-column-of-a-committed-batch-would-do:-one-line-per-distinct-value-how-many-rows-state-it-and-whether…"},{"title":"The distinct values an import names and this tenant does not have, with what each nearly matched.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_unresolved","href":"/api-reference/import/the-distinct-values-an-import-names-and-this-tenant-does-not-have-with-what-each-nearly-matched"},{"title":"The mapping targets an entity's import writer accepts that are not columns of it — a role, a site, a job title.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/import_writer_fields","href":"/api-reference/import/the-mapping-targets-an-entitys-import-writer-accepts-that-are-not-columns-of-it-—-a-role-a-site-a-job-title"},{"title":"Send first invitations to the accounts a staff import created, in waves.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/invite_imported_users","href":"/api-reference/import/send-first-invitations-to-the-accounts-a-staff-import-created-in-waves"},{"title":"Settle which list the first tab of a dropped workbook holds, replacing the placeholder it opened with.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/place_import_head","href":"/api-reference/import/settle-which-list-the-first-tab-of-a-dropped-workbook-holds-replacing-the-placeholder-it-opened-with"},{"title":"Take a file back out of an import before it is written, and withdraw the verdict that named it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_import_file","href":"/api-reference/import/take-a-file-back-out-of-an-import-before-it-is-written-and-withdraw-the-verdict-that-named-it"},{"title":"Queue a blank spreadsheet for an entity: its columns, what each wants, and what already exists.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_import_template","href":"/api-reference/import/queue-a-blank-spreadsheet-for-an-entity:-its-columns-what-each-wants-and-what-already-exists"},{"title":"Queue the read of an import's file again, when it failed or is taking too long.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/retry_import_parse","href":"/api-reference/import/queue-the-read-of-an-imports-file-again-when-it-failed-or-is-taking-too-long"},{"title":"Undo a committed import and report what it left behind.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revert_import","href":"/api-reference/import/undo-a-committed-import-and-report-what-it-left-behind"},{"title":"Undo a whole workbook, deepest sheet first — the assets go before the sites they point at.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revert_import_bundle","href":"/api-reference/import/undo-a-whole-workbook-deepest-sheet-first-—-the-assets-go-before-the-sites-they-point-at"},{"title":"Keep this batch's mapping for the next file that looks like it, with the review's answers.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_import_template","href":"/api-reference/import/keep-this-batchs-mapping-for-the-next-file-that-looks-like-it-with-the-reviews-answers"},{"title":"Bind the file's columns to the record's fields, say which one identifies a record, and say what happens to a row that…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_import_mapping","href":"/api-reference/import/bind-the-files-columns-to-the-records-fields-say-which-one-identifies-a-record-and-say-what-happens-to-a-row-that…"},{"title":"Leave a staged row out of the import, or put it back, before the import is committed: `p_row_id` is the row's id from…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_import_row_left_out","href":"/api-reference/import/leave-a-staged-row-out-of-the-import-or-put-it-back-before-the-import-is-committed:-`p_row_id`-is-the-rows-id-from…"},{"title":"Open a workbook import from rows sent as data and check it without writing anything to the records.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/stage_import_workbook","href":"/api-reference/import/open-a-workbook-import-from-rows-sent-as-data-and-check-it-without-writing-anything-to-the-records"},{"title":"Open an import against an entity and return the batch to attach a file to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/start_import","href":"/api-reference/import/open-an-import-against-an-entity-and-return-the-batch-to-attach-a-file-to"},{"title":"Open an import for a workbook whose tabs decide what it imports, and return the batch to attach the file to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/start_workbook_import","href":"/api-reference/import/open-an-import-for-a-workbook-whose-tabs-decide-what-it-imports-and-return-the-batch-to-attach-the-file-to"},{"title":"Judge every row of an import and store what was decided about each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/validate_import","href":"/api-reference/import/judge-every-row-of-an-import-and-store-what-was-decided-about-each"},{"title":"Judge every sheet of a workbook, shallowest first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/validate_import_bundle","href":"/api-reference/import/judge-every-sheet-of-a-workbook-shallowest-first"}]},{"group":"Inbound mail","pages":[{"title":"Every message that arrived, what it became, and what to do about the ones that became nothing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inbound_mail","href":"/api-reference/inbound-mail/every-message-that-arrived-what-it-became-and-what-to-do-about-the-ones-that-became-nothing"},{"title":"Who has written in this week, and which addresses were refused for sending too much or for being a machine.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inbound_senders","href":"/api-reference/inbound-mail/who-has-written-in-this-week-and-which-addresses-were-refused-for-sending-too-much-or-for-being-a-machine"}]},{"group":"Telegram","pages":[{"title":"Every Telegram message that arrived, what it became, and what to do about the ones that became nothing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inbound_telegram","href":"/api-reference/telegram/every-telegram-message-that-arrived-what-it-became-and-what-to-do-about-the-ones-that-became-nothing"},{"title":"Each file a Telegram message arrived with, whether it reached the request, and why not.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inbound_telegram_attachments","href":"/api-reference/telegram/each-file-a-telegram-message-arrived-with-whether-it-reached-the-request-and-why-not"},{"title":"Add to inbound telegram attachments: Each file a Telegram message arrived with, whether it reached the request, and why not.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /inbound_telegram_attachments","href":"/api-reference/telegram/add-to-inbound-telegram-attachments:-each-file-a-telegram-message-arrived-with-whether-it-reached-the-request-and-why-not"},{"title":"Remove rows from inbound telegram attachments: Each file a Telegram message arrived with, whether it reached the request, and why not.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /inbound_telegram_attachments","href":"/api-reference/telegram/remove-rows-from-inbound-telegram-attachments:-each-file-a-telegram-message-arrived-with-whether-it-reached-the-request-and-why-not"},{"title":"Change rows in inbound telegram attachments: Each file a Telegram message arrived with, whether it reached the request, and why not.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /inbound_telegram_attachments","href":"/api-reference/telegram/change-rows-in-inbound-telegram-attachments:-each-file-a-telegram-message-arrived-with-whether-it-reached-the-request-and-why-not"},{"title":"A single-use t.me link that connects the calling user's Telegram.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_my_telegram_link","href":"/api-reference/telegram/a-single-use-tme-link-that-connects-the-calling-users-telegram"},{"title":"Fetch a file that failed to arrive from Telegram again, with a fresh count of attempts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/retry_telegram_attachment","href":"/api-reference/telegram/fetch-a-file-that-failed-to-arrive-from-telegram-again-with-a-fresh-count-of-attempts"}]},{"group":"Whatsapp","pages":[{"title":"Every WhatsApp message that arrived, what it became, and whether the sender was answered.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inbound_whatsapp","href":"/api-reference/whatsapp/every-whatsapp-message-that-arrived-what-it-became-and-whether-the-sender-was-answered"},{"title":"Save this organisation's Meta app secret, which authenticates what its WhatsApp webhook receives.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_whatsapp_app_secret","href":"/api-reference/whatsapp/save-this-organisations-meta-app-secret-which-authenticates-what-its-whatsapp-webhook-receives"}]},{"group":"Inspections","pages":[{"title":"Failed checks — from an inspection item or a work order task — with the corrective work order each one raised.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inspection_failures","href":"/api-reference/inspections/failed-checks-—-from-an-inspection-item-or-a-work-order-task-—-with-the-corrective-work-order-each-one-raised"},{"title":"The questions an inspection asks, with the answers recorded so far.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inspection_items","href":"/api-reference/inspections/the-questions-an-inspection-asks-with-the-answers-recorded-so-far"},{"title":"Every drawing and document an inspection checklist points at, one row per attachment, so a handset can fetch them all…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inspection_reference_files","href":"/api-reference/inspections/every-drawing-and-document-an-inspection-checklist-points-at-one-row-per-attachment-so-a-handset-can-fetch-them-all…"},{"title":"Every version of every template, with what it asks and what has been answered against it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inspection_template_versions","href":"/api-reference/inspections/every-version-of-every-template-with-what-it-asks-and-what-has-been-answered-against-it"},{"title":"Inspections with derived outcome, progress and overdue state.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inspections","href":"/api-reference/inspections/inspections-with-derived-outcome-progress-and-overdue-state"},{"title":"Answer one item: a reading, a choice, a pass, a fail — or, on a yes/no/NA question, that it does not apply, which is…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/answer_inspection_item","href":"/api-reference/inspections/answer-one-item:-a-reading-a-choice-a-pass-a-fail-—-or-on-a-yesnona-question-that-it-does-not-apply-which-is…"},{"title":"Answer many items in one request — what a column pasted into the checklist grid sends.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/answer_inspection_items","href":"/api-reference/inspections/answer-many-items-in-one-request-—-what-a-column-pasted-into-the-checklist-grid-sends"},{"title":"Start an inspection from a template version, against an asset, a place, or a job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_inspection","href":"/api-reference/inspections/start-an-inspection-from-a-template-version-against-an-asset-a-place-or-a-job"},{"title":"Throw away a draft and its questions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/discard_inspection_draft","href":"/api-reference/inspections/throw-away-a-draft-and-its-questions"},{"title":"Start a new draft of a template, copying every question from the version in force.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/draft_inspection_version","href":"/api-reference/inspections/start-a-new-draft-of-a-template-copying-every-question-from-the-version-in-force"},{"title":"Take a draft of the template this question is on, and answer with the draft's copy of it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/draft_inspection_version_for_item","href":"/api-reference/inspections/take-a-draft-of-the-template-this-question-is-on-and-answer-with-the-drafts-copy-of-it"},{"title":"Put a draft into force, and retire the version it replaces.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_inspection_version","href":"/api-reference/inspections/put-a-draft-into-force-and-retire-the-version-it-replaces"},{"title":"Raise the work a failed item calls for, linked back to the failure.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/raise_corrective_work_order","href":"/api-reference/inspections/raise-the-work-a-failed-item-calls-for-linked-back-to-the-failure"},{"title":"Set the order of a draft's questions from a list of ids.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reorder_inspection_items","href":"/api-reference/inspections/set-the-order-of-a-drafts-questions-from-a-list-of-ids"},{"title":"Approve or reject a submitted inspection.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/review_inspection","href":"/api-reference/inspections/approve-or-reject-a-submitted-inspection"},{"title":"Say which asset categories and which sites an inspection template is offered for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_inspection_template_scope","href":"/api-reference/inspections/say-which-asset-categories-and-which-sites-an-inspection-template-is-offered-for"},{"title":"Submit a completed inspection.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_inspection","href":"/api-reference/inspections/submit-a-completed-inspection"},{"title":"Accept a failure without corrective work, with the reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/waive_inspection_failure","href":"/api-reference/inspections/accept-a-failure-without-corrective-work-with-the-reason"}]},{"group":"Inspection configuration","pages":[{"title":"The questions a template version asks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inspection_item_settings","href":"/api-reference/inspection-configuration/the-questions-a-template-version-asks"},{"title":"Inspection templates with their published version and what it asks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inspection_template_settings","href":"/api-reference/inspection-configuration/inspection-templates-with-their-published-version-and-what-it-asks"},{"title":"Inspection types. is_regulatory marks the ones a regulator asks to see, which is the whole of what a type decides…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inspection_type_settings","href":"/api-reference/inspection-configuration/inspection-types-is_regulatory-marks-the-ones-a-regulator-asks-to-see-which-is-the-whole-of-what-a-type-decides…"},{"title":"Add to inspection type settings: Inspection types. is_regulatory marks the ones a regulator asks to see, which is the whole of what a type decides…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /inspection_type_settings","href":"/api-reference/inspection-configuration/add-to-inspection-type-settings:-inspection-types-is_regulatory-marks-the-ones-a-regulator-asks-to-see-which-is-the-whole-of-what-a-type-decides…"},{"title":"Remove rows from inspection type settings: Inspection types. is_regulatory marks the ones a regulator asks to see, which is the whole of what a type decides…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /inspection_type_settings","href":"/api-reference/inspection-configuration/remove-rows-from-inspection-type-settings:-inspection-types-is_regulatory-marks-the-ones-a-regulator-asks-to-see-which-is-the-whole-of-what-a-type-decides…"},{"title":"Change rows in inspection type settings: Inspection types. is_regulatory marks the ones a regulator asks to see, which is the whole of what a type decides…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /inspection_type_settings","href":"/api-reference/inspection-configuration/change-rows-in-inspection-type-settings:-inspection-types-is_regulatory-marks-the-ones-a-regulator-asks-to-see-which-is-the-whole-of-what-a-type-decides…"}]},{"group":"Inventory","pages":[{"title":"Stock with reorder context. available_quantity is generated from the ledger, not stored.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inventory_available","href":"/api-reference/inventory/stock-with-reorder-context-available_quantity-is-generated-from-the-ledger-not-stored"},{"title":"Inventory available with every field of the records each row points at: location, part, warehouse.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inventory_available_expanded","href":"/api-reference/inventory/inventory-available-with-every-field-of-the-records-each-row-points-at:-location-part-warehouse"},{"title":"Correct a balance.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/adjust_stock","href":"/api-reference/inventory/correct-a-balance"},{"title":"Book a part out to a job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/consume_part","href":"/api-reference/inventory/book-a-part-out-to-a-job"},{"title":"Record a physical count.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/count_stock","href":"/api-reference/inventory/record-a-physical-count"},{"title":"Reject a reorder suggestion, with the reason it was not needed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dismiss_purchase_recommendation","href":"/api-reference/inventory/reject-a-reorder-suggestion-with-the-reason-it-was-not-needed"},{"title":"Hand stock to a person, a project, a department, a cost centre or an asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/issue_stock","href":"/api-reference/inventory/hand-stock-to-a-person-a-project-a-department-a-cost-centre-or-an-asset"},{"title":"Record that a reorder suggestion has been acted on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/mark_recommendation_ordered","href":"/api-reference/inventory/record-that-a-reorder-suggestion-has-been-acted-on"},{"title":"Take a delivery into stock, or record what was already on the shelf.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/receive_stock","href":"/api-reference/inventory/take-a-delivery-into-stock-or-record-what-was-already-on-the-shelf"},{"title":"Recompute the caller's tenant's reorder recommendations, if anything has moved since the last sweep.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/refresh_reorder_recommendations","href":"/api-reference/inventory/recompute-the-callers-tenants-reorder-recommendations-if-anything-has-moved-since-the-last-sweep"},{"title":"Hold stock for a job without consuming it yet.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reserve_part","href":"/api-reference/inventory/hold-stock-for-a-job-without-consuming-it-yet"},{"title":"Which warehouse a part should come from for this job, when the caller has not said.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resolve_warehouse","href":"/api-reference/inventory/which-warehouse-a-part-should-come-from-for-this-job-when-the-caller-has-not-said"},{"title":"Take back stock that was issued, against the issue it came from.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/return_issued_stock","href":"/api-reference/inventory/take-back-stock-that-was-issued-against-the-issue-it-came-from"},{"title":"Return unused stock from a job, to the store it came from.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/return_part","href":"/api-reference/inventory/return-unused-stock-from-a-job-to-the-store-it-came-from"},{"title":"Move stock between stores as two ledger rows in one transaction, carrying its value with it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/transfer_stock","href":"/api-reference/inventory/move-stock-between-stores-as-two-ledger-rows-in-one-transaction-carrying-its-value-with-it"},{"title":"Record that stock still out on an issue will not come back, because it was used up.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/use_up_issued_stock","href":"/api-reference/inventory/record-that-stock-still-out-on-an-issue-will-not-come-back-because-it-was-used-up"},{"title":"The stores that could supply this quantity of a part to a job, best first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/warehouse_options","href":"/api-reference/inventory/the-stores-that-could-supply-this-quantity-of-a-part-to-a-job-best-first"}]},{"group":"Inventory detail","pages":[{"title":"The stock ledger.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /inventory_transactions","href":"/api-reference/inventory-detail/the-stock-ledger"},{"title":"What else will do: alternatives and approved substitutes, with what is on the shelf of each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /part_relationships","href":"/api-reference/inventory-detail/what-else-will-do:-alternatives-and-approved-substitutes-with-what-is-on-the-shelf-of-each"},{"title":"Who sells a part, at what price, with what lead time and minimum order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /part_suppliers","href":"/api-reference/inventory-detail/who-sells-a-part-at-what-price-with-what-lead-time-and-minimum-order"},{"title":"What to buy, how much, by when, and the itemised reasoning behind it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_recommendations","href":"/api-reference/inventory-detail/what-to-buy-how-much-by-when-and-the-itemised-reasoning-behind-it"},{"title":"Stock handed to a person, a project, a department, a cost centre, an asset or a kit, with how much of each issue is…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /stock_issues","href":"/api-reference/inventory-detail/stock-handed-to-a-person-a-project-a-department-a-cost-centre-an-asset-or-a-kit-with-how-much-of-each-issue-is…"}]},{"group":"Procurement","pages":[{"title":"What was paid against a supplier invoice of either kind, when, and why it fell short .","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /invoice_payments","href":"/api-reference/procurement/what-was-paid-against-a-supplier-invoice-of-either-kind-when-and-why-it-fell-short-"},{"title":"Outstanding order lines, one per line, for chasing a supplier about a specific part.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /open_purchase_orders","href":"/api-reference/procurement/outstanding-order-lines-one-per-line-for-chasing-a-supplier-about-a-specific-part"},{"title":"Every status change on every procurement document, with time spent in the previous state.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /procurement_status_history","href":"/api-reference/procurement/every-status-change-on-every-procurement-document-with-time-spent-in-the-previous-state"},{"title":"What a supplier says is in the lorry against one ordered line.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_order_dispatch_items","href":"/api-reference/procurement/what-a-supplier-says-is-in-the-lorry-against-one-ordered-line"},{"title":"What a supplier says has left an order, and whether anything has been booked in against it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_order_dispatches","href":"/api-reference/procurement/what-a-supplier-says-has-left-an-order-and-whether-anything-has-been-booked-in-against-it"},{"title":"Ordered lines with the four quantities: ordered, received, invoiced, cancelled.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_order_items","href":"/api-reference/procurement/ordered-lines-with-the-four-quantities:-ordered-received-invoiced-cancelled"},{"title":"The receiving screen's unfinished work against an order, as it was last saved.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_order_receipt_drafts","href":"/api-reference/procurement/the-receiving-screens-unfinished-work-against-an-order-as-it-was-last-saved"},{"title":"Received lines, each carrying the inventory transaction a part line posted or the assets an asset line put in the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_order_receipt_items","href":"/api-reference/procurement/received-lines-each-carrying-the-inventory-transaction-a-part-line-posted-or-the-assets-an-asset-line-put-in-the…"},{"title":"Deliveries queued to be booked in the background, and what became of each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_order_receipt_jobs","href":"/api-reference/procurement/deliveries-queued-to-be-booked-in-the-background-and-what-became-of-each"},{"title":"Deliveries booked against an order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_order_receipts","href":"/api-reference/procurement/deliveries-booked-against-an-order"},{"title":"Purchase orders with totals, receipt and invoice progress, and whether delivery is overdue.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_orders","href":"/api-reference/procurement/purchase-orders-with-totals-receipt-and-invoice-progress-and-whether-delivery-is-overdue"},{"title":"Purchase orders with every field of the records each row points at: contract, cost centre, requisition, site, vendor…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_orders_expanded","href":"/api-reference/procurement/purchase-orders-with-every-field-of-the-records-each-row-points-at:-contract-cost-centre-requisition-site-vendor…"},{"title":"Requested lines, with the part's current availability beside what was asked for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_requisition_items","href":"/api-reference/procurement/requested-lines-with-the-parts-current-availability-beside-what-was-asked-for"},{"title":"Requisitions with resolved status, origin, traceability and what they are waiting on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_requisitions","href":"/api-reference/procurement/requisitions-with-resolved-status-origin-traceability-and-what-they-are-waiting-on"},{"title":"Purchase requisitions with every field of the records each row points at: asset, cost centre, department, maintenance…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /purchase_requisitions_expanded","href":"/api-reference/procurement/purchase-requisitions-with-every-field-of-the-records-each-row-points-at:-asset-cost-centre-department-maintenance…"},{"title":"One request's lines and how each of them is being answered — ordered, taken from stock, given a spare, still to find…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /requisition_sourcing","href":"/api-reference/procurement/one-requests-lines-and-how-each-of-them-is-being-answered-—-ordered-taken-from-stock-given-a-spare-still-to-find…"},{"title":"The spare assets currently promised to each requested line.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /requisition_spares","href":"/api-reference/procurement/the-spare-assets-currently-promised-to-each-requested-line"},{"title":"The kinds of purchase request a tenant offers, the kinds of line each may carry and the roles each is offered to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /requisition_type_settings","href":"/api-reference/procurement/the-kinds-of-purchase-request-a-tenant-offers-the-kinds-of-line-each-may-carry-and-the-roles-each-is-offered-to"},{"title":"Add to requisition type settings: The kinds of purchase request a tenant offers, the kinds of line each may carry and the roles each is offered to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /requisition_type_settings","href":"/api-reference/procurement/add-to-requisition-type-settings:-the-kinds-of-purchase-request-a-tenant-offers-the-kinds-of-line-each-may-carry-and-the-roles-each-is-offered-to"},{"title":"Remove rows from requisition type settings: The kinds of purchase request a tenant offers, the kinds of line each may carry and the roles each is offered to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /requisition_type_settings","href":"/api-reference/procurement/remove-rows-from-requisition-type-settings:-the-kinds-of-purchase-request-a-tenant-offers-the-kinds-of-line-each-may-carry-and-the-roles-each-is-offered-to"},{"title":"Change rows in requisition type settings: The kinds of purchase request a tenant offers, the kinds of line each may carry and the roles each is offered to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /requisition_type_settings","href":"/api-reference/procurement/change-rows-in-requisition-type-settings:-the-kinds-of-purchase-request-a-tenant-offers-the-kinds-of-line-each-may-carry-and-the-roles-each-is-offered-to"},{"title":"The basket every invited vendor quotes against.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rfq_items","href":"/api-reference/procurement/the-basket-every-invited-vendor-quotes-against"},{"title":"Vendors and quotes side by side, including the invited who never replied.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rfq_quote_comparison","href":"/api-reference/procurement/vendors-and-quotes-side-by-side-including-the-invited-who-never-replied"},{"title":"RFQs with invitation and response counts, and whether the response window has passed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rfqs","href":"/api-reference/procurement/rfqs-with-invitation-and-response-counts-and-whether-the-response-window-has-passed"},{"title":"Record the vendor's acknowledgement, their reference and the date they promised.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/acknowledge_purchase_order","href":"/api-reference/procurement/record-the-vendors-acknowledgement-their-reference-and-the-date-they-promised"},{"title":"Add lines to a draft order — typed, or pulled from an approved request at a quantity of their own.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_purchase_order_lines","href":"/api-reference/procurement/add-lines-to-a-draft-order-—-typed-or-pulled-from-an-approved-request-at-a-quantity-of-their-own"},{"title":"Give particular spare assets to a requested line, and move them to the site and custodian the request names.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/allocate_requisition_assets","href":"/api-reference/procurement/give-particular-spare-assets-to-a-requested-line-and-move-them-to-the-site-and-custodian-the-request-names"},{"title":"Approve an invoice for payment, variance and all.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/approve_supplier_invoice","href":"/api-reference/procurement/approve-an-invoice-for-payment-variance-and-all"},{"title":"Answer part of a requested line from stock, reserving it or issuing it, and say which store it came from.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assign_requisition_stock","href":"/api-reference/procurement/answer-part-of-a-requested-line-from-stock-reserving-it-or-issuing-it-and-say-which-store-it-came-from"},{"title":"Cancel an order, with the reason, before it is fulfilled.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_purchase_order","href":"/api-reference/procurement/cancel-an-order-with-the-reason-before-it-is-fulfilled"},{"title":"Withdraw a requisition before it has been sourced, with the reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_requisition","href":"/api-reference/procurement/withdraw-a-requisition-before-it-has-been-sourced-with-the-reason"},{"title":"Everything booking this delivery would refuse, without booking it: the same arguments as receive_purchase_order, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/check_purchase_order_receipt","href":"/api-reference/procurement/everything-booking-this-delivery-would-refuse-without-booking-it:-the-same-arguments-as-receive_purchase_order-and…"},{"title":"Close an order that is finished with, whether or not everything arrived.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/close_purchase_order","href":"/api-reference/procurement/close-an-order-that-is-finished-with-whether-or-not-everything-arrived"},{"title":"Give up on whatever is still outstanding on an approved request, recording why, and settle it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/close_requisition_short","href":"/api-reference/procurement/give-up-on-whatever-is-still-outstanding-on-an-approved-request-recording-why-and-settle-it"},{"title":"Raise a purchase order from a selected quote, from approved requests, or from lines the buyer types.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_purchase_order","href":"/api-reference/procurement/raise-a-purchase-order-from-a-selected-quote-from-approved-requests-or-from-lines-the-buyer-types"},{"title":"Raise a requisition with its lines, optionally from a reorder recommendation, from the catalogue, or on behalf of…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_purchase_request","href":"/api-reference/procurement/raise-a-requisition-with-its-lines-optionally-from-a-reorder-recommendation-from-the-catalogue-or-on-behalf-of…"},{"title":"Raise an RFQ over a requisition's lines and invite vendors to quote.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_rfq","href":"/api-reference/procurement/raise-an-rfq-over-a-requisitions-lines-and-invite-vendors-to-quote"},{"title":"Accept or reject what a supplier says is owed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decide_supplier_invoice_submission","href":"/api-reference/procurement/accept-or-reject-what-a-supplier-says-is-owed"},{"title":"Record that a vendor will not quote, and why.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decline_quote","href":"/api-reference/procurement/record-that-a-vendor-will-not-quote-and-why"},{"title":"Throw away the receiving form's unfinished work against an order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/discard_purchase_order_receipt_draft","href":"/api-reference/procurement/throw-away-the-receiving-forms-unfinished-work-against-an-order"},{"title":"Advise that goods have left an order, with the delivery note, carrier and waybill that will arrive with them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispatch_purchase_order","href":"/api-reference/procurement/advise-that-goods-have-left-an-order-with-the-delivery-note-carrier-and-waybill-that-will-arrive-with-them"},{"title":"Hold an invoice, with the reason it is disputed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispute_supplier_invoice","href":"/api-reference/procurement/hold-an-invoice-with-the-reason-it-is-disputed"},{"title":"Issue an approved order to the vendor.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/issue_purchase_order","href":"/api-reference/procurement/issue-an-approved-order-to-the-vendor"},{"title":"Send a request for quotation to the vendors on it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/issue_rfq","href":"/api-reference/procurement/send-a-request-for-quotation-to-the-vendors-on-it"},{"title":"Match an invoice against the order and the receipts, and say where it disagrees.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/match_supplier_invoice","href":"/api-reference/procurement/match-an-invoice-against-the-order-and-the-receipts-and-say-where-it-disagrees"},{"title":"Book a delivery in the background: the same arguments as receive_purchase_order, booked by the worker as the caller…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/queue_purchase_order_receipt","href":"/api-reference/procurement/book-a-delivery-in-the-background:-the-same-arguments-as-receive_purchase_order-booked-by-the-worker-as-the-caller…"},{"title":"Book a delivery in against an order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/receive_purchase_order","href":"/api-reference/procurement/book-a-delivery-in-against-an-order"},{"title":"The tenant's own asset fields, as columns of the receiving grid: key, name, type, whether required, why one cannot be…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/receiving_custom_fields","href":"/api-reference/procurement/the-tenants-own-asset-fields-as-columns-of-the-receiving-grid:-key-name-type-whether-required-why-one-cannot-be…"},{"title":"Record that a supplier invoice was paid, in whole or in part.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_invoice_payment","href":"/api-reference/procurement/record-that-a-supplier-invoice-was-paid-in-whole-or-in-part"},{"title":"Record a vendor's response to an RFQ and rescore the field against it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_quote","href":"/api-reference/procurement/record-a-vendors-response-to-an-rfq-and-rescore-the-field-against-it"},{"title":"Record a supplier invoice against an order and run the three-way match on the way in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_supplier_invoice","href":"/api-reference/procurement/record-a-supplier-invoice-against-an-order-and-run-the-three-way-match-on-the-way-in"},{"title":"Return a spare to the pool, leaving the requested line asking for it again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/release_requisition_asset","href":"/api-reference/procurement/return-a-spare-to-the-pool-leaving-the-requested-line-asking-for-it-again"},{"title":"Put stock claimed against a requested line back on the shelf, leaving the line asking for it again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/release_requisition_stock","href":"/api-reference/procurement/put-stock-claimed-against-a-requested-line-back-on-the-shelf-leaving-the-line-asking-for-it-again"},{"title":"Take a line off a draft order, renumbering what is left.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_purchase_order_line","href":"/api-reference/procurement/take-a-line-off-a-draft-order-renumbering-what-is-left"},{"title":"The purchase request types the caller may raise a request as, with the kinds of line each may carry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/requisition_types_for_me","href":"/api-reference/procurement/the-purchase-request-types-the-caller-may-raise-a-request-as-with-the-kinds-of-line-each-may-carry"},{"title":"Escalate from one supplier's price to a real competition, raised from the job rather than from a requisition.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rfq_from_work_order","href":"/api-reference/procurement/escalate-from-one-suppliers-price-to-a-real-competition-raised-from-the-job-rather-than-from-a-requisition"},{"title":"Save the receiving form's unfinished work against an order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_purchase_order_receipt_draft","href":"/api-reference/procurement/save-the-receiving-forms-unfinished-work-against-an-order"},{"title":"Award an RFQ to a quote, demanding a reason when it is not the cheapest.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/select_quote","href":"/api-reference/procurement/award-an-rfq-to-a-quote-demanding-a-reason-when-it-is-not-the-cheapest"},{"title":"Say whether receiving an order line adds what arrives (stock for a part, assets for an asset line) or only records it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_purchase_order_line_receiving","href":"/api-reference/procurement/say-whether-receiving-an-order-line-adds-what-arrives-stock-for-a-part-assets-for-an-asset-line-or-only-records-it"},{"title":"Say which roles a purchase request type is offered to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_requisition_type_roles","href":"/api-reference/procurement/say-which-roles-a-purchase-request-type-is-offered-to"},{"title":"Send a drafted order for whatever approval its value requires.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_purchase_order","href":"/api-reference/procurement/send-a-drafted-order-for-whatever-approval-its-value-requires"},{"title":"Submit a requisition, and route it for approval where the tenant's workflow says so.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_requisition","href":"/api-reference/procurement/submit-a-requisition-and-route-it-for-approval-where-the-tenants-workflow-says-so"},{"title":"What a supplier says is owed against an order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_supplier_invoice","href":"/api-reference/procurement/what-a-supplier-says-is-owed-against-an-order"},{"title":"Change one line of a draft order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_purchase_order_line","href":"/api-reference/procurement/change-one-line-of-a-draft-order"},{"title":"Withdraw a payment recorded in error.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/void_invoice_payment","href":"/api-reference/procurement/withdraw-a-payment-recorded-in-error"},{"title":"Approved request lines with anything left to source, with what the tenant already holds beside what is still to be…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /sourcing_queue","href":"/api-reference/procurement/approved-request-lines-with-anything-left-to-source-with-what-the-tenant-already-holds-beside-what-is-still-to-be…"},{"title":"Assets a tenant owns, holds spare, and has not already promised to a requisition.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /spare_assets","href":"/api-reference/procurement/assets-a-tenant-owns-holds-spare-and-has-not-already-promised-to-a-requisition"},{"title":"Billed lines beside what was ordered and what was received — the match, line by line.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /supplier_invoice_items","href":"/api-reference/procurement/billed-lines-beside-what-was-ordered-and-what-was-received-—-the-match-line-by-line"},{"title":"One line of what a supplier says is owed, beside what the order said.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /supplier_invoice_submission_lines","href":"/api-reference/procurement/one-line-of-what-a-supplier-says-is-owed-beside-what-the-order-said"},{"title":"What a supplier says is owed against an order, which of their accepted claims it bills, whether the buyer accepted it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /supplier_invoice_submissions","href":"/api-reference/procurement/what-a-supplier-says-is-owed-against-an-order-which-of-their-accepted-claims-it-bills-whether-the-buyer-accepted-it…"},{"title":"Supplier invoices with the three-way match verdict, what it disagrees with, and what has been paid against it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /supplier_invoices","href":"/api-reference/procurement/supplier-invoices-with-the-three-way-match-verdict-what-it-disagrees-with-and-what-has-been-paid-against-it"},{"title":"Quoted lines against the RFQ line they answer, so a basket compares line for line.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_quote_items","href":"/api-reference/procurement/quoted-lines-against-the-rfq-line-they-answer-so-a-basket-compares-line-for-line"},{"title":"Unbilled supplier work totalled per workshop per month per currency, with a count of the jobs nobody has priced — the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_provision_summary","href":"/api-reference/procurement/unbilled-supplier-work-totalled-per-workshop-per-month-per-currency-with-a-count-of-the-jobs-nobody-has-priced-—-the…"},{"title":"Work a supplier has finished and not yet billed us for, valued from the accepted claim or the accepted quote.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_provisions","href":"/api-reference/procurement/work-a-supplier-has-finished-and-not-yet-billed-us-for-valued-from-the-accepted-claim-or-the-accepted-quote"}]},{"group":"Kits","pages":[{"title":"Each line of a kit's template, with how much the kit holds against it: a count of assets or tools, or a quantity of a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /kit_lines","href":"/api-reference/kits/each-line-of-a-kits-template-with-how-much-the-kit-holds-against-it:-a-count-of-assets-or-tools-or-a-quantity-of-a…"},{"title":"The assets, tools and parts in each kit, and the ones that used to be, with the template line each one fills.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /kit_members","href":"/api-reference/kits/the-assets-tools-and-parts-in-each-kit-and-the-ones-that-used-to-be-with-the-template-line-each-one-fills"},{"title":"What each kit template asks for: a kind of asset, a type of tool or a part per line, and how many of it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /kit_template_lines","href":"/api-reference/kits/what-each-kit-template-asks-for:-a-kind-of-asset-a-type-of-tool-or-a-part-per-line-and-how-many-of-it"},{"title":"Kit templates, every version of each, with how many lines it has and how many kits were assembled to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /kit_templates","href":"/api-reference/kits/kit-templates-every-version-of-each-with-how-many-lines-it-has-and-how-many-kits-were-assembled-to-it"},{"title":"Add to kit templates: Kit templates, every version of each, with how many lines it has and how many kits were assembled to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /kit_templates","href":"/api-reference/kits/add-to-kit-templates:-kit-templates-every-version-of-each-with-how-many-lines-it-has-and-how-many-kits-were-assembled-to-it"},{"title":"Remove rows from kit templates: Kit templates, every version of each, with how many lines it has and how many kits were assembled to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /kit_templates","href":"/api-reference/kits/remove-rows-from-kit-templates:-kit-templates-every-version-of-each-with-how-many-lines-it-has-and-how-many-kits-were-assembled-to-it"},{"title":"Change rows in kit templates: Kit templates, every version of each, with how many lines it has and how many kits were assembled to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /kit_templates","href":"/api-reference/kits/change-rows-in-kit-templates:-kit-templates-every-version-of-each-with-how-many-lines-it-has-and-how-many-kits-were-assembled-to-it"},{"title":"Kits: where each one is, who has it, how many things are in it, how many places its template asks for that are still…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /kits","href":"/api-reference/kits/kits:-where-each-one-is-who-has-it-how-many-things-are-in-it-how-many-places-its-template-asks-for-that-are-still…"},{"title":"Put an asset in a kit.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_kit_member","href":"/api-reference/kits/put-an-asset-in-a-kit"},{"title":"Put a quantity of a part in a kit by issuing it to the kit from a store at the kit's site.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_kit_part","href":"/api-reference/kits/put-a-quantity-of-a-part-in-a-kit-by-issuing-it-to-the-kit-from-a-store-at-the-kits-site"},{"title":"Put a tool in a kit by checking it out to the kit, past the same gates as any checkout: not already out, not in a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_kit_tool","href":"/api-reference/kits/put-a-tool-in-a-kit-by-checking-it-out-to-the-kit-past-the-same-gates-as-any-checkout:-not-already-out-not-in-a…"},{"title":"Take everything out of a kit and close it: tools go back to the tool room, parts to their stores, and any parts still…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dismantle_kit","href":"/api-reference/kits/take-everything-out-of-a-kit-and-close-it:-tools-go-back-to-the-tool-room-parts-to-their-stores-and-any-parts-still…"},{"title":"Assets that could be put in a kit now: where the kit is, free, and of the kind the named line asks for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/kit_candidates","href":"/api-reference/kits/assets-that-could-be-put-in-a-kit-now:-where-the-kit-is-free-and-of-the-kind-the-named-line-asks-for"},{"title":"Stock that could be put in a kit now: each part and store at the kit's site with some available to the kit, narrowed to…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/kit_part_candidates","href":"/api-reference/kits/stock-that-could-be-put-in-a-kit-now:-each-part-and-store-at-the-kits-site-with-some-available-to-the-kit-narrowed-to…"},{"title":"Tools that could be put in a kit now: where the kit is, free to issue, calibrated, and of the type the named line asks…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/kit_tool_candidates","href":"/api-reference/kits/tools-that-could-be-put-in-a-kit-now:-where-the-kit-is-free-to-issue-calibrated-and-of-the-type-the-named-line-asks…"},{"title":"Put a draft kit template into use, retiring the version that was in use before it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_kit_template","href":"/api-reference/kits/put-a-draft-kit-template-into-use-retiring-the-version-that-was-in-use-before-it"},{"title":"Let go of the parts put aside for a kit.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/release_kit_parts","href":"/api-reference/kits/let-go-of-the-parts-put-aside-for-a-kit"},{"title":"Take an asset, a tool or a part out of a kit.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_kit_member","href":"/api-reference/kits/take-an-asset-a-tool-or-a-part-out-of-a-kit"},{"title":"Put aside in one store what a kit's part lines are still short of, so the kit can be assembled with them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reserve_kit_parts","href":"/api-reference/kits/put-aside-in-one-store-what-a-kits-part-lines-are-still-short-of-so-the-kit-can-be-assembled-with-them"},{"title":"Take a published kit template out of use.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/retire_kit_template","href":"/api-reference/kits/take-a-published-kit-template-out-of-use"},{"title":"Take a kit back from whoever has it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/return_kit","href":"/api-reference/kits/take-a-kit-back-from-whoever-has-it"},{"title":"Start the next version of a kit template as a draft with the same lines, to be changed and published.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revise_kit_template","href":"/api-reference/kits/start-the-next-version-of-a-kit-template-as-a-draft-with-the-same-lines-to-be-changed-and-published"},{"title":"Make a draft kit template from what a kit holds now: a line per asset category, tool type and part, with how many of…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_kit_as_template","href":"/api-reference/kits/make-a-draft-kit-template-from-what-a-kit-holds-now:-a-line-per-asset-category-tool-type-and-part-with-how-many-of…"},{"title":"Move a kit, hand it to somebody, or both, with every asset in it — or refuse the whole move and say which assets…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/transfer_kit","href":"/api-reference/kits/move-a-kit-hand-it-to-somebody-or-both-with-every-asset-in-it-—-or-refuse-the-whole-move-and-say-which-assets…"}]},{"group":"Knowledge","pages":[{"title":"The version history behind an article.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge_article_versions","href":"/api-reference/knowledge/the-version-history-behind-an-article"},{"title":"Knowledge articles with the body of their current version.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge_articles","href":"/api-reference/knowledge/knowledge-articles-with-the-body-of-their-current-version"},{"title":"Was this helpful, and what they said about it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /knowledge_feedback","href":"/api-reference/knowledge/was-this-helpful-and-what-they-said-about-it"},{"title":"What an event taught, who owns it, and whether it reached the plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /lessons_learned","href":"/api-reference/knowledge/what-an-event-taught-who-owns-it-and-whether-it-reached-the-plan"},{"title":"Capture a note on a job or an asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_technician_note","href":"/api-reference/knowledge/capture-a-note-on-a-job-or-an-asset"},{"title":"Archive an article, saying why.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/archive_knowledge_article","href":"/api-reference/knowledge/archive-an-article-saying-why"},{"title":"Close a lesson, recording whether it reached the maintenance plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/implement_lesson","href":"/api-reference/knowledge/close-a-lesson-recording-whether-it-reached-the-maintenance-plan"},{"title":"The guides, articles and notes this job's asset type and classified failure already imply.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/knowledge_for_work_order","href":"/api-reference/knowledge/the-guides-articles-and-notes-this-jobs-asset-type-and-classified-failure-already-imply"},{"title":"Turn a technician's note into a draft article, keeping the note where it was written.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/promote_note_to_article","href":"/api-reference/knowledge/turn-a-technicians-note-into-a-draft-article-keeping-the-note-where-it-was-written"},{"title":"Publish an article's draft version and supersede the one it replaces.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_knowledge_article","href":"/api-reference/knowledge/publish-an-articles-draft-version-and-supersede-the-one-it-replaces"},{"title":"Record whether an article, SOP or guide helped.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_knowledge_feedback","href":"/api-reference/knowledge/record-whether-an-article-sop-or-guide-helped"},{"title":"Count a read of an article.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_knowledge_view","href":"/api-reference/knowledge/count-a-read-of-an-article"},{"title":"Record what an event taught, against the event that taught it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_lesson_learned","href":"/api-reference/knowledge/record-what-an-event-taught-against-the-event-that-taught-it"},{"title":"Bring an archived article back: published again if the version it points at was published, a draft otherwise.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/restore_knowledge_article","href":"/api-reference/knowledge/bring-an-archived-article-back:-published-again-if-the-version-it-points-at-was-published-a-draft-otherwise"},{"title":"Create an article or open its next draft.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_knowledge_article","href":"/api-reference/knowledge/create-an-article-or-open-its-next-draft"},{"title":"Create or amend a diagnostic guide.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_troubleshooting_guide","href":"/api-reference/knowledge/create-or-amend-a-diagnostic-guide"},{"title":"Search articles, guides, notes and lessons, ranked for the asset and failure in hand.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/search_knowledge","href":"/api-reference/knowledge/search-articles-guides-notes-and-lessons-ranked-for-the-asset-and-failure-in-hand"},{"title":"Send an article's open draft for review.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_knowledge_article","href":"/api-reference/knowledge/send-an-articles-open-draft-for-review"},{"title":"Notes captured on a job or an asset, and whether one became an article.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /technician_notes","href":"/api-reference/knowledge/notes-captured-on-a-job-or-an-asset-and-whether-one-became-an-article"},{"title":"Diagnostic guides, indexed by asset type and failure code.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /troubleshooting_guides","href":"/api-reference/knowledge/diagnostic-guides-indexed-by-asset-type-and-failure-code"}]},{"group":"Labels","pages":[{"title":"Marks that can go on a label, as the packed monochrome bitmaps a thermal head prints.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /label_logos","href":"/api-reference/labels/marks-that-can-go-on-a-label-as-the-packed-monochrome-bitmaps-a-thermal-head-prints"},{"title":"Add to label logos: Marks that can go on a label, as the packed monochrome bitmaps a thermal head prints.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /label_logos","href":"/api-reference/labels/add-to-label-logos:-marks-that-can-go-on-a-label-as-the-packed-monochrome-bitmaps-a-thermal-head-prints"},{"title":"Remove rows from label logos: Marks that can go on a label, as the packed monochrome bitmaps a thermal head prints.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /label_logos","href":"/api-reference/labels/remove-rows-from-label-logos:-marks-that-can-go-on-a-label-as-the-packed-monochrome-bitmaps-a-thermal-head-prints"},{"title":"Change rows in label logos: Marks that can go on a label, as the packed monochrome bitmaps a thermal head prints.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /label_logos","href":"/api-reference/labels/change-rows-in-label-logos:-marks-that-can-go-on-a-label-as-the-packed-monochrome-bitmaps-a-thermal-head-prints"},{"title":"Print runs, and whether the bytes were ever produced.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /label_print_jobs","href":"/api-reference/labels/print-runs-and-whether-the-bytes-were-ever-produced"},{"title":"The printers a run can be sent to, and what each of them can do.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /label_printers","href":"/api-reference/labels/the-printers-a-run-can-be-sent-to-and-what-each-of-them-can-do"},{"title":"Add to label printers: The printers a run can be sent to, and what each of them can do.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /label_printers","href":"/api-reference/labels/add-to-label-printers:-the-printers-a-run-can-be-sent-to-and-what-each-of-them-can-do"},{"title":"Remove rows from label printers: The printers a run can be sent to, and what each of them can do.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /label_printers","href":"/api-reference/labels/remove-rows-from-label-printers:-the-printers-a-run-can-be-sent-to-and-what-each-of-them-can-do"},{"title":"Change rows in label printers: The printers a run can be sent to, and what each of them can do.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /label_printers","href":"/api-reference/labels/change-rows-in-label-printers:-the-printers-a-run-can-be-sent-to-and-what-each-of-them-can-do"},{"title":"Every label produced, with what was encoded on it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /label_prints","href":"/api-reference/labels/every-label-produced-with-what-was-encoded-on-it"},{"title":"Label designs: the media, the elements on it, and whether it writes an RFID tag.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /label_templates","href":"/api-reference/labels/label-designs:-the-media-the-elements-on-it-and-whether-it-writes-an-rfid-tag"},{"title":"Add to label templates: Label designs: the media, the elements on it, and whether it writes an RFID tag.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /label_templates","href":"/api-reference/labels/add-to-label-templates:-label-designs:-the-media-the-elements-on-it-and-whether-it-writes-an-rfid-tag"},{"title":"Remove rows from label templates: Label designs: the media, the elements on it, and whether it writes an RFID tag.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /label_templates","href":"/api-reference/labels/remove-rows-from-label-templates:-label-designs:-the-media-the-elements-on-it-and-whether-it-writes-an-rfid-tag"},{"title":"Change rows in label templates: Label designs: the media, the elements on it, and whether it writes an RFID tag.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /label_templates","href":"/api-reference/labels/change-rows-in-label-templates:-label-designs:-the-media-the-elements-on-it-and-whether-it-writes-an-rfid-tag"},{"title":"Say which asset a scanned label is on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/attach_identifier","href":"/api-reference/labels/say-which-asset-a-scanned-label-is-on"},{"title":"The studio's field palette.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/label_placeholders","href":"/api-reference/labels/the-studios-field-palette"},{"title":"A design resolved against a real record — the same structure the printer is sent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_label","href":"/api-reference/labels/a-design-resolved-against-a-real-record-—-the-same-structure-the-printer-is-sent"},{"title":"Queue a print run and return the job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/print_labels","href":"/api-reference/labels/queue-a-print-run-and-return-the-job"},{"title":"A design being edited, resolved against a real record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resolve_label_draft","href":"/api-reference/labels/a-design-being-edited-resolved-against-a-real-record"},{"title":"What a scanned barcode, QR link or RFID tag names.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resolve_scan","href":"/api-reference/labels/what-a-scanned-barcode-qr-link-or-rfid-tag-names"},{"title":"How this organisation turns its own numbers into the hex an RFID tag holds.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rfid_configuration","href":"/api-reference/labels/how-this-organisation-turns-its-own-numbers-into-the-hex-an-rfid-tag-holds"},{"title":"What a tag design would write across a whole register: how many numbers encode exactly, how many lose characters a tag…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rfid_coverage","href":"/api-reference/labels/what-a-tag-design-would-write-across-a-whole-register:-how-many-numbers-encode-exactly-how-many-lose-characters-a-tag…"},{"title":"Store a logo as the packed monochrome bitmap a thermal head prints.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_label_logo","href":"/api-reference/labels/store-a-logo-as-the-packed-monochrome-bitmap-a-thermal-head-prints"},{"title":"Create or amend a label design.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_label_template","href":"/api-reference/labels/create-or-amend-a-label-design"},{"title":"Say whether this organisation own numbers are already tag numbers.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_rfid_configuration","href":"/api-reference/labels/say-whether-this-organisation-own-numbers-are-already-tag-numbers"}]},{"group":"List views","pages":[{"title":"The colleagues the caller may share a saved list view with by name: people who can sign in and reach a site the caller…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /list_view_recipients","href":"/api-reference/list-views/the-colleagues-the-caller-may-share-a-saved-list-view-with-by-name:-people-who-can-sign-in-and-reach-a-site-the-caller…"},{"title":"Add to list view recipients: The colleagues the caller may share a saved list view with by name: people who can sign in and reach a site the caller…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /list_view_recipients","href":"/api-reference/list-views/add-to-list-view-recipients:-the-colleagues-the-caller-may-share-a-saved-list-view-with-by-name:-people-who-can-sign-in-and-reach-a-site-the-caller…"},{"title":"Remove rows from list view recipients: The colleagues the caller may share a saved list view with by name: people who can sign in and reach a site the caller…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /list_view_recipients","href":"/api-reference/list-views/remove-rows-from-list-view-recipients:-the-colleagues-the-caller-may-share-a-saved-list-view-with-by-name:-people-who-can-sign-in-and-reach-a-site-the-caller…"},{"title":"Change rows in list view recipients: The colleagues the caller may share a saved list view with by name: people who can sign in and reach a site the caller…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /list_view_recipients","href":"/api-reference/list-views/change-rows-in-list-view-recipients:-the-colleagues-the-caller-may-share-a-saved-list-view-with-by-name:-people-who-can-sign-in-and-reach-a-site-the-caller…"},{"title":"The roles the caller may share a saved list view with: every active role for a caller whose access is not narrowed…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /list_view_roles","href":"/api-reference/list-views/the-roles-the-caller-may-share-a-saved-list-view-with:-every-active-role-for-a-caller-whose-access-is-not-narrowed…"},{"title":"Add to list view roles: The roles the caller may share a saved list view with: every active role for a caller whose access is not narrowed…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /list_view_roles","href":"/api-reference/list-views/add-to-list-view-roles:-the-roles-the-caller-may-share-a-saved-list-view-with:-every-active-role-for-a-caller-whose-access-is-not-narrowed…"},{"title":"Remove rows from list view roles: The roles the caller may share a saved list view with: every active role for a caller whose access is not narrowed…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /list_view_roles","href":"/api-reference/list-views/remove-rows-from-list-view-roles:-the-roles-the-caller-may-share-a-saved-list-view-with:-every-active-role-for-a-caller-whose-access-is-not-narrowed…"},{"title":"Change rows in list view roles: The roles the caller may share a saved list view with: every active role for a caller whose access is not narrowed…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /list_view_roles","href":"/api-reference/list-views/change-rows-in-list-view-roles:-the-roles-the-caller-may-share-a-saved-list-view-with:-every-active-role-for-a-caller-whose-access-is-not-narrowed…"},{"title":"The roles, sites and people a shared list view is for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /list_view_shares","href":"/api-reference/list-views/the-roles-sites-and-people-a-shared-list-view-is-for"},{"title":"Saved list views the caller may open: their own, their roles' and sites', those shared by colleagues whose site access…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /list_views","href":"/api-reference/list-views/saved-list-views-the-caller-may-open:-their-own-their-roles-and-sites-those-shared-by-colleagues-whose-site-access…"},{"title":"Add to list views: Saved list views the caller may open: their own, their roles' and sites', those shared by colleagues whose site access…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /list_views","href":"/api-reference/list-views/add-to-list-views:-saved-list-views-the-caller-may-open:-their-own-their-roles-and-sites-those-shared-by-colleagues-whose-site-access…"},{"title":"Remove rows from list views: Saved list views the caller may open: their own, their roles' and sites', those shared by colleagues whose site access…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /list_views","href":"/api-reference/list-views/remove-rows-from-list-views:-saved-list-views-the-caller-may-open:-their-own-their-roles-and-sites-those-shared-by-colleagues-whose-site-access…"},{"title":"Change rows in list views: Saved list views the caller may open: their own, their roles' and sites', those shared by colleagues whose site access…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /list_views","href":"/api-reference/list-views/change-rows-in-list-views:-saved-list-views-the-caller-may-open:-their-own-their-roles-and-sites-those-shared-by-colleagues-whose-site-access…"},{"title":"Remove a saved list view and the shares that named its audience.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_list_view","href":"/api-reference/list-views/remove-a-saved-list-view-and-the-shares-that-named-its-audience"},{"title":"Record that a saved list view was applied, for the picker's order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/note_list_view_applied","href":"/api-reference/list-views/record-that-a-saved-list-view-was-applied-for-the-pickers-order"},{"title":"Create or amend a saved list view and the audience it is for: its author alone, roles, named colleagues, or the whole…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_list_view","href":"/api-reference/list-views/create-or-amend-a-saved-list-view-and-the-audience-it-is-for:-its-author-alone-roles-named-colleagues-or-the-whole…"}]},{"group":"Maintenance","pages":[{"title":"The checklist a generated work order inherits, in order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenance_plan_tasks","href":"/api-reference/maintenance/the-checklist-a-generated-work-order-inherits-in-order"},{"title":"What makes a plan fall due, one row per rule.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenance_plan_triggers","href":"/api-reference/maintenance/what-makes-a-plan-fall-due-one-row-per-rule"},{"title":"Every published version of a plan: what it said, who put it in force, and the rounds and jobs it raised.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenance_plan_versions","href":"/api-reference/maintenance/every-published-version-of-a-plan:-what-it-said-who-put-it-in-force-and-the-rounds-and-jobs-it-raised"},{"title":"The maintenance plan register.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenance_plans","href":"/api-reference/maintenance/the-maintenance-plan-register"},{"title":"Maintenance plans with every field of the records each row points at: assigned team, preferred technician, preferred…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /maintenance_plans_expanded","href":"/api-reference/maintenance/maintenance-plans-with-every-field-of-the-records-each-row-points-at:-assigned-team-preferred-technician-preferred…"},{"title":"Start generating occurrences from this plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/activate_maintenance_plan","href":"/api-reference/maintenance/start-generating-occurrences-from-this-plan"},{"title":"Add a section to a plan's checklist: a copy of a library checklist, or an empty one to type into.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_plan_task_block","href":"/api-reference/maintenance/add-a-section-to-a-plans-checklist:-a-copy-of-a-library-checklist-or-an-empty-one-to-type-into"},{"title":"Add one trigger to a plan, or replace the one named.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_plan_trigger","href":"/api-reference/maintenance/add-one-trigger-to-a-plan-or-replace-the-one-named"},{"title":"Take a selection of plans live, and build the schedule once when they are.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_activate_maintenance_plans","href":"/api-reference/maintenance/take-a-selection-of-plans-live-and-build-the-schedule-once-when-they-are"},{"title":"Set — or clear — the crew, the worker or the vendor a selection of plans prefers.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_assign_maintenance_plans","href":"/api-reference/maintenance/set-—-or-clear-—-the-crew-the-worker-or-the-vendor-a-selection-of-plans-prefers"},{"title":"Push a selection of rounds to the same later date, with one reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_defer_occurrences","href":"/api-reference/maintenance/push-a-selection-of-rounds-to-the-same-later-date-with-one-reason"},{"title":"Stop a selection of plans generating, with one reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_pause_maintenance_plans","href":"/api-reference/maintenance/stop-a-selection-of-plans-generating-with-one-reason"},{"title":"Raise what a selection of due rounds asks for — a work order, or the inspection where the plan's type raises one of…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_raise_occurrence_work_orders","href":"/api-reference/maintenance/raise-what-a-selection-of-due-rounds-asks-for-—-a-work-order-or-the-inspection-where-the-plans-type-raises-one-of…"},{"title":"Write off a selection of rounds, with one reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_skip_occurrences","href":"/api-reference/maintenance/write-off-a-selection-of-rounds-with-one-reason"},{"title":"Set the same scheduling terms — priority, lead time, tolerance, whether it raises its own job, whether it needs a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_update_maintenance_plans","href":"/api-reference/maintenance/set-the-same-scheduling-terms-—-priority-lead-time-tolerance-whether-it-raises-its-own-job-whether-it-needs-a…"},{"title":"Copy a plan as an inert draft, for the variant that differs only in what it covers.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clone_maintenance_plan","href":"/api-reference/maintenance/copy-a-plan-as-an-inert-draft-for-the-variant-that-differs-only-in-what-it-covers"},{"title":"Correct what a meter reading from the last thirty days says, and return what it said before.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/correct_meter_reading","href":"/api-reference/maintenance/correct-what-a-meter-reading-from-the-last-thirty-days-says-and-return-what-it-said-before"},{"title":"Turn a due occurrence into the inspection its plan schedules.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_inspection_from_occurrence","href":"/api-reference/maintenance/turn-a-due-occurrence-into-the-inspection-its-plan-schedules"},{"title":"Step 1 of the builder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_maintenance_plan","href":"/api-reference/maintenance/step-1-of-the-builder"},{"title":"Turn a due occurrence into a work order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_work_order_from_occurrence","href":"/api-reference/maintenance/turn-a-due-occurrence-into-a-work-order"},{"title":"Push an occurrence to a later date, with the reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/defer_occurrence","href":"/api-reference/maintenance/push-an-occurrence-to-a-later-date-with-the-reason"},{"title":"Throw away a draft of a library checklist and its steps.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/discard_task_template_draft","href":"/api-reference/maintenance/throw-away-a-draft-of-a-library-checklist-and-its-steps"},{"title":"Start a new draft of a library checklist, copying every step from the version in force.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/draft_task_template_version","href":"/api-reference/maintenance/start-a-new-draft-of-a-library-checklist-copying-every-step-from-the-version-in-force"},{"title":"Raise the occurrences every active plan is due over a horizon.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/generate_maintenance_occurrences","href":"/api-reference/maintenance/raise-the-occurrences-every-active-plan-is-due-over-a-horizon"},{"title":"What every active plan will be due over a horizon, before anything is raised.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/maintenance_forecast","href":"/api-reference/maintenance/what-every-active-plan-will-be-due-over-a-horizon-before-anything-is-raised"},{"title":"The meter types a meter trigger on this plan could actually fire on, with how many meters and assets carry each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/maintenance_plan_meter_types","href":"/api-reference/maintenance/the-meter-types-a-meter-trigger-on-this-plan-could-actually-fire-on-with-how-many-meters-and-assets-carry-each"},{"title":"Which parts of this plan differ from the version in force: plan, triggers, checklist, requirements, scope, calendars.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/maintenance_plan_unpublished_changes","href":"/api-reference/maintenance/which-parts-of-this-plan-differ-from-the-version-in-force:-plan-triggers-checklist-requirements-scope-calendars"},{"title":"Whether a meter reading is from the last thirty days at its site and so can be corrected, what it reads now, and the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/meter_reading_correction","href":"/api-reference/maintenance/whether-a-meter-reading-is-from-the-last-thirty-days-at-its-site-and-so-can-be-corrected-what-it-reads-now-and-the…"},{"title":"Move one round to another day, keeping it before the next round of the same plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/move_occurrence","href":"/api-reference/maintenance/move-one-round-to-another-day-keeping-it-before-the-next-round-of-the-same-plan"},{"title":"Stop generating occurrences, with the reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/pause_maintenance_plan","href":"/api-reference/maintenance/stop-generating-occurrences-with-the-reason"},{"title":"Step 11.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_maintenance_plan","href":"/api-reference/maintenance/step-11"},{"title":"Put the plan as it now stands into force as the next version, and retire the one it replaces.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_maintenance_plan_version","href":"/api-reference/maintenance/put-the-plan-as-it-now-stands-into-force-as-the-next-version-and-retire-the-one-it-replaces"},{"title":"Put a draft of a library checklist into force, and retire the version it replaces.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_task_template_version","href":"/api-reference/maintenance/put-a-draft-of-a-library-checklist-into-force-and-retire-the-version-it-replaces"},{"title":"Record a reading.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_meter_reading","href":"/api-reference/maintenance/record-a-reading"},{"title":"Remove a section of a plan's checklist.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_plan_task_block","href":"/api-reference/maintenance/remove-a-section-of-a-plans-checklist"},{"title":"Replace one plan section's steps with the library's current version of them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/repull_plan_task_block","href":"/api-reference/maintenance/replace-one-plan-sections-steps-with-the-librarys-current-version-of-them"},{"title":"Put a plan's checklist into the library, with its reference material.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_plan_tasks_as_template","href":"/api-reference/maintenance/put-a-plans-checklist-into-the-library-with-its-reference-material"},{"title":"Replace the parts, tools, skills and permits a job from this plan needs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_plan_requirements","href":"/api-reference/maintenance/replace-the-parts-tools-skills-and-permits-a-job-from-this-plan-needs"},{"title":"Say what a plan covers: assets by name, by category, by asset type, or places.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_plan_scope","href":"/api-reference/maintenance/say-what-a-plan-covers:-assets-by-name-by-category-by-asset-type-or-places"},{"title":"Arrange a plan's checklist sections and edit their headings.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_plan_task_blocks","href":"/api-reference/maintenance/arrange-a-plans-checklist-sections-and-edit-their-headings"},{"title":"Set the checklist a job from this plan carries, in the order given.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_plan_tasks","href":"/api-reference/maintenance/set-the-checklist-a-job-from-this-plan-carries-in-the-order-given"},{"title":"Replace what makes the plan due — dates, meter readings, or both.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_plan_triggers","href":"/api-reference/maintenance/replace-what-makes-the-plan-due-—-dates-meter-readings-or-both"},{"title":"Say which roles may change an answer once it has been recorded on a job built from this checklist, replacing whatever…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_task_template_answer_roles","href":"/api-reference/maintenance/say-which-roles-may-change-an-answer-once-it-has-been-recorded-on-a-job-built-from-this-checklist-replacing-whatever…"},{"title":"Skip an occurrence entirely, with the reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/skip_occurrence","href":"/api-reference/maintenance/skip-an-occurrence-entirely-with-the-reason"},{"title":"Change a plan's own details, leaving its scope, triggers and tasks alone.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_maintenance_plan","href":"/api-reference/maintenance/change-a-plans-own-details-leaving-its-scope-triggers-and-tasks-alone"},{"title":"Every version of every library checklist, with what it asks and which plans took a copy of it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /task_template_versions","href":"/api-reference/maintenance/every-version-of-every-library-checklist-with-what-it-asks-and-which-plans-took-a-copy-of-it"}]},{"group":"MCP connections","pages":[{"title":"How busy this organisation's AI surface has been: connections, questions in the last seven days, and how many of those…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mcp_activity","href":"/api-reference/mcp-connections/how-busy-this-organisations-ai-surface-has-been:-connections-questions-in-the-last-seven-days-and-how-many-of-those…"},{"title":"What the MCP server says it was asked, answered and refused — with the person each call was made for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mcp_calls","href":"/api-reference/mcp-connections/what-the-mcp-server-says-it-was-asked-answered-and-refused-—-with-the-person-each-call-was-made-for"},{"title":"Where this deployment's MCP server is, for the connection instructions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mcp_connection","href":"/api-reference/mcp-connections/where-this-deployments-mcp-server-is-for-the-connection-instructions"},{"title":"Record one tool call, answered or refused.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_mcp_call","href":"/api-reference/mcp-connections/record-one-tool-call-answered-or-refused"}]},{"group":"MCP sign-in","pages":[{"title":"AI apps that have registered against this deployment's MCP server.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mcp_clients","href":"/api-reference/mcp-sign-in/ai-apps-that-have-registered-against-this-deployments-mcp-server"},{"title":"Add to mcp clients: AI apps that have registered against this deployment's MCP server.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /mcp_clients","href":"/api-reference/mcp-sign-in/add-to-mcp-clients:-ai-apps-that-have-registered-against-this-deployments-mcp-server"},{"title":"Remove rows from mcp clients: AI apps that have registered against this deployment's MCP server.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /mcp_clients","href":"/api-reference/mcp-sign-in/remove-rows-from-mcp-clients:-ai-apps-that-have-registered-against-this-deployments-mcp-server"},{"title":"Change rows in mcp clients: AI apps that have registered against this deployment's MCP server.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /mcp_clients","href":"/api-reference/mcp-sign-in/change-rows-in-mcp-clients:-ai-apps-that-have-registered-against-this-deployments-mcp-server"},{"title":"Which AI apps have been let in, by whom, and when each was last used.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /mcp_grants","href":"/api-reference/mcp-sign-in/which-ai-apps-have-been-let-in-by-whom-and-when-each-was-last-used"},{"title":"Approve an AI app, as the signed-in person, and get the authorization code to send back to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/authorize_mcp_client","href":"/api-reference/mcp-sign-in/approve-an-ai-app-as-the-signed-in-person-and-get-the-authorization-code-to-send-back-to-it"},{"title":"What the consent screen shows: what the app calls itself, which is a claim; whether this person has already connected…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/mcp_connect_request","href":"/api-reference/mcp-sign-in/what-the-consent-screen-shows:-what-the-app-calls-itself-which-is-a-claim;-whether-this-person-has-already-connected…"},{"title":"Spend an authorization code for an opaque access token and a refresh token.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/redeem_mcp_code","href":"/api-reference/mcp-sign-in/spend-an-authorization-code-for-an-opaque-access-token-and-a-refresh-token"},{"title":"Trade a refresh token for a new pair.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/refresh_mcp_token","href":"/api-reference/mcp-sign-in/trade-a-refresh-token-for-a-new-pair"},{"title":"End an app's permission to ask as somebody.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revoke_mcp_grant","href":"/api-reference/mcp-sign-in/end-an-apps-permission-to-ask-as-somebody"}]},{"group":"Profile","pages":[{"title":"The calling user's own notification addresses, and whether they have proved each one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_channel_addresses","href":"/api-reference/profile/the-calling-users-own-notification-addresses-and-whether-they-have-proved-each-one"},{"title":"Add to my channel addresses: The calling user's own notification addresses, and whether they have proved each one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /my_channel_addresses","href":"/api-reference/profile/add-to-my-channel-addresses:-the-calling-users-own-notification-addresses-and-whether-they-have-proved-each-one"},{"title":"Remove rows from my channel addresses: The calling user's own notification addresses, and whether they have proved each one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /my_channel_addresses","href":"/api-reference/profile/remove-rows-from-my-channel-addresses:-the-calling-users-own-notification-addresses-and-whether-they-have-proved-each-one"},{"title":"Change rows in my channel addresses: The calling user's own notification addresses, and whether they have proved each one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /my_channel_addresses","href":"/api-reference/profile/change-rows-in-my-channel-addresses:-the-calling-users-own-notification-addresses-and-whether-they-have-proved-each-one"},{"title":"The calling user's own enrolled devices, with when each was last seen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_devices","href":"/api-reference/profile/the-calling-users-own-enrolled-devices-with-when-each-was-last-seen"},{"title":"Add to my devices: The calling user's own enrolled devices, with when each was last seen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /my_devices","href":"/api-reference/profile/add-to-my-devices:-the-calling-users-own-enrolled-devices-with-when-each-was-last-seen"},{"title":"Remove rows from my devices: The calling user's own enrolled devices, with when each was last seen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /my_devices","href":"/api-reference/profile/remove-rows-from-my-devices:-the-calling-users-own-enrolled-devices-with-when-each-was-last-seen"},{"title":"Change rows in my devices: The calling user's own enrolled devices, with when each was last seen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /my_devices","href":"/api-reference/profile/change-rows-in-my-devices:-the-calling-users-own-enrolled-devices-with-when-each-was-last-seen"},{"title":"Which external accounts sign the calling user in, and when each was last used.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_identities","href":"/api-reference/profile/which-external-accounts-sign-the-calling-user-in-and-when-each-was-last-used"},{"title":"Add to my identities: Which external accounts sign the calling user in, and when each was last used.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /my_identities","href":"/api-reference/profile/add-to-my-identities:-which-external-accounts-sign-the-calling-user-in-and-when-each-was-last-used"},{"title":"Remove rows from my identities: Which external accounts sign the calling user in, and when each was last used.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /my_identities","href":"/api-reference/profile/remove-rows-from-my-identities:-which-external-accounts-sign-the-calling-user-in-and-when-each-was-last-used"},{"title":"Change rows in my identities: Which external accounts sign the calling user in, and when each was last used.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /my_identities","href":"/api-reference/profile/change-rows-in-my-identities:-which-external-accounts-sign-the-calling-user-in-and-when-each-was-last-used"},{"title":"Everything the calling user's roles add up to, described rather than coded.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_permissions","href":"/api-reference/profile/everything-the-calling-users-roles-add-up-to-described-rather-than-coded"},{"title":"The places inside a site the calling user was granted, personally or through a role — each with everything inside it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_place_access","href":"/api-reference/profile/the-places-inside-a-site-the-calling-user-was-granted-personally-or-through-a-role-—-each-with-everything-inside-it…"},{"title":"The calling user's own record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_profile","href":"/api-reference/profile/the-calling-users-own-record"},{"title":"The calling user's roles, with when each was granted and by whom.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_roles","href":"/api-reference/profile/the-calling-users-roles-with-when-each-was-granted-and-by-whom"},{"title":"The sites the calling user is narrowed to, personally or through a role.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_site_access","href":"/api-reference/profile/the-sites-the-calling-user-is-narrowed-to-personally-or-through-a-role"},{"title":"What is on the calling user right now, as counts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_work_summary","href":"/api-reference/profile/what-is-on-the-calling-user-right-now-as-counts"},{"title":"Give an address of your own and ask for a code.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_my_channel_address","href":"/api-reference/profile/give-an-address-of-your-own-and-ask-for-a-code"},{"title":"Answer the question asked the first time somebody signs in: which language they read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/answer_language_prompt","href":"/api-reference/profile/answer-the-question-asked-the-first-time-somebody-signs-in:-which-language-they-read"},{"title":"Remove the calling user's own photo.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clear_profile_photo","href":"/api-reference/profile/remove-the-calling-users-own-photo"},{"title":"Confirm your own address with the code sent to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/confirm_my_channel_address","href":"/api-reference/profile/confirm-your-own-address-with-the-code-sent-to-it"},{"title":"Remove one of your own addresses.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/forget_my_channel_address","href":"/api-reference/profile/remove-one-of-your-own-addresses"},{"title":"Revoke one of the calling user's own devices and ask it to wipe.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/forget_my_device","href":"/api-reference/profile/revoke-one-of-the-calling-users-own-devices-and-ask-it-to-wipe"},{"title":"The languages a person may choose when asked which language they read, each named in its own script as well as in…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/language_prompt_options","href":"/api-reference/profile/the-languages-a-person-may-choose-when-asked-which-language-they-read-each-named-in-its-own-script-as-well-as-in…"},{"title":"Announce a profile photograph and get somewhere to put it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_profile_photo_upload","href":"/api-reference/profile/announce-a-profile-photograph-and-get-somewhere-to-put-it"},{"title":"Which channels the calling user will take, and the hours they will not.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_my_notification_preferences","href":"/api-reference/profile/which-channels-the-calling-user-will-take-and-the-hours-they-will-not"},{"title":"Save the calling user's own details.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_my_profile","href":"/api-reference/profile/save-the-calling-users-own-details"},{"title":"Turn the calling user's developer mode on or off.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_developer_mode","href":"/api-reference/profile/turn-the-calling-users-developer-mode-on-or-off"},{"title":"Stop an external account from signing the calling user in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unlink_my_identity","href":"/api-reference/profile/stop-an-external-account-from-signing-the-calling-user-in"}]},{"group":"My work","pages":[{"title":"The sites a handset should carry the asset register for: where this person is based, where their open work is, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_handset_sites","href":"/api-reference/my-work/the-sites-a-handset-should-carry-the-asset-register-for:-where-this-person-is-based-where-their-open-work-is-and…"},{"title":"Work assigned to the calling user, with the assignment itself.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_work","href":"/api-reference/my-work/work-assigned-to-the-calling-user-with-the-assignment-itself"},{"title":"My work with every field of the records each row points at: asset, assigned team, assigned vendor, contract…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_work_expanded","href":"/api-reference/my-work/my-work-with-every-field-of-the-records-each-row-points-at:-asset-assigned-team-assigned-vendor-contract…"},{"title":"Whether a job can be done, requirement by requirement.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_readiness","href":"/api-reference/my-work/whether-a-job-can-be-done-requirement-by-requirement"}]},{"group":"Notifications","pages":[{"title":"The signed-in user's own notifications, newest first, one per event however many channels it went by, with the module…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_notifications","href":"/api-reference/notifications/the-signed-in-users-own-notifications-newest-first-one-per-event-however-many-channels-it-went-by-with-the-module…"},{"title":"One row per event, channel and kind of record: the wording in force, and how many audiences it has.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notification_event_channels","href":"/api-reference/notifications/one-row-per-event-channel-and-kind-of-record:-the-wording-in-force-and-how-many-audiences-it-has"},{"title":"Everything this tenant can be told about: what it says, who hears it, and whether it is on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notification_events","href":"/api-reference/notifications/everything-this-tenant-can-be-told-about:-what-it-says-who-hears-it-and-whether-it-is-on"},{"title":"Notifications that did not arrive, with what to do about each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notification_failures","href":"/api-reference/notifications/notifications-that-did-not-arrive-with-what-to-do-about-each"},{"title":"Who has asked to hear about what, and on which channel.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notification_subscriptions","href":"/api-reference/notifications/who-has-asked-to-hear-about-what-and-on-which-channel"},{"title":"The templates each event renders through, per channel.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notification_templates","href":"/api-reference/notifications/the-templates-each-event-renders-through-per-channel"},{"title":"Whether this deployment can mail a copy of a sent email to an address you choose.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/email_previews_enabled","href":"/api-reference/notifications/whether-this-deployment-can-mail-a-copy-of-a-sent-email-to-an-address-you-choose"},{"title":"Mark notifications as read for the calling user.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/mark_notifications_read","href":"/api-reference/notifications/mark-notifications-as-read-for-the-calling-user"},{"title":"For an approval event, the kinds of record an active workflow holds that have no email wording of their own yet: the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/module_wording_choices","href":"/api-reference/notifications/for-an-approval-event-the-kinds-of-record-an-active-workflow-holds-that-have-no-email-wording-of-their-own-yet:-the…"},{"title":"Every notification this organisation sent, newest first, without the bodies.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/notification_log","href":"/api-reference/notifications/every-notification-this-organisation-sent-newest-first-without-the-bodies"},{"title":"One notification as it was sent, bodies included.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/notification_message","href":"/api-reference/notifications/one-notification-as-it-was-sent-bodies-included"},{"title":"What an event type carries, read off the events it has actually raised — and, for an approval about one kind of record…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/notification_placeholders","href":"/api-reference/notifications/what-an-event-type-carries-read-off-the-events-it-has-actually-raised-—-and-for-an-approval-about-one-kind-of-record…"},{"title":"The copies of one sent email that have been mailed to somebody, newest first, and what became of each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/notification_previews","href":"/api-reference/notifications/the-copies-of-one-sent-email-that-have-been-mailed-to-somebody-newest-first-and-what-became-of-each"},{"title":"Who would be notified of an event, before it is sent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_notification_recipients","href":"/api-reference/notifications/who-would-be-notified-of-an-event-before-it-is-sent"},{"title":"What a template would send, rendered against a real event of its type.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_notification_template","href":"/api-reference/notifications/what-a-template-would-send-rendered-against-a-real-event-of-its-type"},{"title":"Send a failed notification again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/retry_notification","href":"/api-reference/notifications/send-a-failed-notification-again"},{"title":"Mail a copy of one sent email to an address you choose, your own by default, to see how it arrives.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/send_notification_preview","href":"/api-reference/notifications/mail-a-copy-of-one-sent-email-to-an-address-you-choose-your-own-by-default-to-see-how-it-arrives"},{"title":"Switch an event on or off for this organisation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_notification_event","href":"/api-reference/notifications/switch-an-event-on-or-off-for-this-organisation"}]},{"group":"Signing in","pages":[{"title":"The calling user's own sessions, live and ended, with the current one marked.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /my_sessions","href":"/api-reference/signing-in/the-calling-users-own-sessions-live-and-ended-with-the-current-one-marked"},{"title":"This organisation's sign-in policy, showing the product defaults where no row has been saved.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /password_policy","href":"/api-reference/signing-in/this-organisations-sign-in-policy-showing-the-product-defaults-where-no-row-has-been-saved"},{"title":"Spend an invitation link: set the account's first password and make it ACTIVE, and link it to the person behind any…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/accept_invitation","href":"/api-reference/signing-in/spend-an-invitation-link:-set-the-accounts-first-password-and-make-it-active-and-link-it-to-the-person-behind-any…"},{"title":"Change the calling user's own password.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/change_password","href":"/api-reference/signing-in/change-the-calling-users-own-password"},{"title":"Open the link a sign-up was emailed: confirm the address, open the organisation, start its trial and sign its first…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/confirm_sign_up","href":"/api-reference/signing-in/open-the-link-a-sign-up-was-emailed:-confirm-the-address-open-the-organisation-start-its-trial-and-sign-its-first…"},{"title":"Create an ACTIVE account with a password and no invitation, for somebody who has no mailbox .","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_user_with_password","href":"/api-reference/signing-in/create-an-active-account-with-a-password-and-no-invitation-for-somebody-who-has-no-mailbox-"},{"title":"Create an INVITED account with its roles and scope, and email a link that turns it ACTIVE.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/invite_user","href":"/api-reference/signing-in/create-an-invited-account-with-its-roles-and-scope-and-email-a-link-that-turns-it-active"},{"title":"The accounts locked out right now, for the access screen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/locked_accounts","href":"/api-reference/signing-in/the-accounts-locked-out-right-now-for-the-access-screen"},{"title":"The password rules the calling user is held to, and when their own password expires.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/my_password_policy","href":"/api-reference/signing-in/the-password-rules-the-calling-user-is-held-to-and-when-their-own-password-expires"},{"title":"Renew a session that is still allowed to run.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/refresh_session","href":"/api-reference/signing-in/renew-a-session-that-is-still-allowed-to-run"},{"title":"Email a single-use reset link.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_password_reset","href":"/api-reference/signing-in/email-a-single-use-reset-link"},{"title":"Mint a fresh invitation link and email it again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resend_invitation","href":"/api-reference/signing-in/mint-a-fresh-invitation-link-and-email-it-again"},{"title":"Email a sign-up's confirmation link again, replacing the one sent before.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resend_sign_up_confirmation","href":"/api-reference/signing-in/email-a-sign-ups-confirmation-link-again-replacing-the-one-sent-before"},{"title":"Spend a reset link: set the same new password on every live account its address names , and clear the lockout on each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reset_password","href":"/api-reference/signing-in/spend-a-reset-link:-set-the-same-new-password-on-every-live-account-its-address-names-and-clear-the-lockout-on-each"},{"title":"Spend the link and remove the account it named.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revoke_invitation","href":"/api-reference/signing-in/spend-the-link-and-remove-the-account-it-named"},{"title":"End a session.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revoke_session","href":"/api-reference/signing-in/end-a-session"},{"title":"Save this organisation's sign-in policy.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_password_policy","href":"/api-reference/signing-in/save-this-organisations-sign-in-policy"},{"title":"Issue or reset another user's password.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_user_password","href":"/api-reference/signing-in/issue-or-reset-another-users-password"},{"title":"Suspend, reactivate or deactivate an account, and revoke its live sessions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_user_status","href":"/api-reference/signing-in/suspend-reactivate-or-deactivate-an-account-and-revoke-its-live-sessions"},{"title":"Exchange an email and password for a session token.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/sign_in","href":"/api-reference/signing-in/exchange-an-email-and-password-for-a-session-token"},{"title":"Create a tenant and email its first administrator a link that opens it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/sign_up","href":"/api-reference/signing-in/create-a-tenant-and-email-its-first-administrator-a-link-that-opens-it"},{"title":"Clear a lockout and its attempt counter.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unlock_user","href":"/api-reference/signing-in/clear-a-lockout-and-its-attempt-counter"},{"title":"Every session in this organisation, for the access screen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/user_sessions","href":"/api-reference/signing-in/every-session-in-this-organisation-for-the-access-screen"}]},{"group":"IT asset topology","pages":[{"title":"The ports of every discovered network device, as the device described them: name, label, hardware address, speed…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /network_interfaces","href":"/api-reference/it-asset-topology/the-ports-of-every-discovered-network-device-as-the-device-described-them:-name-label-hardware-address-speed…"},{"title":"Every connection discovery has drawn between two devices, current and ended: two network elements that announced…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /network_links","href":"/api-reference/it-asset-topology/every-connection-discovery-has-drawn-between-two-devices-current-and-ended:-two-network-elements-that-announced…"},{"title":"Network elements that announced themselves on a discovered device's port, by LLDP or CDP, and that discovery has not…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /network_unknown_neighbours","href":"/api-reference/it-asset-topology/network-elements-that-announced-themselves-on-a-discovered-devices-port-by-lldp-or-cdp-and-that-discovery-has-not…"},{"title":"One map of the physical network: the devices and the current links between them, either around one device (p_device_id…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/network_map","href":"/api-reference/it-asset-topology/one-map-of-the-physical-network:-the-devices-and-the-current-links-between-them-either-around-one-device-p_device_id…"}]},{"group":"Read models","pages":[{"title":"Event and channel pairs with both halves a notification needs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /notification_coverage","href":"/api-reference/read-models/event-and-channel-pairs-with-both-halves-a-notification-needs"},{"title":"What a disconnected client may read and write, generated from the model.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /offline_policies","href":"/api-reference/read-models/what-a-disconnected-client-may-read-and-write-generated-from-the-model"},{"title":"api.work_orders narrowed to states the model counts as open.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /open_work_orders","href":"/api-reference/read-models/apiwork_orders-narrowed-to-states-the-model-counts-as-open"},{"title":"Work orders with resolved type, priority, status, asset and assignees.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_orders","href":"/api-reference/read-models/work-orders-with-resolved-type-priority-status-asset-and-assignees"},{"title":"Work orders with every field of the records each row points at: asset, assigned team, assigned technician, assigned…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_orders_expanded","href":"/api-reference/read-models/work-orders-with-every-field-of-the-records-each-row-points-at:-asset-assigned-team-assigned-technician-assigned…"},{"title":"The request queue, before anything has become a work order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_requests","href":"/api-reference/read-models/the-request-queue-before-anything-has-become-a-work-order"},{"title":"Work requests with every field of the records each row points at: asset, duplicate of, location, requested by, site…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_requests_expanded","href":"/api-reference/read-models/work-requests-with-every-field-of-the-records-each-row-points-at:-asset-duplicate-of-location-requested-by-site…"}]},{"group":"Numbering","pages":[{"title":"Every series this product mints, with the shape this tenant will actually get — its own where it has said, ours where…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /number_series","href":"/api-reference/numbering/every-series-this-product-mints-with-the-shape-this-tenant-will-actually-get-—-its-own-where-it-has-said-ours-where…"},{"title":"The counters behind a series that counts within something — a site, a category, a Location, or more than one — with the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /number_series_sequences","href":"/api-reference/numbering/the-counters-behind-a-series-that-counts-within-something-—-a-site-a-category-a-location-or-more-than-one-—-with-the…"},{"title":"What is wrong with a number format, or what it would produce.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/check_number_format","href":"/api-reference/numbering/what-is-wrong-with-a-number-format-or-what-it-would-produce"},{"title":"How many records this series has numbered, how many of them are in the shape it produces now, the highest number…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/number_series_usage","href":"/api-reference/numbering/how-many-records-this-series-has-numbered-how-many-of-them-are-in-the-shape-it-produces-now-the-highest-number…"},{"title":"Give one series its shape back — the row is deleted rather than overwritten, so a default we improve later reaches this…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reset_number_series","href":"/api-reference/numbering/give-one-series-its-shape-back-—-the-row-is-deleted-rather-than-overwritten-so-a-default-we-improve-later-reaches-this…"},{"title":"Set how one kind of record is numbered for this organisation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_number_series","href":"/api-reference/numbering/set-how-one-kind-of-record-is-numbered-for-this-organisation"},{"title":"Start a series at a given number — what a tenant carrying a register in from another system needs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_next_number","href":"/api-reference/numbering/start-a-series-at-a-given-number-—-what-a-tenant-carrying-a-register-in-from-another-system-needs"}]},{"group":"Branding","pages":[{"title":"This tenant's addresses, and for a domain of their own the two DNS records to publish.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /organization_domains","href":"/api-reference/branding/this-tenants-addresses-and-for-a-domain-of-their-own-the-two-dns-records-to-publish"},{"title":"Add to organization domains: This tenant's addresses, and for a domain of their own the two DNS records to publish.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /organization_domains","href":"/api-reference/branding/add-to-organization-domains:-this-tenants-addresses-and-for-a-domain-of-their-own-the-two-dns-records-to-publish"},{"title":"Remove rows from organization domains: This tenant's addresses, and for a domain of their own the two DNS records to publish.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /organization_domains","href":"/api-reference/branding/remove-rows-from-organization-domains:-this-tenants-addresses-and-for-a-domain-of-their-own-the-two-dns-records-to-publish"},{"title":"Change rows in organization domains: This tenant's addresses, and for a domain of their own the two DNS records to publish.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /organization_domains","href":"/api-reference/branding/change-rows-in-organization-domains:-this-tenants-addresses-and-for-a-domain-of-their-own-the-two-dns-records-to-publish"},{"title":"This tenant.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /organization_profile","href":"/api-reference/branding/this-tenant"},{"title":"Claim a hostname for this tenant, and return what to publish in DNS.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_organization_domain","href":"/api-reference/branding/claim-a-hostname-for-this-tenant-and-return-what-to-publish-in-dns"},{"title":"How the signed-out screens should look on this hostname, whether it offers sign-up, and which handset app it offers.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/branding","href":"/api-reference/branding/how-the-signed-out-screens-should-look-on-this-hostname-whether-it-offers-sign-up-and-which-handset-app-it-offers"},{"title":"Check now whether a claimed hostname's DNS records have appeared.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/check_organization_domain","href":"/api-reference/branding/check-now-whether-a-claimed-hostnames-dns-records-have-appeared"},{"title":"Remove one of a tenant's branding images.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clear_branding_asset","href":"/api-reference/branding/remove-one-of-a-tenants-branding-images"},{"title":"Give up a claimed hostname.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_organization_domain","href":"/api-reference/branding/give-up-a-claimed-hostname"},{"title":"Announce a branding image and get somewhere to put it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_branding_upload","href":"/api-reference/branding/announce-a-branding-image-and-get-somewhere-to-put-it"},{"title":"Set how the signed-out screens look on a tenant's own hostname.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_branding","href":"/api-reference/branding/set-how-the-signed-out-screens-look-on-a-tenants-own-hostname"},{"title":"Save the tenant's own details and the defaults every screen inherits.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_organization_profile","href":"/api-reference/branding/save-the-tenants-own-details-and-the-defaults-every-screen-inherits"},{"title":"Store the logo as one bit a dot, which is the only form a document can carry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_branding_print_logo","href":"/api-reference/branding/store-the-logo-as-one-bit-a-dot-which-is-the-only-form-a-document-can-carry"},{"title":"Claim or move this tenant's subdomain.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_organization_subdomain","href":"/api-reference/branding/claim-or-move-this-tenants-subdomain"},{"title":"Choose which of a tenant's hostnames is the canonical one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_primary_organization_domain","href":"/api-reference/branding/choose-which-of-a-tenants-hostnames-is-the-canonical-one"}]},{"group":"Parts demand","pages":[{"title":"How much of each part went out per month.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /part_consumption","href":"/api-reference/parts-demand/how-much-of-each-part-went-out-per-month"},{"title":"Part consumption with every field of the records each row points at: part, warehouse.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /part_consumption_expanded","href":"/api-reference/parts-demand/part-consumption-with-every-field-of-the-records-each-row-points-at:-part-warehouse"},{"title":"The rate each part runs at, how much it moves about, and whether it is rising.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /part_demand_profiles","href":"/api-reference/parts-demand/the-rate-each-part-runs-at-how-much-it-moves-about-and-whether-it-is-rising"},{"title":"What one part is expected to need over a horizon.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/part_demand_outlook","href":"/api-reference/parts-demand/what-one-part-is-expected-to-need-over-a-horizon"},{"title":"Recompute parts demand for the caller's tenant.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/refresh_parts_demand","href":"/api-reference/parts-demand/recompute-parts-demand-for-the-callers-tenant"}]},{"group":"Costing","pages":[{"title":"What a part has cost, purchase by purchase — the evidence behind its valuation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /part_cost_history","href":"/api-reference/costing/what-a-part-has-cost-purchase-by-purchase-—-the-evidence-behind-its-valuation"},{"title":"How often a part has been missing, for the screen that decides how much to hold.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /part_shortage_summary","href":"/api-reference/costing/how-often-a-part-has-been-missing-for-the-screen-that-decides-how-much-to-hold"},{"title":"Record that a part was needed and not there.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_stockout","href":"/api-reference/costing/record-that-a-part-was-needed-and-not-there"},{"title":"Close a shortage.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resolve_stockout","href":"/api-reference/costing/close-a-shortage"},{"title":"Times a part was needed and not there, and what that cost.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /stockout_events","href":"/api-reference/costing/times-a-part-was-needed-and-not-there-and-what-that-cost"}]},{"group":"Access","pages":[{"title":"Every permission this deployment defines and this tenant has the module for, as module.resource.action.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /permission_catalogue","href":"/api-reference/access/every-permission-this-deployment-defines-and-this-tenant-has-the-module-for-as-moduleresourceaction"},{"title":"Roles with what they grant and who holds them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /role_settings","href":"/api-reference/access/roles-with-what-they-grant-and-who-holds-them"},{"title":"Add to role settings: Roles with what they grant and who holds them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /role_settings","href":"/api-reference/access/add-to-role-settings:-roles-with-what-they-grant-and-who-holds-them"},{"title":"Remove rows from role settings: Roles with what they grant and who holds them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /role_settings","href":"/api-reference/access/remove-rows-from-role-settings:-roles-with-what-they-grant-and-who-holds-them"},{"title":"Change rows in role settings: Roles with what they grant and who holds them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /role_settings","href":"/api-reference/access/change-rows-in-role-settings:-roles-with-what-they-grant-and-who-holds-them"},{"title":"Who can do what, and how widely. reaches_every_site is true when a user has no site grants, personal or through a role…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /user_access","href":"/api-reference/access/who-can-do-what-and-how-widely-reaches_every_site-is-true-when-a-user-has-no-site-grants-personal-or-through-a-role…"}]},{"group":"Readers","pages":[{"title":"Antennas, the place a read on each one means, and which of them have gone quiet.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reader_antennas","href":"/api-reference/readers/antennas-the-place-a-read-on-each-one-means-and-which-of-them-have-gone-quiet"},{"title":"Readers with how they are reached, whether they are reaching us, and what is in front of them now.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /readers","href":"/api-reference/readers/readers-with-how-they-are-reached-whether-they-are-reaching-us-and-what-is-in-front-of-them-now"},{"title":"The MQTT broker a reader or a sensor gateway can publish to instead of one the site runs: the host, the plaintext port…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/broker_connection","href":"/api-reference/readers/the-mqtt-broker-a-reader-or-a-sensor-gateway-can-publish-to-instead-of-one-the-site-runs:-the-host-the-plaintext-port…"},{"title":"Register a discovered tag against an asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/claim_unknown_tag","href":"/api-reference/readers/register-a-discovered-tag-against-an-asset"},{"title":"Add a reader and the device it is.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_reader","href":"/api-reference/readers/add-a-reader-and-the-device-it-is"},{"title":"Issue a key for one reader to carry in its own address.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_reader_key","href":"/api-reference/readers/issue-a-key-for-one-reader-to-carry-in-its-own-address"},{"title":"Stop listing a tag that is not ours.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/ignore_unknown_tag","href":"/api-reference/readers/stop-listing-a-tag-that-is-not-ours"},{"title":"What a map makes of a message, through the same mapper ingest uses.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_reader_mapping","href":"/api-reference/readers/what-a-map-makes-of-a-message-through-the-same-mapper-ingest-uses"},{"title":"A second origin a reader can post to, for a reader too old to complete a handshake with the web address: it accepts TLS…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reader_connection","href":"/api-reference/readers/a-second-origin-a-reader-can-post-to-for-a-reader-too-old-to-complete-a-handshake-with-the-web-address:-it-accepts-tls…"},{"title":"Post a reader's own messages, naming it by its code, and get back what they set off.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_reader_messages","href":"/api-reference/readers/post-a-readers-own-messages-naming-it-by-its-code-and-get-back-what-they-set-off"},{"title":"Save which fields of a reader's messages hold the tag, the antenna, the signal and the time.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_reader_mapping","href":"/api-reference/readers/save-which-fields-of-a-readers-messages-hold-the-tag-the-antenna-the-signal-and-the-time"},{"title":"Store the broker user name and password.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_reader_credential","href":"/api-reference/readers/store-the-broker-user-name-and-password"},{"title":"Feed messages to a reader by hand, to prove the whole path before any hardware is connected.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/simulate_reader_messages","href":"/api-reference/readers/feed-messages-to-a-reader-by-hand-to-prove-the-whole-path-before-any-hardware-is-connected"},{"title":"Where an asset has actually been seen, newest first — not where somebody last typed that it was.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/tag_history","href":"/api-reference/readers/where-an-asset-has-actually-been-seen-newest-first-—-not-where-somebody-last-typed-that-it-was"},{"title":"The individual reads, for the antennas asked to keep them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tag_observations","href":"/api-reference/readers/the-individual-reads-for-the-antennas-asked-to-keep-them"},{"title":"One row per visit — where a tag was, from when to when, and how long it stayed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tag_presences","href":"/api-reference/readers/one-row-per-visit-—-where-a-tag-was-from-when-to-when-and-how-long-it-stayed"},{"title":"Tags nothing knows about, most-seen first — the list a site works down to register what it owns.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /unknown_tags","href":"/api-reference/readers/tags-nothing-knows-about-most-seen-first-—-the-list-a-site-works-down-to-register-what-it-owns"}]},{"group":"Reference columns","pages":[{"title":"Every column a register may borrow from a record it references, ready for the column menu.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reference_columns","href":"/api-reference/reference-columns/every-column-a-register-may-borrow-from-a-record-it-references-ready-for-the-column-menu"},{"title":"Which read model a reference-typed custom field is answered from.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reference_entity_targets","href":"/api-reference/reference-columns/which-read-model-a-reference-typed-custom-field-is-answered-from"},{"title":"The ids a register may borrow from a record it references, kept because a report filter picks by them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reference_filter_keys","href":"/api-reference/reference-columns/the-ids-a-register-may-borrow-from-a-record-it-references-kept-because-a-report-filter-picks-by-them"},{"title":"The registers that offer lookup columns, and where their foreign keys live.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reference_registers","href":"/api-reference/reference-columns/the-registers-that-offer-lookup-columns-and-where-their-foreign-keys-live"},{"title":"Which record references each register offers to read through, one hop.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reference_sources","href":"/api-reference/reference-columns/which-record-references-each-register-offers-to-read-through-one-hop"},{"title":"The read models a reference may be followed into, and what not to offer from them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /reference_targets","href":"/api-reference/reference-columns/the-read-models-a-reference-may-be-followed-into-and-what-not-to-offer-from-them"},{"title":"A uuid, or null where the text is not one — so one bad answer cannot fail a page.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/as_uuid","href":"/api-reference/reference-columns/a-uuid-or-null-where-the-text-is-not-one-—-so-one-bad-answer-cannot-fail-a-page"},{"title":"One referenced record as jsonb, under the reader's own RLS.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reference_record","href":"/api-reference/reference-columns/one-referenced-record-as-jsonb-under-the-readers-own-rls"}]},{"group":"Reports","pages":[{"title":"Saved reports the caller may open: their own, their roles' and sites', and the organisation's, less any in a module the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /report_definitions","href":"/api-reference/reports/saved-reports-the-caller-may-open:-their-own-their-roles-and-sites-and-the-organisations-less-any-in-a-module-the…"},{"title":"Add to report definitions: Saved reports the caller may open: their own, their roles' and sites', and the organisation's, less any in a module the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /report_definitions","href":"/api-reference/reports/add-to-report-definitions:-saved-reports-the-caller-may-open:-their-own-their-roles-and-sites-and-the-organisations-less-any-in-a-module-the…"},{"title":"Remove rows from report definitions: Saved reports the caller may open: their own, their roles' and sites', and the organisation's, less any in a module the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /report_definitions","href":"/api-reference/reports/remove-rows-from-report-definitions:-saved-reports-the-caller-may-open:-their-own-their-roles-and-sites-and-the-organisations-less-any-in-a-module-the…"},{"title":"Change rows in report definitions: Saved reports the caller may open: their own, their roles' and sites', and the organisation's, less any in a module the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /report_definitions","href":"/api-reference/reports/change-rows-in-report-definitions:-saved-reports-the-caller-may-open:-their-own-their-roles-and-sites-and-the-organisations-less-any-in-a-module-the…"},{"title":"Every run of the caller's own report schedules (of every schedule, for an administrator), whose access answered it, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /report_deliveries","href":"/api-reference/reports/every-run-of-the-callers-own-report-schedules-of-every-schedule-for-an-administrator-whose-access-answered-it-and…"},{"title":"The caller's own report schedules (every schedule, for an administrator): when each goes out, to whom, when it is next…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /report_schedules","href":"/api-reference/reports/the-callers-own-report-schedules-every-schedule-for-an-administrator:-when-each-goes-out-to-whom-when-it-is-next…"},{"title":"The roles and sites a shared report is for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /report_shares","href":"/api-reference/reports/the-roles-and-sites-a-shared-report-is-for"},{"title":"The three assertions a reader-less run has instead of a caller to be, and the one about the delivery still being due.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/check_delivery_session","href":"/api-reference/reports/the-three-assertions-a-reader-less-run-has-instead-of-a-caller-to-be-and-the-one-about-the-delivery-still-being-due"},{"title":"Retire a report and any schedule of it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_report","href":"/api-reference/reports/retire-a-report-and-any-schedule-of-it"},{"title":"Stop a schedule.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_report_schedule","href":"/api-reference/reports/stop-a-schedule"},{"title":"The report modules the caller may view, create, edit, export and share in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/my_report_modules","href":"/api-reference/reports/the-report-modules-the-caller-may-view-create-edit-export-and-share-in"},{"title":"Record that a report was run, for the last-run column.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/note_report_run","href":"/api-reference/reports/record-that-a-report-was-run-for-the-last-run-column"},{"title":"Run a report definition that has not been saved, as the caller and through their own access, and answer with the same…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_report","href":"/api-reference/reports/run-a-report-definition-that-has-not-been-saved-as-the-caller-and-through-their-own-access-and-answer-with-the-same…"},{"title":"Publish a report so a schedule may send it, or take it back to draft.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_report","href":"/api-reference/reports/publish-a-report-so-a-schedule-may-send-it-or-take-it-back-to-draft"},{"title":"The values one column of a report source holds, where there are few enough of them to pick from.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/report_column_values","href":"/api-reference/reports/the-values-one-column-of-a-report-source-holds-where-there-are-few-enough-of-them-to-pick-from"},{"title":"What one report source offers: every column, the name to show for it, what kind of value it holds, whether it is…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/report_columns","href":"/api-reference/reports/what-one-report-source-offers:-every-column-the-name-to-show-for-it-what-kind-of-value-it-holds-whether-it-is…"},{"title":"What each column of a report source holds: the kind of value, the vocabulary a CHECK constraint fixes, the register a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/report_field_choices","href":"/api-reference/reports/what-each-column-of-a-report-source-holds:-the-kind-of-value-the-vocabulary-a-check-constraint-fixes-the-register-a…"},{"title":"What one of a report's opening filters may be set to, narrowed by the values of the filters above it: business units…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/report_filter_options","href":"/api-reference/reports/what-one-of-a-reports-opening-filters-may-be-set-to-narrowed-by-the-values-of-the-filters-above-it:-business-units…"},{"title":"One report compiled: the statement, the columns it will produce, and what had to be left out.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/report_plan","href":"/api-reference/reports/one-report-compiled:-the-statement-the-columns-it-will-produce-and-what-had-to-be-left-out"},{"title":"Every saved report with the roles it is shared with, including reports shared with roles the caller does not hold.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/report_role_access","href":"/api-reference/reports/every-saved-report-with-the-roles-it-is-shared-with-including-reports-shared-with-roles-the-caller-does-not-hold"},{"title":"The api views a report may read, each with the name the product uses for it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/report_sources","href":"/api-reference/reports/the-api-views-a-report-may-read-each-with-the-name-the-product-uses-for-it"},{"title":"Run a saved report as the caller, so RLS decides what comes back.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_report","href":"/api-reference/reports/run-a-saved-report-as-the-caller-so-rls-decides-what-comes-back"},{"title":"Run a saved report as the caller and answer with the whole table: ordered columns, their headings, the group levels…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_report_grid","href":"/api-reference/reports/run-a-saved-report-as-the-caller-and-answer-with-the-whole-table:-ordered-columns-their-headings-the-group-levels…"},{"title":"Run a scheduled report as its author and answer with the whole table — the shape a spreadsheet is written from.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_report_grid_for_delivery","href":"/api-reference/reports/run-a-scheduled-report-as-its-author-and-answer-with-the-whole-table-—-the-shape-a-spreadsheet-is-written-from"},{"title":"Create or amend a saved report and the audience it is for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_report","href":"/api-reference/reports/create-or-amend-a-saved-report-and-the-audience-it-is-for"},{"title":"Create or amend a report schedule.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_report_schedule","href":"/api-reference/reports/create-or-amend-a-report-schedule"},{"title":"Set which roles see a saved report: everyone, the roles named, or nobody but its author when none are named.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_report_roles","href":"/api-reference/reports/set-which-roles-see-a-saved-report:-everyone-the-roles-named-or-nobody-but-its-author-when-none-are-named"},{"title":"One level of the work order explorer: the groups below where the reader has got to, with each group's work order counts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/work_order_drilldown","href":"/api-reference/reports/one-level-of-the-work-order-explorer:-the-groups-below-where-the-reader-has-got-to-with-each-groups-work-order-counts"},{"title":"The work orders behind one row of the work order explorer, with each SLA clock read as MET, BREACHED or RUNNING.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/work_order_drilldown_rows","href":"/api-reference/reports/the-work-orders-behind-one-row-of-the-work-order-explorer-with-each-sla-clock-read-as-met-breached-or-running"},{"title":"Each time a work order was raised and each time one was closed, one row apiece, dated when it happened.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_activity","href":"/api-reference/reports/each-time-a-work-order-was-raised-and-each-time-one-was-closed-one-row-apiece-dated-when-it-happened"},{"title":"Each technician on each work order, one row per current assignment, with the role they hold on it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /worker_tickets","href":"/api-reference/reports/each-technician-on-each-work-order-one-row-per-current-assignment-with-the-role-they-hold-on-it"}]},{"group":"Work configuration","pages":[{"title":"Request categories with the triage defaults they suggest.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /request_category_settings","href":"/api-reference/work-configuration/request-categories-with-the-triage-defaults-they-suggest"},{"title":"What each reported severity suggests on this organisation's priority ladder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /request_severity_priorities","href":"/api-reference/work-configuration/what-each-reported-severity-suggests-on-this-organisations-priority-ladder"},{"title":"Where requests arrive from, with how many came by each route.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /request_source_settings","href":"/api-reference/work-configuration/where-requests-arrive-from-with-how-many-came-by-each-route"},{"title":"Add to request source settings: Where requests arrive from, with how many came by each route.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /request_source_settings","href":"/api-reference/work-configuration/add-to-request-source-settings:-where-requests-arrive-from-with-how-many-came-by-each-route"},{"title":"Remove rows from request source settings: Where requests arrive from, with how many came by each route.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /request_source_settings","href":"/api-reference/work-configuration/remove-rows-from-request-source-settings:-where-requests-arrive-from-with-how-many-came-by-each-route"},{"title":"Change rows in request source settings: Where requests arrive from, with how many came by each route.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /request_source_settings","href":"/api-reference/work-configuration/change-rows-in-request-source-settings:-where-requests-arrive-from-with-how-many-came-by-each-route"},{"title":"Say which categories and sites a priority is offered for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_priority_scope","href":"/api-reference/work-configuration/say-which-categories-and-sites-a-priority-is-offered-for"},{"title":"Say which categories, sites and roles a work order type is offered for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_type_scope","href":"/api-reference/work-configuration/say-which-categories-sites-and-roles-a-work-order-type-is-offered-for"},{"title":"The SLA ladder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_priority_settings","href":"/api-reference/work-configuration/the-sla-ladder"},{"title":"Add to work priority settings: The SLA ladder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /work_priority_settings","href":"/api-reference/work-configuration/add-to-work-priority-settings:-the-sla-ladder"},{"title":"Remove rows from work priority settings: The SLA ladder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /work_priority_settings","href":"/api-reference/work-configuration/remove-rows-from-work-priority-settings:-the-sla-ladder"},{"title":"Change rows in work priority settings: The SLA ladder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /work_priority_settings","href":"/api-reference/work-configuration/change-rows-in-work-priority-settings:-the-sla-ladder"},{"title":"Resolution codes with how often each has actually been chosen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_resolution_settings","href":"/api-reference/work-configuration/resolution-codes-with-how-often-each-has-actually-been-chosen"},{"title":"Add to work resolution settings: Resolution codes with how often each has actually been chosen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /work_resolution_settings","href":"/api-reference/work-configuration/add-to-work-resolution-settings:-resolution-codes-with-how-often-each-has-actually-been-chosen"},{"title":"Remove rows from work resolution settings: Resolution codes with how often each has actually been chosen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /work_resolution_settings","href":"/api-reference/work-configuration/remove-rows-from-work-resolution-settings:-resolution-codes-with-how-often-each-has-actually-been-chosen"},{"title":"Change rows in work resolution settings: Resolution codes with how often each has actually been chosen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /work_resolution_settings","href":"/api-reference/work-configuration/change-rows-in-work-resolution-settings:-resolution-codes-with-how-often-each-has-actually-been-chosen"},{"title":"Work order types, with the semantic flags every reliability metric reads.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_type_settings","href":"/api-reference/work-configuration/work-order-types-with-the-semantic-flags-every-reliability-metric-reads"}]},{"group":"Work lifecycle","pages":[{"title":"The assignee accepts the job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/accept_work_order","href":"/api-reference/work-lifecycle/the-assignee-accepts-the-job"},{"title":"Add an item to a work order: a description and a quantity, not linked to parts or stock.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_work_order_item","href":"/api-reference/work-lifecycle/add-an-item-to-a-work-order:-a-description-and-a-quantity-not-linked-to-parts-or-stock"},{"title":"Add a person to a job as support, beside whoever already holds it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_work_order_support","href":"/api-reference/work-lifecycle/add-a-person-to-a-job-as-support-beside-whoever-already-holds-it"},{"title":"Add a step to a job's checklist.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_work_order_task","href":"/api-reference/work-lifecycle/add-a-step-to-a-jobs-checklist"},{"title":"Give a job to a crew, to a person, or to one of a crew's people — the crew keeps it and the person is the one going.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assign_work_order","href":"/api-reference/work-lifecycle/give-a-job-to-a-crew-to-a-person-or-to-one-of-a-crews-people-—-the-crew-keeps-it-and-the-person-is-the-one-going"},{"title":"Send a job out to a supplier, with what they are being asked to do.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assign_work_order_to_vendor","href":"/api-reference/work-lifecycle/send-a-job-out-to-a-supplier-with-what-they-are-being-asked-to-do"},{"title":"What a triage screen may offer for this request, and why an option is blocked.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/available_request_transitions","href":"/api-reference/work-lifecycle/what-a-triage-screen-may-offer-for-this-request-and-why-an-option-is-blocked"},{"title":"Which statuses this job may move to next, and what each would require. from_status is the one it is leaving, because…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/available_transitions","href":"/api-reference/work-lifecycle/which-statuses-this-job-may-move-to-next-and-what-each-would-require-from_status-is-the-one-it-is-leaving-because…"},{"title":"Hand many jobs to one person, one crew, or one supplier.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_assign_work_orders","href":"/api-reference/work-lifecycle/hand-many-jobs-to-one-person-one-crew-or-one-supplier"},{"title":"Classify a selection of reports in one act.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_categorize_work_requests","href":"/api-reference/work-lifecycle/classify-a-selection-of-reports-in-one-act"},{"title":"Turn a selection of triaged reports into work orders, and say which job each became.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_convert_work_requests","href":"/api-reference/work-lifecycle/turn-a-selection-of-triaged-reports-into-work-orders-and-say-which-job-each-became"},{"title":"Delete many jobs in one call, each moved to whichever state its own model uses for a deleted job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_delete_work_orders","href":"/api-reference/work-lifecycle/delete-many-jobs-in-one-call-each-moved-to-whichever-state-its-own-model-uses-for-a-deleted-job"},{"title":"Fold a flood of duplicate reports into the one that survives.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_merge_work_requests","href":"/api-reference/work-lifecycle/fold-a-flood-of-duplicate-reports-into-the-one-that-survives"},{"title":"Refuse a selection of requests, with the one reason every requester will read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_reject_work_requests","href":"/api-reference/work-lifecycle/refuse-a-selection-of-requests-with-the-one-reason-every-requester-will-read"},{"title":"Move the planned start or due date of many jobs at once.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_reschedule_work_orders","href":"/api-reference/work-lifecycle/move-the-planned-start-or-due-date-of-many-jobs-at-once"},{"title":"Change the priority of many jobs at once.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_set_work_order_priority","href":"/api-reference/work-lifecycle/change-the-priority-of-many-jobs-at-once"},{"title":"Move many jobs to the same status in one call.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_transition_work_orders","href":"/api-reference/work-lifecycle/move-many-jobs-to-the-same-status-in-one-call"},{"title":"Move many requests to the same status, through the tenant's own state model.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_transition_work_requests","href":"/api-reference/work-lifecycle/move-many-requests-to-the-same-status-through-the-tenants-own-state-model"},{"title":"Abandon a job, with the reason.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_work_order","href":"/api-reference/work-lifecycle/abandon-a-job-with-the-reason"},{"title":"Say what kind of problem a report is.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/categorize_work_request","href":"/api-reference/work-lifecycle/say-what-kind-of-problem-a-report-is"},{"title":"Clock on to a job, as the caller's own worker or, lacking one, as the caller's own account.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/check_in_work_order","href":"/api-reference/work-lifecycle/clock-on-to-a-job-as-the-callers-own-worker-or-lacking-one-as-the-callers-own-account"},{"title":"Clock off. duration_minutes is generated from the two timestamps.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/check_out_work_order","href":"/api-reference/work-lifecycle/clock-off-duration_minutes-is-generated-from-the-two-timestamps"},{"title":"Close a completed job, after whatever review the tenant requires.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/close_work_order","href":"/api-reference/work-lifecycle/close-a-completed-job-after-whatever-review-the-tenant-requires"},{"title":"Answer one item on a job's checklist.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/complete_task","href":"/api-reference/work-lifecycle/answer-one-item-on-a-jobs-checklist"},{"title":"Answer many of a job's steps in one request — what a column pasted into the checklist grid sends.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/complete_tasks","href":"/api-reference/work-lifecycle/answer-many-of-a-jobs-steps-in-one-request-—-what-a-column-pasted-into-the-checklist-grid-sends"},{"title":"The work is done, with what was found and whether it was fixed first time.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/complete_work_order","href":"/api-reference/work-lifecycle/the-work-is-done-with-what-was-found-and-whether-it-was-fixed-first-time"},{"title":"Turn a triaged request into a work order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/convert_work_request","href":"/api-reference/work-lifecycle/turn-a-triaged-request-into-a-work-order"},{"title":"Raise a job with no request behind it — a breakdown somebody is standing in front of.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_work_order","href":"/api-reference/work-lifecycle/raise-a-job-with-no-request-behind-it-—-a-breakdown-somebody-is-standing-in-front-of"},{"title":"Raise a request against an asset, or against nothing in particular.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_work_request","href":"/api-reference/work-lifecycle/raise-a-request-against-an-asset-or-against-nothing-in-particular"},{"title":"Accept or reject what a supplier says is owed for a job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decide_vendor_invoice","href":"/api-reference/work-lifecycle/accept-or-reject-what-a-supplier-says-is-owed-for-a-job"},{"title":"Agree or refuse a supplier's price.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/decide_vendor_quote","href":"/api-reference/work-lifecycle/agree-or-refuse-a-suppliers-price"},{"title":"The assignee turns the job down, saying why.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/deny_work_order","href":"/api-reference/work-lifecycle/the-assignee-turns-the-job-down-saying-why"},{"title":"Record hours against a job, at a rate type.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/log_labour","href":"/api-reference/work-lifecycle/record-hours-against-a-job-at-a-rate-type"},{"title":"Fold a duplicate request into the one it duplicates.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/merge_work_request","href":"/api-reference/work-lifecycle/fold-a-duplicate-request-into-the-one-it-duplicates"},{"title":"Record who the supplier is sending to a job, in their own words.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/name_vendor_technician","href":"/api-reference/work-lifecycle/record-who-the-supplier-is-sending-to-a-job-in-their-own-words"},{"title":"Stop the clock, with the reason it stopped.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/pause_work_order","href":"/api-reference/work-lifecycle/stop-the-clock-with-the-reason-it-stopped"},{"title":"What a job raised now would be given as its due date: the resolution target from the asset's contract, the matching SLA…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_work_order_due_at","href":"/api-reference/work-lifecycle/what-a-job-raised-now-would-be-given-as-its-due-date:-the-resolution-target-from-the-assets-contract-the-matching-sla…"},{"title":"What priority a job would get if raised now with this type, at this site, against an asset of this category — the same…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_work_order_priority","href":"/api-reference/work-lifecycle/what-priority-a-job-would-get-if-raised-now-with-this-type-at-this-site-against-an-asset-of-this-category-—-the-same…"},{"title":"The response and resolution targets a job would be given if raised now at this priority — from the asset's contract…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/preview_work_order_sla","href":"/api-reference/work-lifecycle/the-response-and-resolution-targets-a-job-would-be-given-if-raised-now-at-this-priority-—-from-the-assets-contract…"},{"title":"Say that a line a supplier described in their own words is a part this plant stocks .","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/recognise_invoice_part","href":"/api-reference/work-lifecycle/say-that-a-line-a-supplier-described-in-their-own-words-is-a-part-this-plant-stocks-"},{"title":"Refuse a request, with the reason the requester will read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reject_work_request","href":"/api-reference/work-lifecycle/refuse-a-request-with-the-reason-the-requester-will-read"},{"title":"Carried out when a raised job's approval is granted: the job is freed, and given to whoever it was raised for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/release_work_order","href":"/api-reference/work-lifecycle/carried-out-when-a-raised-jobs-approval-is-granted:-the-job-is-freed-and-given-to-whoever-it-was-raised-for"},{"title":"Take an item off a work order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_work_order_item","href":"/api-reference/work-lifecycle/take-an-item-off-a-work-order"},{"title":"Take a step off a job's checklist.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_work_order_task","href":"/api-reference/work-lifecycle/take-a-step-off-a-jobs-checklist"},{"title":"Ask for a code to be sent to whoever raised this job, before closing it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_close_otp","href":"/api-reference/work-lifecycle/ask-for-a-code-to-be-sent-to-whoever-raised-this-job-before-closing-it"},{"title":"Ask for a job's deadline to be moved later, and move it if that is granted.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_sla_extension","href":"/api-reference/work-lifecycle/ask-for-a-jobs-deadline-to-be-moved-later-and-move-it-if-that-is-granted"},{"title":"Ask the supplier already on a job what they will charge for it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_vendor_quote","href":"/api-reference/work-lifecycle/ask-the-supplier-already-on-a-job-what-they-will-charge-for-it"},{"title":"Refuses unless the item exists and is on this work order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_work_order_item_on","href":"/api-reference/work-lifecycle/refuses-unless-the-item-exists-and-is-on-this-work-order"},{"title":"Refuses unless the caller may change the items on this work order: the edit permission, a job they may write, and a job…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/require_work_order_items_write","href":"/api-reference/work-lifecycle/refuses-unless-the-caller-may-change-the-items-on-this-work-order:-the-edit-permission-a-job-they-may-write-and-a-job…"},{"title":"Move a job's planned start, its due date, or both.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reschedule_work_order","href":"/api-reference/work-lifecycle/move-a-jobs-planned-start-its-due-date-or-both"},{"title":"Start the clock again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resume_work_order","href":"/api-reference/work-lifecycle/start-the-clock-again"},{"title":"Say who is kept informed of this job without being assigned to it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_work_order_cc","href":"/api-reference/work-lifecycle/say-who-is-kept-informed-of-this-job-without-being-assigned-to-it"},{"title":"Record what failed on a job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_work_order_failure_code","href":"/api-reference/work-lifecycle/record-what-failed-on-a-job"},{"title":"Change a job's priority, with the reason it changed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_work_order_priority","href":"/api-reference/work-lifecycle/change-a-jobs-priority-with-the-reason-it-changed"},{"title":"Record how a job was put right, from the organisation's own list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_work_order_resolution_code","href":"/api-reference/work-lifecycle/record-how-a-job-was-put-right-from-the-organisations-own-list"},{"title":"Work has begun.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/start_work_order","href":"/api-reference/work-lifecycle/work-has-begun"},{"title":"What a supplier says is owed for a job with no order above it: the parts they fitted, the hours they worked, and what…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_vendor_invoice","href":"/api-reference/work-lifecycle/what-a-supplier-says-is-owed-for-a-job-with-no-order-above-it:-the-parts-they-fitted-the-hours-they-worked-and-what…"},{"title":"A supplier's price for a job — answering a request, or volunteering one on work that turned out worse than its scope.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_vendor_quote","href":"/api-reference/work-lifecycle/a-suppliers-price-for-a-job-—-answering-a-request-or-volunteering-one-on-work-that-turned-out-worse-than-its-scope"},{"title":"Move a job to another status, through the tenant's own state model.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/transition_work_order","href":"/api-reference/work-lifecycle/move-a-job-to-another-status-through-the-tenants-own-state-model"},{"title":"Move a request to another status, through the tenant's own state model.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/transition_work_request","href":"/api-reference/work-lifecycle/move-a-request-to-another-status-through-the-tenants-own-state-model"},{"title":"Correct what a job says about itself — its title, what is known, the machine it is against, whether it needs a permit.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_work_order","href":"/api-reference/work-lifecycle/correct-what-a-job-says-about-itself-—-its-title-what-is-known-the-machine-it-is-against-whether-it-needs-a-permit"},{"title":"Change what an item on a work order says, or how many.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_work_order_item","href":"/api-reference/work-lifecycle/change-what-an-item-on-a-work-order-says-or-how-many"},{"title":"Confirm the code sent to close a job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/verify_close_otp","href":"/api-reference/work-lifecycle/confirm-the-code-sent-to-close-a-job"},{"title":"Take a live quote off the table: a buyer retracting a request nobody has priced, or a supplier pulling a price they…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/withdraw_vendor_quote","href":"/api-reference/work-lifecycle/take-a-live-quote-off-the-table:-a-buyer-retracting-a-request-nobody-has-priced-or-a-supplier-pulling-a-price-they…"}]},{"group":"Permits","pages":[{"title":"Take a permit on as the person in charge of the work.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/accept_work_permit","href":"/api-reference/permits/take-a-permit-on-as-the-person-in-charge-of-the-work"},{"title":"Record that a lock, blank or spade has actually gone on, and who put it there.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/apply_permit_isolation","href":"/api-reference/permits/record-that-a-lock-blank-or-spade-has-actually-gone-on-and-who-put-it-there"},{"title":"Archive a permit that never ran or has been handed back.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/archive_work_permit","href":"/api-reference/permits/archive-a-permit-that-never-ran-or-has-been-handed-back"},{"title":"Call a permit off.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_work_permit","href":"/api-reference/permits/call-a-permit-off"},{"title":"Hand a permit back and record the state the area was left in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/close_work_permit","href":"/api-reference/permits/hand-a-permit-back-and-record-the-state-the-area-was-left-in"},{"title":"Record that a precaution has been checked, by whom, and what was read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/confirm_permit_precaution","href":"/api-reference/permits/record-that-a-precaution-has-been-checked-by-whom-and-what-was-read"},{"title":"Draft a permit against a job or a shutdown.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_work_permit","href":"/api-reference/permits/draft-a-permit-against-a-job-or-a-shutdown"},{"title":"Sign a permit out.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/issue_work_permit","href":"/api-reference/permits/sign-a-permit-out"},{"title":"Take somebody off a draft permit.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_permit_crew","href":"/api-reference/permits/take-somebody-off-a-draft-permit"},{"title":"Record that an isolation has been taken off, with who took it and when.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_permit_isolation","href":"/api-reference/permits/record-that-an-isolation-has-been-taken-off-with-who-took-it-and-when"},{"title":"Put a stood-down permit back in force, if it has not run out in the meantime.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resume_work_permit","href":"/api-reference/permits/put-a-stood-down-permit-back-in-force-if-it-has-not-run-out-in-the-meantime"},{"title":"Put somebody on a draft permit — an employee, or a contractor with a name and a company.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_permit_crew","href":"/api-reference/permits/put-somebody-on-a-draft-permit-—-an-employee-or-a-contractor-with-a-name-and-a-company"},{"title":"Add or edit a line on a draft permit's isolation list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_permit_isolation","href":"/api-reference/permits/add-or-edit-a-line-on-a-draft-permits-isolation-list"},{"title":"Add or edit a condition of issue on a draft permit.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_permit_precaution","href":"/api-reference/permits/add-or-edit-a-condition-of-issue-on-a-draft-permit"},{"title":"Stand a live permit down without taking it back — the alarm, the weather, a condition that changed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/suspend_work_permit","href":"/api-reference/permits/stand-a-live-permit-down-without-taking-it-back-—-the-alarm-the-weather-a-condition-that-changed"},{"title":"Edit a permit that has not been issued yet.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_work_permit","href":"/api-reference/permits/edit-a-permit-that-has-not-been-issued-yet"},{"title":"Record that a job does not need the permit it asks for, and why.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/waive_permit_requirement","href":"/api-reference/permits/record-that-a-job-does-not-need-the-permit-it-asks-for-and-why"},{"title":"The sentence refusing the start of this job for want of a permit, or NULL where nothing does.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/work_order_permit_block","href":"/api-reference/permits/the-sentence-refusing-the-start-of-this-job-for-want-of-a-permit-or-null-where-nothing-does"},{"title":"One line per job for the printed pack: the permit in force, why there is none, or that none is needed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_permit_briefing","href":"/api-reference/permits/one-line-per-job-for-the-printed-pack:-the-permit-in-force-why-there-is-none-or-that-none-is-needed"},{"title":"Add to work order permit briefing: One line per job for the printed pack: the permit in force, why there is none, or that none is needed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /work_order_permit_briefing","href":"/api-reference/permits/add-to-work-order-permit-briefing:-one-line-per-job-for-the-printed-pack:-the-permit-in-force-why-there-is-none-or-that-none-is-needed"},{"title":"Remove rows from work order permit briefing: One line per job for the printed pack: the permit in force, why there is none, or that none is needed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /work_order_permit_briefing","href":"/api-reference/permits/remove-rows-from-work-order-permit-briefing:-one-line-per-job-for-the-printed-pack:-the-permit-in-force-why-there-is-none-or-that-none-is-needed"},{"title":"Change rows in work order permit briefing: One line per job for the printed pack: the permit in force, why there is none, or that none is needed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /work_order_permit_briefing","href":"/api-reference/permits/change-rows-in-work-order-permit-briefing:-one-line-per-job-for-the-printed-pack:-the-permit-in-force-why-there-is-none-or-that-none-is-needed"},{"title":"Every permit covering a job, directly or through its shutdown, live ones first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_permits","href":"/api-reference/permits/every-permit-covering-a-job-directly-or-through-its-shutdown-live-ones-first"},{"title":"Who each permit covers by name, employees and contractors alike.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_permit_crew","href":"/api-reference/permits/who-each-permit-covers-by-name-employees-and-contractors-alike"},{"title":"What each permit has locked off, with the lock number and who put it on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_permit_isolations","href":"/api-reference/permits/what-each-permit-has-locked-off-with-the-lock-number-and-who-put-it-on"},{"title":"The conditions of issue on each permit, and the reading that was taken to confirm one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_permit_precautions","href":"/api-reference/permits/the-conditions-of-issue-on-each-permit-and-the-reading-that-was-taken-to-confirm-one"},{"title":"The permit register: what each permit covers, how long it has left, and who signed it out.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_permits","href":"/api-reference/permits/the-permit-register:-what-each-permit-covers-how-long-it-has-left-and-who-signed-it-out"}]},{"group":"Work sequencing","pages":[{"title":"Record that somebody has picked an escalation up.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/acknowledge_escalation","href":"/api-reference/work-sequencing/record-that-somebody-has-picked-an-escalation-up"},{"title":"Make one job wait for another.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_work_order_dependency","href":"/api-reference/work-sequencing/make-one-job-wait-for-another"},{"title":"Drop a dependency between two jobs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_work_order_dependency","href":"/api-reference/work-sequencing/drop-a-dependency-between-two-jobs"},{"title":"Close an escalation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resolve_escalation","href":"/api-reference/work-sequencing/close-an-escalation"},{"title":"Record a review of a finished job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/review_work_order_closure","href":"/api-reference/work-sequencing/record-a-review-of-a-finished-job"},{"title":"Who signed a finished job off, and whether they were happy with it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_closure_reviews","href":"/api-reference/work-sequencing/who-signed-a-finished-job-off-and-whether-they-were-happy-with-it"},{"title":"Which jobs wait on which, and whether the thing being waited for is finished.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_dependencies","href":"/api-reference/work-sequencing/which-jobs-wait-on-which-and-whether-the-thing-being-waited-for-is-finished"},{"title":"Escalations raised on a job, and whether anybody has acknowledged one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_escalations","href":"/api-reference/work-sequencing/escalations-raised-on-a-job-and-whether-anybody-has-acknowledged-one"}]},{"group":"Workflow studio","pages":[{"title":"Name another authority that satisfies a step — a role (optionally narrowed to one of its members), a person, a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_node_approver","href":"/api-reference/workflow-studio/name-another-authority-that-satisfies-a-step-—-a-role-optionally-narrowed-to-one-of-its-members-a-person-a…"},{"title":"Connect one step to the next.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_workflow_edge","href":"/api-reference/workflow-studio/connect-one-step-to-the-next"},{"title":"Add a step to a draft.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_workflow_node","href":"/api-reference/workflow-studio/add-a-step-to-a-draft"},{"title":"Start a new workflow as a copy of an existing one, to change and then publish.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clone_workflow","href":"/api-reference/workflow-studio/start-a-new-workflow-as-a-copy-of-an-existing-one-to-change-and-then-publish"},{"title":"Start a workflow on an entity and action, with an empty draft to draw into.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_workflow","href":"/api-reference/workflow-studio/start-a-workflow-on-an-entity-and-action-with-an-empty-draft-to-draw-into"},{"title":"Stop an authority from satisfying a step.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_node_approver","href":"/api-reference/workflow-studio/stop-an-authority-from-satisfying-a-step"},{"title":"Stop a step asking about a field.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_node_field","href":"/api-reference/workflow-studio/stop-a-step-asking-about-a-field"},{"title":"Delete a workflow that has never held a request.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_workflow","href":"/api-reference/workflow-studio/delete-a-workflow-that-has-never-held-a-request"},{"title":"Disconnect two steps on a draft.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_workflow_edge","href":"/api-reference/workflow-studio/disconnect-two-steps-on-a-draft"},{"title":"Remove a step from a draft, with the connections into and out of it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_workflow_node","href":"/api-reference/workflow-studio/remove-a-step-from-a-draft-with-the-connections-into-and-out-of-it"},{"title":"Open an editable copy of the published chain, or return the draft already open.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/draft_workflow_version","href":"/api-reference/workflow-studio/open-an-editable-copy-of-the-published-chain-or-return-the-draft-already-open"},{"title":"Make a draft the live chain, after checking it can actually be walked.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_workflow_version","href":"/api-reference/workflow-studio/make-a-draft-the-live-chain-after-checking-it-can-actually-be-walked"},{"title":"Set when a workflow holds a request at all.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_workflow_condition","href":"/api-reference/workflow-studio/set-when-a-workflow-holds-a-request-at-all"},{"title":"Say that a step asks about a field, whether it may also change it, and to which values.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_node_field","href":"/api-reference/workflow-studio/say-that-a-step-asks-about-a-field-whether-it-may-also-change-it-and-to-which-values"},{"title":"Tell whoever raised a request when each level of this draft approves it, or turn that off for every level at once.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_workflow_requester_notice","href":"/api-reference/workflow-studio/tell-whoever-raised-a-request-when-each-level-of-this-draft-approves-it-or-turn-that-off-for-every-level-at-once"},{"title":"Say which roles a workflow is eligible for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_workflow_roles","href":"/api-reference/workflow-studio/say-which-roles-a-workflow-is-eligible-for"},{"title":"The fields a step may ask its approver about, whether it may let them change each, and the values each takes where it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/step_field_choices","href":"/api-reference/workflow-studio/the-fields-a-step-may-ask-its-approver-about-whether-it-may-let-them-change-each-and-the-values-each-takes-where-it…"},{"title":"Walk a version against one record: whether its condition would run the chain at all, and which steps that chain reaches.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/try_workflow","href":"/api-reference/workflow-studio/walk-a-version-against-one-record:-whether-its-condition-would-run-the-chain-at-all-and-which-steps-that-chain-reaches"},{"title":"Rename a workflow, reorder it against the others on the same action, turn it on and off, or say whether its approvers…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_workflow","href":"/api-reference/workflow-studio/rename-a-workflow-reorder-it-against-the-others-on-the-same-action-turn-it-on-and-off-or-say-whether-its-approvers…"},{"title":"Edit a step on a draft — its name, how many signatures it wants, its deadline, and whether it reminds, escalates…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_workflow_node","href":"/api-reference/workflow-studio/edit-a-step-on-a-draft-—-its-name-how-many-signatures-it-wants-its-deadline-and-whether-it-reminds-escalates…"},{"title":"What of a workflow version would not come across if it were copied onto another entity, action or way of holding it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/workflow_copy_preview","href":"/api-reference/workflow-studio/what-of-a-workflow-version-would-not-come-across-if-it-were-copied-onto-another-entity-action-or-way-of-holding-it"},{"title":"Fields an approval chain's conditions may name: the held record's own, and — where the record being asked about is a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/workflow_field_choices","href":"/api-reference/workflow-studio/fields-an-approval-chains-conditions-may-name:-the-held-records-own-and-—-where-the-record-being-asked-about-is-a…"},{"title":"Entities and actions a workflow may be configured on, one row for each way the action can be held, and how many…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/workflow_targets","href":"/api-reference/workflow-studio/entities-and-actions-a-workflow-may-be-configured-on-one-row-for-each-way-the-action-can-be-held-and-how-many…"},{"title":"How a workflow version's steps connect, and in what order the steps come.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_edges","href":"/api-reference/workflow-studio/how-a-workflow-versions-steps-connect-and-in-what-order-the-steps-come"},{"title":"Who satisfies each step, one row per named authority.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_node_approvers","href":"/api-reference/workflow-studio/who-satisfies-each-step-one-row-per-named-authority"},{"title":"The fields a step asks its approver to look at, which of them it lets them change, and to what.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_node_fields","href":"/api-reference/workflow-studio/the-fields-a-step-asks-its-approver-to-look-at-which-of-them-it-lets-them-change-and-to-what"},{"title":"The steps of a workflow version, with who each waits for and how many signatures it wants.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_nodes","href":"/api-reference/workflow-studio/the-steps-of-a-workflow-version-with-who-each-waits-for-and-how-many-signatures-it-wants"},{"title":"Draft and published versions of each workflow, the condition each runs under, and what is running against them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /workflow_versions","href":"/api-reference/workflow-studio/draft-and-published-versions-of-each-workflow-the-condition-each-runs-under-and-what-is-running-against-them"}]},{"group":"Shutdown","pages":[{"title":"Add work orders to a shutdown's package, reporting the ones already in another shutdown rather than failing the batch.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_shutdown_work","href":"/api-reference/shutdown/add-work-orders-to-a-shutdowns-package-reporting-the-ones-already-in-another-shutdown-rather-than-failing-the-batch"},{"title":"Archive a shutdown.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/archive_shutdown","href":"/api-reference/shutdown/archive-a-shutdown"},{"title":"Call a shutdown off, with the reason the departments that planned around it will read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_shutdown","href":"/api-reference/shutdown/call-a-shutdown-off-with-the-reason-the-departments-that-planned-around-it-will-read"},{"title":"Plan a shutdown: the site that stops, the window it stops in, and what to call it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_shutdown","href":"/api-reference/shutdown/plan-a-shutdown:-the-site-that-stops-the-window-it-stops-in-and-what-to-call-it"},{"title":"Record that the plant is back on line, and say how much of the package was left open.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/finish_shutdown","href":"/api-reference/shutdown/record-that-the-plant-is-back-on-line-and-say-how-much-of-the-package-was-left-open"},{"title":"Fix a shutdown's work package.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/freeze_shutdown_scope","href":"/api-reference/shutdown/fix-a-shutdowns-work-package"},{"title":"Plan jobs into one of a shutdown's work windows, or take them back out of it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/plan_shutdown_work","href":"/api-reference/shutdown/plan-jobs-into-one-of-a-shutdowns-work-windows-or-take-them-back-out-of-it"},{"title":"Remove a milestone from a shutdown.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_shutdown_milestone","href":"/api-reference/shutdown/remove-a-milestone-from-a-shutdown"},{"title":"Take a line out of a shutdown's scope.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_shutdown_scope","href":"/api-reference/shutdown/take-a-line-out-of-a-shutdowns-scope"},{"title":"Remove a work window, saying how many jobs were planned into it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_shutdown_window","href":"/api-reference/shutdown/remove-a-work-window-saying-how-many-jobs-were-planned-into-it"},{"title":"Take work out of a shutdown's package.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_shutdown_work","href":"/api-reference/shutdown/take-work-out-of-a-shutdowns-package"},{"title":"Add, edit or tick off one of a shutdown's dated gates.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_shutdown_milestone","href":"/api-reference/shutdown/add-edit-or-tick-off-one-of-a-shutdowns-dated-gates"},{"title":"Add or edit one line of what a shutdown takes off line.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_shutdown_scope","href":"/api-reference/shutdown/add-or-edit-one-line-of-what-a-shutdown-takes-off-line"},{"title":"Add or edit one of a shutdown's work windows.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_shutdown_window","href":"/api-reference/shutdown/add-or-edit-one-of-a-shutdowns-work-windows"},{"title":"The critical path through a shutdown's package, in minutes from the start of the plan, with the float on every job that…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/shutdown_critical_path","href":"/api-reference/shutdown/the-critical-path-through-a-shutdowns-package-in-minutes-from-the-start-of-the-plan-with-the-float-on-every-job-that…"},{"title":"Parts, tools, permits, people and vendors across a shutdown's package: how many are asked for, how many are answered…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/shutdown_readiness","href":"/api-reference/shutdown/parts-tools-permits-people-and-vendors-across-a-shutdowns-package:-how-many-are-asked-for-how-many-are-answered…"},{"title":"Record that the plant has actually stopped, freezing the scope if nobody had.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/start_shutdown","href":"/api-reference/shutdown/record-that-the-plant-has-actually-stopped-freezing-the-scope-if-nobody-had"},{"title":"Edit a shutdown's plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_shutdown","href":"/api-reference/shutdown/edit-a-shutdowns-plan"},{"title":"The dated gates a shutdown is run against, and which of them are past due unmet.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /shutdown_milestones","href":"/api-reference/shutdown/the-dated-gates-a-shutdown-is-run-against-and-which-of-them-are-past-due-unmet"},{"title":"The jobs in a shutdown, with each one's permit, its outstanding requirements and what it waits on inside the package.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /shutdown_package","href":"/api-reference/shutdown/the-jobs-in-a-shutdown-with-each-ones-permit-its-outstanding-requirements-and-what-it-waits-on-inside-the-package"},{"title":"What each shutdown takes off line, and how much work is planned against it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /shutdown_scope","href":"/api-reference/shutdown/what-each-shutdown-takes-off-line-and-how-much-work-is-planned-against-it"},{"title":"The intervals inside a shutdown that work can be planned into, with how much is in each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /shutdown_windows","href":"/api-reference/shutdown/the-intervals-inside-a-shutdown-that-work-can-be-planned-into-with-how-much-is-in-each"},{"title":"The shutdown register, each row carrying its own readiness and whether its critical path fits the window it is planned…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /shutdowns","href":"/api-reference/shutdown/the-shutdown-register-each-row-carrying-its-own-readiness-and-whether-its-critical-path-fits-the-window-it-is-planned…"}]},{"group":"Statuses and transitions","pages":[{"title":"Add a status to a register's state model.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_state","href":"/api-reference/statuses-and-transitions/add-a-status-to-a-registers-state-model"},{"title":"Allow a move from one status to another, with what it requires.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_transition","href":"/api-reference/statuses-and-transitions/allow-a-move-from-one-status-to-another-with-what-it-requires"},{"title":"Say that a move collects an answer before it is made.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_transition_prompt","href":"/api-reference/statuses-and-transitions/say-that-a-move-collects-an-answer-before-it-is-made"},{"title":"Say which lifecycle new records are born into at a site or business unit, for a type of record, or for both.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assign_state_model","href":"/api-reference/statuses-and-transitions/say-which-lifecycle-new-records-are-born-into-at-a-site-or-business-unit-for-a-type-of-record-or-for-both"},{"title":"Say which lifecycle new records are born into across several sites, business units and types at once.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assign_state_model_many","href":"/api-reference/statuses-and-transitions/say-which-lifecycle-new-records-are-born-into-across-several-sites-business-units-and-types-at-once"},{"title":"Re-file a set of work requests, maintenance plans, inspections, contracts, vendors, purchase requests, purchase orders…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_move_records_to_state_model","href":"/api-reference/statuses-and-transitions/re-file-a-set-of-work-requests-maintenance-plans-inspections-contracts-vendors-purchase-requests-purchase-orders…"},{"title":"Re-file a set of work orders into another lifecycle, each from the status it is in now, by the mapping given.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/bulk_move_to_state_model","href":"/api-reference/statuses-and-transitions/re-file-a-set-of-work-orders-into-another-lifecycle-each-from-the-status-it-is-in-now-by-the-mapping-given"},{"title":"Start a new lifecycle for a register as a copy of one it already runs: the default one when no source is named.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_state_model","href":"/api-reference/statuses-and-transitions/start-a-new-lifecycle-for-a-register-as-a-copy-of-one-it-already-runs:-the-default-one-when-no-source-is-named"},{"title":"Remove a status.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_state","href":"/api-reference/statuses-and-transitions/remove-a-status"},{"title":"Remove a lifecycle that is not the default, is assigned nowhere and has never held a record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_state_model","href":"/api-reference/statuses-and-transitions/remove-a-lifecycle-that-is-not-the-default-is-assigned-nowhere-and-has-never-held-a-record"},{"title":"Remove a transition.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_transition","href":"/api-reference/statuses-and-transitions/remove-a-transition"},{"title":"Move the open records of one lifecycle into another, within a site or business unit and a type, or say what that would…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/move_to_state_model","href":"/api-reference/statuses-and-transitions/move-the-open-records-of-one-lifecycle-into-another-within-a-site-or-business-unit-and-a-type-or-say-what-that-would…"},{"title":"Stop a move asking for something.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_transition_prompt","href":"/api-reference/statuses-and-transitions/stop-a-move-asking-for-something"},{"title":"Say whether the assignee accepts a job in this status without it moving.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_accept_in_place","href":"/api-reference/statuses-and-transitions/say-whether-the-assignee-accepts-a-job-in-this-status-without-it-moving"},{"title":"Say which status a new record starts in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_initial_state","href":"/api-reference/statuses-and-transitions/say-which-status-a-new-record-starts-in"},{"title":"Mark an asset move as the one a booking makes when it hands the asset over (CHECKOUT) or takes it back (RETURN) from…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_transition_booking_event","href":"/api-reference/statuses-and-transitions/mark-an-asset-move-as-the-one-a-booking-makes-when-it-hands-the-asset-over-checkout-or-takes-it-back-return-from…"},{"title":"Mark a work order move as the assignee's Accept or Deny from its status, or as neither.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_transition_decision","href":"/api-reference/statuses-and-transitions/mark-a-work-order-move-as-the-assignees-accept-or-deny-from-its-status-or-as-neither"},{"title":"Say which roles may make a move, replacing whatever was there.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_transition_roles","href":"/api-reference/statuses-and-transitions/say-which-roles-may-make-a-move-replacing-whatever-was-there"},{"title":"The lifecycle a new record of this register would be born into at this site and for this type of record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/state_model_for","href":"/api-reference/statuses-and-transitions/the-lifecycle-a-new-record-of-this-register-would-be-born-into-at-this-site-and-for-this-type-of-record"},{"title":"How many records are sitting in each status now.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/state_occupancy","href":"/api-reference/statuses-and-transitions/how-many-records-are-sitting-in-each-status-now"},{"title":"Standard columns and custom fields a condition about this kind of record may name, each with what it holds.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/transition_field_choices","href":"/api-reference/statuses-and-transitions/standard-columns-and-custom-fields-a-condition-about-this-kind-of-record-may-name-each-with-what-it-holds"},{"title":"Remove an assignment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unassign_state_model","href":"/api-reference/statuses-and-transitions/remove-an-assignment"},{"title":"Remove several assignments at once.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unassign_state_models","href":"/api-reference/statuses-and-transitions/remove-several-assignments-at-once"},{"title":"Change a status's label, category or presentation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_state","href":"/api-reference/statuses-and-transitions/change-a-statuss-label-category-or-presentation"},{"title":"Rename a lifecycle, or change its description.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_state_model","href":"/api-reference/statuses-and-transitions/rename-a-lifecycle-or-change-its-description"},{"title":"Change what a transition requires, who may make it, or what it is called.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_transition","href":"/api-reference/statuses-and-transitions/change-what-a-transition-requires-who-may-make-it-or-what-it-is-called"},{"title":"Where each of a register's lifecycles applies: a site or a business unit, a type of record, or both.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /state_model_assignments","href":"/api-reference/statuses-and-transitions/where-each-of-a-registers-lifecycles-applies:-a-site-or-a-business-unit-a-type-of-record-or-both"},{"title":"The state models a tenant runs, one row per version.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /state_models","href":"/api-reference/statuses-and-transitions/the-state-models-a-tenant-runs-one-row-per-version"},{"title":"The statuses each register can be in, with how the screens should draw them. display_name is as authored, for the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /state_settings","href":"/api-reference/statuses-and-transitions/the-statuses-each-register-can-be-in-with-how-the-screens-should-draw-them-display_name-is-as-authored-for-the…"},{"title":"Which status may follow which, and what each move requires.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /state_transition_settings","href":"/api-reference/statuses-and-transitions/which-status-may-follow-which-and-what-each-move-requires"},{"title":"Per transition: who may make the move.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /transition_guards","href":"/api-reference/statuses-and-transitions/per-transition:-who-may-make-the-move"}]},{"group":"Workforce","pages":[{"title":"Create the worker row an account is assigned work through, and optionally put them in a team.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/add_user_to_workforce","href":"/api-reference/workforce/create-the-worker-row-an-account-is-assigned-work-through-and-optionally-put-them-in-a-team"},{"title":"What this work can be given to: the crews, the technicians in each of them, the technicians no crew is showing, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assignable_targets","href":"/api-reference/workforce/what-this-work-can-be-given-to:-the-crews-the-technicians-in-each-of-them-the-technicians-no-crew-is-showing-and…"},{"title":"Remove an availability entry, returning the person to their default pattern.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clear_worker_availability","href":"/api-reference/workforce/remove-an-availability-entry-returning-the-person-to-their-default-pattern"},{"title":"Give an existing technician the account they sign in with, keeping their skills and history.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/link_user_to_worker","href":"/api-reference/workforce/give-an-existing-technician-the-account-they-sign-in-with-keeping-their-skills-and-history"},{"title":"Record a certificate or a renewal.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_worker_certification","href":"/api-reference/workforce/record-a-certificate-or-a-renewal"},{"title":"Assess or re-assess a skill.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_worker_skill","href":"/api-reference/workforce/assess-or-re-assess-a-skill"},{"title":"Recompute the performance figures behind the workforce screens.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/refresh_worker_performance","href":"/api-reference/workforce/recompute-the-performance-figures-behind-the-workforce-screens"},{"title":"Take a skill off somebody's record.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/remove_worker_skill","href":"/api-reference/workforce/take-a-skill-off-somebodys-record"},{"title":"Say which asset categories, sites and work order types a team is relevant to, and which roles may see it at all.…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_team_scope","href":"/api-reference/workforce/say-which-asset-categories-sites-and-work-order-types-a-team-is-relevant-to-and-which-roles-may-see-it-at-all…"},{"title":"Add an availability window.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_worker_availability","href":"/api-reference/workforce/add-an-availability-window"},{"title":"Record that a certification has been seen and checked, and by whom.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/verify_worker_certification","href":"/api-reference/workforce/record-that-a-certification-has-been-seen-and-checked-and-by-whom"},{"title":"What each technician is carrying, against the limit they are set.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /technician_workload","href":"/api-reference/workforce/what-each-technician-is-carrying-against-the-limit-they-are-set"}]},{"group":"Welcome","pages":[{"title":"Say which industry the organisation is in, the first time it is set up.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/answer_industry","href":"/api-reference/welcome/say-which-industry-the-organisation-is-in-the-first-time-it-is-set-up"},{"title":"Say which country the organisation is based in, the first time an administrator reaches the app after signing up.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/answer_welcome","href":"/api-reference/welcome/say-which-country-the-organisation-is-based-in-the-first-time-an-administrator-reaches-the-app-after-signing-up"},{"title":"Remove the organisation's sample data.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clear_sample_data","href":"/api-reference/welcome/remove-the-organisations-sample-data"},{"title":"Whether the organisation still has the sample data it was set up with, and how many records.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/sample_data","href":"/api-reference/welcome/whether-the-organisation-still-has-the-sample-data-it-was-set-up-with-and-how-many-records"},{"title":"The countries an organisation may say it is based in, each with the currency, timezone and date format choosing it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/welcome_countries","href":"/api-reference/welcome/the-countries-an-organisation-may-say-it-is-based-in-each-with-the-currency-timezone-and-date-format-choosing-it…"},{"title":"The industries an organisation may say it is in when it is set up: a one-line summary and an icon for each, a longer…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/welcome_industries","href":"/api-reference/welcome/the-industries-an-organisation-may-say-it-is-in-when-it-is-set-up:-a-one-line-summary-and-an-icon-for-each-a-longer…"}]},{"group":"Self verification","pages":[{"title":"Answer for one asset from the link in the email.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/answer_self_verification","href":"/api-reference/self-verification/answer-for-one-asset-from-the-link-in-the-email"},{"title":"The assets this link is asking about, and what has been said about each so far.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/my_self_verification","href":"/api-reference/self-verification/the-assets-this-link-is-asking-about-and-what-has-been-said-about-each-so-far"},{"title":"Redeem a self-verification link for a one-hour session on a role that may call six functions and read no table.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/open_self_verification","href":"/api-reference/self-verification/redeem-a-self-verification-link-for-a-one-hour-session-on-a-role-that-may-call-six-functions-and-read-no-table"},{"title":"Announce a photograph against one asset on a self-verification link, then PUT the bytes to the file service exactly as…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_self_verification_upload","href":"/api-reference/self-verification/announce-a-photograph-against-one-asset-on-a-self-verification-link-then-put-the-bytes-to-the-file-service-exactly-as…"},{"title":"Send a custodian their self-verification link again on a fresh token and a fresh expiry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resend_self_verification","href":"/api-reference/self-verification/send-a-custodian-their-self-verification-link-again-on-a-fresh-token-and-a-fresh-expiry"},{"title":"Send a custodian's answers and close their link.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_self_verification","href":"/api-reference/self-verification/send-a-custodians-answers-and-close-their-link"},{"title":"Who was asked, whether they opened it and whether they answered.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /verification_responses","href":"/api-reference/self-verification/who-was-asked-whether-they-opened-it-and-whether-they-answered"}]},{"group":"IT asset software","pages":[{"title":"Assign a per-user entitlement to people — who it was bought for.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/assign_software_entitlement","href":"/api-reference/it-asset-software/assign-a-per-user-entitlement-to-people-—-who-it-was-bought-for"},{"title":"Withdraw a declaration that was wrong.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_software_entitlement","href":"/api-reference/it-asset-software/withdraw-a-declaration-that-was-wrong"},{"title":"Say what one or more names the scans reported mean: a software name maps to a catalogue product and a publisher name to…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/map_software_names","href":"/api-reference/it-asset-software/say-what-one-or-more-names-the-scans-reported-mean:-a-software-name-maps-to-a-catalogue-product-and-a-publisher-name-to…"},{"title":"Merge one product into another: every name mapped to it and every entitlement for it moves to the product it is merged…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/merge_software_products","href":"/api-reference/it-asset-software/merge-one-product-into-another:-every-name-mapped-to-it-and-every-entitlement-for-it-moves-to-the-product-it-is-merged…"},{"title":"Merge one publisher into another — \"Microsoft Corp.\" into \"Microsoft\".","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/merge_software_publishers","href":"/api-reference/it-asset-software/merge-one-publisher-into-another-—-\"microsoft-corp\"-into-\"microsoft\""},{"title":"Declare what the organisation is entitled to run of one product (no id), or change a declaration: how it is counted…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_software_entitlement","href":"/api-reference/it-asset-software/declare-what-the-organisation-is-entitled-to-run-of-one-product-no-id-or-change-a-declaration:-how-it-is-counted…"},{"title":"Add a software product under a publisher (no id), or change one: its name, publisher, category and whether it needs a…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_software_product","href":"/api-reference/it-asset-software/add-a-software-product-under-a-publisher-no-id-or-change-one:-its-name-publisher-category-and-whether-it-needs-a…"},{"title":"Add a software publisher (no id) or rename one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_software_publisher","href":"/api-reference/it-asset-software/add-a-software-publisher-no-id-or-rename-one"},{"title":"Allow, block, or return to unreviewed one or more products — the allow and deny lists.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_software_policy","href":"/api-reference/it-asset-software/allow-block-or-return-to-unreviewed-one-or-more-products-—-the-allow-and-deny-lists"},{"title":"Take a person off a per-user entitlement.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unassign_software_entitlement","href":"/api-reference/it-asset-software/take-a-person-off-a-per-user-entitlement"},{"title":"The money: licences paid for and not in use.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /software_entitled_not_installed","href":"/api-reference/it-asset-software/the-money:-licences-paid-for-and-not-in-use"},{"title":"Who each USER entitlement was bought for, and whether the product is installed on any device that person is the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /software_entitlement_assignments","href":"/api-reference/it-asset-software/who-each-user-entitlement-was-bought-for-and-whether-the-product-is-installed-on-any-device-that-person-is-the…"},{"title":"What the organisation has declared it is entitled to run: the product, how it is counted (metric DEVICE, USER…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /software_entitlements","href":"/api-reference/it-asset-software/what-the-organisation-has-declared-it-is-entitled-to-run:-the-product-how-it-is-counted-metric-device-user…"},{"title":"Software installed now: one row per product version on one device, with the device, its asset and that asset's…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /software_installations","href":"/api-reference/it-asset-software/software-installed-now:-one-row-per-product-version-on-one-device-with-the-device-its-asset-and-that-assets…"},{"title":"The exposure: each device with a product that needs a licence installed on it and no entitlement in force covering it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /software_installed_not_entitled","href":"/api-reference/it-asset-software/the-exposure:-each-device-with-a-product-that-needs-a-licence-installed-on-it-and-no-entitlement-in-force-covering-it…"},{"title":"The licence position per product that needs a licence: how many devices have it, how many of those no entitlement…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /software_licence_position","href":"/api-reference/it-asset-software/the-licence-position-per-product-that-needs-a-licence:-how-many-devices-have-it-how-many-of-those-no-entitlement…"},{"title":"Every software and publisher name the scans have reported, exactly as spelled, and what it means: the catalogue product…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /software_names","href":"/api-reference/it-asset-software/every-software-and-publisher-name-the-scans-have-reported-exactly-as-spelled-and-what-it-means:-the-catalogue-product…"},{"title":"Software installed now that the organisation's policy does not allow: BLOCKED products (the deny list), and UNREVIEWED…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /software_policy_exceptions","href":"/api-reference/it-asset-software/software-installed-now-that-the-organisations-policy-does-not-allow:-blocked-products-the-deny-list-and-unreviewed…"},{"title":"The software catalogue: each product under its publisher, with what the organisation allows of it (policy: ALLOWED…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /software_products","href":"/api-reference/it-asset-software/the-software-catalogue:-each-product-under-its-publisher-with-what-the-organisation-allows-of-it-policy:-allowed…"},{"title":"Software publishers as this organisation names them, with how many products each has in the catalogue and on how many…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /software_publishers","href":"/api-reference/it-asset-software/software-publishers-as-this-organisation-names-them-with-how-many-products-each-has-in-the-catalogue-and-on-how-many…"},{"title":"Add to software publishers: Software publishers as this organisation names them, with how many products each has in the catalogue and on how many…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /software_publishers","href":"/api-reference/it-asset-software/add-to-software-publishers:-software-publishers-as-this-organisation-names-them-with-how-many-products-each-has-in-the-catalogue-and-on-how-many…"},{"title":"Remove rows from software publishers: Software publishers as this organisation names them, with how many products each has in the catalogue and on how many…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /software_publishers","href":"/api-reference/it-asset-software/remove-rows-from-software-publishers:-software-publishers-as-this-organisation-names-them-with-how-many-products-each-has-in-the-catalogue-and-on-how-many…"},{"title":"Change rows in software publishers: Software publishers as this organisation names them, with how many products each has in the catalogue and on how many…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /software_publishers","href":"/api-reference/it-asset-software/change-rows-in-software-publishers:-software-publishers-as-this-organisation-names-them-with-how-many-products-each-has-in-the-catalogue-and-on-how-many…"},{"title":"Updates installed: operating system updates as the device reported them (change UPDATE — a Windows hotfix, a macOS…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /software_updates","href":"/api-reference/it-asset-software/updates-installed:-operating-system-updates-as-the-device-reported-them-change-update-—-a-windows-hotfix-a-macos…"}]},{"group":"Audit feed","pages":[{"title":"The audit trail in the order a security system can follow without missing anything.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/audit_feed","href":"/api-reference/audit-feed/the-audit-trail-in-the-order-a-security-system-can-follow-without-missing-anything"},{"title":"Issue a key a security system can follow the audit trail with, and nothing else.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_audit_feed_collector","href":"/api-reference/audit-feed/issue-a-key-a-security-system-can-follow-the-audit-trail-with-and-nothing-else"}]},{"group":"Licence","pages":[{"title":"Whether this caller may apply a licence, and the organisation it would be applied to.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/authorize_licence_apply","href":"/api-reference/licence/whether-this-caller-may-apply-a-licence-and-the-organisation-it-would-be-applied-to"},{"title":"This installation's id and the caller's organisation id: the two values a licence is cut against, for an administrator…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/licence_identity","href":"/api-reference/licence/this-installations-id-and-the-callers-organisation-id:-the-two-values-a-licence-is-cut-against-for-an-administrator…"},{"title":"The asset count this installation's licence was priced for, how many are registered, and how many modules are running…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/licence_limits","href":"/api-reference/licence/the-asset-count-this-installations-licence-was-priced-for-how-many-are-registered-and-how-many-modules-are-running…"},{"title":"What the licence in force says: who it was issued to, what it covers, when it was applied and which key signed it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/licence_summary","href":"/api-reference/licence/what-the-licence-in-force-says:-who-it-was-issued-to-what-it-covers-when-it-was-applied-and-which-key-signed-it"}]},{"group":"Upgrade","pages":[{"title":"Whether this caller may upgrade the installation from the browser: an administrator of the organisation the licence…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/authorize_upgrade","href":"/api-reference/upgrade/whether-this-caller-may-upgrade-the-installation-from-the-browser:-an-administrator-of-the-organisation-the-licence…"}]},{"group":"Tools","pages":[{"title":"Which tools are free for a window, and which are booked or out.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/available_tools","href":"/api-reference/tools/which-tools-are-free-for-a-window-and-which-are-booked-or-out"},{"title":"Reserve a tool for a window, refusing a clash.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/book_tool","href":"/api-reference/tools/reserve-a-tool-for-a-window-refusing-a-clash"},{"title":"Release a reservation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_tool_booking","href":"/api-reference/tools/release-a-reservation"},{"title":"Take a tool out, to a person and usually to a job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/checkout_tool","href":"/api-reference/tools/take-a-tool-out-to-a-person-and-usually-to-a-job"},{"title":"Record a calibration, and whether the tool was found out of tolerance.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/record_calibration","href":"/api-reference/tools/record-a-calibration-and-whether-the-tool-was-found-out-of-tolerance"},{"title":"Bring a tool back, with the condition it came back in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/return_tool","href":"/api-reference/tools/bring-a-tool-back-with-the-condition-it-came-back-in"},{"title":"Tool register with calibration state and current holder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tools","href":"/api-reference/tools/tool-register-with-calibration-state-and-current-holder"},{"title":"Tools with every field of the records each row points at: manufacturer, owner, site, tool room.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tools_expanded","href":"/api-reference/tools/tools-with-every-field-of-the-records-each-row-points-at:-manufacturer-owner-site-tool-room"}]},{"group":"Two-factor sign-in","pages":[{"title":"Issue a new seed for the caller and hold it unconfirmed until they prove they scanned it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/begin_mfa_enrolment","href":"/api-reference/two-factor-sign-in/issue-a-new-seed-for-the-caller-and-hold-it-unconfirmed-until-they-prove-they-scanned-it"},{"title":"Confirm an enrolment started at the sign-in screen and issue the session and recovery codes.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/complete_mfa_enrolment","href":"/api-reference/two-factor-sign-in/confirm-an-enrolment-started-at-the-sign-in-screen-and-issue-the-session-and-recovery-codes"},{"title":"Prove the seed was scanned.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/confirm_mfa_enrolment","href":"/api-reference/two-factor-sign-in/prove-the-seed-was-scanned"},{"title":"Remove your own authenticator.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/disable_mfa","href":"/api-reference/two-factor-sign-in/remove-your-own-authenticator"},{"title":"Who has a second factor and who has not, for the access screen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/mfa_enrolment","href":"/api-reference/two-factor-sign-in/who-has-a-second-factor-and-who-has-not-for-the-access-screen"},{"title":"The seed and the otpauth:// URI for somebody enrolling at the sign-in screen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/mfa_enrolment_offer","href":"/api-reference/two-factor-sign-in/the-seed-and-the-otpauth:-uri-for-somebody-enrolling-at-the-sign-in-screen"},{"title":"The caller's own second factor: the organisation's mode, whether they have one, and how many recovery codes are unspent.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/my_mfa","href":"/api-reference/two-factor-sign-in/the-callers-own-second-factor:-the-organisations-mode-whether-they-have-one-and-how-many-recovery-codes-are-unspent"},{"title":"Issue ten new recovery codes and void the old sheet.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/regenerate_recovery_codes","href":"/api-reference/two-factor-sign-in/issue-ten-new-recovery-codes-and-void-the-old-sheet"},{"title":"Clear somebody's second factor and void their recovery codes.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reset_user_mfa","href":"/api-reference/two-factor-sign-in/clear-somebodys-second-factor-and-void-their-recovery-codes"},{"title":"Finish a sign-in with an authenticator code or a recovery code.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/verify_mfa","href":"/api-reference/two-factor-sign-in/finish-a-sign-in-with-an-authenticator-code-or-a-recovery-code"}]},{"group":"Billing","pages":[{"title":"What happened to the caller's account, without our own notes about it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/billing_history","href":"/api-reference/billing/what-happened-to-the-callers-account-without-our-own-notes-about-it"},{"title":"Where the caller's own tenant stands commercially, and whether the caller may pay.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/billing_state","href":"/api-reference/billing/where-the-callers-own-tenant-stands-commercially-and-whether-the-caller-may-pay"},{"title":"Price and keep a plan selection as a draft subscription.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/choose_plan","href":"/api-reference/billing/price-and-keep-a-plan-selection-as-a-draft-subscription"},{"title":"Post rpcmy invoices","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/my_invoices","href":"/api-reference/billing/post-rpcmy_invoices"},{"title":"Each per-user plan the caller's organisation bought, with its seats and how many are taken.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/my_seats","href":"/api-reference/billing/each-per-user-plan-the-callers-organisation-bought-with-its-seats-and-how-many-are-taken"},{"title":"How many assets, users, sites, sensors, readers, trackers, tags, FF\u0026E sites, discovered devices and network collectors…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/my_usage","href":"/api-reference/billing/how-many-assets-users-sites-sensors-readers-trackers-tags-ff\u0026e-sites-discovered-devices-and-network-collectors…"},{"title":"What the caller's tenant can buy, priced by the one calculator.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/plan_catalogue","href":"/api-reference/billing/what-the-callers-tenant-can-buy-priced-by-the-one-calculator"}]},{"group":"Data exports","pages":[{"title":"Stop an export that has not finished, and free this organisation's slot for another.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/cancel_data_export","href":"/api-reference/data-exports/stop-an-export-that-has-not-finished-and-free-this-organisations-slot-for-another"},{"title":"What one export contains, one kind of record at a time, including the ones it left out and why.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/data_export_items","href":"/api-reference/data-exports/what-one-export-contains-one-kind-of-record-at-a-time-including-the-ones-it-left-out-and-why"},{"title":"Whether a new export may be asked for now, and when the next one may be if not.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/data_export_readiness","href":"/api-reference/data-exports/whether-a-new-export-may-be-asked-for-now-and-when-the-next-one-may-be-if-not"},{"title":"The parts one export's archive came to, in order, with whether each can still be downloaded.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/data_export_volumes","href":"/api-reference/data-exports/the-parts-one-exports-archive-came-to-in-order-with-whether-each-can-still-be-downloaded"},{"title":"The copies of your own data you have asked for, newest first, with whether each one can still be downloaded.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/data_exports","href":"/api-reference/data-exports/the-copies-of-your-own-data-you-have-asked-for-newest-first-with-whether-each-one-can-still-be-downloaded"},{"title":"Ask for a copy of everything you can see.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/request_data_export","href":"/api-reference/data-exports/ask-for-a-copy-of-everything-you-can-see"},{"title":"Stop the emailed link for one of your exports working.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/withdraw_data_export_link","href":"/api-reference/data-exports/stop-the-emailed-link-for-one-of-your-exports-working"}]},{"group":"Capacity","pages":[{"title":"Where the hours go: the capacity plan by asset category or by asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capacity_breakdown","href":"/api-reference/capacity/where-the-hours-go:-the-capacity-plan-by-asset-category-or-by-asset"},{"title":"The jobs and unraised rounds behind one day of the capacity plan — the working for its number.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capacity_day_demand","href":"/api-reference/capacity/the-jobs-and-unraised-rounds-behind-one-day-of-the-capacity-plan-—-the-working-for-its-number"},{"title":"Who is rostered on one day of the capacity plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capacity_day_supply","href":"/api-reference/capacity/who-is-rostered-on-one-day-of-the-capacity-plan"},{"title":"Demand against supply, one row per day per site.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capacity_plan","href":"/api-reference/capacity/demand-against-supply-one-row-per-day-per-site"},{"title":"Who is on across a range, shift by shift, with what each one is worth to the plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capacity_roster","href":"/api-reference/capacity/who-is-on-across-a-range-shift-by-shift-with-what-each-one-is-worth-to-the-plan"},{"title":"One row per bar for the technician timeline.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capacity_timeline","href":"/api-reference/capacity/one-row-per-bar-for-the-technician-timeline"},{"title":"The year plan by asset category or by asset.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capacity_year_breakdown","href":"/api-reference/capacity/the-year-plan-by-asset-category-or-by-asset"},{"title":"A year of maintenance as a matrix.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capacity_year_plan","href":"/api-reference/capacity/a-year-of-maintenance-as-a-matrix"},{"title":"The jobs, unraised rounds and projections behind one cell of the year plan.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/capacity_year_week","href":"/api-reference/capacity/the-jobs-unraised-rounds-and-projections-behind-one-cell-of-the-year-plan"}]},{"group":"Clarity","pages":[{"title":"This organisation's Microsoft Clarity project, whether the web app records into it, how much of the screen it may see…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/clarity_settings","href":"/api-reference/clarity/this-organisations-microsoft-clarity-project-whether-the-web-app-records-into-it-how-much-of-the-screen-it-may-see…"},{"title":"Create or change this organisation's Microsoft Clarity settings. p_masking is STRICT (every piece of text is masked…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_clarity_settings","href":"/api-reference/clarity/create-or-change-this-organisations-microsoft-clarity-settings-p_masking-is-strict-every-piece-of-text-is-masked…"},{"title":"Whether the web app records this session into the organisation's Microsoft Clarity project, and what it tells Clarity…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/session_recorder","href":"/api-reference/clarity/whether-the-web-app-records-this-session-into-the-organisations-microsoft-clarity-project-and-what-it-tells-clarity…"}]},{"group":"Sites and locations","pages":[{"title":"The timezone a site in each country starts on, keyed by the country's id — the value a country picker sets — with its…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/country_timezones","href":"/api-reference/sites-and-locations/the-timezone-a-site-in-each-country-starts-on-keyed-by-the-countrys-id-—-the-value-a-country-picker-sets-—-with-its…"},{"title":"Add one site, with the same numbering, rules, reference checks and approval gate as the Sites screen.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_site","href":"/api-reference/sites-and-locations/add-one-site-with-the-same-numbering-rules-reference-checks-and-approval-gate-as-the-sites-screen"},{"title":"Say who answers for a location when its primary head does not.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_location_alternate_heads","href":"/api-reference/sites-and-locations/say-who-answers-for-a-location-when-its-primary-head-does-not"},{"title":"Change one site — its name, address, city, coordinates (`latitude` and `longitude`), `timezone` (an IANA name such as…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/update_site","href":"/api-reference/sites-and-locations/change-one-site-—-its-name-address-city-coordinates-`latitude`-and-`longitude`-`timezone`-an-iana-name-such-as…"}]},{"group":"Tenant switch","pages":[{"title":"Open a further organisation from inside the product and become its administrator.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_organization","href":"/api-reference/tenant-switch/open-a-further-organisation-from-inside-the-product-and-become-its-administrator"},{"title":"The tenants this person can switch between, their current one first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/my_organizations","href":"/api-reference/tenant-switch/the-tenants-this-person-can-switch-between-their-current-one-first"},{"title":"Exchange this session for one in another tenant the same person holds an account in.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/switch_organization","href":"/api-reference/tenant-switch/exchange-this-session-for-one-in-another-tenant-the-same-person-holds-an-account-in"}]},{"group":"SCIM provisioning","pages":[{"title":"Issue a provisioning token and return it once.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/create_scim_token","href":"/api-reference/scim-provisioning/issue-a-provisioning-token-and-return-it-once"},{"title":"Revoke a provisioning token.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/revoke_scim_token","href":"/api-reference/scim-provisioning/revoke-a-provisioning-token"},{"title":"Groups the directory has pushed, with how many people are in each and what each grants here.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /scim_groups","href":"/api-reference/scim-provisioning/groups-the-directory-has-pushed-with-how-many-people-are-in-each-and-what-each-grants-here"},{"title":"The provisioning tokens this tenant has issued.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /scim_tokens","href":"/api-reference/scim-provisioning/the-provisioning-tokens-this-tenant-has-issued"}]},{"group":"Rules","pages":[{"title":"Retire a rule and stop it running.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_rule","href":"/api-reference/rules/retire-a-rule-and-stop-it-running"},{"title":"Put a rule live, return it to draft, or retire it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/publish_rule","href":"/api-reference/rules/put-a-rule-live-return-it-to-draft-or-retire-it"},{"title":"The events, operators and actions the rule engine implements, for building an editor from.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rule_vocabulary","href":"/api-reference/rules/the-events-operators-and-actions-the-rule-engine-implements-for-building-an-editor-from"},{"title":"Create or update a rule with its actions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_rule","href":"/api-reference/rules/create-or-update-a-rule-with-its-actions"},{"title":"Evaluate a rule against one record and return the working.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/try_rule","href":"/api-reference/rules/evaluate-a-rule-against-one-record-and-return-the-working"},{"title":"What each rule does when it matches, and whether the caller or the worker does it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rule_actions","href":"/api-reference/rules/what-each-rule-does-when-it-matches-and-whether-the-caller-or-the-worker-does-it"},{"title":"Add to rule actions: What each rule does when it matches, and whether the caller or the worker does it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rule_actions","href":"/api-reference/rules/add-to-rule-actions:-what-each-rule-does-when-it-matches-and-whether-the-caller-or-the-worker-does-it"},{"title":"Remove rows from rule actions: What each rule does when it matches, and whether the caller or the worker does it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /rule_actions","href":"/api-reference/rules/remove-rows-from-rule-actions:-what-each-rule-does-when-it-matches-and-whether-the-caller-or-the-worker-does-it"},{"title":"Change rows in rule actions: What each rule does when it matches, and whether the caller or the worker does it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /rule_actions","href":"/api-reference/rules/change-rows-in-rule-actions:-what-each-rule-does-when-it-matches-and-whether-the-caller-or-the-worker-does-it"},{"title":"What each rule decided, when, and the per-clause working behind it.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rule_evaluations","href":"/api-reference/rules/what-each-rule-decided-when-and-the-per-clause-working-behind-it"},{"title":"Configured rules with how often each has actually matched and when it last did.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /rules","href":"/api-reference/rules/configured-rules-with-how-often-each-has-actually-matched-and-when-it-last-did"}]},{"group":"Today","pages":[{"title":"Remove one role's Today layout, or the organisation's when no role is given.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_today_layout","href":"/api-reference/today/remove-one-roles-today-layout-or-the-organisations-when-no-role-is-given"},{"title":"The layout the calling user's Today starts from — their first role's that has one, else the organisation's, else the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/my_today_layout","href":"/api-reference/today/the-layout-the-calling-users-today-starts-from-—-their-first-roles-that-has-one-else-the-organisations-else-the…"},{"title":"Set which role's Today layout wins for somebody who holds several, first to last.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/order_today_layouts","href":"/api-reference/today/set-which-roles-today-layout-wins-for-somebody-who-holds-several-first-to-last"},{"title":"Forget the calling user's own changes to Today, so it draws the layout their roles give them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reset_my_today_layout","href":"/api-reference/today/forget-the-calling-users-own-changes-to-today-so-it-draws-the-layout-their-roles-give-them"},{"title":"Keep the calling user's own changes to Today: sections hidden, shown or moved, widgets pinned and numbers set.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_my_today_layout","href":"/api-reference/today/keep-the-calling-users-own-changes-to-today:-sections-hidden-shown-or-moved-widgets-pinned-and-numbers-set"},{"title":"Set the Today layout for one role, or for the whole organisation when no role is given.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_today_layout","href":"/api-reference/today/set-the-today-layout-for-one-role-or-for-the-whole-organisation-when-no-role-is-given"},{"title":"The Today layouts set for the whole organisation (no role) and for individual roles, lowest precedence first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /today_layouts","href":"/api-reference/today/the-today-layouts-set-for-the-whole-organisation-no-role-and-for-individual-roles-lowest-precedence-first"}]},{"group":"Webhooks","pages":[{"title":"Delete a webhook endpoint with its subscriptions and its delivery log.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/delete_webhook_endpoint","href":"/api-reference/webhooks/delete-a-webhook-endpoint-with-its-subscriptions-and-its-delivery-log"},{"title":"Send a dead or delivered webhook call again, with the same id and body and a fresh set of attempts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/resend_webhook_delivery","href":"/api-reference/webhooks/send-a-dead-or-delivered-webhook-call-again-with-the-same-id-and-body-and-a-fresh-set-of-attempts"},{"title":"Replace a webhook endpoint's signing secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rotate_webhook_secret","href":"/api-reference/webhooks/replace-a-webhook-endpoints-signing-secret"},{"title":"Create or change a webhook endpoint.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_webhook_endpoint","href":"/api-reference/webhooks/create-or-change-a-webhook-endpoint"},{"title":"Queue one signed test call (type webhook.test) to an endpoint, whether or not it is switched on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/send_webhook_test","href":"/api-reference/webhooks/queue-one-signed-test-call-type-webhooktest-to-an-endpoint-whether-or-not-it-is-switched-on"},{"title":"Recent webhook deliveries, newest first: the event, its status (PENDING, RETRYING, DELIVERED or DEAD), the attempts…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/webhook_deliveries","href":"/api-reference/webhooks/recent-webhook-deliveries-newest-first:-the-event-its-status-pending-retrying-delivered-or-dead-the-attempts…"},{"title":"This organisation's webhook endpoints: what each is called, the host it posts to, the events it is subscribed to, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/webhook_endpoints","href":"/api-reference/webhooks/this-organisations-webhook-endpoints:-what-each-is-called-the-host-it-posts-to-the-events-it-is-subscribed-to-and…"},{"title":"Every event a webhook endpoint can subscribe to in this organisation. family is record (a change to a register…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /webhook_events","href":"/api-reference/webhooks/every-event-a-webhook-endpoint-can-subscribe-to-in-this-organisation-family-is-record-a-change-to-a-register…"}]},{"group":"Reference","pages":[{"title":"Describe one call on this API: its method and path, what it takes or what it returns, and the sentences the reference…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/describe_call","href":"/api-reference/reference/describe-one-call-on-this-api:-its-method-and-path-what-it-takes-or-what-it-returns-and-the-sentences-the-reference…"}]},{"group":"Directory sync","pages":[{"title":"One connection's sync settings and its last run.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/directory_sync","href":"/api-reference/directory-sync/one-connections-sync-settings-and-its-last-run"},{"title":"What one run decided, person by person, refusals first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/provisioning_events","href":"/api-reference/directory-sync/what-one-run-decided-person-by-person-refusals-first"},{"title":"What each pass over this directory decided.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/provisioning_runs","href":"/api-reference/directory-sync/what-each-pass-over-this-directory-decided"},{"title":"Ask the worker to read this directory on its next pass, applying or as a dry run.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_directory_sync","href":"/api-reference/directory-sync/ask-the-worker-to-read-this-directory-on-its-next-pass-applying-or-as-a-dry-run"},{"title":"Configure reading accounts from a directory.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_directory_sync","href":"/api-reference/directory-sync/configure-reading-accounts-from-a-directory"}]},{"group":"Dispatch","pages":[{"title":"Assign a job from the dispatch board — to a person, a crew or a supplier — moving it if a time is given.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispatch_assign","href":"/api-reference/dispatch/assign-a-job-from-the-dispatch-board-—-to-a-person-a-crew-or-a-supplier-—-moving-it-if-a-time-is-given"},{"title":"The dispatch board.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispatch_board","href":"/api-reference/dispatch/the-dispatch-board"},{"title":"The columns the dispatch board should draw, in order, and the tenant's own word for each where there is one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispatch_columns","href":"/api-reference/dispatch/the-columns-the-dispatch-board-should-draw-in-order-and-the-tenants-own-word-for-each-where-there-is-one"},{"title":"The crews and suppliers a card can be dropped on, with the facts that decide it: a crew's size and how many of them are…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispatch_parties","href":"/api-reference/dispatch/the-crews-and-suppliers-a-card-can-be-dropped-on-with-the-facts-that-decide-it:-a-crews-size-and-how-many-of-them-are…"},{"title":"The consequences of dropping this job on this person, crew or supplier at this time.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispatch_preview","href":"/api-reference/dispatch/the-consequences-of-dropping-this-job-on-this-person-crew-or-supplier-at-this-time"},{"title":"The people the board can drop work on.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/dispatch_technicians","href":"/api-reference/dispatch/the-people-the-board-can-drop-work-on"}]},{"group":"Extracts","pages":[{"title":"One extract's columns in order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/extract_columns","href":"/api-reference/extracts/one-extracts-columns-in-order"},{"title":"What each run of one extract produced, with the checksum it shipped.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/extract_runs","href":"/api-reference/extracts/what-each-run-of-one-extract-produced-with-the-checksum-it-shipped"},{"title":"The columns of one entity an extract may send.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/extractable_columns","href":"/api-reference/extracts/the-columns-of-one-entity-an-extract-may-send"},{"title":"The extracts this tenant sends and how the last run of each went.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/extracts","href":"/api-reference/extracts/the-extracts-this-tenant-sends-and-how-the-last-run-of-each-went"},{"title":"Stop sending an extract.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/forget_extract","href":"/api-reference/extracts/stop-sending-an-extract"},{"title":"Raise an extract's version, freeing its columns to be rearranged.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/raise_extract_version","href":"/api-reference/extracts/raise-an-extracts-version-freeing-its-columns-to-be-rearranged"},{"title":"Wind an extract's watermark back so a window is produced again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/rewind_extract","href":"/api-reference/extracts/wind-an-extracts-watermark-back-so-a-window-is-produced-again"},{"title":"Produce this extract on the next pass rather than at the next interval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_extract","href":"/api-reference/extracts/produce-this-extract-on-the-next-pass-rather-than-at-the-next-interval"},{"title":"Create or update an extract.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_extract","href":"/api-reference/extracts/create-or-update-an-extract"},{"title":"Set an extract's columns in order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_extract_columns","href":"/api-reference/extracts/set-an-extracts-columns-in-order"}]},{"group":"File exchange","pages":[{"title":"What each look at one server found.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/file_exchange_runs","href":"/api-reference/file-exchange/what-each-look-at-one-server-found"},{"title":"The SFTP connections this tenant exchanges files with, and how the last look at each went.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/file_exchanges","href":"/api-reference/file-exchange/the-sftp-connections-this-tenant-exchanges-files-with-and-how-the-last-look-at-each-went"},{"title":"Stop watching for one feed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/forget_watched_file","href":"/api-reference/file-exchange/stop-watching-for-one-feed"},{"title":"The files one connection has seen and what became of each, refusals first.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/landed_files","href":"/api-reference/file-exchange/the-files-one-connection-has-seen-and-what-became-of-each-refusals-first"},{"title":"Look at this server on the next pass rather than at the next interval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_file_exchange","href":"/api-reference/file-exchange/look-at-this-server-on-the-next-pass-rather-than-at-the-next-interval"},{"title":"Create or update an SFTP connection.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_file_exchange","href":"/api-reference/file-exchange/create-or-update-an-sftp-connection"},{"title":"Create or update one feed on an SFTP connection.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_watched_file","href":"/api-reference/file-exchange/create-or-update-one-feed-on-an-sftp-connection"},{"title":"The feeds on one SFTP connection.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/watched_files","href":"/api-reference/file-exchange/the-feeds-on-one-sftp-connection"}]},{"group":"Filing exceptions","pages":[{"title":"How many records are already filed against a category, a place or a kind of work that has something under it, per…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/filing_exceptions","href":"/api-reference/filing-exceptions/how-many-records-are-already-filed-against-a-category-a-place-or-a-kind-of-work-that-has-something-under-it-per…"},{"title":"The registers this organisation answers with the last level on at least one form.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/registers_filed_at_last_level","href":"/api-reference/filing-exceptions/the-registers-this-organisation-answers-with-the-last-level-on-at-least-one-form"}]},{"group":"Platform","pages":[{"title":"Scheduled job status.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/job_health","href":"/api-reference/platform/scheduled-job-status"},{"title":"Recent runs of one job, or of all of them.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/job_runs","href":"/api-reference/platform/recent-runs-of-one-job-or-of-all-of-them"},{"title":"Run a scheduled job now, for the caller's tenant.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/run_job","href":"/api-reference/platform/run-a-scheduled-job-now-for-the-callers-tenant"}]},{"group":"Mapping","pages":[{"title":"What the model proposed for the columns counting could not place, and whether anybody has decided on each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/mapping_suggestions","href":"/api-reference/mapping/what-the-model-proposed-for-the-columns-counting-could-not-place-and-whether-anybody-has-decided-on-each"},{"title":"Ask the model to place the columns counting could not.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/suggest_mapping","href":"/api-reference/mapping/ask-the-model-to-place-the-columns-counting-could-not"}]},{"group":"Reference entry","pages":[{"title":"Whether this organisation picks a manufacturer and a model out of the register or types their names.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reference_entry_policy","href":"/api-reference/reference-entry/whether-this-organisation-picks-a-manufacturer-and-a-model-out-of-the-register-or-types-their-names"},{"title":"The registers a typed name would be matched against, how many rows each holds, and how many names appear on one more…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/reference_entry_registers","href":"/api-reference/reference-entry/the-registers-a-typed-name-would-be-matched-against-how-many-rows-each-holds-and-how-many-names-appear-on-one-more…"},{"title":"Choose how this organisation answers a manufacturer and a model.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/set_reference_entry_policy","href":"/api-reference/reference-entry/choose-how-this-organisation-answers-a-manufacturer-and-a-model"}]},{"group":"Release","pages":[{"title":"Which release this installation runs, which exist, and whether the licence covers the gap.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/release_status","href":"/api-reference/release/which-release-this-installation-runs-which-exist-and-whether-the-licence-covers-the-gap"}]},{"group":"Security streams","pages":[{"title":"Create or change where this organisation's audit trail is pushed as OpenTelemetry logs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_security_stream","href":"/api-reference/security-streams/create-or-change-where-this-organisations-audit-trail-is-pushed-as-opentelemetry-logs"},{"title":"Where this organisation's audit trail is pushed as OpenTelemetry logs, how far delivery has got and the last error, if…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/security_stream","href":"/api-reference/security-streams/where-this-organisations-audit-trail-is-pushed-as-opentelemetry-logs-how-far-delivery-has-got-and-the-last-error-if…"},{"title":"Ask the worker to send one test event to this organisation's collector.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/test_security_stream","href":"/api-reference/security-streams/ask-the-worker-to-send-one-test-event-to-this-organisations-collector"}]},{"group":"T\u0026C appraisal notes","pages":[{"title":"Add a T\u0026C appraisal note (p_id null) or change one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/save_tnc_appraisal_note","href":"/api-reference/t\u0026c-appraisal-notes/add-a-t\u0026c-appraisal-note-p_id-null-or-change-one"},{"title":"Send a T\u0026C appraisal note for approval.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/submit_tnc_appraisal_note","href":"/api-reference/t\u0026c-appraisal-notes/send-a-t\u0026c-appraisal-note-for-approval"},{"title":"The items a T\u0026C appraisal note buys, a row per item: specification (the Item/Specification, up to 500 characters)…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tnc_appraisal_note_items","href":"/api-reference/t\u0026c-appraisal-notes/the-items-a-t\u0026c-appraisal-note-buys-a-row-per-item:-specification-the-itemspecification-up-to-500-characters…"},{"title":"Add to tnc appraisal note items: The items a T\u0026C appraisal note buys, a row per item: specification (the Item/Specification, up to 500 characters)…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tnc_appraisal_note_items","href":"/api-reference/t\u0026c-appraisal-notes/add-to-tnc-appraisal-note-items:-the-items-a-t\u0026c-appraisal-note-buys-a-row-per-item:-specification-the-itemspecification-up-to-500-characters…"},{"title":"Remove rows from tnc appraisal note items: The items a T\u0026C appraisal note buys, a row per item: specification (the Item/Specification, up to 500 characters)…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /tnc_appraisal_note_items","href":"/api-reference/t\u0026c-appraisal-notes/remove-rows-from-tnc-appraisal-note-items:-the-items-a-t\u0026c-appraisal-note-buys-a-row-per-item:-specification-the-itemspecification-up-to-500-characters…"},{"title":"Change rows in tnc appraisal note items: The items a T\u0026C appraisal note buys, a row per item: specification (the Item/Specification, up to 500 characters)…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /tnc_appraisal_note_items","href":"/api-reference/t\u0026c-appraisal-notes/change-rows-in-tnc-appraisal-note-items:-the-items-a-t\u0026c-appraisal-note-buys-a-row-per-item:-specification-the-itemspecification-up-to-500-characters…"},{"title":"The T\u0026C appraisal notes: the papers a manager's IT purchase is appraised on before it is bought, a row per note, each…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tnc_appraisal_notes","href":"/api-reference/t\u0026c-appraisal-notes/the-t\u0026c-appraisal-notes:-the-papers-a-managers-it-purchase-is-appraised-on-before-it-is-bought-a-row-per-note-each…"},{"title":"Where a T\u0026C appraisal note's manager can sit: the values of your organisation's list named Manager Location, in the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tnc_manager_locations","href":"/api-reference/t\u0026c-appraisal-notes/where-a-t\u0026c-appraisal-notes-manager-can-sit:-the-values-of-your-organisations-list-named-manager-location-in-the…"},{"title":"Add to tnc manager locations: Where a T\u0026C appraisal note's manager can sit: the values of your organisation's list named Manager Location, in the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tnc_manager_locations","href":"/api-reference/t\u0026c-appraisal-notes/add-to-tnc-manager-locations:-where-a-t\u0026c-appraisal-notes-manager-can-sit:-the-values-of-your-organisations-list-named-manager-location-in-the…"},{"title":"Remove rows from tnc manager locations: Where a T\u0026C appraisal note's manager can sit: the values of your organisation's list named Manager Location, in the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /tnc_manager_locations","href":"/api-reference/t\u0026c-appraisal-notes/remove-rows-from-tnc-manager-locations:-where-a-t\u0026c-appraisal-notes-manager-can-sit:-the-values-of-your-organisations-list-named-manager-location-in-the…"},{"title":"Change rows in tnc manager locations: Where a T\u0026C appraisal note's manager can sit: the values of your organisation's list named Manager Location, in the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /tnc_manager_locations","href":"/api-reference/t\u0026c-appraisal-notes/change-rows-in-tnc-manager-locations:-where-a-t\u0026c-appraisal-notes-manager-can-sit:-the-values-of-your-organisations-list-named-manager-location-in-the…"}]},{"group":"Search","pages":[{"title":"One search across every register a caller can already open.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/search","href":"/api-reference/search/one-search-across-every-register-a-caller-can-already-open"}]},{"group":"Setup","pages":[{"title":"The setup checklist: what the system needs, in order, with what this caller has and may do.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/setup_progress","href":"/api-reference/setup/the-setup-checklist:-what-the-system-needs-in-order-with-what-this-caller-has-and-may-do"},{"title":"Say this tenant does not need a checklist line, and why.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/skip_setup_step","href":"/api-reference/setup/say-this-tenant-does-not-need-a-checklist-line-and-why"},{"title":"Put a skipped checklist line back on the list.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/unskip_setup_step","href":"/api-reference/setup/put-a-skipped-checklist-line-back-on-the-list"}]},{"group":"Support","pages":[{"title":"The support messenger's workspace and the caller's verified identity in it, or NULL when this deployment has no…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/support_messenger","href":"/api-reference/support/the-support-messengers-workspace-and-the-callers-verified-identity-in-it-or-null-when-this-deployment-has-no…"},{"title":"Who from the vendor has access to this organisation, why, and until when.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /support_access","href":"/api-reference/support/who-from-the-vendor-has-access-to-this-organisation-why-and-until-when"}]},{"group":"Tray","pages":[{"title":"How many items each of the four header trays would show: unread notifications, conversations with unread messages…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/tray_counts","href":"/api-reference/tray/how-many-items-each-of-the-four-header-trays-would-show:-unread-notifications-conversations-with-unread-messages…"}]},{"group":"User activity","pages":[{"title":"Every person in the organisation with how many records they created, changed and deleted in the period, how many…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/user_activity","href":"/api-reference/user-activity/every-person-in-the-organisation-with-how-many-records-they-created-changed-and-deleted-in-the-period-how-many…"},{"title":"The changes behind one count on the User activity screen: one person's creates, changes and deletes to one kind of…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/user_activity_events","href":"/api-reference/user-activity/the-changes-behind-one-count-on-the-user-activity-screen:-one-persons-creates-changes-and-deletes-to-one-kind-of…"},{"title":"One person's creates, changes and deletes in the period, a row per module, adding up to their row on user_activity.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/user_activity_modules","href":"/api-reference/user-activity/one-persons-creates-changes-and-deletes-in-the-period-a-row-per-module-adding-up-to-their-row-on-user_activity"},{"title":"One person's creates, changes and deletes in one module, a row per kind of record, with how many different records they…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/user_activity_record_types","href":"/api-reference/user-activity/one-persons-creates-changes-and-deletes-in-one-module-a-row-per-kind-of-record-with-how-many-different-records-they…"}]},{"group":"Vendor spend forecast","pages":[{"title":"What the suppliers are likely to invoice over the coming months, from the invoices accepted against past work orders.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/vendor_spend_forecast","href":"/api-reference/vendor-spend-forecast/what-the-suppliers-are-likely-to-invoice-over-the-coming-months-from-the-invoices-accepted-against-past-work-orders"},{"title":"What `api.vendor_spend_forecast` was built from: the horizon, the look-back window actually used (shortened to the…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /rpc/vendor_spend_forecast_basis","href":"/api-reference/vendor-spend-forecast/what-`apivendor_spend_forecast`-was-built-from:-the-horizon-the-look-back-window-actually-used-shortened-to-the…"}]},{"group":"Calibration history","pages":[{"title":"Approved substitutes for a tool, so a booking conflict can offer one rather than a reschedule.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tool_alternatives","href":"/api-reference/calibration-history/approved-substitutes-for-a-tool-so-a-booking-conflict-can-offer-one-rather-than-a-reschedule"},{"title":"Calibrations recorded against a tool.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tool_calibration_history","href":"/api-reference/calibration-history/calibrations-recorded-against-a-tool"},{"title":"Certificates attached to a tool, with the countdown and whether a lapse stops it being issued.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tool_certifications","href":"/api-reference/calibration-history/certificates-attached-to-a-tool-with-the-countdown-and-whether-a-lapse-stops-it-being-issued"},{"title":"What has been done to a tool, what it cost, and what is due again.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tool_maintenance","href":"/api-reference/calibration-history/what-has-been-done-to-a-tool-what-it-cost-and-what-is-due-again"},{"title":"Who attended what, how it went, and when it needs refreshing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /training_records","href":"/api-reference/calibration-history/who-attended-what-how-it-went-and-when-it-needs-refreshing"}]},{"group":"Tools on jobs","pages":[{"title":"Reservations on a tool.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tool_bookings","href":"/api-reference/tools-on-jobs/reservations-on-a-tool"},{"title":"Tools taken out and brought back.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tool_checkouts","href":"/api-reference/tools-on-jobs/tools-taken-out-and-brought-back"},{"title":"Items listed on a work order in free text, each a description and a quantity.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_items","href":"/api-reference/tools-on-jobs/items-listed-on-a-work-order-in-free-text-each-a-description-and-a-quantity"},{"title":"The tools a job needs. any_of_type marks a requirement any tool of the type satisfies.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_tools","href":"/api-reference/tools-on-jobs/the-tools-a-job-needs-any_of_type-marks-a-requirement-any-tool-of-the-type-satisfies"}]},{"group":"Tool configuration","pages":[{"title":"Tool categories as a tree, with the tool types under each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tool_category_settings","href":"/api-reference/tool-configuration/tool-categories-as-a-tree-with-the-tool-types-under-each"},{"title":"Tool conditions in rank order, with how many tools are in each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tool_condition_settings","href":"/api-reference/tool-configuration/tool-conditions-in-rank-order-with-how-many-tools-are-in-each"},{"title":"Add to tool condition settings: Tool conditions in rank order, with how many tools are in each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tool_condition_settings","href":"/api-reference/tool-configuration/add-to-tool-condition-settings:-tool-conditions-in-rank-order-with-how-many-tools-are-in-each"},{"title":"Remove rows from tool condition settings: Tool conditions in rank order, with how many tools are in each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /tool_condition_settings","href":"/api-reference/tool-configuration/remove-rows-from-tool-condition-settings:-tool-conditions-in-rank-order-with-how-many-tools-are-in-each"},{"title":"Change rows in tool condition settings: Tool conditions in rank order, with how many tools are in each.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /tool_condition_settings","href":"/api-reference/tool-configuration/change-rows-in-tool-condition-settings:-tool-conditions-in-rank-order-with-how-many-tools-are-in-each"},{"title":"Tool statuses.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tool_status_settings","href":"/api-reference/tool-configuration/tool-statuses"},{"title":"Add to tool status settings: Tool statuses.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /tool_status_settings","href":"/api-reference/tool-configuration/add-to-tool-status-settings:-tool-statuses"},{"title":"Remove rows from tool status settings: Tool statuses.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /tool_status_settings","href":"/api-reference/tool-configuration/remove-rows-from-tool-status-settings:-tool-statuses"},{"title":"Change rows in tool status settings: Tool statuses.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /tool_status_settings","href":"/api-reference/tool-configuration/change-rows-in-tool-status-settings:-tool-statuses"},{"title":"Tool types with what they demand.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /tool_type_settings","href":"/api-reference/tool-configuration/tool-types-with-what-they-demand"}]},{"group":"Work order execution","pages":[{"title":"One thing a supplier says they used or did.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_invoice_lines","href":"/api-reference/work-order-execution/one-thing-a-supplier-says-they-used-or-did"},{"title":"What a supplier says is owed for one job — the parts, the hours and their account of the failure — whether the buyer…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /vendor_invoices","href":"/api-reference/work-order-execution/what-a-supplier-says-is-owed-for-one-job-—-the-parts-the-hours-and-their-account-of-the-failure-—-whether-the-buyer…"},{"title":"Hours booked to a work order, planned against actual, with whose time it was.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_labour","href":"/api-reference/work-order-execution/hours-booked-to-a-work-order-planned-against-actual-with-whose-time-it-was"},{"title":"Work order labour with every field of the records each row points at: technician, vendor, work order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_labour_expanded","href":"/api-reference/work-order-execution/work-order-labour-with-every-field-of-the-records-each-row-points-at:-technician-vendor-work-order"},{"title":"Parts booked to a work order. quantity_used is consumption net of returns.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_parts","href":"/api-reference/work-order-execution/parts-booked-to-a-work-order-quantity_used-is-consumption-net-of-returns"},{"title":"Work order parts with every field of the records each row points at: part, substituted part, warehouse, work order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_parts_expanded","href":"/api-reference/work-order-execution/work-order-parts-with-every-field-of-the-records-each-row-points-at:-part-substituted-part-warehouse-work-order"},{"title":"What a quoted price is made of, where the supplier broke it down.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_quote_lines","href":"/api-reference/work-order-execution/what-a-quoted-price-is-made-of-where-the-supplier-broke-it-down"},{"title":"Add to work order quote lines: What a quoted price is made of, where the supplier broke it down.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /work_order_quote_lines","href":"/api-reference/work-order-execution/add-to-work-order-quote-lines:-what-a-quoted-price-is-made-of-where-the-supplier-broke-it-down"},{"title":"Remove rows from work order quote lines: What a quoted price is made of, where the supplier broke it down.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /work_order_quote_lines","href":"/api-reference/work-order-execution/remove-rows-from-work-order-quote-lines:-what-a-quoted-price-is-made-of-where-the-supplier-broke-it-down"},{"title":"Change rows in work order quote lines: What a quoted price is made of, where the supplier broke it down.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /work_order_quote_lines","href":"/api-reference/work-order-execution/change-rows-in-work-order-quote-lines:-what-a-quoted-price-is-made-of-where-the-supplier-broke-it-down"},{"title":"What a supplier says a job will cost, who asked, whether the buyer agreed, and what the job has actually cost since.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_quotes","href":"/api-reference/work-order-execution/what-a-supplier-says-a-job-will-cost-who-asked-whether-the-buyer-agreed-and-what-the-job-has-actually-cost-since"},{"title":"Every drawing and document a job's checklist points at, in one list per job, so a handset can fetch them all before it…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_reference_files","href":"/api-reference/work-order-execution/every-drawing-and-document-a-jobs-checklist-points-at-in-one-list-per-job-so-a-handset-can-fetch-them-all-before-it…"},{"title":"Every SLA extension granted on a work order, a row per field it changed: who asked (requested_by), when they asked…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_sla_changes","href":"/api-reference/work-order-execution/every-sla-extension-granted-on-a-work-order-a-row-per-field-it-changed:-who-asked-requested_by-when-they-asked…"},{"title":"What happened to a work order's SLA, in the order it happened: targets set, the clock paused and resumed, warnings, and…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_sla_log","href":"/api-reference/work-order-execution/what-happened-to-a-work-orders-sla-in-the-order-it-happened:-targets-set-the-clock-paused-and-resumed-warnings-and…"},{"title":"Every status a work order has been in, in order, with how long it stayed — the current one included, with is_running…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_status_log","href":"/api-reference/work-order-execution/every-status-a-work-order-has-been-in-in-order-with-how-long-it-stayed-—-the-current-one-included-with-is_running…"},{"title":"The sections a job's checklist is planned in, with the heading and the paragraph a technician reads before the first…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_task_blocks","href":"/api-reference/work-order-execution/the-sections-a-jobs-checklist-is-planned-in-with-the-heading-and-the-paragraph-a-technician-reads-before-the-first…"},{"title":"Add to work order task blocks: The sections a job's checklist is planned in, with the heading and the paragraph a technician reads before the first…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /work_order_task_blocks","href":"/api-reference/work-order-execution/add-to-work-order-task-blocks:-the-sections-a-jobs-checklist-is-planned-in-with-the-heading-and-the-paragraph-a-technician-reads-before-the-first…"},{"title":"Remove rows from work order task blocks: The sections a job's checklist is planned in, with the heading and the paragraph a technician reads before the first…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /work_order_task_blocks","href":"/api-reference/work-order-execution/remove-rows-from-work-order-task-blocks:-the-sections-a-jobs-checklist-is-planned-in-with-the-heading-and-the-paragraph-a-technician-reads-before-the-first…"},{"title":"Change rows in work order task blocks: The sections a job's checklist is planned in, with the heading and the paragraph a technician reads before the first…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /work_order_task_blocks","href":"/api-reference/work-order-execution/change-rows-in-work-order-task-blocks:-the-sections-a-jobs-checklist-is-planned-in-with-the-heading-and-the-paragraph-a-technician-reads-before-the-first…"},{"title":"The checklist on a work order.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_tasks","href":"/api-reference/work-order-execution/the-checklist-on-a-work-order"},{"title":"Clock-in and clock-out segments against a work order, per worker — or, lacking one, per account, named from created_by…","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /work_order_time_entries","href":"/api-reference/work-order-execution/clock-in-and-clock-out-segments-against-a-work-order-per-worker-—-or-lacking-one-per-account-named-from-created_by…"}]}]}]}]},"basePath":"","title":"Give a lost report to a team, an officer on it, or both, and tell them. - Asset Infinity","buildId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","deploymentId":"dpl_345ReqzYaAjzS9QpeJemsKdb7KDj","dynamics":["b0f84f53ff"],"chunks":["Page-Buji1S4J.js","ApiExamples-BNP-Fvr0.js","utils-0BK-9q6z.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","cloneDeep-izs3Hzxb.js","utils-DfjzsUJT.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BSgu6h1D.js","shallow-Biv1i9Gs.js","snippetPresets-CpTQv-Ez.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","getApiPlaygroundDisplay-BoGOXhtF.js","CodeSnippet-DvQoT18_.js","CodeSnippets-Dnpa15xT.js","getPastedJson-xAIyhUFE.js","icon-S6FBih11.js","MethodPill-SaYeUZyk.js","DuplicateIcon-Cs-p3v2Q.js","createIcon-DjCFEoHq.js","DynamicMarkdown-BcnBltEQ.js","addUniqueKeysToSchema-B4v9psJ4.js","SectionHeading-BUBl0eEF.js","axios-vUo_bRtp.js"]}
